Package com.google.cloud.aiplatform.v1beta1

Class FetchExamplesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.FetchExamplesRequest
All Implemented Interfaces:
FetchExamplesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FetchExamplesRequest extends com.google.protobuf.GeneratedMessage implements FetchExamplesRequestOrBuilder
 Request message for
 [ExampleStoreService.FetchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.FetchExamples].
Protobuf type google.cloud.aiplatform.v1beta1.FetchExamplesRequest
See Also:

  • Field Details

    • STORED_CONTENTS_EXAMPLE_FILTER_FIELD_NUMBER

      public static final int STORED_CONTENTS_EXAMPLE_FILTER_FIELD_NUMBER
      See Also:

    • EXAMPLE_STORE_FIELD_NUMBER

      public static final int EXAMPLE_STORE_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • EXAMPLE_IDS_FIELD_NUMBER

      public static final int EXAMPLE_IDS_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

    • getMetadataFilterCase

      public FetchExamplesRequest.MetadataFilterCase getMetadataFilterCase()
      Specified by:
      getMetadataFilterCase in interface FetchExamplesRequestOrBuilder

    • hasStoredContentsExampleFilter

      public boolean hasStoredContentsExampleFilter()
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
      Specified by:
      hasStoredContentsExampleFilter in interface FetchExamplesRequestOrBuilder
      Returns:
      Whether the storedContentsExampleFilter field is set.

    • getStoredContentsExampleFilter

      public StoredContentsExampleFilter getStoredContentsExampleFilter()
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
      Specified by:
      getStoredContentsExampleFilter in interface FetchExamplesRequestOrBuilder
      Returns:
      The storedContentsExampleFilter.

    • getStoredContentsExampleFilterOrBuilder

      public StoredContentsExampleFilterOrBuilder getStoredContentsExampleFilterOrBuilder()
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;
      Specified by:
      getStoredContentsExampleFilterOrBuilder in interface FetchExamplesRequestOrBuilder

    • getExampleStore

      public String getExampleStore()
       Required. The name of the ExampleStore resource that the examples should be
 fetched from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
      string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getExampleStore in interface FetchExamplesRequestOrBuilder
      Returns:
      The exampleStore.

    • getExampleStoreBytes

      public com.google.protobuf.ByteString getExampleStoreBytes()
       Required. The name of the ExampleStore resource that the examples should be
 fetched from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
      string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getExampleStoreBytes in interface FetchExamplesRequestOrBuilder
      Returns:
      The bytes for exampleStore.

    • getPageSize

      public int getPageSize()
       Optional. The maximum number of examples to return. The service may return
 fewer than this value. If unspecified, at most 100 examples will be
 returned.
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface FetchExamplesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

      public String getPageToken()
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.FetchExamplesResponse.next_page_token]
 value returned from a previous list
 [ExampleStoreService.FetchExamplesResponse][] call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface FetchExamplesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. The
 [next_page_token][google.cloud.aiplatform.v1beta1.FetchExamplesResponse.next_page_token]
 value returned from a previous list
 [ExampleStoreService.FetchExamplesResponse][] call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface FetchExamplesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • getExampleIdsList

      public com.google.protobuf.ProtocolStringList getExampleIdsList()
       Optional. Example IDs to fetch. If both metadata filters and Example IDs
 are specified, then both ID and metadata filtering will be applied.
      repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExampleIdsList in interface FetchExamplesRequestOrBuilder
      Returns:
      A list containing the exampleIds.

    • getExampleIdsCount

      public int getExampleIdsCount()
       Optional. Example IDs to fetch. If both metadata filters and Example IDs
 are specified, then both ID and metadata filtering will be applied.
      repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExampleIdsCount in interface FetchExamplesRequestOrBuilder
      Returns:
      The count of exampleIds.

    • getExampleIds

      public String getExampleIds(int index)
       Optional. Example IDs to fetch. If both metadata filters and Example IDs
 are specified, then both ID and metadata filtering will be applied.
      repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExampleIds in interface FetchExamplesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The exampleIds at the given index.

    • getExampleIdsBytes

      public com.google.protobuf.ByteString getExampleIdsBytes(int index)
       Optional. Example IDs to fetch. If both metadata filters and Example IDs
 are specified, then both ID and metadata filtering will be applied.
      repeated string example_ids = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExampleIdsBytes in interface FetchExamplesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the exampleIds at the given index.

    • 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 FetchExamplesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FetchExamplesRequest.Builder newBuilder()

    • newBuilder

      public static FetchExamplesRequest.Builder newBuilder(FetchExamplesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FetchExamplesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FetchExamplesRequest> 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 FetchExamplesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder