Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListIndexEndpointsRequest.
Request message for IndexEndpointService.ListIndexEndpoints .
Generated from protobuf message google.cloud.aiplatform.v1.ListIndexEndpointsRequest
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}
↳ filter
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"
↳ page_size
int
Optional. The standard list page size.
↳ page_token
string
Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.
↳ read_mask
getParent
Required. The resource name of the Location from which to list the
IndexEndpoints. Format: projects/{project}/locations/{location}
string
setParent
Required. The resource name of the Location from which to list the
IndexEndpoints. Format: projects/{project}/locations/{location}
var
string
$this
getFilter
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
-
index_endpointsupports = and !=.index_endpointrepresents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename .-
display_namesupports =, != and regex() (uses re2 syntax) -
labelssupports general map functions that is:labels.key=value- key:value equalitylabels.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
setFilter
Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.
-
index_endpointsupports = and !=.index_endpointrepresents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename .-
display_namesupports =, != and regex() (uses re2 syntax) -
labelssupports general map functions that is:labels.key=value- key:value equalitylabels.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"
-
var
string
$this
getPageSize
Optional. The standard list page size.
int
setPageSize
Optional. The standard list page size.
var
int
$this
getPageToken
Optional. The standard list page token.
Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.
string
setPageToken
Optional. The standard list page token.
Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.
var
string
$this
getReadMask
Optional. Mask specifying which fields to read.
hasReadMask
clearReadMask
setReadMask
Optional. Mask specifying which fields to read.
$this
static::build
parent
string
Required. The resource name of the Location from which to list the
IndexEndpoints. Format: projects/{project}/locations/{location}
Please see IndexEndpointServiceClient::locationName()
for help formatting this field.
