Class: Google::Cloud::AIPlatform::V1::ListIndexEndpointsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb

Overview

Request message for IndexEndpointService.ListIndexEndpoints.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.
  • display_name supports =, != and regex() (uses re2 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".

Returns:

  • (::String) —

    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.
    • display_name supports =, != and regex() (uses re2 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"


100
101
102
103
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb', line 100

class ListIndexEndpointsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns Optional. The standard list page size.

Returns:

  • (::Integer) —

    Optional. The standard list page size.



100
101
102
103
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb', line 100

class ListIndexEndpointsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

Returns:



100
101
102
103
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb', line 100

class ListIndexEndpointsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}.

Returns:

  • (::String) —

    Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}



100
101
102
103
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb', line 100

class ListIndexEndpointsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Optional. Mask specifying which fields to read.

Returns:



100
101
102
103
 
# File 'proto_docs/google/cloud/aiplatform/v1/index_endpoint_service.rb', line 100

class ListIndexEndpointsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end