Package Methods (2.22.0)

Summary of entries of Methods for cloudkms.

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient

  EkmServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 transports 
 . 
 base 
 . 
 EkmServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 transports 
 . 
 base 
 . 
 EkmServiceTransport 
 ]]] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the ekm service async client.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified billing_account string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_billing_account_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified organization string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_organization_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.create_ekm_connection

  create_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 CreateEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ekm_connection_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ekm_connection 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

Creates a new xref_EkmConnection in a given Project and Location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.create_ekm_connection

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.ekm_config_path

  ekm_config_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified ekm_config string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.ekm_config_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.ekm_connection_path

  ekm_connection_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 ekm_connection 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified ekm_connection string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.ekm_connection_path

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

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.from_service_account_json

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_ekm_config

  get_ekm_config 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 GetEkmConfigRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 

Returns the xref_EkmConfig singleton resource for a given project and location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_ekm_config

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_ekm_connection

  get_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 GetEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

Returns metadata for a given xref_EkmConnection.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_ekm_connection

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Gets the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_iam_policy

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.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.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_operation

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.get_transport_class

  get_transport_class 
 () 
 - 
> ( 
 typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 transports 
 . 
 base 
 . 
 EkmServiceTransport 
 ] 
 ) 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.list_ekm_connections

  list_ekm_connections 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 pagers 
 . 
 ListEkmConnectionsAsyncPager 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.list_locations

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_billing_account_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a folder path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_folder_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a location path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_location_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_organization_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a project path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_common_project_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_ekm_config_path

  parse_ekm_config_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a ekm_config path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_ekm_config_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_ekm_connection_path

  parse_ekm_connection_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a ekm_connection path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_ekm_connection_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_service_path

  parse_service_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a service path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.parse_service_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.service_path

  service_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 namespace 
 : 
 str 
 , 
 service 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified service string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.service_path

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Sets the IAM access control policy on the specified function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.set_iam_policy

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsResponse 
 

Tests the specified permissions against the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.test_iam_permissions

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.update_ekm_config

  update_ekm_config 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 UpdateEkmConfigRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 ekm_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 

Updates the xref_EkmConfig singleton resource for a given project and location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.update_ekm_config

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.update_ekm_connection

  update_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 UpdateEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 ekm_connection 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.verify_connectivity

  verify_connectivity 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 VerifyConnectivityRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 VerifyConnectivityResponse 
 

Verifies that Cloud KMS can successfully connect to the external key manager specified by an xref_EkmConnection.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceAsyncClient.verify_connectivity

google.cloud.kms_v1.services.ekm_service.EkmServiceClient

  EkmServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 transports 
 . 
 base 
 . 
 EkmServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 transports 
 . 
 base 
 . 
 EkmServiceTransport 
 ]]] 
 = 
 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 
 = 
 

Instantiates the ekm service client.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

Releases underlying transport's resources.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient. exit

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified billing_account string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_billing_account_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified folder string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_folder_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified location string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_location_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified organization string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_organization_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified project string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.common_project_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.create_ekm_connection

  create_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 CreateEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ekm_connection_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ekm_connection 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

Creates a new xref_EkmConnection in a given Project and Location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.create_ekm_connection

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.ekm_config_path

  ekm_config_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified ekm_config string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.ekm_config_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.ekm_connection_path

  ekm_connection_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 ekm_connection 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified ekm_connection string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.ekm_connection_path

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

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.from_service_account_info

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

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

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.from_service_account_json

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_ekm_config

  get_ekm_config 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 GetEkmConfigRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 

Returns the xref_EkmConfig singleton resource for a given project and location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_ekm_config

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_ekm_connection

  get_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 GetEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

Returns metadata for a given xref_EkmConnection.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_ekm_connection

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Gets the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_iam_policy

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

Gets information about a location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_location

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.get_operation

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.list_ekm_connections

  list_ekm_connections 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 ekm_service 
 . 
 pagers 
 . 
 ListEkmConnectionsPager 
 

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.list_locations

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a billing_account path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_billing_account_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a folder path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_folder_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a location path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_location_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a organization path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_organization_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parse a project path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_common_project_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_ekm_config_path

  parse_ekm_config_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a ekm_config path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_ekm_config_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_ekm_connection_path

  parse_ekm_connection_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a ekm_connection path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_ekm_connection_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_service_path

  parse_service_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a service path into its component segments.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.parse_service_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.service_path

  service_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 namespace 
 : 
 str 
 , 
 service 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified service string.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.service_path

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Sets the IAM access control policy on the specified function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.set_iam_policy

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsResponse 
 

