Create

Creates a sink in the specified folder.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const CreateSinkRequest = cloudApi.logging.sink_service.CreateSinkRequest;
const Sink = cloudApi.logging.sink.Sink;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.SinkServiceClient);

  const operation = await client.create(
    CreateSinkRequest.fromPartial({
      folderId: "folderId",
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // serviceAccountId: "serviceAccountId",
      // yds: {
      // streamName: "streamName"
      // },
      // s3: {
      // bucket: "bucket",
      // prefix: "prefix"
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Sink>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.logging.v1.sink_service_pb2 import CreateSinkMetadata
from yandex.cloud.logging.v1.sink_service_pb2 import CreateSinkRequest
from yandex.cloud.logging.v1.sink_pb2 import Sink
from yandex.cloud.logging.v1.sink_service_pb2_grpc import SinkServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SinkServiceStub)
operation = service.Create(
    CreateSinkRequest(
        folder_id="folderId",
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # service_account_id = "serviceAccountId",
        # yds = Sink.Yds(
        # stream_name = "streamName"
        # ),
        # s_3 = Sink.S3(
        # bucket = "bucket",
        # prefix = "prefix"
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Sink,
    meta_type=CreateSinkMetadata,
)
print(operation_result)

CreateSinkRequest

folderId : string

ID of the folder to create a sink in.

To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name : string

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

description : string

Description of the sink.

labels : string

Sink labels as key:value pairs.

serviceAccountId : string

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

One of sink

Logs destination

• yds : Sink.Yds

  Yandex data stream

• s3 : Sink.S3

  Object storage

Yds

streamName : string

Fully qualified name of data stream

S3

bucket : string

Object storage bucket

prefix : string

Prefix to use for saved log object names

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

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

modifiedAt : 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 : google.protobuf.Any

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.

One of result

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.

• error : google.rpc.Status

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

• response : google.protobuf.Any

  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.

---