Package com.google.cloud.aiplatform.v1

Class Examples.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Examples.Builder>
com.google.cloud.aiplatform.v1.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.GeneratedMessage.Builder<Examples.Builder> implements ExamplesOrBuilder
 Example-based explainability that returns the nearest neighbors from the
 provided dataset.
Protobuf type google.cloud.aiplatform.v1.Examples

  • Method Summary

    Modifier and Type
    Method
    Description
    Examples
    build()
     
    Examples
    buildPartial()
     
    Examples.Builder
    clear()
     
    Examples.Builder
    clearConfig()
     
    Examples.Builder
    clearExampleGcsSource()
    The Cloud Storage input instances.
    Examples.Builder
    clearNearestNeighborSearchConfig()
    The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1.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
    clearPresets()
    Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
    Examples.Builder
    clearSource()
     
    Examples.ConfigCase
    getConfigCase()
     
    Examples
    getDefaultInstanceForType()
     
    static final 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.
    com.google.protobuf.Value
    getNearestNeighborSearchConfig()
    The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1.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.v1.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.v1.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
    hasNearestNeighborSearchConfig()
    The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1.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.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Examples.Builder
    mergeExampleGcsSource(Examples.ExampleGcsSource value)
    The Cloud Storage input instances.
    Examples.Builder
    mergeFrom(Examples other)
     
    Examples.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Examples.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    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.v1.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
    setExampleGcsSource(Examples.ExampleGcsSource value)
    The Cloud Storage input instances.
    Examples.Builder
    setExampleGcsSource(Examples.ExampleGcsSource.Builder builderForValue)
    The Cloud Storage input instances.
    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.v1.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.Builder builderForValue)
    The full configuration for the generated index, the semantics are the same as [metadata][google.cloud.aiplatform.v1.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 value)
    Simplified preset configuration, which automatically sets configuration values based on the desired query speed-precision trade-off and modality.
    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.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • mergeFrom

      public Examples.Builder mergeFrom(Examples other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • getSourceCase

      public Examples.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface ExamplesOrBuilder

    • clearSource

      public Examples.Builder clearSource()

    • getConfigCase

      public Examples.ConfigCase getConfigCase()
      Specified by:
      getConfigCase in interface ExamplesOrBuilder

    • clearConfig

      public Examples.Builder clearConfig()

    • hasExampleGcsSource

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

    • getExampleGcsSource

      public Examples.ExampleGcsSource getExampleGcsSource()
       The Cloud Storage input instances.
      .google.cloud.aiplatform.v1.Examples.ExampleGcsSource example_gcs_source = 5;
      Specified by:
      getExampleGcsSource in interface ExamplesOrBuilder
      Returns:
      The exampleGcsSource.

    • setExampleGcsSource

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

    • setExampleGcsSource

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

    • mergeExampleGcsSource

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

    • clearExampleGcsSource

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

    • getExampleGcsSourceBuilder

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

    • getExampleGcsSourceOrBuilder

      public Examples.ExampleGcsSourceOrBuilder getExampleGcsSourceOrBuilder()
       The Cloud Storage input instances.
      .google.cloud.aiplatform.v1.Examples.ExampleGcsSource example_gcs_source = 5;
      Specified by:
      getExampleGcsSourceOrBuilder in interface ExamplesOrBuilder

    • hasNearestNeighborSearchConfig

      public boolean hasNearestNeighborSearchConfig()
       The full configuration for the generated index, the semantics are the
 same as [metadata][google.cloud.aiplatform.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.Presets presets = 4;
      Specified by:
      getPresetsOrBuilder 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.