Class ListIndexEndpointsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder>
com.google.cloud.visionai.v1.ListIndexEndpointsRequest.Builder
All Implemented Interfaces:
ListIndexEndpointsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListIndexEndpointsRequest

public static final class ListIndexEndpointsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListIndexEndpointsRequest.Builder> implements ListIndexEndpointsRequestOrBuilder
 Request message for ListIndexEndpoints.
 
Protobuf type google.cloud.visionai.v1.ListIndexEndpointsRequest
  • 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<ListIndexEndpointsRequest.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<ListIndexEndpointsRequest.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<ListIndexEndpointsRequest.Builder>
    • getDefaultInstanceForType

      public ListIndexEndpointsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public ListIndexEndpointsRequest.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<ListIndexEndpointsRequest.Builder>
    • mergeFrom

    • isInitialized

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

      public ListIndexEndpointsRequest.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<ListIndexEndpointsRequest.Builder>
      Throws:
      IOException
    • getParent

      public String getParent()
       Required. Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The parent.
    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The bytes for parent.
    • setParent

      public ListIndexEndpointsRequest.Builder setParent(String value)
       Required. Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.
    • clearParent

      public ListIndexEndpointsRequest.Builder clearParent()
       Required. Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.
    • setParentBytes

      public ListIndexEndpointsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. Format: `projects/{project}/locations/{location}`
       
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.
    • getPageSize

      public int getPageSize()
       Optional. Requested page size. Server may return fewer items than
       requested. The service may return fewer than this value. If unspecified, a
       page size of 50 will be used. The maximum value is 1000; values above 1000
       will be coerced to 1000.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageSize in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The pageSize.
    • setPageSize

      public ListIndexEndpointsRequest.Builder setPageSize(int value)
       Optional. Requested page size. Server may return fewer items than
       requested. The service may return fewer than this value. If unspecified, a
       page size of 50 will be used. The maximum value is 1000; values above 1000
       will be coerced to 1000.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.
    • clearPageSize

      public ListIndexEndpointsRequest.Builder clearPageSize()
       Optional. Requested page size. Server may return fewer items than
       requested. The service may return fewer than this value. If unspecified, a
       page size of 50 will be used. The maximum value is 1000; values above 1000
       will be coerced to 1000.
       
      int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • getPageToken

      public String getPageToken()
       Optional. A token identifying a page of results the server should return.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. A token identifying a page of results the server should return.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • setPageToken

      public ListIndexEndpointsRequest.Builder setPageToken(String value)
       Optional. A token identifying a page of results the server should return.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.
    • clearPageToken

      public ListIndexEndpointsRequest.Builder clearPageToken()
       Optional. A token identifying a page of results the server should return.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setPageTokenBytes

      public ListIndexEndpointsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Optional. A token identifying a page of results the server should return.
       
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.
    • getFilter

      public String getFilter()
       Optional. The filter applied to the returned list.
       We only support filtering for the `deployed_image_index.image_index` field.
       However, to filter by a corpus instead of an image index, simply use
       `deployed_image_index.corpus`, which will return all endpoints with
       `deployed_image_index.image_index` inside of the given corpus.
       A basic filter on image index would look like:
       deployed_image_index.image_index =
       "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
       A basic filter on corpus would look like:
       deployed_image_index.corpus =
       "projects/123/locations/us-central1/corpora/my_corpus"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilter in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The filter.
    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Optional. The filter applied to the returned list.
       We only support filtering for the `deployed_image_index.image_index` field.
       However, to filter by a corpus instead of an image index, simply use
       `deployed_image_index.corpus`, which will return all endpoints with
       `deployed_image_index.image_index` inside of the given corpus.
       A basic filter on image index would look like:
       deployed_image_index.image_index =
       "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
       A basic filter on corpus would look like:
       deployed_image_index.corpus =
       "projects/123/locations/us-central1/corpora/my_corpus"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getFilterBytes in interface ListIndexEndpointsRequestOrBuilder
      Returns:
      The bytes for filter.
    • setFilter

      public ListIndexEndpointsRequest.Builder setFilter(String value)
       Optional. The filter applied to the returned list.
       We only support filtering for the `deployed_image_index.image_index` field.
       However, to filter by a corpus instead of an image index, simply use
       `deployed_image_index.corpus`, which will return all endpoints with
       `deployed_image_index.image_index` inside of the given corpus.
       A basic filter on image index would look like:
       deployed_image_index.image_index =
       "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
       A basic filter on corpus would look like:
       deployed_image_index.corpus =
       "projects/123/locations/us-central1/corpora/my_corpus"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.
    • clearFilter

      public ListIndexEndpointsRequest.Builder clearFilter()
       Optional. The filter applied to the returned list.
       We only support filtering for the `deployed_image_index.image_index` field.
       However, to filter by a corpus instead of an image index, simply use
       `deployed_image_index.corpus`, which will return all endpoints with
       `deployed_image_index.image_index` inside of the given corpus.
       A basic filter on image index would look like:
       deployed_image_index.image_index =
       "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
       A basic filter on corpus would look like:
       deployed_image_index.corpus =
       "projects/123/locations/us-central1/corpora/my_corpus"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.
    • setFilterBytes

      public ListIndexEndpointsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Optional. The filter applied to the returned list.
       We only support filtering for the `deployed_image_index.image_index` field.
       However, to filter by a corpus instead of an image index, simply use
       `deployed_image_index.corpus`, which will return all endpoints with
       `deployed_image_index.image_index` inside of the given corpus.
       A basic filter on image index would look like:
       deployed_image_index.image_index =
       "projects/123/locations/us-central1/corpora/my_corpus/imageIndexes/my_image_index"
       A basic filter on corpus would look like:
       deployed_image_index.corpus =
       "projects/123/locations/us-central1/corpora/my_corpus"
       
      string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.