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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The project and location that the Study belongs to. Format: |
↳ 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 |
getParent
Required. The project and location that the Study belongs to.
Format: projects/{project}/locations/{location}/studies/{study}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The project and location that the Study belongs to.
Format: projects/{project}/locations/{location}/studies/{study}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSuggestionCount
Required. The number of suggestions requested. It must be positive.
Generated from protobuf field int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setSuggestionCount
Required. The number of suggestions requested. It must be positive.
Generated from protobuf field int32 suggestion_count = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
Generated from protobuf field string client_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
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.
Generated from protobuf field string client_id = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |