As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

ArtifactRegistry

class google.cloud.artifactregistry_v1beta2.services.artifact_registry.ArtifactRegistryAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.artifactregistry_v1beta2.services.artifact_registry.transports.base.ArtifactRegistryTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The Artifact Registry API service.

Artifact Registry is an artifact management system for storing artifacts from different package management systems.

The resources managed by this API are:

  • Repositories, which group packages and their data.

  • Packages, which group versions and their tags.

  • Versions, which are specific forms of a package.

  • Tags, which represent alternative names for versions.

  • Files, which contain content and are optionally associated with a Package or Version.

Instantiates the artifact registry client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ArtifactRegistryTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async create_repository(request: Optional[google.cloud.artifactregistry_v1beta2.types.repository.CreateRepositoryRequest] = None, *, parent: Optional[str] = None, repository: Optional[google.cloud.artifactregistry_v1beta2.types.repository.Repository] = None, repository_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.CreateRepositoryRequest) – The request object. The request to create a new repository.

  • parent (str) –

    The name of the parent resource where the repository will be created.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • repository (google.cloud.artifactregistry_v1beta2.types.Repository) – The repository to be created. This corresponds to the repository field on the request instance; if request is provided, this should not be set.

  • repository_id (str) –

    The repository id to use for this repository.

    This corresponds to the repository_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.artifactregistry_v1beta2.types.Repository A Repository for storing artifacts with a specific format.

Return type

google.api_core.operation_async.AsyncOperation

async create_tag(request: Optional[google.cloud.artifactregistry_v1beta2.types.tag.CreateTagRequest] = None, *, parent: Optional[str] = None, tag: Optional[google.cloud.artifactregistry_v1beta2.types.tag.Tag] = None, tag_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Creates a tag.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.CreateTagRequest) – The request object. The request to create a new tag.

  • parent (str) –

    The name of the parent resource where the tag will be created.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • tag (google.cloud.artifactregistry_v1beta2.types.Tag) – The tag to be created. This corresponds to the tag field on the request instance; if request is provided, this should not be set.

  • tag_id (str) –

    The tag id to use for this repository.

    This corresponds to the tag_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

