Google Cloud Ai Platform V1 Client - Class ListIndexEndpointsRequest (1.22.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
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
Google\Protobuf\FieldMask

Optional. Mask specifying which fields to read.

getParent

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

Returns
Type
Description
string

setParent

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

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 .
    • 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
Type
Description
string

setFilter

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"
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. The standard list page size.

Returns
Type
Description
int

setPageSize

Optional. The standard list page size.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Optional. The standard list page token.

Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

Returns
Type
Description
string

setPageToken

Optional. The standard list page token.

Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReadMask

Optional. Mask specifying which fields to read.

Returns
Type
Description

hasReadMask

clearReadMask

setReadMask

Optional. Mask specifying which fields to read.

Parameter
Name
Description
Returns
Type
Description
$this

static::build

Parameter
Name
Description
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.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: