Class ApiKeysAsyncClient (0.1.0)
Stay organized with collections
Save and categorize content based on your preferences.
ApiKeysAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Manages the API keys associated with projects.
Properties
transport
Returns the transport used by the client instance.
ApiKeysTransport
The transport used by the client instance.
Methods
ApiKeysAsyncClient
ApiKeysAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.api_keys_v2.services.api_keys.transports.base.ApiKeysTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the api keys client.
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, .ApiKeysTransport]
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.
google.auth.exceptions.MutualTlsChannelError
If mutual TLS transport creation failed for any reason.
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_key
create_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.CreateKeyRequest, dict]] = None, *, parent: Optional[str] = None, key: Optional[google.cloud.api_keys_v2.types.resources.Key] = None, key_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new API key.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_create_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.CreateKeyRequest(
parent="parent_value",
)
# Make the request
operation = client.create_key(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.CreateKeyRequest, dict]
The request object. Request message for CreateKey method.
parent
strRequired. The project in which the API key is created. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
key
Key
Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields. This corresponds to the key field on the request instance; if request is provided, this should not be set.
key_id
strUser specified key id (optional). If specified, it will become the final component of the key resource name. The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?. The id must NOT be a UUID-like string. This corresponds to the key_id field on the request instance; if request is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be Key The representation of a key managed by the API Keys API.
delete_key
delete_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.DeleteKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_delete_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.DeleteKeyRequest(
name="name_value",
)
# Make the request
operation = client.delete_key(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.DeleteKeyRequest, dict]
The request object. Request message for DeleteKey method.
name
strRequired. The resource name of the API key to be deleted. 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.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be Key The representation of a key managed by the API Keys API.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
ApiKeysAsyncClient
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.
info
dict
The service account private key info.
ApiKeysAsyncClient
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.
filename
str
The path to the service account private key json file.
ApiKeysAsyncClient
The constructed client.
get_key
get_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.GetKeyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the metadata for an API key. The key string of the API key isn't included in the response.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_get_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.GetKeyRequest(
name="name_value",
)
# Make the request
response = await client.get_key(request=request)
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.GetKeyRequest, dict]
The request object. Request message for GetKey method.
name
strRequired. The resource name of the API key to get. 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.
google.cloud.api_keys_v2.types.Key
The representation of a key managed by the API Keys API.
get_key_string
get_key_string(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.GetKeyStringRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Get the key string for an API key.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_get_key_string():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.GetKeyStringRequest(
name="name_value",
)
# Make the request
response = await client.get_key_string(request=request)
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.GetKeyStringRequest, dict]
The request object. Request message for GetKeyString method.
name
strRequired. The resource name of the API key to be retrieved. 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.
google.cloud.api_keys_v2.types.GetKeyStringResponse
Response message for GetKeyString method.
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: 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 variabel 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.
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.
google.auth.exceptions.MutualTLSChannelError
If any errors happen.
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
returns the API endpoint and the client cert source to use.
get_operation
get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the latest state of a long-running operation.
request
.operations_pb2.GetOperationRequestThe request object. Request message for GetOperation method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
.operations_pb2.OperationOperation object.
get_transport_class
get_transport_class()Returns an appropriate transport class.
key_path
key_path(project: str, location: str, key: str)Returns a fully-qualified key string.
list_keys
list_keys(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.ListKeysRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the API keys owned by a project. The key string of the API key isn't included in the response.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_list_keys():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.ListKeysRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_keys(request=request)
# Handle the response
async for response in page_result:
print(response)
request
Union[google.cloud.api_keys_v2.types.ListKeysRequest, dict]
The request object. Request message for ListKeys method.
parent
strRequired. Lists all API keys associated with this project. 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.
google.cloud.api_keys_v2.services.api_keys.pagers.ListKeysAsyncPager
Response message for ListKeys method. Iterating over this object will yield results and resolve additional pages automatically.
lookup_key
lookup_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.LookupKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Find the parent project and resource name of the API key that
matches the key string in the request. If the API key has been
purged, resource name will not be set. The service account must
have the apikeys.keys.lookup permission on the parent
project.
from google.cloud import api_keys_v2
async def sample_lookup_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.LookupKeyRequest(
key_string="key_string_value",
)
# Make the request
response = await client.lookup_key(request=request)
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.LookupKeyRequest, dict]
The request object. Request message for LookupKey method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.cloud.api_keys_v2.types.LookupKeyResponse
Response message for LookupKey method.
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_key_path
parse_key_path(path: str)Parses a key path into its component segments.
undelete_key
undelete_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.UndeleteKeyRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Undeletes an API key which was deleted within 30 days.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_undelete_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.UndeleteKeyRequest(
name="name_value",
)
# Make the request
operation = client.undelete_key(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.UndeleteKeyRequest, dict]
The request object. Request message for UndeleteKey method.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be Key The representation of a key managed by the API Keys API.
update_key
update_key(request: Optional[Union[google.cloud.api_keys_v2.types.apikeys.UpdateKeyRequest, dict]] = None, *, key: Optional[google.cloud.api_keys_v2.types.resources.Key] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Patches the modifiable fields of an API key. The key string of the API key isn't included in the response.
NOTE: Key is a global resource; hence the only supported value
for location is global.
from google.cloud import api_keys_v2
async def sample_update_key():
# Create a client
client = api_keys_v2.ApiKeysAsyncClient()
# Initialize request argument(s)
request = api_keys_v2.UpdateKeyRequest(
)
# Make the request
operation = client.update_key(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
request
Union[google.cloud.api_keys_v2.types.UpdateKeyRequest, dict]
The request object. Request message for UpdateKey method.
key
Key
Required. Set the name field to the resource name of the API key to be updated. You can update only the display_name, restrictions, and annotations fields. This corresponds to the key field on the request instance; if request is provided, this should not be set.
update_mask
google.protobuf.field_mask_pb2.FieldMaskThe field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: display_name, restrictions, and annotations. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation_async.AsyncOperation
An object representing a long-running operation. The result type for the operation will be Key The representation of a key managed by the API Keys API.