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

Version 1.8.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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
Name	Description
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". *base_model_nameonly supports = Some examples: *model=1234*displayName="myDisplayName"*labels.myKey="myValue"*baseModelName="text-bison"`
↳ 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
Type	Description
string

setParent

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

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

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.

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

Returns
Type	Description
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".
  • base_model_name only supports = Some examples:
  • model=1234
  • displayName="myDisplayName"
  • labels.myKey="myValue"
  • baseModelName="text-bison"

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 ListModelsResponse.next_page_token of the previous ModelService.ListModels call.

Returns
Type	Description
string

setPageToken

The standard list page token.

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

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:

• 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 to list the Models from. Format: projects/{project}/locations/{location} Please see Google\Cloud\AIPlatform\V1\ModelServiceClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\ListModelsRequest