Class Similarity.Builder (2.4.0)

Version 2.4.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 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

Inheritance

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

Implements

SimilarityOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.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)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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)

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

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Similarity.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Similarity.Builder

Overrides

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

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

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

clone()

public Similarity.Builder clone()

Returns

Type	Description
Similarity.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

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

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Similarity.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Similarity.Builder

Overrides

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

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

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

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

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Similarity.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Similarity.Builder

Overrides

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