Google Cloud Ai Platform V1 Client - Class ListModelsRequest (0.21.0)

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

Request message for ModelService.ListModels.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ filter string

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * model supports = and !=. model represents the Model ID, i.e. the last segment of the Model'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: *model=1234*displayName="myDisplayName"*labels.myKey="myValue"`

↳ page_size int

The standard list page size.

↳ page_token string

The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

↳ read_mask Google\Protobuf\FieldMask

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 to list the Models from.

Format: projects/{project}/locations/{location}

Returns
TypeDescription
string

setParent

Required. The resource name of the Location to list the Models from.

Format: projects/{project}/locations/{location}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

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

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model'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:
    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"
Returns
TypeDescription
string

setFilter

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

  • model supports = and !=. model represents the Model ID, i.e. the last segment of the Model'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:
    • model=1234
    • displayName="myDisplayName"
    • labels.myKey="myValue"
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Returns
TypeDescription
int

setPageSize

The standard list page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

Returns
TypeDescription
string

setPageToken

The standard list page token.

Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

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

static::build

Parameter
NameDescription
parent string

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

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ListModelsRequest