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
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Similarity.Builder
Overrides

build()

public Similarity build()
Returns
TypeDescription
Similarity

buildPartial()

public Similarity buildPartial()
Returns
TypeDescription
Similarity

clear()

public Similarity.Builder clear()
Returns
TypeDescription
Similarity.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Similarity.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Similarity.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDefaultInstanceForType()

public Similarity getDefaultInstanceForType()
Returns
TypeDescription
Similarity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getGcsSource()

public GcsSource getGcsSource()

The Cloud Storage location for the input instances.

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

Returns
TypeDescription
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
TypeDescription
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Cloud Storage location for the input instances.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ValueOrBuilder

hasGcsSource()

public boolean hasGcsSource()

The Cloud Storage location for the input instances.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the nearestNeighborSearchConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Similarity other)

public Similarity.Builder mergeFrom(Similarity other)
Parameter
NameDescription
otherSimilarity
Returns
TypeDescription
Similarity.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Similarity.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueGcsSource
Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
Similarity.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Similarity.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Similarity.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Similarity.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueGcsSource
Returns
TypeDescription
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
NameDescription
builderForValueGcsSource.Builder
Returns
TypeDescription
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
NameDescription
valueValue
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
Similarity.Builder

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

public Similarity.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Similarity.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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