Google Cloud Datastream V1 Client - Class UpdateConnectionProfileRequest (1.4.2)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class UpdateConnectionProfileRequest.

Connection profile update message.

Generated from protobuf message google.cloud.datastream.v1.UpdateConnectionProfileRequest

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ update_mask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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_profile Google\Cloud\Datastream\V1\ConnectionProfile

Required. The connection profile to update.

↳ request_id string

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

↳ validate_only bool

Optional. Only validate the connection profile, but don't update any resources. The default is false.

↳ force bool

Optional. Update the connection profile without validating it.

getUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getConnectionProfile

Required. The connection profile to update.

Returns
TypeDescription
Google\Cloud\Datastream\V1\ConnectionProfile|null

hasConnectionProfile

clearConnectionProfile

setConnectionProfile

Required. The connection profile to update.

Parameter
NameDescription
var Google\Cloud\Datastream\V1\ConnectionProfile
Returns
TypeDescription
$this

getRequestId

Optional. A 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
TypeDescription
string

setRequestId

Optional. A 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
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

Optional. Only validate the connection profile, but don't update any resources. The default is false.

Returns
TypeDescription
bool

setValidateOnly

Optional. Only validate the connection profile, but don't update any resources. The default is false.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getForce

Optional. Update the connection profile without validating it.

Returns
TypeDescription
bool

setForce

Optional. Update the connection profile without validating it.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
connectionProfile Google\Cloud\Datastream\V1\ConnectionProfile

Required. The connection profile to update.

updateMask Google\Protobuf\FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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
TypeDescription
Google\Cloud\Datastream\V1\UpdateConnectionProfileRequest