Google Cloud Developer Connect V1 Client - Class UpdateConnectionRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Developer Connect V1 Client class UpdateConnectionRequest.

Message for updating a Connection

Generated from protobuf message google.cloud.developerconnect.v1.UpdateConnectionRequest

Namespace

Google \ Cloud \ DeveloperConnect \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten in the Connection 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.
`↳ connection`	`Google\Cloud\DeveloperConnect\V1\Connection` Required. The resource being updated
`↳ 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).
`↳ allow_missing`	`bool` Optional. If set to true, and the connection is not found a new connection will be created. In this situation `update_mask` is ignored. The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).
`↳ validate_only`	`bool` Optional. If set, validate the request, but do not actually post it.

getUpdateMask

Required. Field mask is used to specify the fields to be overwritten in the Connection 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

Required. Field mask is used to specify the fields to be overwritten in the Connection resource by the update.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getConnection

Required. The resource being updated

Returns
Type	Description
`Google\Cloud\DeveloperConnect\V1\Connection\|null`

hasConnection

clearConnection

setConnection

Required. The resource being updated

Parameter
Name	Description
`var`	`Google\Cloud\DeveloperConnect\V1\Connection`

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAllowMissing

Optional. If set to true, and the connection is not found a new connection will be created. In this situation update_mask is ignored.

The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).

Returns
Type	Description
`bool`

setAllowMissing

Optional. If set to true, and the connection is not found a new connection will be created. In this situation update_mask is ignored.

The creation will succeed only if the input connection has all the necessary information (e.g a github_config with both user_oauth_token and installation_id properties).

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getValidateOnly

Optional. If set, validate the request, but do not actually post it.

Returns
Type	Description
`bool`

setValidateOnly

Optional. If set, validate the request, but do not actually post it.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`connection`	`Google\Cloud\DeveloperConnect\V1\Connection` Required. The resource being updated
`updateMask`	`Google\Protobuf\FieldMask` Required. Field mask is used to specify the fields to be overwritten in the Connection 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\Cloud\DeveloperConnect\V1\UpdateConnectionRequest`