Tests the specified IAM permissions against the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.test_iam_permissions

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.update_ekm_config

  update_ekm_config 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 UpdateEkmConfigRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 ekm_config 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConfig 
 

Updates the xref_EkmConfig singleton resource for a given project and location.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.update_ekm_config

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.update_ekm_connection

  update_ekm_connection 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 UpdateEkmConnectionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 ekm_connection 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 EkmConnection 
 

Updates an xref_EkmConnection's metadata.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.update_ekm_connection

google.cloud.kms_v1.services.ekm_service.EkmServiceClient.verify_connectivity

  verify_connectivity 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 VerifyConnectivityRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 VerifyConnectivityResponse 
 

Verifies that Cloud KMS can successfully connect to the external key manager specified by an xref_EkmConnection.

See more: google.cloud.kms_v1.services.ekm_service.EkmServiceClient.verify_connectivity

google.cloud.kms_v1.services.ekm_service.pagers.ListEkmConnectionsAsyncPager

  ListEkmConnectionsAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.ekm_service.pagers.ListEkmConnectionsPager

  ListEkmConnectionsPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 ekm_service 
 . 
 ListEkmConnectionsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient

  KeyManagementServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 transports 
 . 
 base 
 . 
 KeyManagementServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 transports 
 . 
 base 
 . 
 KeyManagementServiceTransport 
 ]]] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

Instantiates the key management service async client.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.asymmetric_decrypt

  asymmetric_decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricDecryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ciphertext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricDecryptResponse 
 

Decrypts data that was encrypted with a public key retrieved from xref_GetPublicKey corresponding to a xref_CryptoKeyVersion with xref_CryptoKey.purpose ASYMMETRIC_DECRYPT.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.asymmetric_decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.asymmetric_sign

  asymmetric_sign 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricSignRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 digest 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 Digest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricSignResponse 
 

Signs data using a xref_CryptoKeyVersion with xref_CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from xref_GetPublicKey.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.asymmetric_sign

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.create_crypto_key

  create_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.create_crypto_key_version

  create_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_version 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.create_import_job

  create_import_job 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateImportJobRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 import_job_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 import_job 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.create_key_ring

  create_key_ring 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateKeyRingRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 key_ring_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 key_ring 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 

Create a new xref_KeyRing in a given Project and Location.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.create_key_ring

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.crypto_key_path

  crypto_key_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.crypto_key_version_path

  crypto_key_version_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 , 
 crypto_key_version 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.decrypt

  decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DecryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ciphertext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DecryptResponse 
 

Decrypts data that was protected by xref_Encrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.destroy_crypto_key_version

  destroy_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DestroyCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.encrypt

  encrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 EncryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 plaintext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 EncryptResponse 
 

Encrypts data, so that it can only be recovered by a call to xref_Decrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.encrypt

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

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.from_service_account_json

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.generate_random_bytes

  generate_random_bytes 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GenerateRandomBytesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 location 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 length_bytes 
 : 
 typing 
 . 
 Optional 
 [ 
 int 
 ] 
 = 
 None 
 , 
 protection_level 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ProtectionLevel 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GenerateRandomBytesResponse 
 

Generate random bytes using the Cloud KMS randomness source in the provided location.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.generate_random_bytes

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_crypto_key

  get_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

Returns metadata for a given xref_CryptoKey, as well as its xref_primary xref_CryptoKeyVersion.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_crypto_key

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_crypto_key_version

  get_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_import_job

  get_import_job 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetImportJobRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_key_ring

  get_key_ring 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetKeyRingRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_public_key

  get_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 PublicKey 
 

Returns the public key for the given xref_CryptoKeyVersion.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_public_key

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.get_transport_class

  get_transport_class 
 () 
 - 
> ( 
 typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 transports 
 . 
 base 
 . 
 KeyManagementServiceTransport 
 ] 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.import_crypto_key_version

  import_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ImportCryptoKeyVersionRequest 
 , 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.import_job_path

  import_job_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 import_job 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.key_ring_path

  key_ring_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.list_crypto_key_versions

  list_crypto_key_versions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListCryptoKeyVersionsAsyncPager 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.list_crypto_keys

  list_crypto_keys 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListCryptoKeysAsyncPager 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.list_import_jobs

  list_import_jobs 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListImportJobsAsyncPager 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.list_key_rings

  list_key_rings 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListKeyRingsAsyncPager 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.list_locations

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.mac_sign

  mac_sign 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacSignRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacSignResponse 
 

