Class ExamplesOverride.Builder (3.42.0)

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

Overrides for example-based explanations.

Protobuf type google.cloud.aiplatform.v1beta1.ExamplesOverride

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.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.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

addRestrictions(ExamplesRestrictionsNamespace value)

public ExamplesOverride.Builder addRestrictions(ExamplesRestrictionsNamespace value)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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

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.aiplatform.v1beta1.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

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

clearRestrictions()

public ExamplesOverride.Builder clearRestrictions()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.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

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type Description
List<Builder>

getRestrictionsCount()

public int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type Description
int

getRestrictionsList()

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.ExamplesRestrictionsNamespace restrictions = 3;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExamplesOverride.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExamplesOverride.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExamplesOverride.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExamplesOverride.Builder
Overrides

removeRestrictions(int index)

public ExamplesOverride.Builder removeRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

repeated .google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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

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

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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