Google Cloud Ai Platform V1 Client - Class ListEndpointsRequest (0.16.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListEndpointsRequest.

Request message for EndpointService.ListEndpoints.

Generated from protobuf message google.cloud.aiplatform.v1.ListEndpointsRequest

Methods

build

Parameter
NameDescription
parent string

Required. The resource name of the Location from which to list the Endpoints. Format: projects/{project}/locations/{location} Please see {@see \Google\Cloud\AIPlatform\V1\EndpointServiceClient::locationName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ListEndpointsRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the Location from which to list the Endpoints. 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. * endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * display_name supports = and, != * 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: *endpoint=1*displayName="myDisplayName"*labels.myKey="myValue"`

↳ page_size int

Optional. The standard list page size.

↳ page_token string

Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

↳ read_mask Google\Protobuf\FieldMask

Optional. Mask specifying which fields to read.

↳ order_by string

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * display_name * create_time * update_time Example: display_name, create_time desc.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
    • display_name supports = and, !=
    • 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:
    • endpoint=1
    • displayName="myDisplayName"
    • labels.myKey="myValue"
Returns
TypeDescription
string

setFilter

Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported.

  • endpoint supports = and !=. endpoint represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name.
    • display_name supports = and, !=
    • 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:
    • endpoint=1
    • displayName="myDisplayName"
    • labels.myKey="myValue"
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The standard list page size.

Returns
TypeDescription
int

setPageSize

Optional. The standard list page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

Optional. The standard list page token.

Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

Returns
TypeDescription
string

setPageToken

Optional. The standard list page token.

Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Optional. Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. Mask specifying which fields to read.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time Example: display_name, create_time desc.
Returns
TypeDescription
string

setOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported fields:

  • display_name
  • create_time
  • update_time Example: display_name, create_time desc.
Parameter
NameDescription
var string
Returns
TypeDescription
$this