Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the updateMask 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.
This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".
requestId
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).
validateOnly
boolean
Optional. Only validate the stream with the changes, without actually updating it. The default is false.
force
boolean
Optional. Update the stream without validating it.
[[["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-06-13 UTC."],[[["\u003cp\u003eThis page details how to update a stream's configuration using a \u003ccode\u003ePATCH\u003c/code\u003e request to the specified endpoint: \u003ccode\u003ehttps://datastream.googleapis.com/v1/{stream.name}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUpdating a stream requires specifying the \u003ccode\u003estream.name\u003c/code\u003e as a path parameter within the URL.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters such as \u003ccode\u003eupdateMask\u003c/code\u003e, \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003evalidateOnly\u003c/code\u003e, and \u003ccode\u003eforce\u003c/code\u003e can be used to control which fields are updated, ensure idempotency, validate the update, and skip validation respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires an instance of the \u003ccode\u003eStream\u003c/code\u003e resource, and a successful response returns an instance of the \u003ccode\u003eOperation\u003c/code\u003e resource.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to update a stream requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.streams.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nUse this method to update the configuration of a stream.\n\n### HTTP request\n\n`PATCH https://datastream.googleapis.com/v1/{stream.name}`\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Stream](/datastream/docs/reference/rest/v1/projects.locations.streams#Stream).\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/datastream/docs/reference/rest/v1/projects.locations.operations#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource:\n\n- `datastream.streams.update`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
