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

Methods

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 {@see \Google\Cloud\AIPlatform\V1\ModelServiceClient::locationName()} for help formatting this field.

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

__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"`. 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
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". Some examples:
- model=1234
- displayName="myDisplayName"
- 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.

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
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