Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Container Registry API, gRPC: LifecyclePolicyService.ListDryRunResultAffectedImages

Written by
Updated at November 26, 2024

Retrieves the list of the affected images.

gRPC request

rpc ListDryRunResultAffectedImages (ListDryRunLifecyclePolicyResultAffectedImagesRequest) returns (ListDryRunLifecyclePolicyResultAffectedImagesResponse)

ListDryRunLifecyclePolicyResultAffectedImagesRequest

{
  "dry_run_lifecycle_policy_result_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "filter": "string",
  "order_by": "string"
}

Field

Description

dry_run_lifecycle_policy_result_id

string

Required field. ID of the dry run result of the lifecycle policy

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListDryRunLifecyclePolicyResultAffectedImagesResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListDryRunLifecyclePolicyResultAffectedImagesResponse.next_page_token returned by a previous list request.

filter

string

A filter expression that filters affected images listed in the response.

The expression must specify:

  1. The field name. Currently you can use filtering only on LifecyclePolicy.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

order_by

string

Sorting the list by LifecyclePolicy.name and LifecyclePolicy.created_at fields.
The default sorting order is ascending.

ListDryRunLifecyclePolicyResultAffectedImagesResponse

{
  "affected_images": [
    {
      "id": "string",
      "name": "string",
      "digest": "string",
      "compressed_size": "int64",
      "config": {
        "id": "string",
        "digest": "string",
        "size": "int64",
        "urls": [
          "string"
        ]
      },
      "layers": [
        {
          "id": "string",
          "digest": "string",
          "size": "int64",
          "urls": [
            "string"
          ]
        }
      ],
      "tags": [
        "string"
      ],
      "created_at": "google.protobuf.Timestamp"
    }
  ],
  "next_page_token": "string"
}

Field

Description

affected_images[]

Image

List of affected images.

next_page_token

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListDryRunLifecyclePolicyResultAffectedImagesRequest.page_size, use next_page_token as the value
for the ListDryRunLifecyclePolicyResultAffectedImagesRequest.page_token parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

Image

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

A Blob resource.

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

List of blob urls.
Previous
ListDryRunResults
Next
Overview