Class ExamplesOverride.Builder (3.8.0)

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

Overrides for example-based explanations.

Protobuf type google.cloud.aiplatform.v1.ExamplesOverride

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.ExamplesRestrictionsNamespace>
Returns
TypeDescription
ExamplesOverride.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExamplesOverride.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
valueExamplesRestrictionsNamespace
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
builderForValueExamplesRestrictionsNamespace.Builder
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
NameDescription
indexint
valueExamplesRestrictionsNamespace
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
NameDescription
indexint
builderForValueExamplesRestrictionsNamespace.Builder
Returns
TypeDescription
ExamplesOverride.Builder

addRestrictionsBuilder()

public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
ExamplesRestrictionsNamespace.Builder

addRestrictionsBuilder(int index)

public ExamplesRestrictionsNamespace.Builder addRestrictionsBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespace.Builder

build()

public ExamplesOverride build()
Returns
TypeDescription
ExamplesOverride

buildPartial()

public ExamplesOverride buildPartial()
Returns
TypeDescription
ExamplesOverride

clear()

public ExamplesOverride.Builder clear()
Returns
TypeDescription
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
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

clearDataFormat()

public ExamplesOverride.Builder clearDataFormat()

The format of the data being provided with each call.

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

Returns
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExamplesOverride.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

clearNeighborCount()

public ExamplesOverride.Builder clearNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ExamplesOverride.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

clearRestrictions()

public ExamplesOverride.Builder clearRestrictions()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
ExamplesOverride.Builder

clearReturnEmbeddings()

public ExamplesOverride.Builder clearReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

clone()

public ExamplesOverride.Builder clone()
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

getCrowdingCount()

public int getCrowdingCount()

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

int32 crowding_count = 2;

Returns
TypeDescription
int

The crowdingCount.

getDataFormat()

public ExamplesOverride.DataFormat getDataFormat()

The format of the data being provided with each call.

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

Returns
TypeDescription
ExamplesOverride.DataFormat

The dataFormat.

getDataFormatValue()

public int getDataFormatValue()

The format of the data being provided with each call.

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

Returns
TypeDescription
int

The enum numeric value on the wire for dataFormat.

getDefaultInstanceForType()

public ExamplesOverride getDefaultInstanceForType()
Returns
TypeDescription
ExamplesOverride

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return.

int32 neighbor_count = 1;

Returns
TypeDescription
int

The neighborCount.

getRestrictions(int index)

public ExamplesRestrictionsNamespace getRestrictions(int index)

Restrict the resulting nearest neighbors to respect these constraints.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespace

getRestrictionsBuilder(int index)

public ExamplesRestrictionsNamespace.Builder getRestrictionsBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespace.Builder

getRestrictionsBuilderList()

public List<ExamplesRestrictionsNamespace.Builder> getRestrictionsBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
List<Builder>

getRestrictionsCount()

public int getRestrictionsCount()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
int

getRestrictionsList()

public List<ExamplesRestrictionsNamespace> getRestrictionsList()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
List<ExamplesRestrictionsNamespace>

getRestrictionsOrBuilder(int index)

public ExamplesRestrictionsNamespaceOrBuilder getRestrictionsOrBuilder(int index)

Restrict the resulting nearest neighbors to respect these constraints.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ExamplesRestrictionsNamespaceOrBuilder

getRestrictionsOrBuilderList()

public List<? extends ExamplesRestrictionsNamespaceOrBuilder> getRestrictionsOrBuilderList()

Restrict the resulting nearest neighbors to respect these constraints.

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.ExamplesRestrictionsNamespaceOrBuilder>

getReturnEmbeddings()

public boolean getReturnEmbeddings()

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Returns
TypeDescription
boolean

The returnEmbeddings.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExamplesOverride other)

public ExamplesOverride.Builder mergeFrom(ExamplesOverride other)
Parameter
NameDescription
otherExamplesOverride
Returns
TypeDescription
ExamplesOverride.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExamplesOverride.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExamplesOverride.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExamplesOverride.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExamplesOverride.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valueint

The crowdingCount to set.

Returns
TypeDescription
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.v1.ExamplesOverride.DataFormat data_format = 5;

Parameter
NameDescription
valueExamplesOverride.DataFormat

The dataFormat to set.

Returns
TypeDescription
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.v1.ExamplesOverride.DataFormat data_format = 5;

Parameter
NameDescription
valueint

The enum numeric value on the wire for dataFormat to set.

Returns
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExamplesOverride.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExamplesOverride.Builder
Overrides

setNeighborCount(int value)

public ExamplesOverride.Builder setNeighborCount(int value)

The number of neighbors to return.

int32 neighbor_count = 1;

Parameter
NameDescription
valueint

The neighborCount to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
NameDescription
indexint
valueExamplesRestrictionsNamespace
Returns
TypeDescription
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.v1.ExamplesRestrictionsNamespace restrictions = 3;

Parameters
NameDescription
indexint
builderForValueExamplesRestrictionsNamespace.Builder
Returns
TypeDescription
ExamplesOverride.Builder

setReturnEmbeddings(boolean value)

public ExamplesOverride.Builder setReturnEmbeddings(boolean value)

If true, return the embeddings instead of neighbors.

bool return_embeddings = 4;

Parameter
NameDescription
valueboolean

The returnEmbeddings to set.

Returns
TypeDescription
ExamplesOverride.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExamplesOverride.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExamplesOverride.Builder
Overrides