Google Cloud Workload Manager V1 Client - Class RunEvaluationRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Workload Manager V1 Client class RunEvaluationRequest.

Request message for the RunEvaluation RPC.

Generated from protobuf message google.cloud.workloadmanager.v1.RunEvaluationRequest

Namespace

Google \ Cloud \ WorkloadManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the Evaluation using the form: projects/{project}/locations/{location}/evaluations/{evaluation}.

↳ execution_id string

Required. ID of the execution which will be created.

↳ execution Execution

Required. The resource being created.

↳ request_id string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

getName

Required. The resource name of the Evaluation using the form: projects/{project}/locations/{location}/evaluations/{evaluation}.

Returns
Type Description
string

setName

Required. The resource name of the Evaluation using the form: projects/{project}/locations/{location}/evaluations/{evaluation}.

Parameter
Name Description
var string
Returns
Type Description
$this

getExecutionId

Required. ID of the execution which will be created.

Returns
Type Description
string

setExecutionId

Required. ID of the execution which will be created.

Parameter
Name Description
var string
Returns
Type Description
$this

getExecution

Required. The resource being created.

Returns
Type Description
Execution|null

hasExecution

clearExecution

setExecution

Required. The resource being created.

Parameter
Name Description
var Execution
Returns
Type Description
$this

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type Description
string

setRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The resource name of the Evaluation using the form: projects/{project}/locations/{location}/evaluations/{evaluation}. Please see WorkloadManagerClient::evaluationName() for help formatting this field.

execution Execution

Required. The resource being created.

executionId string

Required. ID of the execution which will be created.

Returns
Type Description
RunEvaluationRequest