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

BinauthzManagementServiceV1¶

class google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.BinauthzManagementServiceV1AsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport, typing.Callable[[...], google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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

This API implements a REST model with the following objects:

[Policy][google.cloud.binaryauthorization.v1.Policy]
[Attestor][google.cloud.binaryauthorization.v1.Attestor]

Instantiates the binauthz management service v1 async client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,BinauthzManagementServiceV1Transport,Callable[..., BinauthzManagementServiceV1Transport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the BinauthzManagementServiceV1Transport constructor. 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 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.

Raises

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

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static attestor_path(project: str, attestor: str) → str¶: Returns a fully-qualified attestor string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.CreateAttestorRequest, dict]] = None, *, parent: Optional[str] = None, attestor_id: Optional[str] = None, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Creates an [attestor][google.cloud.binaryauthorization.v1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1.Attestor] already exists.

# 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 binaryauthorization_v1

async def sample_create_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    attestor = binaryauthorization_v1.Attestor()
    attestor.user_owned_grafeas_note.note_reference = "note_reference_value"
    attestor.name = "name_value"

    request = binaryauthorization_v1.CreateAttestorRequest(
        parent="parent_value",
        attestor_id="attestor_id_value",
        attestor=attestor,
    )

    # Make the request
    response = await client.create_attestor(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.CreateAttestorRequest, dict]]) – The request object. Request message for [BinauthzManagementService.CreateAttestor][].
parent (str) –
Required. The parent of this [attestor][google.cloud.binaryauthorization.v1.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][google.cloud.binaryauthorization.v1.Attestor] ID.

This corresponds to the attestor_id field on the request instance; if request is provided, this should not be set.
attestor (google.cloud.binaryauthorization_v1.types.Attestor) –
Required. The initial [attestor][google.cloud.binaryauthorization.v1.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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

async delete_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.DeleteAttestorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

async def sample_delete_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    request = binaryauthorization_v1.DeleteAttestorRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_attestor(request=request)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.DeleteAttestorRequest, dict]]) – The request object. Request message for [BinauthzManagementService.DeleteAttestor][].
name (str) –
Required. The name of the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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_async.AsyncRetry) – 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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1AsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1AsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1AsyncClient

async get_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.GetAttestorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Gets an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

async def sample_get_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    request = binaryauthorization_v1.GetAttestorRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_attestor(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.GetAttestorRequest, dict]]) – The request object. Request message for [BinauthzManagementService.GetAttestor][].
name (str) –
Required. The name of the [attestor][google.cloud.binaryauthorization.v1.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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_policy(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.GetPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Policy[source]¶

A [policy][google.cloud.binaryauthorization.v1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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 [policy][google.cloud.binaryauthorization.v1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1.Policy] if the project does not have one.

# 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 binaryauthorization_v1

async def sample_get_policy():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    request = binaryauthorization_v1.GetPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.GetPolicyRequest, dict]]) – The request object. Request message for [BinauthzManagementService.GetPolicy][].
name (str) –
Required. The resource name of the [policy][google.cloud.binaryauthorization.v1.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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A [policy][google.cloud.binaryauthorization.v1.Policy] for container image binary authorization.

Return type

google.cloud.binaryauthorization_v1.types.Policy

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_attestors(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.ListAttestorsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsAsyncPager[source]¶

Lists [attestors][google.cloud.binaryauthorization.v1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.

# 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 binaryauthorization_v1

async def sample_list_attestors():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    request = binaryauthorization_v1.ListAttestorsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.ListAttestorsRequest, dict]]) – The request object. Request message for [BinauthzManagementService.ListAttestors][].
parent (str) –
Required. The resource name of the project associated with the [attestors][google.cloud.binaryauthorization.v1.Attestor], 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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response message for [BinauthzManagementService.ListAttestors][].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsAsyncPager

static parse_attestor_path(path: str) → Dict[str, str]¶: Parses a attestor path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_policy_path(path: str) → Dict[str, str]¶: Parses a policy path into its component segments.

static policy_path(project: str) → str¶: Returns a fully-qualified policy string.

property transport: google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: BinauthzManagementServiceV1Transport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.UpdateAttestorRequest, dict]] = None, *, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Updates an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

async def sample_update_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    attestor = binaryauthorization_v1.Attestor()
    attestor.user_owned_grafeas_note.note_reference = "note_reference_value"
    attestor.name = "name_value"

    request = binaryauthorization_v1.UpdateAttestorRequest(
        attestor=attestor,
    )

    # Make the request
    response = await client.update_attestor(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.UpdateAttestorRequest, dict]]) – The request object. Request message for [BinauthzManagementService.UpdateAttestor][].