async delete_package(request: Optional[google.cloud.artifactregistry_v1beta2.types.package.DeletePackageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.DeletePackageRequest) – The request object. The request to delete a package.

  • name (str) – The name of the package to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

async delete_repository(request: Optional[google.cloud.artifactregistry_v1beta2.types.repository.DeleteRepositoryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.DeleteRepositoryRequest) – The request object. The request to delete a repository.

  • name (str) – The name of the repository to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

async delete_tag(request: Optional[google.cloud.artifactregistry_v1beta2.types.tag.DeleteTagRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a tag.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.DeleteTagRequest) – The request object. The request to delete a tag.

  • name (str) – The name of the tag to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

async delete_version(request: Optional[google.cloud.artifactregistry_v1beta2.types.version.DeleteVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.DeleteVersionRequest) – The request object. The request to delete a version.

  • name (str) – The name of the version to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation_async.AsyncOperation

static file_path(project: str, location: str, repo: str, file: str)str

Returns a fully-qualified file string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryAsyncClient

async get_file(request: Optional[google.cloud.artifactregistry_v1beta2.types.file.GetFileRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.file.File[source]

Gets a file.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.GetFileRequest) – The request object. The request to retrieve a file.

  • name (str) – The name of the file to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Files store content that is potentially associated with Packages or Versions.

Return type

google.cloud.artifactregistry_v1beta2.types.File

async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Gets the IAM policy for a given resource.

Parameters
  • request (google.iam.v1.iam_policy_pb2.GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

async get_package(request: Optional[google.cloud.artifactregistry_v1beta2.types.package.GetPackageRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.package.Package[source]

Gets a package.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.GetPackageRequest) – The request object. The request to retrieve a package.

  • name (str) – The name of the package to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Packages are named collections of versions.

Return type

google.cloud.artifactregistry_v1beta2.types.Package

async get_repository(request: Optional[google.cloud.artifactregistry_v1beta2.types.repository.GetRepositoryRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.repository.Repository[source]

Gets a repository.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.GetRepositoryRequest) – The request object. The request to retrieve a repository.

  • name (str) –

    The name of the repository to retrieve.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A Repository for storing artifacts with a specific format.

Return type

google.cloud.artifactregistry_v1beta2.types.Repository

async get_tag(request: Optional[google.cloud.artifactregistry_v1beta2.types.tag.GetTagRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Gets a tag.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.GetTagRequest) – The request object. The request to retrieve a tag.

  • name (str) – The name of the tag to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

get_transport_class()Type[google.cloud.artifactregistry_v1beta2.services.artifact_registry.transports.base.ArtifactRegistryTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async get_version(request: Optional[google.cloud.artifactregistry_v1beta2.types.version.GetVersionRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.version.Version[source]

Gets a version

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.GetVersionRequest) – The request object. The request to retrieve a version.

  • name (str) – The name of the version to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.artifactregistry_v1beta2.types.Version

async list_files(request: Optional[google.cloud.artifactregistry_v1beta2.types.file.ListFilesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesAsyncPager[source]

Lists files.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.ListFilesRequest) – The request object. The request to list files.

  • parent (str) –

    The name of the parent resource whose files will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing files. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesAsyncPager

async list_packages(request: Optional[google.cloud.artifactregistry_v1beta2.types.package.ListPackagesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesAsyncPager[source]

Lists packages.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.ListPackagesRequest) – The request object. The request to list packages.

  • parent (str) –

    The name of the parent resource whose packages will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing packages. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesAsyncPager

async list_repositories(request: Optional[google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesAsyncPager[source]

Lists repositories.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.ListRepositoriesRequest) – The request object. The request to list repositories.

  • parent (str) –

    The name of the parent resource whose repositories will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing repositories. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesAsyncPager

async list_tags(request: Optional[google.cloud.artifactregistry_v1beta2.types.tag.ListTagsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsAsyncPager[source]

Lists tags.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.ListTagsRequest) – The request object. The request to list tags.

  • parent (str) –

    The name of the parent resource whose tags will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing tags. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsAsyncPager

async list_versions(request: Optional[google.cloud.artifactregistry_v1beta2.types.version.ListVersionsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsAsyncPager[source]

Lists versions.

Parameters
  • request (google.cloud.artifactregistry_v1beta2.types.ListVersionsRequest) – The request object. The request to list versions.

  • parent (str) –

    The name of the parent resource whose versions will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing versions. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsAsyncPager

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_file_path(path: str)Dict[str, str]

Parses a file path into its component segments.

static parse_repository_path(path: str)Dict[str, str]

Parses a repository path into its component segments.

static repository_path(project: str, location: str, repository: str)str

Returns a fully-qualified repository string.

async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Updates the IAM policy for a given resource.

Parameters
  • request (google.iam.v1.iam_policy_pb2.SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]

Tests if the caller has a list of permissions on a resource.

Parameters
  • request (google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.artifactregistry_v1beta2.services.artifact_registry.transports.base.ArtifactRegistryTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

ArtifactRegistryTransport

async update_repository(request: Optional[google.cloud.artifactregistry_v1beta2.types.repository.UpdateRepositoryRequest] = None, *, repository: Optional[google.cloud.artifactregistry_v1beta2.types.repository.Repository] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.repository.Repository[source]

Updates a repository.

Parameters
Returns

A Repository for storing artifacts with a specific format.

Return type

google.cloud.artifactregistry_v1beta2.types.Repository

async update_tag(request: Optional[google.cloud.artifactregistry_v1beta2.types.tag.UpdateTagRequest] = None, *, tag: Optional[google.cloud.artifactregistry_v1beta2.types.tag.Tag] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Updates a tag.

Parameters
Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

class google.cloud.artifactregistry_v1beta2.services.artifact_registry.ArtifactRegistryClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.artifactregistry_v1beta2.services.artifact_registry.transports.base.ArtifactRegistryTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The Artifact Registry API service.

Artifact Registry is an artifact management system for storing artifacts from different package management systems.

The resources managed by this API are:

  • Repositories, which group packages and their data.

  • Packages, which group versions and their tags.

  • Versions, which are specific forms of a package.

  • Tags, which represent alternative names for versions.

  • Files, which contain content and are optionally associated with a Package or Version.

Instantiates the artifact registry client.

Parameters
  • credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

  • transport (Union[str, ArtifactRegistryTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • client_info (google.api_core.gapic_v1.client_info.ClientInfo) – The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

create_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.CreateRepositoryRequest, dict]] = None, *, parent: Optional[str] = None, repository: Optional[google.cloud.artifactregistry_v1beta2.types.repository.Repository] = None, repository_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.CreateRepositoryRequest, dict]) – The request object. The request to create a new repository.

  • parent (str) –

    The name of the parent resource where the repository will be created.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • repository (google.cloud.artifactregistry_v1beta2.types.Repository) – The repository to be created. This corresponds to the repository field on the request instance; if request is provided, this should not be set.

  • repository_id (str) –

    The repository id to use for this repository.

    This corresponds to the repository_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.artifactregistry_v1beta2.types.Repository A Repository for storing artifacts with a specific format.

Return type

google.api_core.operation.Operation

create_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.CreateTagRequest, dict]] = None, *, parent: Optional[str] = None, tag: Optional[google.cloud.artifactregistry_v1beta2.types.tag.Tag] = None, tag_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Creates a tag.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.CreateTagRequest, dict]) – The request object. The request to create a new tag.

  • parent (str) –

    The name of the parent resource where the tag will be created.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • tag (google.cloud.artifactregistry_v1beta2.types.Tag) – The tag to be created. This corresponds to the tag field on the request instance; if request is provided, this should not be set.

  • tag_id (str) –

    The tag id to use for this repository.

    This corresponds to the tag_id field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

delete_package(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.DeletePackageRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.DeletePackageRequest, dict]) – The request object. The request to delete a package.

  • name (str) – The name of the package to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

delete_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.DeleteRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.DeleteRepositoryRequest, dict]) – The request object. The request to delete a repository.

  • name (str) – The name of the repository to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

delete_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.DeleteTagRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a tag.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.DeleteTagRequest, dict]) – The request object. The request to delete a tag.

  • name (str) – The name of the tag to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

delete_version(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.DeleteVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.DeleteVersionRequest, dict]) – The request object. The request to delete a version.

  • name (str) – The name of the version to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated

empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {

rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

}

The JSON representation for Empty is empty JSON object {}.

Return type

google.api_core.operation.Operation

static file_path(project: str, location: str, repo: str, file: str)str[source]

Returns a fully-qualified file string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

ArtifactRegistryClient

get_file(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.file.GetFileRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.file.File[source]

Gets a file.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.GetFileRequest, dict]) – The request object. The request to retrieve a file.

  • name (str) – The name of the file to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Files store content that is potentially associated with Packages or Versions.

Return type

google.cloud.artifactregistry_v1beta2.types.File

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Gets the IAM policy for a given resource.

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]) – The request object. Request message for GetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

get_package(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.GetPackageRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.package.Package[source]

Gets a package.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.GetPackageRequest, dict]) – The request object. The request to retrieve a package.

  • name (str) – The name of the package to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Packages are named collections of versions.

Return type

google.cloud.artifactregistry_v1beta2.types.Package

get_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.GetRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.repository.Repository[source]

Gets a repository.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.GetRepositoryRequest, dict]) – The request object. The request to retrieve a repository.

  • name (str) –

    The name of the repository to retrieve.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A Repository for storing artifacts with a specific format.

Return type

google.cloud.artifactregistry_v1beta2.types.Repository

get_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.GetTagRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Gets a tag.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.GetTagRequest, dict]) – The request object. The request to retrieve a tag.

  • name (str) – The name of the tag to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

