Google Cloud Ai Platform V1 Client - Class ListHyperparameterTuningJobsRequest (0.20.0)

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

Request message for JobService.ListHyperparameterTuningJobs.

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

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 HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`
`↳ filter`	`string` The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_"``state!="JOB_STATE_FAILED" OR display_name="my_job"``NOT display_name="my_job"``create_time>"2021-05-18T00:00:00Z"``labels.keyA=valueA``labels.keyB:`
`↳ page_size`	`int` The standard list page size.
`↳ page_token`	`string` The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.
`↳ read_mask`	`Google\Protobuf\FieldMask` Mask specifying which fields to read.

getParent

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

Returns
Type	Description
`string`

setParent

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

The standard list filter.

Supported fields:

display_name supports =, != comparisons, and : wildcard.
state supports =, != comparisons.
create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence Some examples of using the filter are:
state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
state!="JOB_STATE_FAILED" OR display_name="my_job"
NOT display_name="my_job"
create_time>"2021-05-18T00:00:00Z"
labels.keyA=valueA
labels.keyB:*

Returns
Type	Description
`string`

setFilter

The standard list filter.

Supported fields:

display_name supports =, != comparisons, and : wildcard.
state supports =, != comparisons.
create_time supports =, !=,<, <=,>, >= comparisons. create_time must be in RFC 3339 format.
labels supports general map functions that is: labels.key=value - key:value equality `labels.key:* - key existence Some examples of using the filter are:
state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"
state!="JOB_STATE_FAILED" OR display_name="my_job"
NOT display_name="my_job"
create_time>"2021-05-18T00:00:00Z"
labels.keyA=valueA
labels.keyB:*

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 ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.

Returns
Type	Description
`string`

setPageToken

The standard list page token.

Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs 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`

static::build

Parameter
Name	Description
`parent`	`string` Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}` Please see Google\Cloud\AIPlatform\V1\JobServiceClient::locationName() for help formatting this field.

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