Google Cloud Ai Platform V1 Client - Class ListTrialsRequest (0.10.0)

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

Request message for VizierService.ListTrials.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the Study to list the Trial from. Format: projects/{project}/locations/{location}/studies/{study}

↳ 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 number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default.

getParent

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

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

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.

Generated from protobuf field string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
string

setPageToken

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

If unspecified, there are no subsequent pages.

Generated from protobuf field string page_token = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The number of Trials to retrieve per "page" of results.

If unspecified, the service will pick an appropriate default.

Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

setPageSize

Optional. The number of Trials to retrieve per "page" of results.

If unspecified, the service will pick an appropriate default.

Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$this