Google Cloud Ai Platform V1 Client - Class SuggestTrialsRequest (0.16.0)

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

Request message for VizierService.SuggestTrials.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The project and location that the Study belongs to. Format: projects/{project}/locations/{location}/studies/{study}

↳ suggestion_count int

Required. The number of suggestions requested. It must be positive.

↳ client_id string

Required. The identifier of the client that is requesting the suggestion. If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

getParent

Required. The project and location that the Study belongs to.

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

Returns
TypeDescription
string

setParent

Required. The project and location that the Study belongs to.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSuggestionCount

Required. The number of suggestions requested. It must be positive.

Returns
TypeDescription
int

setSuggestionCount

Required. The number of suggestions requested. It must be positive.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getClientId

Required. The identifier of the client that is requesting the suggestion.

If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

Returns
TypeDescription
string

setClientId

Required. The identifier of the client that is requesting the suggestion.

If multiple SuggestTrialsRequests have the same client_id, the service will return the identical suggested Trial if the Trial is pending, and provide a new Trial if the last suggested Trial was completed.

Parameter
NameDescription
var string
Returns
TypeDescription
$this