airflow.providers.google.cloud.hooks.os_login

Module Contents

Classes

OSLoginHook

Hook for Google OS login APIs.
class airflow.providers.google.cloud.hooks.os_login.OSLoginHook(gcp_conn_id: str = 'google_cloud_default', delegate_to: Optional[str] = None, impersonation_chain: Optional[Union[str, Sequence[str]]] = None)[source]

Bases: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

Hook for Google OS login APIs.

All the methods in the hook where project_id is used must be called with keyword arguments rather than positional.

get_conn(self) → google.cloud.oslogin_v1.OsLoginServiceClient[source]

Return OS Login service client

import_ssh_public_key(self, user: str, ssh_public_key: Dict, project_id: str = PROVIDE_PROJECT_ID, retry: Optional[google.api_core.retry.Retry] = None, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.oslogin_v1.ImportSshPublicKeyResponse[source]

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Parameters

  • user (str) -- The unique ID for the user

  • ssh_public_key (dict) -- The SSH public key and expiration time.

  • project_id (str) -- The project ID of the Google Cloud project.

  • retry (Optional[google.api_core.retry.Retry]) -- A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

  • timeout (Optional[float]) -- The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

  • metadata (Sequence[Tuple[str, str]]) -- Additional metadata that is provided to the method.

Returns

A ImportSshPublicKeyResponse instance.

Was this entry helpful?