Google Cloud Config V1 Client - Class UpdateDeploymentGroupRequest (1.8.0)

1.8.0 (latest) 1.7.2 1.6.1 1.5.0 1.4.1 1.3.0 1.2.1 1.1.0 1.0.1 0.5.2 0.2.0 0.1.3

Reference documentation and code samples for the Google Cloud Config V1 Client class UpdateDeploymentGroupRequest.

A request message for updating a deployment group

Generated from protobuf message google.cloud.config.v1.UpdateDeploymentGroupRequest

Namespace

Google \ Cloud \ Config \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ update_mask	Google\Protobuf\FieldMask Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
↳ deployment_group	DeploymentGroup Required. DeploymentGroup to update. The deployment group's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}
↳ 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).

getUpdateMask

Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update.

The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

getDeploymentGroup

Required. DeploymentGroup to update.

The deployment group's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}

Returns
Type	Description
DeploymentGroup|null

hasDeploymentGroup

clearDeploymentGroup

setDeploymentGroup

Required. DeploymentGroup to update.

The deployment group's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}

Parameter
Name	Description
var	DeploymentGroup

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
deploymentGroup	DeploymentGroup Required. DeploymentGroup to update. The deployment group's name field is used to identify the resource to be updated. Format: projects/{project}/locations/{location}/deploymentGroups/{deployment_group_id}
updateMask	Google\Protobuf\FieldMask Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

Returns
Type	Description
UpdateDeploymentGroupRequest