Update
Updates the specified lifecycle policy.
- TypeScript
- Python
import {
cloudApi,
decodeMessage,
serviceClients,
Session,
waitForOperation,
} from "@yandex-cloud/nodejs-sdk";
const LifecyclePolicy =
cloudApi.containerregistry.lifecycle_policy.LifecyclePolicy;
const LifecyclePolicy_Status =
cloudApi.containerregistry.lifecycle_policy.LifecyclePolicy_Status;
const UpdateLifecyclePolicyRequest =
cloudApi.containerregistry.lifecycle_policy_service
.UpdateLifecyclePolicyRequest;
(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.LifecyclePolicyServiceClient);
const operation = await client.update(
UpdateLifecyclePolicyRequest.fromPartial({
lifecyclePolicyId: "lifecyclePolicyId",
// updateMask: {
// paths: ["paths"]
// },
// name: "name",
// description: "description",
status: LifecyclePolicy_Status.ACTIVE,
// rules: [{
// description: "description",
// expirePeriod: {
// seconds: 0,
// nanos: 0
// },
// tagRegexp: "tagRegexp",
// untagged: true,
// retainedTop: 0
// }]
})
);
const finishedOp = await waitForOperation(operation, session);
if (finishedOp.response) {
const result = decodeMessage<typeof LifecyclePolicy>(finishedOp.response);
console.log(result);
}
})();
import os
import grpc
import yandexcloud
from yandex.cloud.containerregistry.v1.lifecycle_policy_pb2 import LifecyclePolicy
from yandex.cloud.containerregistry.v1.lifecycle_policy_service_pb2_grpc import (
LifecyclePolicyServiceStub,
)
from yandex.cloud.containerregistry.v1.lifecycle_policy_pb2 import LifecycleRule
from yandex.cloud.containerregistry.v1.lifecycle_policy_service_pb2 import (
UpdateLifecyclePolicyMetadata,
)
from yandex.cloud.containerregistry.v1.lifecycle_policy_service_pb2 import (
UpdateLifecyclePolicyRequest,
)
token = os.getenv("YC_OAUTH_TOKEN")
sdk = yandexcloud.SDK(token=token)
service = sdk.client(LifecyclePolicyServiceStub)
operation = service.Update(
UpdateLifecyclePolicyRequest(
lifecycle_policy_id="lifecyclePolicyId",
# update_mask = FieldMask.FromJsonString("field1,field2"),
# name = "name",
# description = "description",
status=LifecyclePolicy.Status.ACTIVE,
# rules = [LifecycleRule(
# description = "description",
# expire_period = Duration(
# seconds = 0,
# nanos = 0
# ),
# tag_regexp = "tagRegexp",
# untagged = true,
# retained_top = 0
# )]
)
)
operation_result = sdk.wait_operation_and_get_result(
operation,
response_type=LifecyclePolicy,
meta_type=UpdateLifecyclePolicyMetadata,
)
print(operation_result)
UpdateLifecyclePolicyRequest
lifecyclePolicyId
: string
ID of the lifecycle policy.
updateMask
: google.protobuf.FieldMask
Field mask that specifies which fields of the lifecycle policy resource are going to be updated.
name
: string
Name of lifecycle policy.
description
: string
Description of lifecycle policy.
status
: LifecyclePolicy.Status
Status of the lifecycle policy.
rules
: LifecycleRule
The rules of the lifecycle policy.
LifecycleRule
description
: string
Description of the lifecycle policy rule.
expirePeriod
: google.protobuf.Duration
Period of time for automatic deletion. Period must be a multiple of 24 hours.
tagRegexp
: string
Tag for specifying a filter in the form of a regular expression.
untagged
: bool
Tag for applying the rule to Docker images without tags.
retainedTop
: int64
Number of Docker images (falling under the specified filter by tags) that must be left, even if the expire_period has already expired.
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.