Class ExamplesOverride.Builder (1.15.0)

public static final class ExamplesOverride.Builder extends GeneratedMessageV3.Builder<ExamplesOverride.Builder> implements ExamplesOverrideOrBuilder

Overrides for example-based explanations.

Protobuf type google.cloud.vertexai.v1.ExamplesOverride

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExamplesOverride.Builder

Implements

ExamplesOverrideOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllRestrictions(Iterable<? extends ExamplesRestrictionsNamespace> values)

public ExamplesOverride.Builder addAllRestrictions(Iterable<? extends ExamplesRestrictionsNamespace> values)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.vertexai.api.ExamplesRestrictionsNamespace>`

Returns
Type	Description
`ExamplesOverride.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExamplesOverride.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addRestrictions(ExamplesRestrictionsNamespace value)

public ExamplesOverride.Builder addRestrictions(ExamplesRestrictionsNamespace value)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`value`	`ExamplesRestrictionsNamespace`

Returns
Type	Description
`ExamplesOverride.Builder`

addRestrictions(ExamplesRestrictionsNamespace.Builder builderForValue)

public ExamplesOverride.Builder addRestrictions(ExamplesRestrictionsNamespace.Builder builderForValue)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`builderForValue`	`ExamplesRestrictionsNamespace.Builder`

Returns
Type	Description
`ExamplesOverride.Builder`

addRestrictions(int index, ExamplesRestrictionsNamespace value)

public ExamplesOverride.Builder addRestrictions(int index, ExamplesRestrictionsNamespace value)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
Name	Description
`index`	`int`
`value`	`ExamplesRestrictionsNamespace`

Returns
Type	Description
`ExamplesOverride.Builder`

addRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)

public ExamplesOverride.Builder addRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ExamplesRestrictionsNamespace.Builder`

Returns
Type	Description
`ExamplesOverride.Builder`

addRestrictionsBuilder()

public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`ExamplesRestrictionsNamespace.Builder`

addRestrictionsBuilder(int index)

public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExamplesRestrictionsNamespace.Builder`

build()

public ExamplesOverride build()

Returns
Type	Description
`ExamplesOverride`

buildPartial()

public ExamplesOverride buildPartial()

Returns
Type	Description
`ExamplesOverride`

clear()

public ExamplesOverride.Builder clear()

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCrowdingCount()

public ExamplesOverride.Builder clearCrowdingCount()

The number of neighbors to return that have the same crowding tag.

int32 crowding_count = 2;

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

clearDataFormat()

public ExamplesOverride.Builder clearDataFormat()

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExamplesOverride.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearNeighborCount()

public ExamplesOverride.Builder clearNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExamplesOverride.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRestrictions()

public ExamplesOverride.Builder clearRestrictions()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`ExamplesOverride.Builder`

clearReturnEmbeddings()

public ExamplesOverride.Builder clearReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

clone()

public ExamplesOverride.Builder clone()

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCrowdingCount()

public int getCrowdingCount()

The number of neighbors to return that have the same crowding tag.

int32 crowding_count = 2;

Returns
Type	Description
`int`	The crowdingCount.

getDataFormat()

public ExamplesOverride.DataFormat getDataFormat()

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
Type	Description
`ExamplesOverride.DataFormat`	The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Returns
Type	Description
`int`	The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExamplesOverride getDefaultInstanceForType()

Returns
Type	Description
`ExamplesOverride`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
Type	Description
`int`	The neighborCount.

getRestrictions(int index)

public ExamplesRestrictionsNamespace getRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExamplesRestrictionsNamespace`

getRestrictionsBuilder(int index)

public ExamplesRestrictionsNamespace.Builder getRestrictionsBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExamplesRestrictionsNamespace.Builder`

getRestrictionsBuilderList()

public List<ExamplesRestrictionsNamespace.Builder> getRestrictionsBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`List<Builder>`

getRestrictionsCount()

public int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`int`

getRestrictionsList()

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`List<ExamplesRestrictionsNamespace>`

getRestrictionsOrBuilder(int index)

public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExamplesRestrictionsNamespaceOrBuilder`

getRestrictionsOrBuilderList()

public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type	Description
`List<? extends com.google.cloud.vertexai.api.ExamplesRestrictionsNamespaceOrBuilder>`

getReturnEmbeddings()

public boolean getReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
Type	Description
`boolean`	The returnEmbeddings.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ExamplesOverride other)

public ExamplesOverride.Builder mergeFrom(ExamplesOverride other)

Parameter
Name	Description
`other`	`ExamplesOverride`

Returns
Type	Description
`ExamplesOverride.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExamplesOverride.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ExamplesOverride.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExamplesOverride.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeRestrictions(int index)

public ExamplesOverride.Builder removeRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ExamplesOverride.Builder`

setCrowdingCount(int value)

public ExamplesOverride.Builder setCrowdingCount(int value)

The number of neighbors to return that have the same crowding tag.

int32 crowding_count = 2;

Parameter
Name	Description
`value`	`int` The crowdingCount to set.

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

setDataFormat(ExamplesOverride.DataFormat value)

public ExamplesOverride.Builder setDataFormat(ExamplesOverride.DataFormat value)

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Parameter
Name	Description
`value`	`ExamplesOverride.DataFormat` The dataFormat to set.

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

setDataFormatValue(int value)

public ExamplesOverride.Builder setDataFormatValue(int value)

The format of the data being provided with each call.

.google.cloud.vertexai.v1.ExamplesOverride.DataFormat data_format = 5;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for dataFormat to set.

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExamplesOverride.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setNeighborCount(int value)

public ExamplesOverride.Builder setNeighborCount(int value)

The number of neighbors to return.

int32 neighbor_count = 1;

Parameter
Name	Description
`value`	`int` The neighborCount to set.

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExamplesOverride.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRestrictions(int index, ExamplesRestrictionsNamespace value)

public ExamplesOverride.Builder setRestrictions(int index, ExamplesRestrictionsNamespace value)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
Name	Description
`index`	`int`
`value`	`ExamplesRestrictionsNamespace`

Returns
Type	Description
`ExamplesOverride.Builder`

setRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)

public ExamplesOverride.Builder setRestrictions(int index, ExamplesRestrictionsNamespace.Builder builderForValue)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.vertexai.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`ExamplesRestrictionsNamespace.Builder`

Returns
Type	Description
`ExamplesOverride.Builder`

setReturnEmbeddings(boolean value)

public ExamplesOverride.Builder setReturnEmbeddings(boolean value)

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Parameter
Name	Description
`value`	`boolean` The returnEmbeddings to set.

Returns
Type	Description
`ExamplesOverride.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExamplesOverride.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ExamplesOverride.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)