Update
Updates the specified certificate.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const Certificate = cloudApi.certificatemanager.certificate.Certificate;
const UpdateCertificateRequest =
cloudApi.certificatemanager.certificate_service.UpdateCertificateRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.CertificateServiceClient);
const operation = await client.update(
UpdateCertificateRequest.fromPartial({
certificateId: "certificateId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
// labels: {"key": "labels"},
// certificate: "certificate",
// chain: "chain",
// privateKey: "privateKey",
// deletionProtection: true
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof Certificate>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.certificatemanager.v1.certificate_pb2 import Certificate
from yandex.cloud.certificatemanager.v1.certificate_service_pb2_grpc import CertificateServiceStub
from yandex.cloud.certificatemanager.v1.certificate_service_pb2 import UpdateCertificateMetadata
from yandex.cloud.certificatemanager.v1.certificate_service_pb2 import UpdateCertificateRequest
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(CertificateServiceStub)
operation = service.Update(
UpdateCertificateRequest(
certificate_id="certificateId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
# labels = {"key": "labels"},
# certificate = "certificate",
# chain = "chain",
# private_key = "privateKey",
# deletion_protection = true
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=Certificate,
meta_type=UpdateCertificateMetadata,
)
print(operation_result)
UpdateCertificateRequest
certificateId
: string
ID of the certificate to update. To get the ID of a certificate use a CertificateService.List request.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which attributes of the certificate are going to be updated.
name
: string
New name for the certificate.
description
: string
New description for the certificate.
labels
: string
New labels for the certificate as key:value
pairs.
certificate
: string
New PEM-encoded certificate content for the certificate. Used only for imported certificates.
chain
: string
New PEM-encoded certificate chain content for the certificate. Used only for imported certificates.
privateKey
: string
New PEM-encoded private key content for the certificate. Used only for imported certificates.
deletionProtection
: bool
Flag that protects deletion of the certificate
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.StatusThe error result of the operation in case of failure or cancellation.
response
: google.protobuf.AnyThe 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.