Update

Updates the specified snapshot schedule.

The schedule is updated only after all snapshot creations and deletions triggered by the schedule are completed.

TypeScript

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

const SnapshotSchedule = cloudApi.compute.snapshot_schedule.SnapshotSchedule;
const UpdateSnapshotScheduleRequest =
  cloudApi.compute.snapshot_schedule_service.UpdateSnapshotScheduleRequest;

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

  const operation = await client.update(
    UpdateSnapshotScheduleRequest.fromPartial({
      // snapshotScheduleId: "snapshotScheduleId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // schedulePolicy: {
      // startAt: {
      // seconds: 0,
      // nanos: 0
      // },
      // expression: "expression"
      // },
      // retentionPeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // snapshotCount: 0,
      // snapshotSpec: {
      // description: "description",
      // labels: {"key": "labels"}
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.compute.v1.snapshot_schedule_pb2 import SchedulePolicy
from yandex.cloud.compute.v1.snapshot_schedule_pb2 import SnapshotSchedule
from yandex.cloud.compute.v1.snapshot_schedule_service_pb2_grpc import SnapshotScheduleServiceStub
from yandex.cloud.compute.v1.snapshot_schedule_pb2 import SnapshotSpec
from yandex.cloud.compute.v1.snapshot_schedule_service_pb2 import UpdateSnapshotScheduleMetadata
from yandex.cloud.compute.v1.snapshot_schedule_service_pb2 import UpdateSnapshotScheduleRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SnapshotScheduleServiceStub)
operation = service.Update(
    UpdateSnapshotScheduleRequest(
        # snapshot_schedule_id = "snapshotScheduleId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # schedule_policy = SchedulePolicy(
        # start_at = Timestamp(
        # seconds = 0,
        # nanos = 0
        # ),
        # expression = "expression"
        # ),
        # retention_period = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # snapshot_count = 0,
        # snapshot_spec = SnapshotSpec(
        # description = "description",
        # labels = {"key": "labels"}
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=SnapshotSchedule,
    meta_type=UpdateSnapshotScheduleMetadata,
)
print(operation_result)

UpdateSnapshotScheduleRequest

snapshotScheduleId : string

ID of the snapshot schedule to update.

To get the snapshot schedule ID, make a SnapshotScheduleService.List request.

updateMask : google.protobuf.FieldMask

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

name : string

New name for the snapshot schedule.

The name must be unique within the folder.

description : string

New description of the snapshot schedule.

labels : string

Snapshot schedule labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:

1. Get the current set of labels with a SnapshotScheduleService.Get request.
2. Add or remove a label in this set.
3. Send the new set in this field.

schedulePolicy : SchedulePolicy

New frequency settings of the snapshot schedule.

One of retentionPolicy

New retention policy of the snapshot schedule.

• retentionPeriod : google.protobuf.Duration

  Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is

  automatically deleted.

• snapshotCount : int64

  Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this

  number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted after the sixth one is created, the second is deleted after the seventh one is created, and so on.

snapshotSpec : SnapshotSpec

New attributes of snapshots created by the snapshot schedule.

SchedulePolicy

A resource for frequency settings of a snapshot schedule.

startAt : google.protobuf.Timestamp

Timestamp for creating the first snapshot.

expression : string

Cron expression for the snapshot schedule (UTC+0).

The expression must consist of five fields (Minutes Hours Day-of-month Month Day-of-week) or be one of nonstandard predefined expressions (e.g. @hourly). For details about the format, see documentation

SnapshotSpec

A resource for attributes of snapshots created by the snapshot schedule.

description : string

Description of the created snapshot.

labels : string

Snapshot labels as key:value pairs.

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.

---