Google Cloud App Hub V1 Client - Class CreateWorkloadRequest (0.1.3)

Reference documentation and code samples for the Google Cloud App Hub V1 Client class CreateWorkloadRequest.

Request for CreateWorkload.

Generated from protobuf message google.cloud.apphub.v1.CreateWorkloadRequest

Namespace

Google \ Cloud \ AppHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Fully qualified name of the Application to create Workload in. Expected format: projects/{project}/locations/{location}/applications/{application}.

↳ workload_id string

Required. The Workload identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

↳ workload Google\Cloud\AppHub\V1\Workload

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).

getParent

Required. Fully qualified name of the Application to create Workload in.

Expected format: projects/{project}/locations/{location}/applications/{application}.

Returns
Type Description
string

setParent

Required. Fully qualified name of the Application to create Workload in.

Expected format: projects/{project}/locations/{location}/applications/{application}.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkloadId

Required. The Workload identifier.

Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns
Type Description
string

setWorkloadId

Required. The Workload identifier.

Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Parameter
Name Description
var string
Returns
Type Description
$this

getWorkload

Required. The resource being created.

Returns
Type Description
Google\Cloud\AppHub\V1\Workload|null

hasWorkload

clearWorkload

setWorkload

Required. The resource being created.

Parameter
Name Description
var Google\Cloud\AppHub\V1\Workload
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
parent string

Required. Fully qualified name of the Application to create Workload in. Expected format: projects/{project}/locations/{location}/applications/{application}. Please see Google\Cloud\AppHub\V1\AppHubClient::applicationName() for help formatting this field.

workload Google\Cloud\AppHub\V1\Workload

Required. The resource being created.

workloadId string

Required. The Workload identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Returns
Type Description
Google\Cloud\AppHub\V1\CreateWorkloadRequest