attestor (google.cloud.binaryauthorization_v1.types.Attestor) –
Required. The updated [attestor][google.cloud.binaryauthorization.v1.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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

async update_policy(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.UpdatePolicyRequest, dict]] = None, *, policy: Optional[google.cloud.binaryauthorization_v1.types.resources.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Policy[source]¶

Creates or updates a project’s [policy][google.cloud.binaryauthorization.v1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1.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.

# 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 binaryauthorization_v1

async def sample_update_policy():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1AsyncClient()

    # Initialize request argument(s)
    policy = binaryauthorization_v1.Policy()
    policy.default_admission_rule.evaluation_mode = "ALWAYS_DENY"
    policy.default_admission_rule.enforcement_mode = "DRYRUN_AUDIT_LOG_ONLY"

    request = binaryauthorization_v1.UpdatePolicyRequest(
        policy=policy,
    )

    # Make the request
    response = await client.update_policy(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.binaryauthorization_v1.types.UpdatePolicyRequest, dict]]) – The request object. Request message for [BinauthzManagementService.UpdatePolicy][].
policy (google.cloud.binaryauthorization_v1.types.Policy) –
Required. A new or updated [policy][google.cloud.binaryauthorization.v1.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_async.AsyncRetry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

A [policy][google.cloud.binaryauthorization.v1.Policy] for container image binary authorization.

Return type

google.cloud.binaryauthorization_v1.types.Policy

class google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.BinauthzManagementServiceV1Client(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport, typing.Callable[[...], google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport]]] = 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>)[source]¶

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

This API implements a REST model with the following objects:

[Policy][google.cloud.binaryauthorization.v1.Policy]
[Attestor][google.cloud.binaryauthorization.v1.Attestor]

Instantiates the binauthz management service v1 client.

Parameters

credentials (Optional[google.auth.credentials.Credentials]) – The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport (Optional[Union[str,BinauthzManagementServiceV1Transport,Callable[..., BinauthzManagementServiceV1Transport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the BinauthzManagementServiceV1Transport constructor. 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.

Raises

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

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

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static attestor_path(project: str, attestor: str) → str[source]¶: Returns a fully-qualified attestor string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.CreateAttestorRequest, dict]] = None, *, parent: Optional[str] = None, attestor_id: Optional[str] = None, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Creates an [attestor][google.cloud.binaryauthorization.v1.Attestor], and returns a copy of the new [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed, ALREADY_EXISTS if the [attestor][google.cloud.binaryauthorization.v1.Attestor] already exists.

# 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 binaryauthorization_v1

def sample_create_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    attestor = binaryauthorization_v1.Attestor()
    attestor.user_owned_grafeas_note.note_reference = "note_reference_value"
    attestor.name = "name_value"

    request = binaryauthorization_v1.CreateAttestorRequest(
        parent="parent_value",
        attestor_id="attestor_id_value",
        attestor=attestor,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.CreateAttestorRequest, dict]) – The request object. Request message for [BinauthzManagementService.CreateAttestor][].
parent (str) –
Required. The parent of this [attestor][google.cloud.binaryauthorization.v1.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][google.cloud.binaryauthorization.v1.Attestor] ID.

This corresponds to the attestor_id field on the request instance; if request is provided, this should not be set.
attestor (google.cloud.binaryauthorization_v1.types.Attestor) –
Required. The initial [attestor][google.cloud.binaryauthorization.v1.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

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

delete_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.DeleteAttestorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

Deletes an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

def sample_delete_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    request = binaryauthorization_v1.DeleteAttestorRequest(
        name="name_value",
    )

    # Make the request
    client.delete_attestor(request=request)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.DeleteAttestorRequest, dict]) – The request object. Request message for [BinauthzManagementService.DeleteAttestor][].
name (str) –
Required. The name of the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1Client

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1Client

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

BinauthzManagementServiceV1Client

get_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.GetAttestorRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Gets an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

def sample_get_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    request = binaryauthorization_v1.GetAttestorRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.GetAttestorRequest, dict]) – The request object. Request message for [BinauthzManagementService.GetAttestor][].
name (str) –
Required. The name of the [attestor][google.cloud.binaryauthorization.v1.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

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_policy(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.GetPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Policy[source]¶

A [policy][google.cloud.binaryauthorization.v1.Policy] specifies the [attestors][google.cloud.binaryauthorization.v1.Attestor] 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 [policy][google.cloud.binaryauthorization.v1.Policy] for this project. Returns a default [policy][google.cloud.binaryauthorization.v1.Policy] if the project does not have one.

# 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 binaryauthorization_v1

def sample_get_policy():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    request = binaryauthorization_v1.GetPolicyRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.GetPolicyRequest, dict]) – The request object. Request message for [BinauthzManagementService.GetPolicy][].
name (str) –
Required. The resource name of the [policy][google.cloud.binaryauthorization.v1.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

A [policy][google.cloud.binaryauthorization.v1.Policy] for container image binary authorization.

Return type

google.cloud.binaryauthorization_v1.types.Policy

list_attestors(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.ListAttestorsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsPager[source]¶

Lists [attestors][google.cloud.binaryauthorization.v1.Attestor]. Returns INVALID_ARGUMENT if the project does not exist.

# 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 binaryauthorization_v1

def sample_list_attestors():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    request = binaryauthorization_v1.ListAttestorsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.ListAttestorsRequest, dict]) – The request object. Request message for [BinauthzManagementService.ListAttestors][].
parent (str) –
Required. The resource name of the project associated with the [attestors][google.cloud.binaryauthorization.v1.Attestor], 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

