Package com.google.cloud.aiplatform.v1

Interface ListIndexEndpointsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListIndexEndpointsRequest, ListIndexEndpointsRequest.Builder
    public interface ListIndexEndpointsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Optional.
      com.google.protobuf.ByteString getFilterBytes()
      Optional.
      int getPageSize()
      Optional.
      String getPageToken()
      Optional.
      com.google.protobuf.ByteString getPageTokenBytes()
      Optional.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.FieldMask getReadMask()
      Optional.
      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      Optional.
      boolean hasReadMask()
      Optional.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        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) = { ... }
        Returns:
        The parent.

      • getParentBytes

        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) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        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.v1.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:
        The filter.

      • getFilterBytes

        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.v1.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:
        The bytes for filter.

      • getPageSize

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

      • getPageToken

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

      • getPageTokenBytes

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

      • hasReadMask

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

      • getReadMask

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

      • getReadMaskOrBuilder

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