Google Cloud Ai Platform V1 Client - Class ListEndpointsRequest (1.11.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

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 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". * base_model_name only supports =. Some examples: * endpoint=1 * displayName="myDisplayName" * labels.myKey="myValue" * baseModelName="text-bison"
↳ 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
Type Description
string

setParent

Required. The resource name of the Location from which to list the Endpoints. 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.

  • 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".
    • base_model_name only supports =. Some examples:
    • endpoint=1
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • baseModelName="text-bison"
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.

  • 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".
    • base_model_name only supports =. Some examples:
    • endpoint=1
    • displayName="myDisplayName"
    • labels.myKey="myValue"
    • baseModelName="text-bison"
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 ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call.

Returns
Type Description
string

setPageToken

Optional. The standard list page token.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getReadMask

Optional. Mask specifying which fields to read.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Optional. Mask specifying which fields to read.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

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