Update

Updates the specified log group.

TypeScript

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

const LogGroup = cloudApi.logging.log_group.LogGroup;
const UpdateLogGroupRequest =
  cloudApi.logging.log_group_service.UpdateLogGroupRequest;

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

  const operation = await client.update(
    UpdateLogGroupRequest.fromPartial({
      logGroupId: "logGroupId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // retentionPeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // dataStream: "dataStream"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.logging.v1.log_group_pb2 import LogGroup
from yandex.cloud.logging.v1.log_group_service_pb2_grpc import LogGroupServiceStub
from yandex.cloud.logging.v1.log_group_service_pb2 import UpdateLogGroupMetadata
from yandex.cloud.logging.v1.log_group_service_pb2 import UpdateLogGroupRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(LogGroupServiceStub)
operation = service.Update(
    UpdateLogGroupRequest(
        log_group_id="logGroupId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # retention_period = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # data_stream = "dataStream"
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=LogGroup,
    meta_type=UpdateLogGroupMetadata,
)
print(operation_result)

UpdateLogGroupRequest

logGroupId : string

ID of the log group to update.

To get a log group ID make a LogGroupService.List request.

updateMask : google.protobuf.FieldMask

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

name : string

New name of the log group. The name must be unique within the folder.

description : string

New Description of the log group.

labels : string

New log group labels as key:value pairs.

retentionPeriod : google.protobuf.Duration

New log group entry retention period.

Entries will be present in group during this period. If specified, must be non-negative. Empty or zero value is treated as no limit.

dataStream : string

If specified, log records will be written to this data stream

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.

---