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>)
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
transport
Returns the transport used by the client instance.
Type | Description |
ArtifactRegistryTransport | The transport used by the client instance. |
Methods
ArtifactRegistryClient
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>)
Instantiates the artifact registry client.
Name | Description |
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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_repository
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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
Name | Description |
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 |
repository |
google.cloud.artifactregistry_v1beta2.types.Repository
The repository to be created. This corresponds to the |
repository_id |
str
The repository id to use for this repository. This corresponds to the |
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. |
Type | Description |
google.api_core.operation.Operation | An 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: 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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a tag.
Name | Description |
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 |
tag |
google.cloud.artifactregistry_v1beta2.types.Tag
The tag to be created. This corresponds to the |
tag_id |
str
The tag id to use for this repository. This corresponds to the |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Tag | Tags point to a version and represent an alternative name that can be used to access the version. |
delete_package
delete_package(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.DeletePackageRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | 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 {}. |
delete_repository
delete_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.DeleteRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | 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 {}. |
delete_tag
delete_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.DeleteTagRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a tag.
Name | Description |
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 |
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: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.DeleteVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
Name | Description |
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 |
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. |
Type | Description |
google.api_core.operation.Operation | 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 {}. |
file_path
file_path(project: str, location: str, repo: str, file: 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ArtifactRegistryClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
ArtifactRegistryClient | The 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
ArtifactRegistryClient | The constructed client. |
get_file
get_file(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.file.GetFileRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a file.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.File | Files store content that is potentially associated with Packages or Versions. |
get_iam_policy
get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the IAM policy for a given resource.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]
The request object. Request message for |
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. |
Type | Description |
google.iam.v1.policy_pb2.Policy | 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](\=""> |
get_package
get_package(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.GetPackageRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a package.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Package | Packages are named collections of versions. |
get_repository
get_repository(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.GetRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a repository.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Repository | A Repository for storing artifacts with a specific format. |
get_tag
get_tag(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.GetTagRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a tag.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Tag | Tags point to a version and represent an alternative name that can be used to access the version. |
get_version
get_version(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.GetVersionRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets a version
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Version | 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. |
list_files
list_files(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.file.ListFilesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists files.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListFilesPager | The response from listing files. Iterating over this object will yield results and resolve additional pages automatically. |
list_packages
list_packages(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.package.ListPackagesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists packages.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListPackagesPager | The response from listing packages. Iterating over this object will yield results and resolve additional pages automatically. |
list_repositories
list_repositories(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.repository.ListRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists repositories.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListRepositoriesPager | The response from listing repositories. Iterating over this object will yield results and resolve additional pages automatically. |
list_tags
list_tags(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.tag.ListTagsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists tags.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListTagsPager | The response from listing tags. Iterating over this object will yield results and resolve additional pages automatically. |
list_versions
list_versions(request: Optional[Union[google.cloud.artifactregistry_v1beta2.types.version.ListVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists versions.
Name | Description |
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 |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.services.artifact_registry.pagers.ListVersionsPager | The response from listing versions. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_file_path
parse_file_path(path: str)
Parses a file path into its component segments.
parse_repository_path
parse_repository_path(path: str)
Parses a repository path into its component segments.
repository_path
repository_path(project: str, location: str, repository: str)
Returns a fully-qualified repository string.
set_iam_policy
set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates the IAM policy for a given resource.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]
The request object. Request message for |
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. |
Type | Description |
google.iam.v1.policy_pb2.Policy | 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](\=""> |
test_iam_permissions
test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Tests if the caller has a list of permissions on a resource.
Name | Description |
request |
Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]
The request object. Request message for |
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. |
Type | Description |
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse | Response message for TestIamPermissions method. |
update_repository
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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a repository.
Name | Description |
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 |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The update mask applies to the resource. For the |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Repository | A Repository for storing artifacts with a specific format. |
update_tag
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 = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a tag.
Name | Description |
request |
Union[google.cloud.artifactregistry_v1beta2.types.UpdateTagRequest, dict]
The request object. The request to create or update a tag. |
tag |
google.cloud.artifactregistry_v1beta2.types.Tag
The tag that replaces the resource on the server. This corresponds to the |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The update mask applies to the resource. For the |
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. |
Type | Description |
google.cloud.artifactregistry_v1beta2.types.Tag | Tags point to a version and represent an alternative name that can be used to access the version. |