Package com.google.cloud.aiplatform.v1

Class ListIndexEndpointsRequest

  • All Implemented Interfaces:
    ListIndexEndpointsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListIndexEndpointsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListIndexEndpointsRequestOrBuilder
     Request message for
 [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
    Protobuf type google.cloud.aiplatform.v1.ListIndexEndpointsRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

      • 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.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];
        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.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];
        Specified by:
        getFilterBytes in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The bytes for filter.

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

      • getPageToken

        public 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];
        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.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];
        Specified by:
        getPageTokenBytes in interface ListIndexEndpointsRequestOrBuilder
        Returns:
        The bytes for pageToken.

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

      • 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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ListIndexEndpointsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListIndexEndpointsRequest> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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