- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates a sink. This method replaces the values of the destination
and filter
fields of the existing sink with the corresponding values from the new sink.
The updated sink might also have a new writerIdentity
; see the uniqueWriterIdentity
field.
HTTP request
PUT https://logging.googleapis.com/v2/{sinkName=folders/*/sinks/*}
The URL uses gRPC Transcoding syntax.
Path parameters
sinkName
string
Required. The full resource name of the sink to update, including the parent resource and the sink identifier:
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
For example:
"projects/my-project/sinks/my-sink"
Authorization requires the following IAM
permission on the specified resource sinkName
:
-
logging.sinks.update
Query parameters
uniqueWriterIdentity
boolean
Optional. See sinks.create
for a description of this field. When updating a sink, the effect of this field on the value of writerIdentity
in the updated sink depends on both the old and new values of this field:
- If the old and new values of this field are both false or both true, then there is no change to the sink's
writerIdentity. - If the old value is false and the new value is true, then
writerIdentityis changed to a service agent owned by Cloud Logging. - It is an error if the old value is true and the new value is set to false or defaulted to false.
customWriterIdentity
string
Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email
. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated.
updateMask
string (
FieldMask
format)
Optional. Field mask that specifies the fields in sink
that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name
and output only fields cannot be updated.
An empty updateMask
is temporarily treated as using the following mask for backwards compatibility purposes:
destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an empty updateMask
will be an error.
For a detailed FieldMask
definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
For example: updateMask=filter
This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo"
.
Request body
The request body contains an instance of LogSink
.
Response body
If successful, the response body contains an instance of LogSink
.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/logging.admin -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