Signs data using a xref_CryptoKeyVersion with xref_CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.mac_sign

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.mac_verify

  mac_verify 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacVerifyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 mac 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacVerifyResponse 
 

Verifies MAC tag using a xref_CryptoKeyVersion with xref_CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.mac_verify

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_crypto_key_path

  parse_crypto_key_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_crypto_key_version_path

  parse_crypto_key_version_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_import_job_path

  parse_import_job_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_key_ring_path

  parse_key_ring_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.parse_public_key_path

  parse_public_key_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.public_key_path

  public_key_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 , 
 crypto_key_version 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.raw_decrypt

  raw_decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawDecryptRequest 
 , 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawDecryptResponse 
 

Decrypts data that was originally encrypted using a raw cryptographic mechanism.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.raw_decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.raw_encrypt

  raw_encrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawEncryptRequest 
 , 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawEncryptResponse 
 

Encrypts data using portable cryptographic primitives.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.raw_encrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.restore_crypto_key_version

  restore_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RestoreCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

Restore a xref_CryptoKeyVersion in the xref_DESTROY_SCHEDULED state.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.restore_crypto_key_version

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Sets the IAM access control policy on the specified function.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.set_iam_policy

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsResponse 
 

Tests the specified permissions against the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.test_iam_permissions

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.update_crypto_key

  update_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 crypto_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.update_crypto_key_primary_version

  update_crypto_key_primary_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyPrimaryVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_version_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

Update the version of a xref_CryptoKey that will be used in xref_Encrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.update_crypto_key_primary_version

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceAsyncClient.update_crypto_key_version

  update_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 crypto_key_version 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 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 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient

  KeyManagementServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 transports 
 . 
 base 
 . 
 KeyManagementServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 transports 
 . 
 base 
 . 
 KeyManagementServiceTransport 
 ]]] 
 = 
 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 
 = 
 

Instantiates the key management service client.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.asymmetric_decrypt

  asymmetric_decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricDecryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ciphertext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricDecryptResponse 
 

Decrypts data that was encrypted with a public key retrieved from xref_GetPublicKey corresponding to a xref_CryptoKeyVersion with xref_CryptoKey.purpose ASYMMETRIC_DECRYPT.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.asymmetric_decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.asymmetric_sign

  asymmetric_sign 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricSignRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 digest 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 Digest 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 AsymmetricSignResponse 
 

Signs data using a xref_CryptoKeyVersion with xref_CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from xref_GetPublicKey.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.asymmetric_sign

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.create_crypto_key

  create_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.create_crypto_key_version

  create_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_version 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.create_import_job

  create_import_job 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateImportJobRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 import_job_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 import_job 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.create_key_ring

  create_key_ring 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 CreateKeyRingRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 key_ring_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 key_ring 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 

Create a new xref_KeyRing in a given Project and Location.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.create_key_ring

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.crypto_key_path

  crypto_key_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.crypto_key_version_path

  crypto_key_version_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 , 
 crypto_key_version 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.decrypt

  decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DecryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ciphertext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DecryptResponse 
 

Decrypts data that was protected by xref_Encrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.destroy_crypto_key_version

  destroy_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 DestroyCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.encrypt

  encrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 EncryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 plaintext 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 EncryptResponse 
 

Encrypts data, so that it can only be recovered by a call to xref_Decrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.encrypt

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

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.from_service_account_info

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

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

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.from_service_account_json

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.generate_random_bytes

  generate_random_bytes 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GenerateRandomBytesRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 location 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 length_bytes 
 : 
 typing 
 . 
 Optional 
 [ 
 int 
 ] 
 = 
 None 
 , 
 protection_level 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ProtectionLevel 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GenerateRandomBytesResponse 
 

Generate random bytes using the Cloud KMS randomness source in the provided location.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.generate_random_bytes

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_crypto_key

  get_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

Returns metadata for a given xref_CryptoKey, as well as its xref_primary xref_CryptoKeyVersion.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_crypto_key

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_crypto_key_version

  get_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Gets the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_iam_policy

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_import_job

  get_import_job 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetImportJobRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 ImportJob 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_key_ring

  get_key_ring 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetKeyRingRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 KeyRing 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 Location 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

