Package com.google.cloud.aiplatform.v1beta1

Class FetchExamplesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<FetchExamplesRequest.Builder>
com.google.cloud.aiplatform.v1beta1.FetchExamplesRequest.Builder
All Implemented Interfaces:
FetchExamplesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
FetchExamplesRequest
public static final class FetchExamplesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<FetchExamplesRequest.Builder> implements FetchExamplesRequestOrBuilder
 Request message for
 [ExampleStoreService.FetchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.FetchExamples].
Protobuf type google.cloud.aiplatform.v1beta1.FetchExamplesRequest

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

    • clear

      public FetchExamplesRequest.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<FetchExamplesRequest.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<FetchExamplesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public FetchExamplesRequest.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<FetchExamplesRequest.Builder>

    • mergeFrom

      public FetchExamplesRequest.Builder mergeFrom(FetchExamplesRequest other)

    • isInitialized

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

    • mergeFrom

      public FetchExamplesRequest.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<FetchExamplesRequest.Builder>
      Throws:
      IOException

    • getMetadataFilterCase

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

    • clearMetadataFilter

      public FetchExamplesRequest.Builder clearMetadataFilter()

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

    • setStoredContentsExampleFilter

      public FetchExamplesRequest.Builder setStoredContentsExampleFilter(StoredContentsExampleFilter value)
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

    • setStoredContentsExampleFilter

      public FetchExamplesRequest.Builder setStoredContentsExampleFilter(StoredContentsExampleFilter.Builder builderForValue)
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

    • mergeStoredContentsExampleFilter

      public FetchExamplesRequest.Builder mergeStoredContentsExampleFilter(StoredContentsExampleFilter value)
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

    • clearStoredContentsExampleFilter

      public FetchExamplesRequest.Builder clearStoredContentsExampleFilter()
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

    • getStoredContentsExampleFilterBuilder

      public StoredContentsExampleFilter.Builder getStoredContentsExampleFilterBuilder()
       The metadata filters for StoredContentsExamples.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleFilter stored_contents_example_filter = 8;

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

    • setExampleStore

      public FetchExamplesRequest.Builder setExampleStore(String value)
       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) = { ... }
      Parameters:
      value - The exampleStore to set.
      Returns:
      This builder for chaining.

    • clearExampleStore

      public FetchExamplesRequest.Builder clearExampleStore()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setExampleStoreBytes

      public FetchExamplesRequest.Builder setExampleStoreBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for exampleStore to set.
      Returns:
      This builder for chaining.

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

    • setPageSize

      public FetchExamplesRequest.Builder setPageSize(int value)
       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];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public FetchExamplesRequest.Builder clearPageSize()
       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];
      Returns:
      This builder for chaining.

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

    • setPageToken

      public FetchExamplesRequest.Builder setPageToken(String value)
       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];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public FetchExamplesRequest.Builder clearPageToken()
       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];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public FetchExamplesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

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

    • setExampleIds

      public FetchExamplesRequest.Builder setExampleIds(int index, String value)
       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];
      Parameters:
      index - The index to set the value at.
      value - The exampleIds to set.
      Returns:
      This builder for chaining.

    • addExampleIds

      public FetchExamplesRequest.Builder addExampleIds(String value)
       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];
      Parameters:
      value - The exampleIds to add.
      Returns:
      This builder for chaining.

    • addAllExampleIds

      public FetchExamplesRequest.Builder addAllExampleIds(Iterable<String> values)
       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];
      Parameters:
      values - The exampleIds to add.
      Returns:
      This builder for chaining.

    • clearExampleIds

      public FetchExamplesRequest.Builder clearExampleIds()
       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];
      Returns:
      This builder for chaining.

    • addExampleIdsBytes

      public FetchExamplesRequest.Builder addExampleIdsBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes of the exampleIds to add.
      Returns:
      This builder for chaining.