Google Cloud Ai Platform V1 Client - Class ListStudiesRequest (0.23.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
NameDescription
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
TypeDescription
string

setParent

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

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageToken

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

If unspecified, there are no subsequent pages.

Returns
TypeDescription
string

setPageToken

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

If unspecified, there are no subsequent pages.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

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

If unspecified, service will pick an appropriate default.

Returns
TypeDescription
int

setPageSize

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

If unspecified, service will pick an appropriate default.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\AIPlatform\V1\ListStudiesRequest