Google Cloud Datastream V1 Client - Class UpdateStreamRequest (2.0.0-RC1)

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

Request message for updating a stream.

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

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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 stream 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.

↳ stream Google\Cloud\Datastream\V1\Stream

Required. The stream resource 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 stream with the changes, without actually updating it. The default is false.

↳ force bool

Optional. Update the stream without validating it.

getUpdateMask

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

getStream

Required. The stream resource to update.

Returns
Type Description
Google\Cloud\Datastream\V1\Stream|null

hasStream

clearStream

setStream

Required. The stream resource to update.

Parameter
Name Description
var Google\Cloud\Datastream\V1\Stream
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. Only validate the stream with the changes, without actually updating it. The default is false.

Returns
Type Description
bool

setValidateOnly

Optional. Only validate the stream with the changes, without actually updating it. The default is false.

Parameter
Name Description
var bool
Returns
Type Description
$this

getForce

Optional. Update the stream without validating it.

Returns
Type Description
bool

setForce

Optional. Update the stream without validating it.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
stream Google\Cloud\Datastream\V1\Stream

Required. The stream resource to update.

updateMask Google\Protobuf\FieldMask

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