Package Methods (2.15.1)

Summary of entries of Methods for oslogin.

  OsLoginServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 services 
 . 
 os_login_service 
 . 
 transports 
 . 
 base 
 . 
 OsLoginServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 services 
 . 
 os_login_service 
 . 
 transports 
 . 
 base 
 . 
 OsLoginServiceTransport 
 ]]] 
 = 
 '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 os login service async client.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 
  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 
  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 
  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 
  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 
  create_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 CreateSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 
  delete_posix_account 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 DeletePosixAccountRequest 
 , 
 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 
 ]] 
 = 
 () 
 ) 
 - 
> None 
 
  delete_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 DeleteSshPublicKeyRequest 
 , 
 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 
 ]] 
 = 
 () 
 ) 
 - 
> None 
 
  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.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.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.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.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.from_service_account_json

  get_login_profile 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 GetLoginProfileRequest 
 , 
 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 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 LoginProfile 
 

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.get_login_profile

  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.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.get_mtls_endpoint_and_cert_source

  get_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 GetSshPublicKeyRequest 
 , 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 
  get_transport_class 
 ( 
 label 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ) 
 - 
> typing 
 . 
 Type 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 services 
 . 
 os_login_service 
 . 
 transports 
 . 
 base 
 . 
 OsLoginServiceTransport 
 ] 
 
  import_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 ImportSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 None 
 , 
 project_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 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 ImportSshPublicKeyResponse 
 

Adds an SSH public key and returns the profile information.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.import_ssh_public_key

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_posix_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a posix_account path into its component segments.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.parse_posix_account_path

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

Parses a ssh_public_key path into its component segments.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.parse_ssh_public_key_path

  posix_account_path 
 ( 
 user 
 : 
 str 
 , 
 project 
 : 
 str 
 ) 
 - 
> str 
 
  ssh_public_key_path 
 ( 
 user 
 : 
 str 
 , 
 fingerprint 
 : 
 str 
 ) 
 - 
> str 
 
  update_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 UpdateSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 

Updates an SSH public key and returns the profile information.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceAsyncClient.update_ssh_public_key

  OsLoginServiceClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 services 
 . 
 os_login_service 
 . 
 transports 
 . 
 base 
 . 
 OsLoginServiceTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 services 
 . 
 os_login_service 
 . 
 transports 
 . 
 base 
 . 
 OsLoginServiceTransport 
 ]]] 
 = 
 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 os login service client.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

Releases underlying transport's resources.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient. exit

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 
  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 
  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 
  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 
  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 
  create_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 CreateSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 
  delete_posix_account 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 DeletePosixAccountRequest 
 , 
 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 
 ]] 
 = 
 () 
 ) 
 - 
> None 
 
  delete_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 DeleteSshPublicKeyRequest 
 , 
 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 
 ]] 
 = 
 () 
 ) 
 - 
> None 
 
  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

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

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.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.oslogin_v1.services.os_login_service.OsLoginServiceClient.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.oslogin_v1.services.os_login_service.OsLoginServiceClient.from_service_account_json

  get_login_profile 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 GetLoginProfileRequest 
 , 
 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 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 LoginProfile 
 

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.get_login_profile

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 
  get_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 GetSshPublicKeyRequest 
 , 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 
  import_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 ImportSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 None 
 , 
 project_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 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 ImportSshPublicKeyResponse 
 

Adds an SSH public key and returns the profile information.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.import_ssh_public_key

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

Parse a billing_account path into its component segments.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.parse_common_billing_account_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
  parse_posix_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

Parses a posix_account path into its component segments.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.parse_posix_account_path

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

Parses a ssh_public_key path into its component segments.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.parse_ssh_public_key_path

  posix_account_path 
 ( 
 user 
 : 
 str 
 , 
 project 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified posix_account string.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.posix_account_path

  ssh_public_key_path 
 ( 
 user 
 : 
 str 
 , 
 fingerprint 
 : 
 str 
 ) 
 - 
> str 
 

Returns a fully-qualified ssh_public_key string.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.ssh_public_key_path

  update_ssh_public_key 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 types 
 . 
 oslogin 
 . 
 UpdateSshPublicKeyRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 ssh_public_key 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 ] 
 = 
 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 
 . 
 oslogin_v1 
 . 
 common 
 . 
 types 
 . 
 common 
 . 
 SshPublicKey 
 

Updates an SSH public key and returns the profile information.

See more: google.cloud.oslogin_v1.services.os_login_service.OsLoginServiceClient.update_ssh_public_key

Design a Mobile Site
View Site in Mobile | Classic
Share by: