Update

Updates the specified scan policy.

TypeScript

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

const ScanPolicy = cloudApi.containerregistry.scan_policy.ScanPolicy;
const UpdateScanPolicyRequest =
  cloudApi.containerregistry.scan_policy_service.UpdateScanPolicyRequest;

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

  const operation = await client.update(
    UpdateScanPolicyRequest.fromPartial({
      scanPolicyId: "scanPolicyId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // rules: {
      // pushRule: {
      // repositoryPrefixes: ["repositoryPrefixes"],
      // disabled: true
      // },
      // scheduleRules: [{
      // repositoryPrefixes: ["repositoryPrefixes"],
      // rescanPeriod: {
      // seconds: 0,
      // nanos: 0
      // },
      // disabled: true
      // }]
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.containerregistry.v1.scan_policy_pb2 import PushRule
from yandex.cloud.containerregistry.v1.scan_policy_pb2 import ScanPolicy
from yandex.cloud.containerregistry.v1.scan_policy_service_pb2_grpc import ScanPolicyServiceStub
from yandex.cloud.containerregistry.v1.scan_policy_pb2 import ScanRules
from yandex.cloud.containerregistry.v1.scan_policy_pb2 import ScheduledRule
from yandex.cloud.containerregistry.v1.scan_policy_service_pb2 import UpdateScanPolicyMetadata
from yandex.cloud.containerregistry.v1.scan_policy_service_pb2 import UpdateScanPolicyRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ScanPolicyServiceStub)
operation = service.Update(
    UpdateScanPolicyRequest(
        scan_policy_id="scanPolicyId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # rules = ScanRules(
        # push_rule = PushRule(
        # repository_prefixes = ["repositoryPrefixes"],
        # disabled = true
        # ),
        # schedule_rules = [ScheduledRule(
        # repository_prefixes = ["repositoryPrefixes"],
        # rescan_period = Duration(
        # seconds = 0,
        # nanos = 0
        # ),
        # disabled = true
        # )]
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=ScanPolicy,
    meta_type=UpdateScanPolicyMetadata,
)
print(operation_result)

UpdateScanPolicyRequest

scanPolicyId : string

ID of the scan policy.

updateMask : google.protobuf.FieldMask

Field mask that specifies which fields of the scan policy resource are going to be updated.

name : string

Name of the scan policy.

description : string

Description of the scan policy.

rules : ScanRules

Rules of the scan policy.

ScanRules

pushRule : PushRule

Description of on-push scan rule.

scheduleRules : ScheduledRule

Description of time based rescan rule.

PushRule

repositoryPrefixes : string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

disabled : bool

Turns off scan rule.

ScheduledRule

repositoryPrefixes : string

List of repositories that are scanned with rule. Child repositories are included into parent node. "*" - means all repositories in registry

rescanPeriod : google.protobuf.Duration

Period of time since last scan to trigger automatic rescan.

disabled : bool

Turns off scan rule.

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.

---