Package com.google.cloud.aiplatform.v1beta1

Class 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.GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder>
implements ListIndexEndpointsRequestOrBuilder
     Request message for
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints].
    Protobuf type google.cloud.aiplatform.v1beta1.ListIndexEndpointsRequest

    • Method Detail

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

      • setRepeatedField

        public ListIndexEndpointsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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. The resource name of the Location from which to list the
 IndexEndpoints. 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. The resource name of the Location from which to list the
 IndexEndpoints. 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. The resource name of the Location from which to list the
 IndexEndpoints. 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. The resource name of the Location from which to list the
 IndexEndpoints. 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. The resource name of the Location from which to list the
 IndexEndpoints. 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.

      • getFilter

        public String getFilter()
         Optional. An expression for filtering the results of the request. For field
 names both snake_case and camelCase are supported.

   * `index_endpoint` supports = and !=. `index_endpoint` represents the
      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
      [resourcename][google.cloud.aiplatform.v1beta1.IndexEndpoint.name].
   * `display_name` supports =, != and regex()
             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
   * `labels` supports general map functions that is:
             `labels.key=value` - key:value equality
             `labels.key:* or labels:key - key existence
              A key including a space must be quoted. `labels."a key"`.

 Some examples:
   * `index_endpoint="1"`
   * `display_name="myDisplayName"`
   * `regex(display_name, "^A") -> The display name starts with an A.
   * `labels.myKey="myValue"`
        string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. An expression for filtering the results of the request. For field
 names both snake_case and camelCase are supported.

   * `index_endpoint` supports = and !=. `index_endpoint` represents the
      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
      [resourcename][google.cloud.aiplatform.v1beta1.IndexEndpoint.name].
   * `display_name` supports =, != and regex()
             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
   * `labels` supports general map functions that is:
             `labels.key=value` - key:value equality
             `labels.key:* or labels:key - key existence
              A key including a space must be quoted. `labels."a key"`.

 Some examples:
   * `index_endpoint="1"`
   * `display_name="myDisplayName"`
   * `regex(display_name, "^A") -> The display name starts with an A.
   * `labels.myKey="myValue"`
        string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListIndexEndpointsRequest.Builder setFilter​(String value)
         Optional. An expression for filtering the results of the request. For field
 names both snake_case and camelCase are supported.

   * `index_endpoint` supports = and !=. `index_endpoint` represents the
      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
      [resourcename][google.cloud.aiplatform.v1beta1.IndexEndpoint.name].
   * `display_name` supports =, != and regex()
             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
   * `labels` supports general map functions that is:
             `labels.key=value` - key:value equality
             `labels.key:* or labels:key - key existence
              A key including a space must be quoted. `labels."a key"`.

 Some examples:
   * `index_endpoint="1"`
   * `display_name="myDisplayName"`
   * `regex(display_name, "^A") -> The display name starts with an A.
   * `labels.myKey="myValue"`
        string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListIndexEndpointsRequest.Builder clearFilter()
         Optional. An expression for filtering the results of the request. For field
 names both snake_case and camelCase are supported.

   * `index_endpoint` supports = and !=. `index_endpoint` represents the
      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
      [resourcename][google.cloud.aiplatform.v1beta1.IndexEndpoint.name].
   * `display_name` supports =, != and regex()
             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
   * `labels` supports general map functions that is:
             `labels.key=value` - key:value equality
             `labels.key:* or labels:key - key existence
              A key including a space must be quoted. `labels."a key"`.

 Some examples:
   * `index_endpoint="1"`
   * `display_name="myDisplayName"`
   * `regex(display_name, "^A") -> The display name starts with an A.
   * `labels.myKey="myValue"`
        string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ListIndexEndpointsRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         Optional. An expression for filtering the results of the request. For field
 names both snake_case and camelCase are supported.

   * `index_endpoint` supports = and !=. `index_endpoint` represents the
      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
      [resourcename][google.cloud.aiplatform.v1beta1.IndexEndpoint.name].
   * `display_name` supports =, != and regex()
             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
   * `labels` supports general map functions that is:
             `labels.key=value` - key:value equality
             `labels.key:* or labels:key - key existence
              A key including a space must be quoted. `labels."a key"`.

 Some examples:
   * `index_endpoint="1"`
   * `display_name="myDisplayName"`
   * `regex(display_name, "^A") -> The display name starts with an A.
   * `labels.myKey="myValue"`
        string filter = 2 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • getPageSize

        public int getPageSize()
         Optional. The standard list page size.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageSize in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ListIndexEndpointsRequest.Builder setPageSize​(int value)
         Optional. The standard list page size.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListIndexEndpointsRequest.Builder clearPageSize()
         Optional. The standard list page size.
        int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         Optional. The standard list page token.
 Typically obtained via
 [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
 of the previous
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
 call.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageToken in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional. The standard list page token.
 Typically obtained via
 [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
 of the previous
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
 call.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageTokenBytes in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListIndexEndpointsRequest.Builder setPageToken​(String value)
         Optional. The standard list page token.
 Typically obtained via
 [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
 of the previous
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
 call.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListIndexEndpointsRequest.Builder clearPageToken()
         Optional. The standard list page token.
 Typically obtained via
 [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
 of the previous
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
 call.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListIndexEndpointsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional. The standard list page token.
 Typically obtained via
 [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1beta1.ListIndexEndpointsResponse.next_page_token]
 of the previous
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1beta1.IndexEndpointService.ListIndexEndpoints]
 call.
        string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • hasReadMask

        public boolean hasReadMask()
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasReadMask in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        Whether the readMask field is set.

      • getReadMask

        public com.google.protobuf.FieldMask getReadMask()
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReadMask in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The readMask.

      • setReadMask

        public ListIndexEndpointsRequest.Builder setReadMask​(com.google.protobuf.FieldMask value)
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

      • setReadMask

        public ListIndexEndpointsRequest.Builder setReadMask​(com.google.protobuf.FieldMask.Builder builderForValue)
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

      • mergeReadMask

        public ListIndexEndpointsRequest.Builder mergeReadMask​(com.google.protobuf.FieldMask value)
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

      • clearReadMask

        public ListIndexEndpointsRequest.Builder clearReadMask()
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getReadMaskBuilder

        public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

      • getReadMaskOrBuilder

        public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         Optional. Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getReadMaskOrBuilder in interface ListIndexEndpointsRequestOrBuilder

      • setUnknownFields

        public final ListIndexEndpointsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder>

      • mergeUnknownFields

        public final ListIndexEndpointsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListIndexEndpointsRequest.Builder>