public static final class Examples.Builder extends com.google.protobuf.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| Modifier and Type | Method and Description |
|---|---|
Examples.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Examples |
build() |
Examples |
buildPartial() |
Examples.Builder |
clear() |
Examples.Builder |
clearConfig() |
Examples.Builder |
clearExampleGcsSource()
The Cloud Storage input instances.
|
Examples.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Examples.Builder |
clearGcsSource()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
Examples.Builder |
clearNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
Examples.Builder |
clearNeighborCount()
The number of neighbors to return when querying for examples.
|
Examples.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Examples.Builder |
clearPresets()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
Examples.Builder |
clearSource() |
Examples.Builder |
clone() |
Examples.ConfigCase |
getConfigCase() |
Examples |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
Examples.ExampleGcsSource |
getExampleGcsSource()
The Cloud Storage input instances.
|
Examples.ExampleGcsSource.Builder |
getExampleGcsSourceBuilder()
The Cloud Storage input instances.
|
Examples.ExampleGcsSourceOrBuilder |
getExampleGcsSourceOrBuilder()
The Cloud Storage input instances.
|
GcsSource |
getGcsSource()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
GcsSource.Builder |
getGcsSourceBuilder()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
GcsSourceOrBuilder |
getGcsSourceOrBuilder()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
com.google.protobuf.Value |
getNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
com.google.protobuf.Value.Builder |
getNearestNeighborSearchConfigBuilder()
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
com.google.protobuf.ValueOrBuilder |
getNearestNeighborSearchConfigOrBuilder()
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
int |
getNeighborCount()
The number of neighbors to return when querying for examples.
|
Presets |
getPresets()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
Presets.Builder |
getPresetsBuilder()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
PresetsOrBuilder |
getPresetsOrBuilder()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
Examples.SourceCase |
getSourceCase() |
boolean |
hasExampleGcsSource()
The Cloud Storage input instances.
|
boolean |
hasGcsSource()
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
boolean |
hasNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
boolean |
hasPresets()
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Examples.Builder |
mergeExampleGcsSource(Examples.ExampleGcsSource value)
The Cloud Storage input instances.
|
Examples.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Examples.Builder |
mergeFrom(Examples other) |
Examples.Builder |
mergeFrom(com.google.protobuf.Message other) |
Examples.Builder |
mergeGcsSource(GcsSource value)
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
Examples.Builder |
mergeNearestNeighborSearchConfig(com.google.protobuf.Value value)
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
Examples.Builder |
mergePresets(Presets value)
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
Examples.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Examples.Builder |
setExampleGcsSource(Examples.ExampleGcsSource.Builder builderForValue)
The Cloud Storage input instances.
|
Examples.Builder |
setExampleGcsSource(Examples.ExampleGcsSource value)
The Cloud Storage input instances.
|
Examples.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Examples.Builder |
setGcsSource(GcsSource.Builder builderForValue)
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
Examples.Builder |
setGcsSource(GcsSource value)
The Cloud Storage locations that contain the instances to be
indexed for approximate nearest neighbor search.
|
Examples.Builder |
setNearestNeighborSearchConfig(com.google.protobuf.Value.Builder builderForValue)
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
Examples.Builder |
setNearestNeighborSearchConfig(com.google.protobuf.Value value)
The full configuration for the generated index, the semantics are the
same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and
should match
[NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
|
Examples.Builder |
setNeighborCount(int value)
The number of neighbors to return when querying for examples.
|
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.
|
Examples.Builder |
setPresets(Presets value)
Simplified preset configuration, which automatically sets configuration
values based on the desired query speed-precision trade-off and modality.
|
Examples.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Examples.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Examples build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Examples buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Examples.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Examples.Builder>public Examples.Builder mergeFrom(Examples other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public Examples.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Examples.Builder>IOExceptionpublic Examples.SourceCase getSourceCase()
getSourceCase in interface ExamplesOrBuilderpublic Examples.Builder clearSource()
public Examples.ConfigCase getConfigCase()
getConfigCase in interface ExamplesOrBuilderpublic Examples.Builder clearConfig()
public boolean hasExampleGcsSource()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
hasExampleGcsSource in interface ExamplesOrBuilderpublic Examples.ExampleGcsSource getExampleGcsSource()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
getExampleGcsSource in interface ExamplesOrBuilderpublic Examples.Builder setExampleGcsSource(Examples.ExampleGcsSource value)
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples.Builder setExampleGcsSource(Examples.ExampleGcsSource.Builder builderForValue)
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples.Builder mergeExampleGcsSource(Examples.ExampleGcsSource value)
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples.Builder clearExampleGcsSource()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples.ExampleGcsSource.Builder getExampleGcsSourceBuilder()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()
The Cloud Storage input instances.
.google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
getExampleGcsSourceOrBuilder in interface ExamplesOrBuilderpublic boolean hasNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;hasNearestNeighborSearchConfig in interface ExamplesOrBuilderpublic com.google.protobuf.Value getNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;getNearestNeighborSearchConfig in interface ExamplesOrBuilderpublic Examples.Builder setNearestNeighborSearchConfig(com.google.protobuf.Value value)
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;public Examples.Builder setNearestNeighborSearchConfig(com.google.protobuf.Value.Builder builderForValue)
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;public Examples.Builder mergeNearestNeighborSearchConfig(com.google.protobuf.Value value)
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;public Examples.Builder clearNearestNeighborSearchConfig()
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;public com.google.protobuf.Value.Builder getNearestNeighborSearchConfigBuilder()
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;public com.google.protobuf.ValueOrBuilder getNearestNeighborSearchConfigOrBuilder()
The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1beta1.Index.metadata] and should match [NearestNeighborSearchConfig](https://cloud.google.com/vertex-ai/docs/explainable-ai/configuring-explanations-example-based#nearest-neighbor-search-config).
.google.protobuf.Value nearest_neighbor_search_config = 2;getNearestNeighborSearchConfigOrBuilder in interface ExamplesOrBuilderpublic 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;hasPresets in interface ExamplesOrBuilderpublic 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;getPresets in interface ExamplesOrBuilderpublic 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;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;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;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;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;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;getPresetsOrBuilder in interface ExamplesOrBuilderpublic 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;hasGcsSource in interface ExamplesOrBuilderpublic 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;getGcsSource in interface ExamplesOrBuilderpublic 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;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;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;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;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;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;getGcsSourceOrBuilder in interface ExamplesOrBuilderpublic int getNeighborCount()
The number of neighbors to return when querying for examples.
int32 neighbor_count = 3;getNeighborCount in interface ExamplesOrBuilderpublic Examples.Builder setNeighborCount(int value)
The number of neighbors to return when querying for examples.
int32 neighbor_count = 3;value - The neighborCount to set.public Examples.Builder clearNeighborCount()
The number of neighbors to return when querying for examples.
int32 neighbor_count = 3;public final Examples.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>public final Examples.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>Copyright © 2025 Google LLC. All rights reserved.