Class BinauthzManagementServiceV1AsyncClient (0.5.0) 

BinauthzManagementServiceV1AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-binary-authorization/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Google Cloud Management Service for Binary Authorization admission policies and attestation authorities.

This API implements a REST model with the following objects:

  • Policy
  • Attestor

Properties

transport

Returns the transport used by the client instance.

Returns
Type Description
BinauthzManagementServiceV1Transport The transport used by the client instance.

Methods

BinauthzManagementServiceV1AsyncClient

BinauthzManagementServiceV1AsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-binary-authorization/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the binauthz management service v1 client.

Parameters
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, .BinauthzManagementServiceV1Transport]

The transport to use. If set to None, a transport is chosen automatically.
client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

attestor_path

attestor_path(project: str, attestor: str)

Returns a fully-qualified attestor string.

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_attestor

create_attestor(request: Optional[google.cloud.binaryauthorization_v1.types.service.CreateAttestorRequest] = None, *, parent: Optional[str] = None, attestor_id: Optional[str] = None, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an xref_attestor, and returns a copy of the new xref_attestor. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the xref_attestor already exists.

Parameters
Name Description
request CreateAttestorRequest

The request object. Request message for [BinauthzManagementService.CreateAttestor][].
parent str

Required. The parent of this attestor. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
attestor_id str

Required. The attestors ID. This corresponds to the attestor_id field on the request instance; if request is provided, this should not be set.
attestor Attestor

Required. The initial attestor value. The service will overwrite the [attestor name][google.cloud.binaryauthorization.v1.Attestor.name] field with the resource name, in the format projects//attestors/. This corresponds to the attestor 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
Type Description
google.cloud.binaryauthorization_v1.types.Attestor An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.

delete_attestor

delete_attestor(request: Optional[google.cloud.binaryauthorization_v1.types.service.DeleteAttestorRequest] = 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 an xref_attestor. Returns NOT_FOUND if the xref_attestor does not exist.

Parameters
Name Description
request DeleteAttestorRequest

The request object. Request message for [BinauthzManagementService.DeleteAttestor][].
name str

Required. The name of the attestors to delete, in the format projects//attestors/. 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.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
BinauthzManagementServiceV1AsyncClient 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.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
BinauthzManagementServiceV1AsyncClient 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.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
BinauthzManagementServiceV1AsyncClient The constructed client.

get_attestor

get_attestor(request: Optional[google.cloud.binaryauthorization_v1.types.service.GetAttestorRequest] = 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 an xref_attestor. Returns NOT_FOUND if the xref_attestor does not exist.

Parameters
Name Description
request GetAttestorRequest

The request object. Request message for [BinauthzManagementService.GetAttestor][].
name str

Required. The name of the attestor to retrieve, in the format projects//attestors/. 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
Type Description
google.cloud.binaryauthorization_v1.types.Attestor An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.

get_policy

get_policy(request: Optional[google.cloud.binaryauthorization_v1.types.service.GetPolicyRequest] = 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]] = ())

A xref_policy specifies the xref_attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy.

Gets the xref_policy for this project. Returns a default xref_policy if the project does not have one.

Parameters
Name Description
request GetPolicyRequest

The request object. Request message for [BinauthzManagementService.GetPolicy][].
name str

Required. The resource name of the policy to retrieve, in the format projects/*/policy. 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
Type Description
google.cloud.binaryauthorization_v1.types.Policy A policy for container image binary authorization.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_attestors

list_attestors(request: Optional[google.cloud.binaryauthorization_v1.types.service.ListAttestorsRequest] = 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 xref_attestors. Returns INVALID_ARGUMENT if the project does not exist.

Parameters
Name Description
request ListAttestorsRequest

The request object. Request message for [BinauthzManagementService.ListAttestors][].
parent str

Required. The resource name of the project associated with the attestors, in the format projects/*. 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
Type Description
google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsAsyncPager Response message for [BinauthzManagementService.ListAttestors][]. Iterating over this object will yield results and resolve additional pages automatically.

parse_attestor_path

parse_attestor_path(path: str)

Parses a attestor path into its component segments.

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_policy_path

parse_policy_path(path: str)

Parses a policy path into its component segments.

policy_path

policy_path(project: str)

Returns a fully-qualified policy string.

update_attestor

update_attestor(request: Optional[google.cloud.binaryauthorization_v1.types.service.UpdateAttestorRequest] = None, *, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an xref_attestor. Returns NOT_FOUND if the xref_attestor does not exist.

Parameters
Name Description
request UpdateAttestorRequest

The request object. Request message for [BinauthzManagementService.UpdateAttestor][].
attestor Attestor

Required. The updated attestor value. The service will overwrite the [attestor name][google.cloud.binaryauthorization.v1.Attestor.name] field with the resource name in the request URL, in the format projects//attestors/. This corresponds to the attestor 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
Type Description
google.cloud.binaryauthorization_v1.types.Attestor An attestor that attests to container image artifacts. An existing attestor cannot be modified except where indicated.

update_policy

update_policy(request: Optional[google.cloud.binaryauthorization_v1.types.service.UpdatePolicyRequest] = None, *, policy: Optional[google.cloud.binaryauthorization_v1.types.resources.Policy] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates or updates a project's xref_policy, and returns a copy of the new xref_policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed.

Parameters
Name Description
request UpdatePolicyRequest

The request object. Request message for [BinauthzManagementService.UpdatePolicy][].
policy Policy

Required. A new or updated policy value. The service will overwrite the [policy name][google.cloud.binaryauthorization.v1.Policy.name] field with the resource name in the request URL, in the format projects/*/policy. This corresponds to the policy 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
Type Description
google.cloud.binaryauthorization_v1.types.Policy A policy for container image binary authorization.