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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Datastream V1 Client - Class UpdateStreamRequest (2.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.4.0 (latest)](/php/docs/reference/cloud-datastream/latest/V1.UpdateStreamRequest)\n- [2.3.1](/php/docs/reference/cloud-datastream/2.3.1/V1.UpdateStreamRequest)\n- [2.2.0](/php/docs/reference/cloud-datastream/2.2.0/V1.UpdateStreamRequest)\n- [2.1.1](/php/docs/reference/cloud-datastream/2.1.1/V1.UpdateStreamRequest)\n- [2.0.1](/php/docs/reference/cloud-datastream/2.0.1/V1.UpdateStreamRequest)\n- [1.5.5](/php/docs/reference/cloud-datastream/1.5.5/V1.UpdateStreamRequest)\n- [1.4.2](/php/docs/reference/cloud-datastream/1.4.2/V1.UpdateStreamRequest)\n- [1.3.0](/php/docs/reference/cloud-datastream/1.3.0/V1.UpdateStreamRequest)\n- [1.2.1](/php/docs/reference/cloud-datastream/1.2.1/V1.UpdateStreamRequest)\n- [1.1.0](/php/docs/reference/cloud-datastream/1.1.0/V1.UpdateStreamRequest)\n- [1.0.5](/php/docs/reference/cloud-datastream/1.0.5/V1.UpdateStreamRequest) \nReference documentation and code samples for the Google Cloud Datastream V1 Client class UpdateStreamRequest.\n\nRequest message for updating a stream.\n\nGenerated from protobuf message `google.cloud.datastream.v1.UpdateStreamRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Datastream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getUpdateMask\n\nOptional. Field mask is used to specify the fields to be overwritten in the\nstream resource by the update.\n\nThe fields specified in the update_mask are relative to the resource, not\nthe full request. A field will be overwritten if it is in the mask. If the\nuser does not provide a mask then all fields will be overwritten.\n\n### hasUpdateMask\n\n### clearUpdateMask\n\n### setUpdateMask\n\nOptional. Field mask is used to specify the fields to be overwritten in the\nstream resource by the update.\n\nThe fields specified in the update_mask are relative to the resource, not\nthe full request. A field will be overwritten if it is in the mask. If the\nuser does not provide a mask then all fields will be overwritten.\n\n### getStream\n\nRequired. The stream resource to update.\n\n### hasStream\n\n### clearStream\n\n### setStream\n\nRequired. The stream resource to update.\n\n### getRequestId\n\nOptional. A request ID to identify requests. Specify a unique request ID\nso that if you must retry your request, the server will know to ignore\nthe request if it has already been completed. The server will guarantee\nthat for at least 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID,\nthe server can check if original operation with the same request ID was\nreceived, and if so, will ignore the second request. This prevents clients\nfrom accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. A request ID to identify requests. Specify a unique request ID\nso that if you must retry your request, the server will know to ignore\nthe request if it has already been completed. The server will guarantee\nthat for at least 60 minutes since the first request.\n\nFor example, consider a situation where you make an initial request and the\nrequest times out. If you make the request again with the same request ID,\nthe server can check if original operation with the same request ID was\nreceived, and if so, will ignore the second request. This prevents clients\nfrom accidentally creating duplicate commitments.\nThe request ID must be a valid UUID with the exception that zero UUID is\nnot supported (00000000-0000-0000-0000-000000000000).\n\n### getValidateOnly\n\nOptional. Only validate the stream with the changes, without actually\nupdating it. The default is false.\n\n### setValidateOnly\n\nOptional. Only validate the stream with the changes, without actually\nupdating it. The default is false.\n\n### getForce\n\nOptional. Update the stream without validating it.\n\n### setForce\n\nOptional. Update the stream without validating it.\n\n### static::build"]]
