Class Similarity.Builder (2.4.0)

public static final class Similarity.Builder extends GeneratedMessageV3.Builder<Similarity.Builder> implements SimilarityOrBuilder

Similarity explainability that returns the nearest neighbors from the provided dataset.

Protobuf type google.cloud.aiplatform.v1beta1.Similarity

Implements

SimilarityOrBuilder

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Similarity.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Similarity.Builder
Overrides

build()

public Similarity build()
Returns
Type Description
Similarity

buildPartial()

public Similarity buildPartial()
Returns
Type Description
Similarity

clear()

public Similarity.Builder clear()
Returns
Type Description
Similarity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Similarity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Similarity.Builder
Overrides

clearGcsSource()

public Similarity.Builder clearGcsSource()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type Description
Similarity.Builder

clearNearestNeighborSearchConfig()

public Similarity.Builder clearNearestNeighborSearchConfig()

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type Description
Similarity.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Similarity.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Similarity.Builder
Overrides

clone()

public Similarity.Builder clone()
Returns
Type Description
Similarity.Builder
Overrides

getDefaultInstanceForType()

public Similarity getDefaultInstanceForType()
Returns
Type Description
Similarity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGcsSource()

public GcsSource getGcsSource()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceBuilder()

public GcsSource.Builder getGcsSourceBuilder()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type Description
GcsSourceOrBuilder

getNearestNeighborSearchConfig()

public Value getNearestNeighborSearchConfig()

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type Description
Value

The nearestNeighborSearchConfig.

getNearestNeighborSearchConfigBuilder()

public Value.Builder getNearestNeighborSearchConfigBuilder()

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type Description
Builder

getNearestNeighborSearchConfigOrBuilder()

public ValueOrBuilder getNearestNeighborSearchConfigOrBuilder()

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type Description
ValueOrBuilder

hasGcsSource()

public boolean hasGcsSource()

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Returns
Type Description
boolean

Whether the gcsSource field is set.

hasNearestNeighborSearchConfig()

public boolean hasNearestNeighborSearchConfig()

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Returns
Type Description
boolean

Whether the nearestNeighborSearchConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Similarity other)

public Similarity.Builder mergeFrom(Similarity other)
Parameter
Name Description
other Similarity
Returns
Type Description
Similarity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Similarity.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Similarity.Builder
Overrides Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeGcsSource(GcsSource value)

public Similarity.Builder mergeGcsSource(GcsSource value)

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Parameter
Name Description
value GcsSource
Returns
Type Description
Similarity.Builder

mergeNearestNeighborSearchConfig(Value value)

public Similarity.Builder mergeNearestNeighborSearchConfig(Value value)

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Parameter
Name Description
value Value
Returns
Type Description
Similarity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public Similarity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Similarity.Builder
Overrides

setGcsSource(GcsSource value)

public Similarity.Builder setGcsSource(GcsSource value)

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Parameter
Name Description
value GcsSource
Returns
Type Description
Similarity.Builder

setGcsSource(GcsSource.Builder builderForValue)

public Similarity.Builder setGcsSource(GcsSource.Builder builderForValue)

The Cloud Storage location for the input instances.

.google.cloud.aiplatform.v1beta1.GcsSource gcs_source = 1;

Parameter
Name Description
builderForValue GcsSource.Builder
Returns
Type Description
Similarity.Builder

setNearestNeighborSearchConfig(Value value)

public Similarity.Builder setNearestNeighborSearchConfig(Value value)

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Parameter
Name Description
value Value
Returns
Type Description
Similarity.Builder

setNearestNeighborSearchConfig(Value.Builder builderForValue)

public Similarity.Builder setNearestNeighborSearchConfig(Value.Builder builderForValue)

The configuration for the generated index, the semantics are the same as metadata and should match NearestNeighborSearchConfig.

.google.protobuf.Value nearest_neighbor_search_config = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Similarity.Builder

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

public Similarity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Similarity.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Similarity.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Similarity.Builder
Overrides