Class ConfidentialComputingAsyncClient (0.5.0)
 
 
 
 
 
 
 Stay organized with collections
 
 
 
 Save and categorize content based on your preferences.
 
  
 
 ConfidentialComputingAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.confidentialcomputing_v1.services.confidential_computing.transports.base.ConfidentialComputingTransport, typing.Callable[[...], google.cloud.confidentialcomputing_v1.services.confidential_computing.transports.base.ConfidentialComputingTransport]]] = '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>)Service describing handlers for resources
Properties
api_endpoint
Return the API endpoint used by the client instance.
| Returns | |
|---|---|
| Type | Description | 
| str | The API endpoint used by the client instance. | 
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description | 
| ConfidentialComputingTransport | The transport used by the client instance. | 
universe_domain
Return the universe domain used by the client instance.
| Returns | |
|---|---|
| Type | Description | 
| str | The universe domain used by the client instance. | 
Methods
ConfidentialComputingAsyncClient
ConfidentialComputingAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.confidentialcomputing_v1.services.confidential_computing.transports.base.ConfidentialComputingTransport, typing.Callable[[...], google.cloud.confidentialcomputing_v1.services.confidential_computing.transports.base.ConfidentialComputingTransport]]] = '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>)Instantiates the confidential computing async 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 | Optional[Union[str,ConfidentialComputingTransport,Callable[..., ConfidentialComputingTransport]]]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 ConfidentialComputingTransport 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  | 
| client_info | google.api_core.gapic_v1.client_info.ClientInfoThe client info used to send a user-agent string along with API requests. If  | 
| Exceptions | |
|---|---|
| Type | Description | 
| google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. | 
challenge_path
challenge_path(project: str, location: str, uuid: str) -> strReturns a fully-qualified challenge string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> strReturns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> strReturns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> strReturns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> strReturns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> strReturns a fully-qualified project string.
create_challenge
create_challenge(
 request: typing.Optional[
 typing.Union[
 google.cloud.confidentialcomputing_v1.types.service.CreateChallengeRequest,
 dict,
 ]
 ] = None,
 *,
 parent: typing.Optional[str] = None,
 challenge: typing.Optional[
 google.cloud.confidentialcomputing_v1.types.service.Challenge
 ] = None,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.confidentialcomputing_v1.types.service.ChallengeCreates a new Challenge in a given project and location.
# 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 confidentialcomputing_v1
async def sample_create_challenge():
 # Create a client
 client = confidentialcomputing_v1.ConfidentialComputingAsyncClient()
 # Initialize request argument(s)
 request = confidentialcomputing_v1.CreateChallengeRequest(
 parent="parent_value",
 )
 # Make the request
 response = await client.create_challenge(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Optional[Union[google.cloud.confidentialcomputing_v1.types.CreateChallengeRequest, dict]]The request object. Message for creating a Challenge | 
| parent | Required. The resource name of the location where the Challenge will be used, in the format  | 
| challenge | Challenge Required. The Challenge to be created. Currently this field can be empty as all the Challenge fields are set by the server. This corresponds to the  | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.confidentialcomputing_v1.types.Challenge  | A Challenge from the server used to guarantee freshness of attestations | 
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 | strThe path to the service account private key json file. | 
| Returns | |
|---|---|
| Type | Description | 
| ConfidentialComputingAsyncClient | 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 | dictThe service account private key info. | 
| Returns | |
|---|---|
| Type | Description | 
| ConfidentialComputingAsyncClient | 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 | strThe path to the service account private key json file. | 
| Returns | |
|---|---|
| Type | Description | 
| ConfidentialComputingAsyncClient | The constructed client. | 
get_location
get_location(
 request: typing.Optional[
 google.cloud.location.locations_pb2.GetLocationRequest
 ] = None,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.LocationGets information about a location.
| Parameters | |
|---|---|
| Name | Description | 
| request | The request object. Request message for  | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
|  | Location object. | 
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
 client_options: typing.Optional[
 google.api_core.client_options.ClientOptions
 ] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description | 
| client_options | google.api_core.client_options.ClientOptionsCustom options for the client. Only the  | 
| Exceptions | |
|---|---|
| Type | Description | 
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. | 
| Returns | |
|---|---|
| Type | Description | 
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. | 
get_transport_class
get_transport_class(
 label: typing.Optional[str] = None,
) -> typing.Type[
 google.cloud.confidentialcomputing_v1.services.confidential_computing.transports.base.ConfidentialComputingTransport
]Returns an appropriate transport class.
| Parameter | |
|---|---|
| Name | Description | 
| label | typing.Optional[str]The name of the desired transport. If none is provided, then the first transport in the registry is used. | 
list_locations
list_locations(
 request: typing.Optional[
 google.cloud.location.locations_pb2.ListLocationsRequest
 ] = None,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponseLists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description | 
| request | The request object. Request message for  | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
|  | Response message for ListLocationsmethod. | 
parse_challenge_path
parse_challenge_path(path: str) -> typing.Dict[str, str]Parses a challenge path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]Parse a project path into its component segments.
verify_attestation
verify_attestation(
 request: typing.Optional[
 typing.Union[
 google.cloud.confidentialcomputing_v1.types.service.VerifyAttestationRequest,
 dict,
 ]
 ] = None,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.confidentialcomputing_v1.types.service.VerifyAttestationResponseVerifies the provided attestation info, returning a signed attestation token.
# 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 confidentialcomputing_v1
async def sample_verify_attestation():
 # Create a client
 client = confidentialcomputing_v1.ConfidentialComputingAsyncClient()
 # Initialize request argument(s)
 request = confidentialcomputing_v1.VerifyAttestationRequest(
 challenge="challenge_value",
 )
 # Make the request
 response = await client.verify_attestation(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Optional[Union[google.cloud.confidentialcomputing_v1.types.VerifyAttestationRequest, dict]]The request object. A request for an attestation token, providing all the necessary information needed for this service to verify the platform state of the requestor. | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.confidentialcomputing_v1.types.VerifyAttestationResponse  | A response once an attestation has been successfully verified, containing a signed attestation token. | 
verify_confidential_gke
verify_confidential_gke(
 request: typing.Optional[
 typing.Union[
 google.cloud.confidentialcomputing_v1.types.service.VerifyConfidentialGkeRequest,
 dict,
 ]
 ] = None,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.confidentialcomputing_v1.types.service.VerifyConfidentialGkeResponseVerifies the provided Confidential GKE attestation info, returning a signed OIDC token.
# 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 confidentialcomputing_v1
async def sample_verify_confidential_gke():
 # Create a client
 client = confidentialcomputing_v1.ConfidentialComputingAsyncClient()
 # Initialize request argument(s)
 request = confidentialcomputing_v1.VerifyConfidentialGkeRequest(
 challenge="challenge_value",
 )
 # Make the request
 response = await client.verify_confidential_gke(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Optional[Union[google.cloud.confidentialcomputing_v1.types.VerifyConfidentialGkeRequest, dict]]The request object. A request for an attestation token, providing all the necessary information needed for this service to verify Confidential GKE platform state of the requestor. | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.confidentialcomputing_v1.types.VerifyConfidentialGkeResponse  | VerifyConfidentialGkeResponse response is returened once a Confidential GKE attestation has been successfully verified, containing a signed OIDC token. | 
verify_confidential_space
verify_confidential_space(
 request: typing.Optional[
 typing.Union[
 google.cloud.confidentialcomputing_v1.types.service.VerifyConfidentialSpaceRequest,
 dict,
 ]
 ] = None,
 *,
 retry: typing.Optional[
 typing.Union[
 google.api_core.retry.retry_unary_async.AsyncRetry,
 google.api_core.gapic_v1.method._MethodDefault,
 ]
 ] = _MethodDefault._DEFAULT_VALUE,
 timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
 metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
 google.cloud.confidentialcomputing_v1.types.service.VerifyConfidentialSpaceResponse
)Verifies whether the provided attestation info is valid, returning a signed attestation token if so.
# 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 confidentialcomputing_v1
async def sample_verify_confidential_space():
 # Create a client
 client = confidentialcomputing_v1.ConfidentialComputingAsyncClient()
 # Initialize request argument(s)
 request = confidentialcomputing_v1.VerifyConfidentialSpaceRequest(
 challenge="challenge_value",
 )
 # Make the request
 response = await client.verify_confidential_space(request=request)
 # Handle the response
 print(response)
| Parameters | |
|---|---|
| Name | Description | 
| request | Optional[Union[google.cloud.confidentialcomputing_v1.types.VerifyConfidentialSpaceRequest, dict]]The request object. A request for an attestation token, providing all the necessary information needed for this service to verify the platform state of the requestor. | 
| retry | google.api_core.retry_async.AsyncRetryDesignation of what errors, if any, should be retried. | 
| timeout | floatThe timeout for this request. | 
| metadata | Sequence[Tuple[str, Union[str, bytes]]]Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type  | 
| Returns | |
|---|---|
| Type | Description | 
| google.cloud.confidentialcomputing_v1.types.VerifyConfidentialSpaceResponse  | VerifyConfidentialSpaceResponse is returned once a Confidential Space attestation has been successfully verified, containing a signed token. |