Artifact Registry API . projects . locations . repositories . packages . versions

Instance Methods

delete(name, force=None, x__xgafv=None)

Deletes a version and all of its content. The returned operation will

get(name, view=None, x__xgafv=None)

Gets a version

list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)

Lists versions.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

delete(name, force=None, x__xgafv=None)
Deletes a version and all of its content. The returned operation will
complete once the version has been deleted.

Args:
  name: string, The name of the version to delete. (required)
  force: boolean, By default, a version that is tagged may not be deleted. If force=true, the
version and any tags pointing to the version are deleted.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a
      # network API call.
    "metadata": { # Service-specific metadata associated with the operation.  It typically
        # contains progress information and common metadata such as create time.
        # Some services might not provide such metadata.  Any method that returns a
        # long-running operation should document the metadata type, if any.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "response": { # 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 standard
        # `Get`/`Create`/`Update`, the response should be the resource.  For other
        # methods, the response should have the type `XxxResponse`, where `Xxx`
        # is the original method name.  For example, if the original method name
        # is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # different programming environments, including REST APIs and RPC APIs. It is
        # used by [gRPC](https://github.com/grpc). Each `Status` message contains
        # three pieces of data: error code, error message, and error details.
        #
        # You can find out more about this error model and how to work with it in the
        # [API Design Guide](https://cloud.google.com/apis/design/errors).
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "message": "A String", # A developer-facing error message, which should be in English. Any
          # user-facing error message should be localized and sent in the
          # google.rpc.Status.details field, or localized by the client.
    },
    "name": "A String", # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the
        # `name` should be a resource name ending with `operations/{unique_id}`.
    "done": True or False, # 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.
  }
get(name, view=None, x__xgafv=None)
Gets a version

Args:
  name: string, The name of the version to retrieve. (required)
  view: string, The view that should be returned in the response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The body of a version resource. A version resource represents a
      # collection of components, such as files and other data. This may correspond
      # to a version in many package management schemes.
    "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that
        # reference this version.
      { # Tags point to a version and represent an alternative name that can be used
            # to access the version.
          "version": "A String", # The name of the version the tag refers to, for example:
              # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811"
          "name": "A String", # The name of the tag, for example:
              # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1".
        },
    ],
    "name": "A String", # The name of the version, for example:
        # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1".
    "description": "A String", # Optional. Description of the version, as specified in its metadata.
    "createTime": "A String", # The time when the version was created.
    "updateTime": "A String", # The time when the version was last updated.
  }
list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)
Lists versions.

Args:
  parent: string, The name of the parent resource whose versions will be listed. (required)
  pageToken: string, The next_page_token value returned from a previous list request, if any.
  pageSize: integer, The maximum number of versions to return.
  view: string, The view that should be returned in the response.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from listing versions.
    "nextPageToken": "A String", # The token to retrieve the next page of versions, or empty if there are no
        # more versions to return.
    "versions": [ # The versions returned.
      { # The body of a version resource. A version resource represents a
          # collection of components, such as files and other data. This may correspond
          # to a version in many package management schemes.
        "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that
            # reference this version.
          { # Tags point to a version and represent an alternative name that can be used
                # to access the version.
              "version": "A String", # The name of the version the tag refers to, for example:
                  # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811"
              "name": "A String", # The name of the tag, for example:
                  # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1".
            },
        ],
        "name": "A String", # The name of the version, for example:
            # "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1".
        "description": "A String", # Optional. Description of the version, as specified in its metadata.
        "createTime": "A String", # The time when the version was created.
        "updateTime": "A String", # The time when the version was last updated.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.