get_version(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.GetVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.version.Version[source]

Gets a version

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.GetVersionRequest, dict]) – The request object. The request to retrieve a version.

  • name (str) – The name of the version to retrieve. This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.artifactregistry_v1beta2.types.Version

list_files(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.file.ListFilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesPager[source]

Lists files.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.ListFilesRequest, dict]) – The request object. The request to list files.

  • parent (str) –

    The name of the parent resource whose files will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing files. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesPager

list_packages(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.ListPackagesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesPager[source]

Lists packages.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.ListPackagesRequest, dict]) – The request object. The request to list packages.

  • parent (str) –

    The name of the parent resource whose packages will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing packages. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesPager

list_repositories(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesPager[source]

Lists repositories.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.ListRepositoriesRequest, dict]) – The request object. The request to list repositories.

  • parent (str) –

    The name of the parent resource whose repositories will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing repositories. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesPager

list_tags(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.ListTagsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsPager[source]

Lists tags.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.ListTagsRequest, dict]) – The request object. The request to list tags.

  • parent (str) –

    The name of the parent resource whose tags will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing tags. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsPager

list_versions(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.ListVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsPager[source]

Lists versions.

Parameters
  • request (Union[google.cloud.artifactregistry_v1beta2.types.ListVersionsRequest, dict]) – The request object. The request to list versions.

  • parent (str) –

    The name of the parent resource whose versions will be listed.

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

The response from listing versions. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsPager

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_file_path(path: str)Dict[str, str][source]

Parses a file path into its component segments.

static parse_repository_path(path: str)Dict[str, str][source]

Parses a repository path into its component segments.

static repository_path(project: str, location: str, repository: str)str[source]

Returns a fully-qualified repository string.

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.policy_pb2.Policy[source]

Updates the IAM policy for a given resource.

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]) – The request object. Request message for SetIamPolicy method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Defines an Identity and Access Management (IAM) policy. It is used to

