Package com.google.cloud.aiplatform.v1beta1

Class Examples.Builder

  • All Implemented Interfaces:
    ExamplesOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Examples
    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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • clear

        public Examples.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • getDefaultInstanceForType

        public Examples getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Examples build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Examples buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Examples.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • setField

        public Examples.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • clearField

        public Examples.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • clearOneof

        public Examples.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • setRepeatedField

        public Examples.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • addRepeatedField

        public Examples.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • mergeFrom

        public Examples.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Examples.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • mergeFrom

        public Examples.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Examples.Builder>
        Throws:
        IOException

      • hasExampleGcsSource

        public boolean hasExampleGcsSource()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;
        Specified by:
        hasExampleGcsSource in interface ExamplesOrBuilder
        Returns:
        Whether the exampleGcsSource field is set.

      • setExampleGcsSource

        public Examples.Builder setExampleGcsSource​(Examples.ExampleGcsSource value)
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

      • mergeExampleGcsSource

        public Examples.Builder mergeExampleGcsSource​(Examples.ExampleGcsSource value)
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

      • clearExampleGcsSource

        public Examples.Builder clearExampleGcsSource()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

      • getExampleGcsSourceBuilder

        public Examples.ExampleGcsSource.Builder getExampleGcsSourceBuilder()
         The Cloud Storage input instances.
        .google.cloud.aiplatform.v1beta1.Examples.ExampleGcsSource example_gcs_source = 5;

      • hasNearestNeighborSearchConfig

        public 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;
        Specified by:
        hasNearestNeighborSearchConfig in interface ExamplesOrBuilder
        Returns:
        Whether the nearestNeighborSearchConfig field is set.

      • getNearestNeighborSearchConfig

        public 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;
        Specified by:
        getNearestNeighborSearchConfig in interface ExamplesOrBuilder
        Returns:
        The nearestNeighborSearchConfig.

      • setNearestNeighborSearchConfig

        public 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;

      • setNearestNeighborSearchConfig

        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;

      • mergeNearestNeighborSearchConfig

        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;

      • clearNearestNeighborSearchConfig

        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;

      • getNearestNeighborSearchConfigBuilder

        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;

      • getNearestNeighborSearchConfigOrBuilder

        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;
        Specified by:
        getNearestNeighborSearchConfigOrBuilder in interface ExamplesOrBuilder

      • 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;
        Specified by:
        hasPresets in interface ExamplesOrBuilder
        Returns:
        Whether the presets field is set.

      • 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;
        Specified by:
        getPresets in interface ExamplesOrBuilder
        Returns:
        The presets.

      • setPresets

        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;

      • setPresets

        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;

      • mergePresets

        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;

      • 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;

      • 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;

      • 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;
        Specified by:
        getPresetsOrBuilder in interface ExamplesOrBuilder

      • 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;
        Specified by:
        hasGcsSource in interface ExamplesOrBuilder
        Returns:
        Whether the gcsSource field is set.

      • 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;
        Specified by:
        getGcsSource in interface ExamplesOrBuilder
        Returns:
        The gcsSource.

      • setGcsSource

        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;

      • setGcsSource

        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;

      • mergeGcsSource

        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;

      • 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;

      • 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;

      • 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;
        Specified by:
        getGcsSourceOrBuilder in interface ExamplesOrBuilder

      • getNeighborCount

        public int getNeighborCount()
         The number of neighbors to return when querying for examples.
        int32 neighbor_count = 3;
        Specified by:
        getNeighborCount in interface ExamplesOrBuilder
        Returns:
        The neighborCount.

      • setNeighborCount

        public Examples.Builder setNeighborCount​(int value)
         The number of neighbors to return when querying for examples.
        int32 neighbor_count = 3;
        Parameters:
        value - The neighborCount to set.
        Returns:
        This builder for chaining.

      • clearNeighborCount

        public Examples.Builder clearNeighborCount()
         The number of neighbors to return when querying for examples.
        int32 neighbor_count = 3;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Examples.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>

      • mergeUnknownFields

        public final Examples.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Examples.Builder>