Class ArtifactRegistryClient (1.11.2)

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

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.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
TypeDescription
strThe API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
TypeDescription
ArtifactRegistryTransportThe transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
TypeDescription
strThe universe domain used by the client instance.

Methods

ArtifactRegistryClient

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

Instantiates the artifact registry client.

Parameters
NameDescription
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 Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

apt_artifact_path

apt_artifact_path(
    project: str, location: str, repository: str, apt_artifact: str
) -> str

Returns a fully-qualified apt_artifact string.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_repository

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_create_repository():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.CreateRepositoryRequest(
        parent="parent_value",
    )

    # Make the request
    operation = client.create_repository(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.CreateRepositoryRequest, dict]

The request object. The request to create a new repository.

parent str

Required. 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
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be Repository A Repository for storing artifacts with a specific format.

create_tag

create_tag(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.tag.CreateTagRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    tag: typing.Optional[google.cloud.artifactregistry_v1beta2.types.tag.Tag] = None,
    tag_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.tag.Tag

Creates a tag.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_create_tag():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.CreateTagRequest(
    )

    # Make the request
    response = client.create_tag(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.TagTags point to a version and represent an alternative name that can be used to access the version.

delete_package

delete_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.package.DeletePackageRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_delete_package():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.DeletePackageRequest(
    )

    # Make the request
    operation = client.delete_package(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.api_core.operation.OperationAn 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); }

delete_repository

delete_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.repository.DeleteRepositoryRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_delete_repository():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.DeleteRepositoryRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_repository(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.DeleteRepositoryRequest, dict]

The request object. The request to delete a repository.

name str

Required. 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
TypeDescription
google.api_core.operation.OperationAn 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); }

delete_tag

delete_tag(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.tag.DeleteTagRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Deletes a tag.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_delete_tag():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.DeleteTagRequest(
    )

    # Make the request
    client.delete_tag(request=request)
Parameters
NameDescription
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

delete_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.version.DeleteVersionRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_delete_version():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.DeleteVersionRequest(
    )

    # Make the request
    operation = client.delete_version(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.api_core.operation.OperationAn 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); }

file_path

file_path(project: str, location: str, repository: str, file: str) -> str

Returns a fully-qualified file string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ArtifactRegistryClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
ArtifactRegistryClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
ArtifactRegistryClientThe constructed client.

get_file

