RescheduleMaintenance

Reschedules a planned maintenance operation.

TypeScript

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

const Cluster = cloudApi.dataproc.cluster.Cluster;
const RescheduleMaintenanceRequest =
  cloudApi.mdb.clickhouse_cluster_service.RescheduleMaintenanceRequest;
const RescheduleMaintenanceRequest_RescheduleType =
  cloudApi.mdb.clickhouse_cluster_service
    .RescheduleMaintenanceRequest_RescheduleType;

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

  const operation = await client.rescheduleMaintenance(
    RescheduleMaintenanceRequest.fromPartial({
      clusterId: "clusterId",
      rescheduleType: RescheduleMaintenanceRequest_RescheduleType.IMMEDIATE,
      // delayedUntil: {
      // seconds: 0,
      // nanos: 0
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.cluster_pb2 import Cluster
from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import RescheduleMaintenanceMetadata
from yandex.cloud.mdb.clickhouse.v1.cluster_service_pb2 import RescheduleMaintenanceRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.RescheduleMaintenance(
    RescheduleMaintenanceRequest(
        cluster_id="clusterId",
        reschedule_type=RescheduleMaintenanceRequest.RescheduleType.IMMEDIATE,
        # delayed_until = Timestamp(
        # seconds = 0,
        # nanos = 0
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Cluster,
    meta_type=RescheduleMaintenanceMetadata,
)
print(operation_result)

RescheduleMaintenanceRequest

RescheduleType

• RESCHEDULE_TYPE_UNSPECIFIED

  Time of the maintenance is not specified..

• IMMEDIATE

  Start the maintenance operation immediately.

• NEXT_AVAILABLE_WINDOW

  Start the maintenance operation within the next available maintenance window.

• SPECIFIC_TIME

  Start the maintenance operation at the specific time.

clusterId : string

ID of the OpenSearch cluster to reschedule the maintenance operation for.

To get the ID, use a ClusterService.List request.

rescheduleType : RescheduleType

The type of the reschedule request.

delayedUntil : google.protobuf.Timestamp

The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to a moment in the past if reschedule_type.IMMEDIATE reschedule type is selected.

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.

---