Class Examples.Builder (3.44.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.aiplatform.v1beta1.Examples

Implements

ExamplesOrBuilder

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

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

clearConfig()

public Examples.Builder clearConfig()
Returns
Type Description
Examples.Builder

clearExampleGcsSource()

public Examples.Builder clearExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.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

clearGcsSource()

public Examples.Builder clearGcsSource()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Returns
Type Description
Examples.Builder

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

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.aiplatform.v1beta1.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

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

getExampleGcsSource()

public Examples.ExampleGcsSource getExampleGcsSource()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
Examples.ExampleGcsSource.Builder

getExampleGcsSourceOrBuilder()

public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
Examples.ExampleGcsSourceOrBuilder

getGcsSource()

public GcsSource getGcsSource()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceBuilder()

public GcsSource.Builder getGcsSourceBuilder()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Returns
Type Description
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Returns
Type Description
GcsSourceOrBuilder

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.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.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

Returns
Type Description
boolean

Whether the exampleGcsSource field is set.

hasGcsSource()

public boolean hasGcsSource()

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Returns
Type Description
boolean

Whether the gcsSource 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.aiplatform.v1beta1.Presets presets = 4;

Returns
Type Description
boolean

Whether the presets field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExampleGcsSource(Examples.ExampleGcsSource value)

public Examples.Builder mergeExampleGcsSource(Examples.ExampleGcsSource value)

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeGcsSource(GcsSource value)

public Examples.Builder mergeGcsSource(GcsSource value)

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Parameter
Name Description
value GcsSource
Returns
Type Description
Examples.Builder

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.aiplatform.v1beta1.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

setExampleGcsSource(Examples.ExampleGcsSource value)

public Examples.Builder setExampleGcsSource(Examples.ExampleGcsSource value)

The Cloud Storage input instances.

.google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.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

setGcsSource(GcsSource value)

public Examples.Builder setGcsSource(GcsSource value)

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

Parameter
Name Description
value GcsSource
Returns
Type Description
Examples.Builder

setGcsSource(GcsSource.Builder builderForValue)

public Examples.Builder setGcsSource(GcsSource.Builder builderForValue)

The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.

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

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

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.aiplatform.v1beta1.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.aiplatform.v1beta1.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

setUnknownFields(UnknownFieldSet unknownFields)

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