Contact UsGet started

Cloud Logging Service, gRPC: SinkService.Update

Written by
Updated at December 17, 2024

Updates the specified sink.

gRPC request

rpc Update (UpdateSinkRequest) returns (operation.Operation)

UpdateSinkRequest

{
  "sink_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "service_account_id": "string",
  // Includes only one of the fields `yds`, `s3`
  "yds": {
    "stream_name": "string"
  },
  "s3": {
    "bucket": "string",
    "prefix": "string"
  }
  // end of the list of possible fields
}

Field

Description

sink_id

string

Required field. ID of the sink to update.

To get a sink ID make a SinkService.List request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the function should be updated.

name

string

New name of the sink.
The name must be unique within the folder.

description

string

New Description of the sink.

labels

object (map<string, string>)

New sink labels as key:value pairs.

service_account_id

string

new service account to use for logs writing to the sink.

yds

Yds

Yandex data stream

Includes only one of the fields yds, s3.

New logs destination

s3

S3

Object storage

Includes only one of the fields yds, s3.

New logs destination

Yds

Field

Description

stream_name

string

Fully qualified name of data stream

S3

Field

Description

bucket

string

Object storage bucket

prefix

string

Prefix to use for saved log object names

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "sink_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "cloud_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "service_account_id": "string",
    // Includes only one of the fields `yds`, `s3`
    "yds": {
      "stream_name": "string"
    },
    "s3": {
      "bucket": "string",
      "prefix": "string"
    }
    // end of the list of possible fields
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdateSinkMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Sink

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdateSinkMetadata

Field

Description

sink_id

string

ID of the sink being updated.

Sink

Field

Description

id

string

Sink ID.

folder_id

string

Sink folder ID.

cloud_id

string

Sink cloud ID.

created_at

google.protobuf.Timestamp

Sink creation time.

name

string

Sink name.

description

string

Sink description.

labels

object (map<string, string>)

Sink labels.

service_account_id

string

Logs will be written to the sink on behalf of this service account

yds

Yds

Yandex data stream

Includes only one of the fields yds, s3.

Logs destination

s3

S3

Object storage

Includes only one of the fields yds, s3.

Logs destination

Yds

Field

Description

stream_name

string

Fully qualified name of data stream

S3

Field

Description

bucket

string

Object storage bucket

prefix

string

Prefix to use for saved log object names
Previous
Create
Next
Delete