Gets the latest state of a long-running operation.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_operation

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_public_key

  get_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 GetPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 PublicKey 
 

Returns the public key for the given xref_CryptoKeyVersion.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.get_public_key

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.import_crypto_key_version

  import_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ImportCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

Import wrapped key material into a xref_CryptoKeyVersion.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.import_crypto_key_version

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.import_job_path

  import_job_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 import_job 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.key_ring_path

  key_ring_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.list_crypto_key_versions

  list_crypto_key_versions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> ( 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListCryptoKeyVersionsPager 
 ) 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.list_crypto_keys

  list_crypto_keys 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListCryptoKeysPager 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.list_import_jobs

  list_import_jobs 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListImportJobsPager 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.list_key_rings

  list_key_rings 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 services 
 . 
 key_management_service 
 . 
 pagers 
 . 
 ListKeyRingsPager 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.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 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsResponse 
 

Lists information about the supported locations for this service.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.list_locations

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.mac_sign

  mac_sign 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacSignRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacSignResponse 
 

Signs data using a xref_CryptoKeyVersion with xref_CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.mac_sign

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.mac_verify

  mac_verify 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacVerifyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 data 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 mac 
 : 
 typing 
 . 
 Optional 
 [ 
 bytes 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 MacVerifyResponse 
 

Verifies MAC tag using a xref_CryptoKeyVersion with xref_CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.mac_verify

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_crypto_key_path

  parse_crypto_key_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_crypto_key_version_path

  parse_crypto_key_version_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a crypto_key_version path into its component segments.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_crypto_key_version_path

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_import_job_path

  parse_import_job_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_key_ring_path

  parse_key_ring_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.parse_public_key_path

  parse_public_key_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.public_key_path

  public_key_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 , 
 crypto_key_version 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.raw_decrypt

  raw_decrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawDecryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawDecryptResponse 
 

Decrypts data that was originally encrypted using a raw cryptographic mechanism.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.raw_decrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.raw_encrypt

  raw_encrypt 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawEncryptRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RawEncryptResponse 
 

Encrypts data using portable cryptographic primitives.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.raw_encrypt

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.restore_crypto_key_version

  restore_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 RestoreCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

Restore a xref_CryptoKeyVersion in the xref_DESTROY_SCHEDULED state.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.restore_crypto_key_version

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 policy_pb2 
 . 
 Policy 
 

Sets the IAM access control policy on the specified function.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.set_iam_policy

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsResponse 
 

Tests the specified IAM permissions against the IAM access control policy for a function.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.test_iam_permissions

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.update_crypto_key

  update_crypto_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 crypto_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.update_crypto_key_primary_version

  update_crypto_key_primary_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyPrimaryVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 crypto_key_version_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKey 
 

Update the version of a xref_CryptoKey that will be used in xref_Encrypt.

See more: google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.update_crypto_key_primary_version

google.cloud.kms_v1.services.key_management_service.KeyManagementServiceClient.update_crypto_key_version

  update_crypto_key_version 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 UpdateCryptoKeyVersionRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 crypto_key_version 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 resources 
 . 
 CryptoKeyVersion 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListCryptoKeyVersionsAsyncPager

  ListCryptoKeyVersionsAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListCryptoKeyVersionsPager

  ListCryptoKeyVersionsPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeyVersionsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListCryptoKeysAsyncPager

  ListCryptoKeysAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListCryptoKeysPager

  ListCryptoKeysPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListCryptoKeysResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListImportJobsAsyncPager

  ListImportJobsAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsResponse 
 ], 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListImportJobsPager

  ListImportJobsPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListImportJobsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListKeyRingsAsyncPager

  ListKeyRingsAsyncPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 typing 
 . 
 Awaitable 
 [ 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsResponse 
 ] 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 

google.cloud.kms_v1.services.key_management_service.pagers.ListKeyRingsPager

  ListKeyRingsPager 
 ( 
 method 
 : 
 typing 
 . 
 Callable 
 [ 
 [ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsResponse 
 ], 
 request 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsRequest 
 , 
 response 
 : 
 google 
 . 
 cloud 
 . 
 kms_v1 
 . 
 types 
 . 
 service 
 . 
 ListKeyRingsResponse 
 , 
 * 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 () 
 ) 
 
Create a Mobile Website
View Site in Mobile | Classic
Share by: