Method: projects.traceSinks.patch

Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output-only fields (e.g. the writerIdentity).

HTTP request

PATCH https://cloudtrace.googleapis.com/v2beta1/{name=projects/*/traceSinks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The full resource name of the sink to update, including the parent resource and the sink identifier:

"projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]"

Example: "projects/12345/traceSinks/my-sink-id".

Authorization requires the following IAM permission on the specified resource name:

  • cloudtrace.tracesinks.update

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask that specifies the fields in traceSink that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. name and writerIdentity fields cannot be updated.

An empty updateMask is considered an error.

For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Example: updateMask=outputConfig.

A comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of TraceSink.

Response body

If successful, the response body contains an instance of TraceSink.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/trace.append
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.