Class Examples.Builder (1.22.0) 

publicstaticfinalclass Examples.BuilderextendsGeneratedMessageV3.Builder<Examples.Builder>implementsExamplesOrBuilder

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

Protobuf type google.cloud.vertexai.v1.Examples

Implements

ExamplesOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicExamples.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Examples.Builder
Overrides

build()

publicExamplesbuild()
Returns
Type Description
Examples

buildPartial()

publicExamplesbuildPartial()
Returns
Type Description
Examples

clear()

publicExamples.Builderclear()
Returns
Type Description
Examples.Builder
Overrides

clearConfig()

publicExamples.BuilderclearConfig()
Returns
Type Description
Examples.Builder

clearExampleGcsSource()

publicExamples.BuilderclearExampleGcsSource()

The Cloud Storage input instances.

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

Returns
Type Description
Examples.Builder

clearField(Descriptors.FieldDescriptor field)

publicExamples.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Examples.Builder
Overrides

clearNearestNeighborSearchConfig()

publicExamples.BuilderclearNearestNeighborSearchConfig()

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

publicExamples.BuilderclearNeighborCount()

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)

publicExamples.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Examples.Builder
Overrides

clearPresets()

publicExamples.BuilderclearPresets()

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

publicExamples.BuilderclearSource()
Returns
Type Description
Examples.Builder

clone()

publicExamples.Builderclone()
Returns
Type Description
Examples.Builder
Overrides

getConfigCase()

publicExamples.ConfigCasegetConfigCase()
Returns
Type Description
Examples.ConfigCase

getDefaultInstanceForType()

publicExamplesgetDefaultInstanceForType()
Returns
Type Description
Examples

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExampleGcsSource()

publicExamples.ExampleGcsSourcegetExampleGcsSource()

The Cloud Storage input instances.

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

Returns
Type Description
Examples.ExampleGcsSource

The exampleGcsSource.

getExampleGcsSourceBuilder()

publicExamples.ExampleGcsSource.BuildergetExampleGcsSourceBuilder()

The Cloud Storage input instances.

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

Returns
Type Description
Examples.ExampleGcsSource.Builder

getExampleGcsSourceOrBuilder()

publicExamples.ExampleGcsSourceOrBuildergetExampleGcsSourceOrBuilder()

The Cloud Storage input instances.

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

Returns
Type Description
Examples.ExampleGcsSourceOrBuilder

getNearestNeighborSearchConfig()

publicValuegetNearestNeighborSearchConfig()

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

publicValue.BuildergetNearestNeighborSearchConfigBuilder()

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

publicValueOrBuildergetNearestNeighborSearchConfigOrBuilder()

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

publicintgetNeighborCount()

The number of neighbors to return when querying for examples.

int32 neighbor_count = 3;

Returns
Type Description
int

The neighborCount.

getPresets()

publicPresetsgetPresets()

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

publicPresets.BuildergetPresetsBuilder()

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

publicPresetsOrBuildergetPresetsOrBuilder()

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

publicExamples.SourceCasegetSourceCase()
Returns
Type Description
Examples.SourceCase

hasExampleGcsSource()

publicbooleanhasExampleGcsSource()

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

publicbooleanhasNearestNeighborSearchConfig()

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

publicbooleanhasPresets()

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

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeExampleGcsSource(Examples.ExampleGcsSource value)

publicExamples.BuildermergeExampleGcsSource(Examples.ExampleGcsSourcevalue)

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)

publicExamples.BuildermergeFrom(Examplesother)
Parameter
Name Description
other Examples
Returns
Type Description
Examples.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicExamples.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Examples.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicExamples.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
Examples.Builder
Overrides

mergeNearestNeighborSearchConfig(Value value)

publicExamples.BuildermergeNearestNeighborSearchConfig(Valuevalue)

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)

publicExamples.BuildermergePresets(Presetsvalue)

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)

publicfinalExamples.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Examples.Builder
Overrides

setExampleGcsSource(Examples.ExampleGcsSource value)

publicExamples.BuildersetExampleGcsSource(Examples.ExampleGcsSourcevalue)

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)

publicExamples.BuildersetExampleGcsSource(Examples.ExampleGcsSource.BuilderbuilderForValue)

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)

publicExamples.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Examples.Builder
Overrides

setNearestNeighborSearchConfig(Value value)

publicExamples.BuildersetNearestNeighborSearchConfig(Valuevalue)

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)

publicExamples.BuildersetNearestNeighborSearchConfig(Value.BuilderbuilderForValue)

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)

publicExamples.BuildersetNeighborCount(intvalue)

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)

publicExamples.BuildersetPresets(Presetsvalue)

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)

publicExamples.BuildersetPresets(Presets.BuilderbuilderForValue)

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)

publicExamples.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Examples.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalExamples.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Examples.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.