specify access control policies for Cloud Platform resources.

A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource.

JSON Example

{
“bindings”: [
{

“role”: “roles/resourcemanager.organizationAdmin”, “members”: [ “user:mike@example.com”, “group:admins@example.com”, “domain:google.com”, “serviceAccount:my-project-id@appspot.gserviceaccount.com” ]

}, { “role”: “roles/resourcemanager.organizationViewer”, “members”: [“user:eve@example.com”], “condition”: { “title”: “expirable access”, “description”: “Does not grant access after Sep 2020”, “expression”: “request.time < timestamp(‘2020-10-01T00:00:00.000Z’)”, } }

]

}

YAML Example

bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp(‘2020-10-01T00:00:00.000Z’)

For a description of IAM and its features, see the [IAM developer’s guide](https://cloud.google.com/iam/docs).

Return type

google.iam.v1.policy_pb2.Policy

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]

Tests if the caller has a list of permissions on a resource.

Parameters
  • request (Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]) – The request object. Request message for TestIamPermissions method.

  • retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

  • timeout (float) – The timeout for this request.

  • metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for TestIamPermissions method.

Return type

google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

property transport: google.cloud.artifactregistry_v1beta2.services.artifact_registry.transports.base.ArtifactRegistryTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

ArtifactRegistryTransport

update_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.UpdateRepositoryRequest, dict]] = None, *, repository: Optional[google.cloud.artifactregistry_v1beta2.types.repository.Repository] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.repository.Repository[source]

Updates a repository.

Parameters
Returns

A Repository for storing artifacts with a specific format.

Return type

google.cloud.artifactregistry_v1beta2.types.Repository

update_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.UpdateTagRequest, dict]] = None, *, tag: Optional[google.cloud.artifactregistry_v1beta2.types.tag.Tag] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.artifactregistry_v1beta2.types.tag.Tag[source]

Updates a tag.

Parameters
Returns

Tags point to a version and represent an alternative name that can be used to access the version.

Return type

google.cloud.artifactregistry_v1beta2.types.Tag

