Google Cloud Ai Platform V1 Client - Class ListModelVersionsRequest (1.11.0)

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

Request message for ModelService.ListModelVersions.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the model to list versions for.
↳ page_size int

The standard list page size.
↳ page_token string

The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call.
↳ filter string

An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * * 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: *labels.myKey="myValue"`
↳ 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: * * create_time * * update_time Example: update_time asc, create_time desc.

getName

Required. The name of the model to list versions for.

Returns
Type Description
string

setName

Required. The name of the model to list versions for.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The standard list page size.

Returns
Type Description
int

setPageSize

The standard list page size.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

The standard list page token.

Typically obtained via next_page_token of the previous ListModelVersions call.

Returns
Type Description
string

setPageToken

The standard list page token.

Typically obtained via next_page_token of the previous ListModelVersions call.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

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

  • 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:
      • labels.myKey="myValue"
Returns
Type Description
string

setFilter

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

  • 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:
      • labels.myKey="myValue"
Parameter
Name Description
var string
Returns
Type Description
$this

getReadMask

Mask specifying which fields to read.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

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:

  • create_time
  • update_time Example: update_time asc, 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:

  • create_time
  • update_time Example: update_time asc, create_time desc.
Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the model to list versions for. Please see Google\Cloud\AIPlatform\V1\ModelServiceClient::modelName() for help formatting this field.
Returns
Type Description
Google\Cloud\AIPlatform\V1\ListModelVersionsRequest