Package com.google.cloud.aiplatform.v1beta1

Class Examples

  • All Implemented Interfaces:
    ExamplesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Examples
extends com.google.protobuf.GeneratedMessageV3
implements ExamplesOrBuilder
     Example-based explainability that returns the nearest neighbors from the
 provided dataset.
    Protobuf type google.cloud.aiplatform.v1beta1.Examples
    See Also:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      Examples.ConfigCase getConfigCase()  
      static Examples getDefaultInstance()  
      Examples getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      Examples.ExampleGcsSource getExampleGcsSource()
      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.
      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.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.
      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.
      boolean hasGcsSource()
      The Cloud Storage locations that contain the instances to be indexed for approximate nearest neighbor search.
      int hashCode()  
      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()  
      static Examples.Builder newBuilder()  
      static Examples.Builder newBuilder​(Examples prototype)  
      Examples.Builder newBuilderForType()  
      protected Examples.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      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.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

      • EXAMPLE_GCS_SOURCE_FIELD_NUMBER

        public static final int EXAMPLE_GCS_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER

        public static final int NEAREST_NEIGHBOR_SEARCH_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GCS_SOURCE_FIELD_NUMBER

        public static final int GCS_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEIGHBOR_COUNT_FIELD_NUMBER

        public static final int NEIGHBOR_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

      • isInitialized

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

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

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

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

      • getDefaultInstanceForType

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