Response message for [BinauthzManagementService.ListAttestors][].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsPager

static parse_attestor_path(path: str) → Dict[str, str][source]¶: Parses a attestor path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_policy_path(path: str) → Dict[str, str][source]¶: Parses a policy path into its component segments.

static policy_path(project: str) → str[source]¶: Returns a fully-qualified policy string.

property transport: google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.transports.base.BinauthzManagementServiceV1Transport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

BinauthzManagementServiceV1Transport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_attestor(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.UpdateAttestorRequest, dict]] = None, *, attestor: Optional[google.cloud.binaryauthorization_v1.types.resources.Attestor] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Attestor[source]¶

Updates an [attestor][google.cloud.binaryauthorization.v1.Attestor]. Returns NOT_FOUND if the [attestor][google.cloud.binaryauthorization.v1.Attestor] does not exist.

# 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 binaryauthorization_v1

def sample_update_attestor():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    attestor = binaryauthorization_v1.Attestor()
    attestor.user_owned_grafeas_note.note_reference = "note_reference_value"
    attestor.name = "name_value"

    request = binaryauthorization_v1.UpdateAttestorRequest(
        attestor=attestor,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.UpdateAttestorRequest, dict]) – The request object. Request message for [BinauthzManagementService.UpdateAttestor][].
attestor (google.cloud.binaryauthorization_v1.types.Attestor) –
Required. The updated [attestor][google.cloud.binaryauthorization.v1.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

An [attestor][google.cloud.binaryauthorization.v1.Attestor] that attests to container image: artifacts. An existing attestor cannot be modified except where indicated.

Return type

google.cloud.binaryauthorization_v1.types.Attestor

update_policy(request: Optional[Union[google.cloud.binaryauthorization_v1.types.service.UpdatePolicyRequest, dict]] = None, *, policy: Optional[google.cloud.binaryauthorization_v1.types.resources.Policy] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.binaryauthorization_v1.types.resources.Policy[source]¶

Creates or updates a project’s [policy][google.cloud.binaryauthorization.v1.Policy], and returns a copy of the new [policy][google.cloud.binaryauthorization.v1.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.

# 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 binaryauthorization_v1

def sample_update_policy():
    # Create a client
    client = binaryauthorization_v1.BinauthzManagementServiceV1Client()

    # Initialize request argument(s)
    policy = binaryauthorization_v1.Policy()
    policy.default_admission_rule.evaluation_mode = "ALWAYS_DENY"
    policy.default_admission_rule.enforcement_mode = "DRYRUN_AUDIT_LOG_ONLY"

    request = binaryauthorization_v1.UpdatePolicyRequest(
        policy=policy,
    )

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.binaryauthorization_v1.types.UpdatePolicyRequest, dict]) – The request object. Request message for [BinauthzManagementService.UpdatePolicy][].
policy (google.cloud.binaryauthorization_v1.types.Policy) –
Required. A new or updated [policy][google.cloud.binaryauthorization.v1.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

A [policy][google.cloud.binaryauthorization.v1.Policy] for container image binary authorization.

Return type

google.cloud.binaryauthorization_v1.types.Policy

class google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsAsyncPager(method: Callable[[...], Awaitable[google.cloud.binaryauthorization_v1.types.service.ListAttestorsResponse]], request: google.cloud.binaryauthorization_v1.types.service.ListAttestorsRequest, response: google.cloud.binaryauthorization_v1.types.service.ListAttestorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_attestors requests.

This class thinly wraps an initial google.cloud.binaryauthorization_v1.types.ListAttestorsResponse object, and provides an __aiter__ method to iterate through its attestors field.

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

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

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.binaryauthorization_v1.types.ListAttestorsRequest) – The initial request object.
response (google.cloud.binaryauthorization_v1.types.ListAttestorsResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.binaryauthorization_v1.services.binauthz_management_service_v1.pagers.ListAttestorsPager(method: Callable[[...], google.cloud.binaryauthorization_v1.types.service.ListAttestorsResponse], request: google.cloud.binaryauthorization_v1.types.service.ListAttestorsRequest, response: google.cloud.binaryauthorization_v1.types.service.ListAttestorsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_attestors requests.

This class thinly wraps an initial google.cloud.binaryauthorization_v1.types.ListAttestorsResponse object, and provides an __iter__ method to iterate through its attestors field.

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

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

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.binaryauthorization_v1.types.ListAttestorsRequest) – The initial request object.
response (google.cloud.binaryauthorization_v1.types.ListAttestorsResponse) – The initial response object.
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.

BinauthzManagementServiceV1¶

google-cloud-binary-authorization

Navigation

Related Topics