Get started
Yandex Container Registry

LifecyclePolicyService

Call Description
Get
List
Create
Update
Delete
DryRun
GetDryRunResult
ListDryRunResults
ListDryRunResultAffectedImages

Calls LifecyclePolicyService

Get

rpc Get (GetLifecyclePolicyRequest) returns (LifecyclePolicy)

GetLifecyclePolicyRequest

Field Description
lifecycle_policy_id string
Required. false The maximum string length in characters is 50.

LifecyclePolicy

Field Description
id string
name string
repository_id string
description string
status enum Status
    created_at google.protobuf.Timestamp
    rules[] LifecycleRule

    LifecycleRule

    Field Description
    description string
    The maximum string length in characters is 256.
    expire_period google.protobuf.Duration
    The minimum value is 24h.
    tag_regexp string
    The maximum string length in characters is 256.
    untagged bool
    retained_top int64
    The minimum value is 0.

    List

    rpc List (ListLifecyclePoliciesRequest) returns (ListLifecyclePoliciesResponse)

    ListLifecyclePoliciesRequest

    Field Description
    id oneof: registry_id or repository_id
      registry_id string
    The maximum string length in characters is 50.
      repository_id string
    The maximum string length in characters is 50.
    page_size int64
    Acceptable values are 0 to 1000, inclusive.
    page_token string
    The maximum string length in characters is 100.
    filter string
    The maximum string length in characters is 1000.
    order_by string
    The maximum string length in characters is 100.

    ListLifecyclePoliciesResponse

    Field Description
    lifecycle_policies[] LifecyclePolicy
    next_page_token string

    LifecyclePolicy

    Field Description
    id string
    name string
    repository_id string
    description string
    status enum Status
      created_at google.protobuf.Timestamp
      rules[] LifecycleRule

      LifecycleRule

      Field Description
      description string
      The maximum string length in characters is 256.
      expire_period google.protobuf.Duration
      The minimum value is 24h.
      tag_regexp string
      The maximum string length in characters is 256.
      untagged bool
      retained_top int64
      The minimum value is 0.

      Create

      rpc Create (CreateLifecyclePolicyRequest) returns (operation.Operation)

      Metadata and response of Operation:

          Operation.metadata:CreateLifecyclePolicyMetadata

          Operation.response:LifecyclePolicy

      CreateLifecyclePolicyRequest

      Field Description
      repository_id string
      Required. false The maximum string length in characters is 50.
      name string
      Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
      description string
      The maximum string length in characters is 256.
      status LifecyclePolicy.Status
      Required. false
      rules[] LifecycleRule

      LifecycleRule

      Field Description
      description string
      The maximum string length in characters is 256.
      expire_period google.protobuf.Duration
      The minimum value is 24h.
      tag_regexp string
      The maximum string length in characters is 256.
      untagged bool
      retained_top int64
      The minimum value is 0.

      Operation

      Field Description
      id string
      ID of the operation.
      description string
      Description of the operation. 0-256 characters long.
      created_at google.protobuf.Timestamp
      Creation timestamp.
      created_by string
      ID of the user or service account who initiated the operation.
      modified_at 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<CreateLifecyclePolicyMetadata>
      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.
      result oneof: error or response
      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<LifecyclePolicy>
      if operation finished successfully.

      CreateLifecyclePolicyMetadata

      Field Description
      lifecycle_policy_id string

      LifecyclePolicy

      Field Description
      id string
      name string
      repository_id string
      description string
      status enum Status
        created_at google.protobuf.Timestamp
        rules[] LifecycleRule

        Update

        rpc Update (UpdateLifecyclePolicyRequest) returns (operation.Operation)

        Metadata and response of Operation:

            Operation.metadata:UpdateLifecyclePolicyMetadata

            Operation.response:LifecyclePolicy

        UpdateLifecyclePolicyRequest

        Field Description
        lifecycle_policy_id string
        Required. false The maximum string length in characters is 50.
        update_mask google.protobuf.FieldMask
        name string
        Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9].
        description string
        The maximum string length in characters is 256.
        status LifecyclePolicy.Status
        Required. false
        rules[] LifecycleRule

        LifecycleRule

        Field Description
        description string
        The maximum string length in characters is 256.
        expire_period google.protobuf.Duration
        The minimum value is 24h.
        tag_regexp string
        The maximum string length in characters is 256.
        untagged bool
        retained_top int64
        The minimum value is 0.

        Operation

        Field Description
        id string
        ID of the operation.
        description string
        Description of the operation. 0-256 characters long.
        created_at google.protobuf.Timestamp
        Creation timestamp.
        created_by string
        ID of the user or service account who initiated the operation.
        modified_at 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<UpdateLifecyclePolicyMetadata>
        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.
        result oneof: error or response
        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<LifecyclePolicy>
        if operation finished successfully.

        UpdateLifecyclePolicyMetadata

        Field Description
        lifecycle_policy_id string

        LifecyclePolicy

        Field Description
        id string
        name string
        repository_id string
        description string
        status enum Status
          created_at google.protobuf.Timestamp
          rules[] LifecycleRule

          Delete

          rpc Delete (DeleteLifecyclePolicyRequest) returns (operation.Operation)

          Metadata and response of Operation:

              Operation.metadata:DeleteLifecyclePolicyMetadata

              Operation.response:google.protobuf.Empty

          DeleteLifecyclePolicyRequest

          Field Description
          lifecycle_policy_id string
          Required. false The maximum string length in characters is 50.

          Operation

          Field Description
          id string
          ID of the operation.
          description string
          Description of the operation. 0-256 characters long.
          created_at google.protobuf.Timestamp
          Creation timestamp.
          created_by string
          ID of the user or service account who initiated the operation.
          modified_at 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<DeleteLifecyclePolicyMetadata>
          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.
          result oneof: error or response
          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<google.protobuf.Empty>
          if operation finished successfully.

          DeleteLifecyclePolicyMetadata

          Field Description
          lifecycle_policy_id string

          DryRun

          rpc DryRun (DryRunLifecyclePolicyRequest) returns (operation.Operation)

          Metadata and response of Operation:

              Operation.metadata:DryRunLifecyclePolicyMetadata

              Operation.response:DryRunLifecyclePolicyResult

          DryRunLifecyclePolicyRequest

          Field Description
          lifecycle_policy_id string
          Required. false The maximum string length in characters is 50.

          Operation

          Field Description
          id string
          ID of the operation.
          description string
          Description of the operation. 0-256 characters long.
          created_at google.protobuf.Timestamp
          Creation timestamp.
          created_by string
          ID of the user or service account who initiated the operation.
          modified_at 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<DryRunLifecyclePolicyMetadata>
          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.
          result oneof: error or response
          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<DryRunLifecyclePolicyResult>
          if operation finished successfully.

          DryRunLifecyclePolicyMetadata

          Field Description
          dry_run_lifecycle_policy_result_id string
          lifecycle_policy_id string

          DryRunLifecyclePolicyResult

          Field Description
          dry_run_lifecycle_policy_result_id string
          lifecycle_policy_id string
          run_at google.protobuf.Timestamp
          affected_images_count int64

          GetDryRunResult

          rpc GetDryRunResult (GetDryRunLifecyclePolicyResultRequest) returns (DryRunLifecyclePolicyResult)

          GetDryRunLifecyclePolicyResultRequest

          Field Description
          dry_run_lifecycle_policy_result_id string
          Required. false The maximum string length in characters is 50.

          DryRunLifecyclePolicyResult

          Field Description
          dry_run_lifecycle_policy_result_id string
          lifecycle_policy_id string
          run_at google.protobuf.Timestamp
          affected_images_count int64

          ListDryRunResults

          rpc ListDryRunResults (ListDryRunLifecyclePolicyResultsRequest) returns (ListDryRunLifecyclePolicyResultsResponse)

          ListDryRunLifecyclePolicyResultsRequest

          Field Description
          lifecycle_policy_id string
          Required. false The maximum string length in characters is 50.
          page_size int64
          Acceptable values are 0 to 1000, inclusive.
          page_token string
          The maximum string length in characters is 100.
          filter string
          The maximum string length in characters is 1000.
          order_by string
          The maximum string length in characters is 100.

          ListDryRunLifecyclePolicyResultsResponse

          Field Description
          dry_run_lifecycle_policy_results[] DryRunLifecyclePolicyResult
          next_page_token string

          DryRunLifecyclePolicyResult

          Field Description
          dry_run_lifecycle_policy_result_id string
          lifecycle_policy_id string
          run_at google.protobuf.Timestamp
          affected_images_count int64

          ListDryRunResultAffectedImages

          rpc ListDryRunResultAffectedImages (ListDryRunLifecyclePolicyResultAffectedImagesRequest) returns (ListDryRunLifecyclePolicyResultAffectedImagesResponse)

          ListDryRunLifecyclePolicyResultAffectedImagesRequest

          Field Description
          dry_run_lifecycle_policy_result_id string
          Required. false The maximum string length in characters is 50.
          page_size int64
          Acceptable values are 0 to 1000, inclusive.
          page_token string
          The maximum string length in characters is 100.
          filter string
          The maximum string length in characters is 1000.
          order_by string
          The maximum string length in characters is 100.

          ListDryRunLifecyclePolicyResultAffectedImagesResponse

          Field Description
          affected_images[] Image
          next_page_token string

          Image

          Field Description
          id string
          Output only. ID of the Docker image.
          name string
          Name of the Docker image. The name is unique within the registry.
          digest string
          Content-addressable identifier of the Docker image.
          compressed_size int64
          Compressed size of the Docker image, specified in bytes.
          config Blob
          Configuration of the Docker image.
          layers[] Blob
          Layers of the Docker image.
          tags[] string
          Tags of the Docker image.
          Each tag is unique within the repository.
          created_at google.protobuf.Timestamp
          Output only. Creation timestamp in RFC3339 text format.

          Blob

          Field Description
          id string
          Output only. ID of the blob.
          digest string
          Content-addressable identifier of the blob.
          size int64
          Size of the blob, specified in bytes.
          urls[] string