tessl/pypi-google-cloud-orchestration-airflow
Google Cloud Composer (Orchestration Airflow) API client library for managing Apache Airflow environments
—
Pending
user-workloads.mddocs/
User Workloads Management
Manage user workloads secrets and configuration maps within Cloud Composer environments for secure handling of sensitive data, configuration parameters, and runtime settings.
Capabilities
User Workloads Secrets
Create, read, update, and delete secrets for user workloads within Cloud Composer environments.
def create_user_workloads_secret(
self,
request: CreateUserWorkloadsSecretRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsSecret:
"""
Create a user workloads secret.
Parameters:
request (CreateUserWorkloadsSecretRequest): Required. Request object containing environment parent and secret configuration.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsSecret: Created secret with metadata and data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def get_user_workloads_secret(
self,
request: GetUserWorkloadsSecretRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsSecret:
"""
Get a user workloads secret.
Parameters:
request (GetUserWorkloadsSecretRequest): Required. Request object containing secret name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsSecret: Secret details including data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def list_user_workloads_secrets(
self,
request: ListUserWorkloadsSecretsRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> pagers.ListUserWorkloadsSecretsPager:
"""
List user workloads secrets in an environment.
Parameters:
request (ListUserWorkloadsSecretsRequest): Required. Request object containing environment parent and pagination options.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
pagers.ListUserWorkloadsSecretsPager: Paginated list of secrets.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def update_user_workloads_secret(
self,
request: UpdateUserWorkloadsSecretRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsSecret:
"""
Update a user workloads secret.
Parameters:
request (UpdateUserWorkloadsSecretRequest): Required. Request object containing secret and field mask.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsSecret: Updated secret with new data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def delete_user_workloads_secret(
self,
request: DeleteUserWorkloadsSecretRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> None:
"""
Delete a user workloads secret.
Parameters:
request (DeleteUserWorkloadsSecretRequest): Required. Request object containing secret name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
None
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""User Workloads Config Maps
Create, read, update, and delete configuration maps for user workloads within Cloud Composer environments.
def create_user_workloads_config_map(
self,
request: CreateUserWorkloadsConfigMapRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsConfigMap:
"""
Create a user workloads config map.
Parameters:
request (CreateUserWorkloadsConfigMapRequest): Required. Request object containing environment parent and config map configuration.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsConfigMap: Created config map with metadata and data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def get_user_workloads_config_map(
self,
request: GetUserWorkloadsConfigMapRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsConfigMap:
"""
Get a user workloads config map.
Parameters:
request (GetUserWorkloadsConfigMapRequest): Required. Request object containing config map name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsConfigMap: Config map details including data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def list_user_workloads_config_maps(
self,
request: ListUserWorkloadsConfigMapsRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> pagers.ListUserWorkloadsConfigMapsPager:
"""
List user workloads config maps in an environment.
Parameters:
request (ListUserWorkloadsConfigMapsRequest): Required. Request object containing environment parent and pagination options.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
pagers.ListUserWorkloadsConfigMapsPager: Paginated list of config maps.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def update_user_workloads_config_map(
self,
request: UpdateUserWorkloadsConfigMapRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> UserWorkloadsConfigMap:
"""
Update a user workloads config map.
Parameters:
request (UpdateUserWorkloadsConfigMapRequest): Required. Request object containing config map and field mask.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
UserWorkloadsConfigMap: Updated config map with new data.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""
def delete_user_workloads_config_map(
self,
request: DeleteUserWorkloadsConfigMapRequest,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = ()
) -> None:
"""
Delete a user workloads config map.
Parameters:
request (DeleteUserWorkloadsConfigMapRequest): Required. Request object containing config map name.
retry (OptionalRetry): Retry configuration for the request.
timeout (float): Request timeout in seconds.
metadata (Sequence[Tuple[str, str]]): Additional gRPC metadata.
Returns:
None
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request fails.
"""Usage Examples
from google.cloud.orchestration.airflow.service import EnvironmentsClient
# Initialize client
client = EnvironmentsClient()
# Create a secret for database credentials
project_id = "your-project-id"
location = "us-central1"
environment_id = "my-environment"
parent = f"projects/{project_id}/locations/{location}/environments/{environment_id}"
# Create secret
secret_request = {
"parent": parent,
"user_workloads_secret": {
"name": f"{parent}/userWorkloadsSecrets/db-credentials",
"data": {
"username": b"db_user",
"password": b"secure_password"
}
}
}
secret = client.create_user_workloads_secret(request=secret_request)
print(f"Created secret: {secret.name}")
# Create config map for application settings
config_map_request = {
"parent": parent,
"user_workloads_config_map": {
"name": f"{parent}/userWorkloadsConfigMaps/app-config",
"data": {
"debug_mode": "false",
"log_level": "INFO",
"max_workers": "10"
}
}
}
config_map = client.create_user_workloads_config_map(request=config_map_request)
print(f"Created config map: {config_map.name}")
# List all secrets
list_secrets_request = {"parent": parent}
secrets_page = client.list_user_workloads_secrets(request=list_secrets_request)
for secret in secrets_page:
print(f"Secret: {secret.name}")
print(f"Keys: {list(secret.data.keys())}")Request/Response Types
Secret Request Types
class CreateUserWorkloadsSecretRequest:
"""
Request to create a user workloads secret.
Attributes:
parent (str): Required. Environment resource name (projects/{project}/locations/{location}/environments/{environment})
user_workloads_secret (UserWorkloadsSecret): Required. Secret to create
"""
class GetUserWorkloadsSecretRequest:
"""
Request to get a user workloads secret.
Attributes:
name (str): Required. Secret resource name
"""
class ListUserWorkloadsSecretsRequest:
"""
Request to list user workloads secrets.
Attributes:
parent (str): Required. Environment resource name
page_size (int): Optional. Maximum number of secrets to return per page
page_token (str): Optional. Token for pagination
"""
class UpdateUserWorkloadsSecretRequest:
"""
Request to update a user workloads secret.
Attributes:
user_workloads_secret (UserWorkloadsSecret): Required. Secret with updated data
"""
class DeleteUserWorkloadsSecretRequest:
"""
Request to delete a user workloads secret.
Attributes:
name (str): Required. Secret resource name to delete
"""Config Map Request Types
class CreateUserWorkloadsConfigMapRequest:
"""
Request to create a user workloads config map.
Attributes:
parent (str): Required. Environment resource name (projects/{project}/locations/{location}/environments/{environment})
user_workloads_config_map (UserWorkloadsConfigMap): Required. Config map to create
"""
class GetUserWorkloadsConfigMapRequest:
"""
Request to get a user workloads config map.
Attributes:
name (str): Required. Config map resource name
"""
class ListUserWorkloadsConfigMapsRequest:
"""
Request to list user workloads config maps.
Attributes:
parent (str): Required. Environment resource name
page_size (int): Optional. Maximum number of config maps to return per page
page_token (str): Optional. Token for pagination
"""
class UpdateUserWorkloadsConfigMapRequest:
"""
Request to update a user workloads config map.
Attributes:
user_workloads_config_map (UserWorkloadsConfigMap): Required. Config map with updated data
"""
class DeleteUserWorkloadsConfigMapRequest:
"""
Request to delete a user workloads config map.
Attributes:
name (str): Required. Config map resource name to delete
"""Response Types
class ListUserWorkloadsSecretsResponse:
"""
Response containing user workloads secrets.
Attributes:
user_workloads_secrets (MutableSequence[UserWorkloadsSecret]): List of secrets
next_page_token (str): Token for retrieving next page of results
"""
class ListUserWorkloadsConfigMapsResponse:
"""
Response containing user workloads config maps.
Attributes:
user_workloads_config_maps (MutableSequence[UserWorkloadsConfigMap]): List of config maps
next_page_token (str): Token for retrieving next page of results
"""Data Types
class UserWorkloadsSecret:
"""
User workloads secret stored in an environment.
Attributes:
name (str): Secret resource name
data (MutableMapping[str, bytes]): Secret data as key-value pairs with binary values
"""
class UserWorkloadsConfigMap:
"""
User workloads config map stored in an environment.
Attributes:
name (str): Config map resource name
data (MutableMapping[str, str]): Config data as key-value pairs with string values
"""Install with Tessl CLI
npx tessl i tessl/pypi-google-cloud-orchestration-airflow