Google Cloud Ai Platform V1 Client - Class ListStudiesRequest (0.24.0)

Version 0.24.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 ListStudiesRequest.

Request message for VizierService.ListStudies.

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

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 Study from. Format: projects/{project}/locations/{location}
↳ page_token	string Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages.
↳ page_size	int Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default.

getParent

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

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

Returns
Type	Description
string

setParent

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

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageToken

Optional. A page token to request the next page of results.

If unspecified, there are no subsequent pages.

Returns
Type	Description
string

setPageToken

Optional. A page token to request the next page of results.

If unspecified, there are no subsequent pages.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Optional. The maximum number of studies to return per "page" of results.

If unspecified, service will pick an appropriate default.

Returns
Type	Description
int

setPageSize

Optional. The maximum number of studies to return per "page" of results.

If unspecified, service will pick an appropriate default.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

static::build

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

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