Contact UsGet started

Container Registry API, gRPC: LifecyclePolicyService.DryRun

Written by
Updated at November 26, 2024

Creates a request of a dry run of the lifecycle policy.

gRPC request

rpc DryRun (DryRunLifecyclePolicyRequest) returns (operation.Operation)

DryRunLifecyclePolicyRequest

{
  "lifecycle_policy_id": "string"
}

Field

Description

lifecycle_policy_id

string

Required field. ID of the lifecycle policy.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "dry_run_lifecycle_policy_result_id": "string",
    "lifecycle_policy_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "dry_run_lifecycle_policy_result_id": "string",
    "lifecycle_policy_id": "string",
    "run_at": "google.protobuf.Timestamp",
    "affected_images_count": "int64"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see 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

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.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

DryRunLifecyclePolicyResult

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.

Includes only one of the fields error, 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.

DryRunLifecyclePolicyMetadata

Field

Description

dry_run_lifecycle_policy_result_id

string

ID of the dry run result of the lifecycle policy.

lifecycle_policy_id

string

ID of the lifecycle policy.

DryRunLifecyclePolicyResult

Field

Description

dry_run_lifecycle_policy_result_id

string

ID of the dry run result of the lifecycle policy.

lifecycle_policy_id

string

ID of the lifecycle policy.

run_at

google.protobuf.Timestamp

Time of the getting result.

affected_images_count

int64

Count of affected images.
Previous
Delete
Next
GetDryRunResult