AddVersion

Adds new version based on a previous one.

TypeScript

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

const AddVersionRequest = cloudApi.lockbox.secret_service.AddVersionRequest;
const Version = cloudApi.certificatemanager.certificate.Version;

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

  const operation = await client.addVersion(
    AddVersionRequest.fromPartial({
      secretId: "secretId",
      // description: "description",
      // payloadEntries: [{
      // key: "key",
      // textValue: "textValue",
      // binaryValue: Buffer.from([])
      // }],
      // baseVersionId: "baseVersionId"
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.lockbox.v1.secret_service_pb2 import AddVersionMetadata
from yandex.cloud.lockbox.v1.secret_service_pb2 import AddVersionRequest
from yandex.cloud.lockbox.v1.secret_service_pb2 import PayloadEntryChange
from yandex.cloud.lockbox.v1.secret_service_pb2_grpc import SecretServiceStub
from yandex.cloud.certificatemanager.v1.certificate_pb2 import Version

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SecretServiceStub)
operation = service.AddVersion(
    AddVersionRequest(
        secret_id="secretId",
        # description = "description",
        # payload_entries = [PayloadEntryChange(
        # key = "key",
        # text_value = "textValue",
        # binary_value = b''
        # )],
        # base_version_id = "baseVersionId"
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Version,
    meta_type=AddVersionMetadata,
)
print(operation_result)

AddVersionRequest

secretId : string

ID of the secret.

description : string

Description of the version.

payloadEntries : PayloadEntryChange

Describe how payload entries of the base version change in the added version.

baseVersionId : string

Optional base version id. Defaults to the current version if not specified

PayloadEntryChange

key : string

Non-confidential key of the entry.

One of value

Confidential value of the entry.

• textValue : string

  Use the field to set a text value.

• binaryValue : bytes

  Use the field to set a binary value.

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.

---