get_file(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.file.GetFileRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.file.File

Gets a file.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_file():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetFileRequest(
    )

    # Make the request
    response = client.get_file(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.FileFiles store content that is potentially associated with Packages or Versions.

get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM policy for a given resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.iam.v1.policy_pb2.PolicyAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "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')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ 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')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
NameDescription
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation 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
TypeDescription
.location_pb2.LocationLocation object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_package

get_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.package.GetPackageRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.package.Package

Gets a package.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_package():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetPackageRequest(
    )

    # Make the request
    response = client.get_package(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.PackagePackages are named collections of versions.

get_project_settings

get_project_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.settings.GetProjectSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.settings.ProjectSettings

Retrieves the Settings for the Project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_project_settings():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetProjectSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_project_settings(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.GetProjectSettingsRequest, dict]

The request object. Gets the redirection status for a project.

name str

Required. The name of the projectSettings resource. 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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.ProjectSettingsThe Artifact Registry settings that apply to a Project.

get_repository

get_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.repository.GetRepositoryRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.repository.Repository

Gets a repository.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_repository():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetRepositoryRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_repository(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.GetRepositoryRequest, dict]

The request object. The request to retrieve a repository.

name str

Required. 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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.RepositoryA Repository for storing artifacts with a specific format.

get_tag

get_tag(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.tag.GetTagRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.tag.Tag

Gets a tag.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_tag():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetTagRequest(
    )

    # Make the request
    response = client.get_tag(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.TagTags point to a version and represent an alternative name that can be used to access the version.

get_version

get_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.version.GetVersionRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.version.Version

Gets a version

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_get_version():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.GetVersionRequest(
    )

    # Make the request
    response = client.get_version(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.VersionThe 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.

import_apt_artifacts

import_apt_artifacts(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.apt_artifact.ImportAptArtifactsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_import_apt_artifacts():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ImportAptArtifactsRequest(
    )

    # Make the request
    operation = client.import_apt_artifacts(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsRequest, dict]

The request object. The request to import new apt artifacts.

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
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ImportAptArtifactsResponse The response message from importing APT artifacts.

import_yum_artifacts

import_yum_artifacts(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.yum_artifact.ImportYumArtifactsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_import_yum_artifacts():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ImportYumArtifactsRequest(
    )

    # Make the request
    operation = client.import_yum_artifacts(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsRequest, dict]

The request object. The request to import new yum artifacts.

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
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be ImportYumArtifactsResponse The response message from importing YUM artifacts.

list_files

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

Lists files.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_list_files():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ListFilesRequest(
    )

    # Make the request
    page_result = client.list_files(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.ListFilesRequest, dict]

The request object. The request to list files.

parent str

The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 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
TypeDescription
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesPagerThe response from listing files. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
NameDescription
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations 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
TypeDescription
.location_pb2.ListLocationsResponseResponse message for ListLocations method.

list_packages

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

Lists packages.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_list_packages():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ListPackagesRequest(
    )

    # Make the request
    page_result = client.list_packages(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesPagerThe response from listing packages. Iterating over this object will yield results and resolve additional pages automatically.

list_repositories

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

Lists repositories.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_list_repositories():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ListRepositoriesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_repositories(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.ListRepositoriesRequest, dict]

The request object. The request to list repositories.

parent str

Required. 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
TypeDescription
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesPagerThe response from listing repositories. Iterating over this object will yield results and resolve additional pages automatically.

list_tags

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

Lists tags.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_list_tags():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ListTagsRequest(
    )

    # Make the request
    page_result = client.list_tags(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsPagerThe response from listing tags. Iterating over this object will yield results and resolve additional pages automatically.

list_versions

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

Lists versions.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_list_versions():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.ListVersionsRequest(
    )

    # Make the request
    page_result = client.list_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
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
TypeDescription
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsPagerThe response from listing versions. Iterating over this object will yield results and resolve additional pages automatically.

parse_apt_artifact_path

parse_apt_artifact_path(path: str) -> typing.Dict[str, str]

Parses a apt_artifact path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_file_path

parse_file_path(path: str) -> typing.Dict[str, str]

Parses a file path into its component segments.

parse_project_settings_path

parse_project_settings_path(path: str) -> typing.Dict[str, str]

Parses a project_settings path into its component segments.

parse_repository_path

parse_repository_path(path: str) -> typing.Dict[str, str]

Parses a repository path into its component segments.

parse_tag_path

parse_tag_path(path: str) -> typing.Dict[str, str]

Parses a tag path into its component segments.

parse_version_path

parse_version_path(path: str) -> typing.Dict[str, str]

Parses a version path into its component segments.

parse_yum_artifact_path

parse_yum_artifact_path(path: str) -> typing.Dict[str, str]

Parses a yum_artifact path into its component segments.

project_settings_path

project_settings_path(project: str) -> str

Returns a fully-qualified project_settings string.

repository_path

repository_path(project: str, location: str, repository: str) -> str

Returns a fully-qualified repository string.

set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Updates the IAM policy for a given resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.iam.v1.policy_pb2.PolicyAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "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')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ 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')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

tag_path

tag_path(
    project: str, location: str, repository: str, package: str, tag: str
) -> str

Returns a fully-qualified tag string.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
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
TypeDescription
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponseResponse message for TestIamPermissions method.

update_project_settings

update_project_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.artifactregistry_v1beta2.types.settings.UpdateProjectSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    project_settings: typing.Optional[
        google.cloud.artifactregistry_v1beta2.types.settings.ProjectSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.artifactregistry_v1beta2.types.settings.ProjectSettings

Updates the Settings for the Project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_update_project_settings():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.UpdateProjectSettingsRequest(
    )

    # Make the request
    response = client.update_project_settings(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.UpdateProjectSettingsRequest, dict]

The request object. Sets the settings of the project.

project_settings google.cloud.artifactregistry_v1beta2.types.ProjectSettings

The project settings. This corresponds to the project_settings field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Field mask to support partial updates. This corresponds to the update_mask 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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.ProjectSettingsThe Artifact Registry settings that apply to a Project.

update_repository

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

Updates a repository.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import artifactregistry_v1beta2

def sample_update_repository():
    # Create a client
    client = artifactregistry_v1beta2.ArtifactRegistryClient()

    # Initialize request argument(s)
    request = artifactregistry_v1beta2.UpdateRepositoryRequest(
    )

    # Make the request
    response = client.update_repository(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.artifactregistry_v1beta2.types.UpdateRepositoryRequest, dict]

The request object. The request to update a repository.

repository google.cloud.artifactregistry_v1beta2.types.Repository

The repository that replaces the resource on the server. This corresponds to the repository field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask This corresponds to the update_mask 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
TypeDescription
google.cloud.artifactregistry_v1beta2.types.RepositoryA Repository for storing artifacts with a specific format.