class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesAsyncPager(method: Callable[[...], Awaitable[google.cloud.artifactregistry_v1beta2.types.file.ListFilesResponse]], request: google.cloud.artifactregistry_v1beta2.types.file.ListFilesRequest, response: google.cloud.artifactregistry_v1beta2.types.file.ListFilesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_files requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListFilesResponse object, and provides an __aiter__ method to iterate through its files field.

If there are more pages, the __aiter__ method will make additional ListFiles requests and continue to iterate through the files field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListFilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesPager(method: Callable[[...], google.cloud.artifactregistry_v1beta2.types.file.ListFilesResponse], request: google.cloud.artifactregistry_v1beta2.types.file.ListFilesRequest, response: google.cloud.artifactregistry_v1beta2.types.file.ListFilesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_files requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListFilesResponse object, and provides an __iter__ method to iterate through its files field.

If there are more pages, the __iter__ method will make additional ListFiles requests and continue to iterate through the files field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListFilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesAsyncPager(method: Callable[[...], Awaitable[google.cloud.artifactregistry_v1beta2.types.package.ListPackagesResponse]], request: google.cloud.artifactregistry_v1beta2.types.package.ListPackagesRequest, response: google.cloud.artifactregistry_v1beta2.types.package.ListPackagesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_packages requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListPackagesResponse object, and provides an __aiter__ method to iterate through its packages field.

If there are more pages, the __aiter__ method will make additional ListPackages requests and continue to iterate through the packages field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListPackagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesPager(method: Callable[[...], google.cloud.artifactregistry_v1beta2.types.package.ListPackagesResponse], request: google.cloud.artifactregistry_v1beta2.types.package.ListPackagesRequest, response: google.cloud.artifactregistry_v1beta2.types.package.ListPackagesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_packages requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListPackagesResponse object, and provides an __iter__ method to iterate through its packages field.

If there are more pages, the __iter__ method will make additional ListPackages requests and continue to iterate through the packages field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListPackagesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesAsyncPager(method: Callable[[...], Awaitable[google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesResponse]], request: google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesRequest, response: google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_repositories requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListRepositoriesResponse object, and provides an __aiter__ method to iterate through its repositories field.

If there are more pages, the __aiter__ method will make additional ListRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesPager(method: Callable[[...], google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesResponse], request: google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesRequest, response: google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_repositories requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListRepositoriesResponse object, and provides an __iter__ method to iterate through its repositories field.

If there are more pages, the __iter__ method will make additional ListRepositories requests and continue to iterate through the repositories field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsAsyncPager(method: Callable[[...], Awaitable[google.cloud.artifactregistry_v1beta2.types.tag.ListTagsResponse]], request: google.cloud.artifactregistry_v1beta2.types.tag.ListTagsRequest, response: google.cloud.artifactregistry_v1beta2.types.tag.ListTagsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_tags requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListTagsResponse object, and provides an __aiter__ method to iterate through its tags field.

If there are more pages, the __aiter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsPager(method: Callable[[...], google.cloud.artifactregistry_v1beta2.types.tag.ListTagsResponse], request: google.cloud.artifactregistry_v1beta2.types.tag.ListTagsRequest, response: google.cloud.artifactregistry_v1beta2.types.tag.ListTagsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_tags requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListTagsResponse object, and provides an __iter__ method to iterate through its tags field.

If there are more pages, the __iter__ method will make additional ListTags requests and continue to iterate through the tags field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListTagsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.artifactregistry_v1beta2.types.version.ListVersionsResponse]], request: google.cloud.artifactregistry_v1beta2.types.version.ListVersionsRequest, response: google.cloud.artifactregistry_v1beta2.types.version.ListVersionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_versions requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListVersionsResponse object, and provides an __aiter__ method to iterate through its versions field.

If there are more pages, the __aiter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsPager(method: Callable[[...], google.cloud.artifactregistry_v1beta2.types.version.ListVersionsResponse], request: google.cloud.artifactregistry_v1beta2.types.version.ListVersionsRequest, response: google.cloud.artifactregistry_v1beta2.types.version.ListVersionsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_versions requests.

This class thinly wraps an initial google.cloud.artifactregistry_v1beta2.types.ListVersionsResponse object, and provides an __iter__ method to iterate through its versions field.

If there are more pages, the __iter__ method will make additional ListVersions requests and continue to iterate through the versions field on the corresponding responses.

All the usual google.cloud.artifactregistry_v1beta2.types.ListVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters