Package com.google.cloud.aiplatform.v1

Class Examples

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Examples
All Implemented Interfaces:
ExamplesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Examples extends com.google.protobuf.GeneratedMessage implements ExamplesOrBuilder
 Example-based explainability that returns the nearest neighbors from the
 provided dataset.
Protobuf type google.cloud.aiplatform.v1.Examples
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Examples.Builder
    Example-based explainability that returns the nearest neighbors from the provided dataset.
    static enum 
    Examples.ConfigCase
     
    static final class 
    Examples.ExampleGcsSource
    The Cloud Storage input instances.
    static interface 
    Examples.ExampleGcsSourceOrBuilder
     
    static enum 
    Examples.SourceCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    EXAMPLE_GCS_SOURCE_FIELD_NUMBER
     
    static final int
    NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
     
    static final int
    NEIGHBOR_COUNT_FIELD_NUMBER
     
    static final int
    PRESETS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Examples.ConfigCase
    getConfigCase()
     
    static Examples
    getDefaultInstance()
     
    Examples
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Examples.ExampleGcsSource
    getExampleGcsSource()
    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.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.
    com.google.protobuf.Parser<Examples>
    getParserForType()
     
    Presets
    getPresets()
    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.
    int
    getSerializedSize()
     
    Examples.SourceCase
    getSourceCase()
     
    boolean
    hasExampleGcsSource()
    The Cloud Storage input instances.
    int
    hashCode()
     
    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()
     
    static Examples.Builder
    newBuilder()
     
    static Examples.Builder
    newBuilder(Examples prototype)
     
    Examples.Builder
    newBuilderForType()
     
    protected Examples.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Examples
    parseDelimitedFrom(InputStream input)
     
    static Examples
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Examples
    parseFrom(byte[] data)
     
    static Examples
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Examples
    parseFrom(com.google.protobuf.ByteString data)
     
    static Examples
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Examples
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Examples
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Examples
    parseFrom(InputStream input)
     
    static Examples
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Examples
    parseFrom(ByteBuffer data)
     
    static Examples
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Examples>
    parser()
     
    Examples.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • EXAMPLE_GCS_SOURCE_FIELD_NUMBER

      public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER
      See Also:

    • NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

      public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
      See Also:

    • PRESETS_FIELD_NUMBER

      public static final int PRESETS_FIELD_NUMBER
      See Also:

    • NEIGHBOR_COUNT_FIELD_NUMBER

      public static final int NEIGHBOR_COUNT_FIELD_NUMBER
      See Also:

  • 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

    • getSourceCase

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

    • getConfigCase

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

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

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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Examples parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Examples parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Examples parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Examples parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Examples parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Examples parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Examples parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Examples.Builder newBuilder()

    • newBuilder

      public static Examples.Builder newBuilder(Examples prototype)

    • toBuilder

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

    • newBuilderForType

      protected Examples.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Examples getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Examples> parser()

    • getParserForType

      public com.google.protobuf.Parser<Examples> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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