Class Examples.Builder (1.4.0)

public static final class Examples.Builder extends GeneratedMessageV3.Builder<Examples.Builder> implements ExamplesOrBuilder

Example-based explainability that returns the nearest neighbors from the provided dataset.

Protobuf type google.cloud.vertexai.v1.Examples

Inheritance

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

Implements

ExamplesOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

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.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

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

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

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

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)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Examples.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Examples.Builder

Overrides

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

build()

public Examples build()

Returns
Type	Description
Examples

buildPartial()

public Examples buildPartial()

Returns
Type	Description
Examples

clear()

public Examples.Builder clear()

Returns
Type	Description
Examples.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearConfig()

public Examples.Builder clearConfig()

Returns
Type	Description
Examples.Builder

clearExampleGcsSource()

public Examples.Builder clearExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.Builder

clearField(Descriptors.FieldDescriptor field)

public Examples.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Examples.Builder

Overrides

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

clearNearestNeighborSearchConfig()

public Examples.Builder clearNearestNeighborSearchConfig()

The full 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
Examples.Builder

clearNeighborCount()

public Examples.Builder clearNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
Type	Description
Examples.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Examples.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Examples.Builder

Overrides

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

clearPresets()

public Examples.Builder clearPresets()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Returns
Type	Description
Examples.Builder

clearSource()

public Examples.Builder clearSource()

Returns
Type	Description
Examples.Builder

clone()

public Examples.Builder clone()

Returns
Type	Description
Examples.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getConfigCase()

public Examples.ConfigCase getConfigCase()

Returns
Type	Description
Examples.ConfigCase

getDefaultInstanceForType()

public Examples getDefaultInstanceForType()

Returns
Type	Description
Examples

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getExampleGcsSource()

public Examples.ExampleGcsSource getExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.ExampleGcsSource	The exampleGcsSource.

getExampleGcsSourceBuilder()

public Examples.ExampleGcsSource.Builder getExampleGcsSourceBuilder()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.ExampleGcsSource.Builder

getExampleGcsSourceOrBuilder()

public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
Examples.ExampleGcsSourceOrBuilder

getNearestNeighborSearchConfig()

public Value getNearestNeighborSearchConfig()

The full 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 full 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 full 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

getNeighborCount()

public int getNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
Type	Description
int	The neighborCount.

getPresets()

public Presets getPresets()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Returns
Type	Description
Presets	The presets.

getPresetsBuilder()

public Presets.Builder getPresetsBuilder()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Returns
Type	Description
Presets.Builder

getPresetsOrBuilder()

public PresetsOrBuilder getPresetsOrBuilder()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Returns
Type	Description
PresetsOrBuilder

getSourceCase()

public Examples.SourceCase getSourceCase()

Returns
Type	Description
Examples.SourceCase

hasExampleGcsSource()

public boolean hasExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type	Description
boolean	Whether the exampleGcsSource field is set.

hasNearestNeighborSearchConfig()

public boolean hasNearestNeighborSearchConfig()

The full 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.

hasPresets()

public boolean hasPresets()

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Returns
Type	Description
boolean	Whether the presets 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()

mergeExampleGcsSource(Examples.ExampleGcsSource value)

public Examples.Builder mergeExampleGcsSource(Examples.ExampleGcsSource value)

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Parameter
Name	Description
value	Examples.ExampleGcsSource

Returns
Type	Description
Examples.Builder

mergeFrom(Examples other)

public Examples.Builder mergeFrom(Examples other)

Parameter
Name	Description
other	Examples

Returns
Type	Description
Examples.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Examples.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Examples.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Examples.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Examples.Builder

Overrides

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

mergeNearestNeighborSearchConfig(Value value)

public Examples.Builder mergeNearestNeighborSearchConfig(Value value)

The full 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
Examples.Builder

mergePresets(Presets value)

public Examples.Builder mergePresets(Presets value)

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Parameter
Name	Description
value	Presets

Returns
Type	Description
Examples.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Examples.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Examples.Builder

Overrides

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

setExampleGcsSource(Examples.ExampleGcsSource value)

public Examples.Builder setExampleGcsSource(Examples.ExampleGcsSource value)

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Parameter
Name	Description
value	Examples.ExampleGcsSource

Returns
Type	Description
Examples.Builder

setExampleGcsSource(Examples.ExampleGcsSource.Builder builderForValue)

public Examples.Builder setExampleGcsSource(Examples.ExampleGcsSource.Builder builderForValue)

The Cloud Storage input instances.

.google.cloud.vertexai.v1.Examples.ExampleGcsSource example_gcs_source = 5;

Parameter
Name	Description
builderForValue	Examples.ExampleGcsSource.Builder

Returns
Type	Description
Examples.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Examples.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Examples.Builder

Overrides

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

setNearestNeighborSearchConfig(Value value)

public Examples.Builder setNearestNeighborSearchConfig(Value value)

The full 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
Examples.Builder

setNearestNeighborSearchConfig(Value.Builder builderForValue)

public Examples.Builder setNearestNeighborSearchConfig(Value.Builder builderForValue)

The full 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
Examples.Builder

setNeighborCount(int value)

public Examples.Builder setNeighborCount(int value)

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Parameter
Name	Description
value	int The neighborCount to set.

Returns
Type	Description
Examples.Builder	This builder for chaining.

setPresets(Presets value)

public Examples.Builder setPresets(Presets value)

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Parameter
Name	Description
value	Presets

Returns
Type	Description
Examples.Builder

setPresets(Presets.Builder builderForValue)

public Examples.Builder setPresets(Presets.Builder builderForValue)

Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.

.google.cloud.vertexai.v1.Presets presets = 4;

Parameter
Name	Description
builderForValue	Presets.Builder

Returns
Type	Description
Examples.Builder

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Examples.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final Examples.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Examples.Builder

Overrides

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