public sealed class EnvironmentsClientImpl : EnvironmentsClientReference documentation and code samples for the Cloud Composer v1 API class EnvironmentsClientImpl.
Environments client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Orchestration.Airflow.Service.V1Assembly
Google.Cloud.Orchestration.Airflow.Service.V1.dll
Remarks
Managed Apache Airflow Environments.
Constructors
EnvironmentsClientImpl(EnvironmentsClient, EnvironmentsSettings, ILogger)
public EnvironmentsClientImpl(Environments.EnvironmentsClient grpcClient, EnvironmentsSettings settings, ILogger logger)Constructs a client wrapper for the Environments service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | EnvironmentsEnvironmentsClientThe underlying gRPC client. |
settings | EnvironmentsSettingsThe base EnvironmentsSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CreateEnvironmentOperationsClient
public override OperationsClient CreateEnvironmentOperationsClient { get; }The long-running operations client for CreateEnvironment.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DatabaseFailoverOperationsClient
public override OperationsClient DatabaseFailoverOperationsClient { get; }The long-running operations client for DatabaseFailover.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteEnvironmentOperationsClient
public override OperationsClient DeleteEnvironmentOperationsClient { get; }The long-running operations client for DeleteEnvironment.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override Environments.EnvironmentsClient GrpcClient { get; }The underlying gRPC Environments client
| Property Value | |
|---|---|
| Type | Description |
EnvironmentsEnvironmentsClient | |
LoadSnapshotOperationsClient
public override OperationsClient LoadSnapshotOperationsClient { get; }The long-running operations client for LoadSnapshot.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SaveSnapshotOperationsClient
public override OperationsClient SaveSnapshotOperationsClient { get; }The long-running operations client for SaveSnapshot.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateEnvironmentOperationsClient
public override OperationsClient UpdateEnvironmentOperationsClient { get; }The long-running operations client for UpdateEnvironment.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallSettings)
public override Operation<Environment, OperationMetadata> CreateEnvironment(CreateEnvironmentRequest request, CallSettings callSettings = null)Create a new environment.
| Parameters | |
|---|---|
| Name | Description |
request | CreateEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEnvironmentOperationMetadata | The RPC response. |
CreateEnvironmentAsync(CreateEnvironmentRequest, CallSettings)
public override Task<Operation<Environment, OperationMetadata>> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallSettings callSettings = null)Create a new environment.
| Parameters | |
|---|---|
| Name | Description |
request | CreateEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEnvironmentOperationMetadata | A Task containing the RPC response. |
CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest, CallSettings)
public override UserWorkloadsConfigMap CreateUserWorkloadsConfigMap(CreateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Creates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | CreateUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsConfigMap | The RPC response. |
CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest, CallSettings)
public override Task<UserWorkloadsConfigMap> CreateUserWorkloadsConfigMapAsync(CreateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Creates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | CreateUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsConfigMap | A Task containing the RPC response. |
CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest, CallSettings)
public override UserWorkloadsSecret CreateUserWorkloadsSecret(CreateUserWorkloadsSecretRequest request, CallSettings callSettings = null)Creates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | CreateUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsSecret | The RPC response. |
CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest, CallSettings)
public override Task<UserWorkloadsSecret> CreateUserWorkloadsSecretAsync(CreateUserWorkloadsSecretRequest request, CallSettings callSettings = null)Creates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | CreateUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsSecret | A Task containing the RPC response. |
DatabaseFailover(DatabaseFailoverRequest, CallSettings)
public override Operation<DatabaseFailoverResponse, OperationMetadata> DatabaseFailover(DatabaseFailoverRequest request, CallSettings callSettings = null)Triggers database failover (only for highly resilient environments).
| Parameters | |
|---|---|
| Name | Description |
request | DatabaseFailoverRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationDatabaseFailoverResponseOperationMetadata | The RPC response. |
DatabaseFailoverAsync(DatabaseFailoverRequest, CallSettings)
public override Task<Operation<DatabaseFailoverResponse, OperationMetadata>> DatabaseFailoverAsync(DatabaseFailoverRequest request, CallSettings callSettings = null)Triggers database failover (only for highly resilient environments).
| Parameters | |
|---|---|
| Name | Description |
request | DatabaseFailoverRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationDatabaseFailoverResponseOperationMetadata | A Task containing the RPC response. |
DeleteEnvironment(DeleteEnvironmentRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteEnvironment(DeleteEnvironmentRequest request, CallSettings callSettings = null)Delete an environment.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallSettings callSettings = null)Delete an environment.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest, CallSettings)
public override void DeleteUserWorkloadsConfigMap(DeleteUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Deletes a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest, CallSettings)
public override Task DeleteUserWorkloadsConfigMapAsync(DeleteUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Deletes a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest, CallSettings)
public override void DeleteUserWorkloadsSecret(DeleteUserWorkloadsSecretRequest request, CallSettings callSettings = null)Deletes a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest, CallSettings)
public override Task DeleteUserWorkloadsSecretAsync(DeleteUserWorkloadsSecretRequest request, CallSettings callSettings = null)Deletes a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
ExecuteAirflowCommand(ExecuteAirflowCommandRequest, CallSettings)
public override ExecuteAirflowCommandResponse ExecuteAirflowCommand(ExecuteAirflowCommandRequest request, CallSettings callSettings = null)Executes Airflow CLI command.
| Parameters | |
|---|---|
| Name | Description |
request | ExecuteAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ExecuteAirflowCommandResponse | The RPC response. |
ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, CallSettings)
public override Task<ExecuteAirflowCommandResponse> ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest request, CallSettings callSettings = null)Executes Airflow CLI command.
| Parameters | |
|---|---|
| Name | Description |
request | ExecuteAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskExecuteAirflowCommandResponse | A Task containing the RPC response. |
FetchDatabaseProperties(FetchDatabasePropertiesRequest, CallSettings)
public override FetchDatabasePropertiesResponse FetchDatabaseProperties(FetchDatabasePropertiesRequest request, CallSettings callSettings = null)Fetches database properties.
| Parameters | |
|---|---|
| Name | Description |
request | FetchDatabasePropertiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
FetchDatabasePropertiesResponse | The RPC response. |
FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, CallSettings)
public override Task<FetchDatabasePropertiesResponse> FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest request, CallSettings callSettings = null)Fetches database properties.
| Parameters | |
|---|---|
| Name | Description |
request | FetchDatabasePropertiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskFetchDatabasePropertiesResponse | A Task containing the RPC response. |
GetEnvironment(GetEnvironmentRequest, CallSettings)
public override Environment GetEnvironment(GetEnvironmentRequest request, CallSettings callSettings = null)Get an existing environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Environment | The RPC response. |
GetEnvironmentAsync(GetEnvironmentRequest, CallSettings)
public override Task<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallSettings callSettings = null)Get an existing environment.
| Parameters | |
|---|---|
| Name | Description |
request | GetEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskEnvironment | A Task containing the RPC response. |
GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest, CallSettings)
public override UserWorkloadsConfigMap GetUserWorkloadsConfigMap(GetUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Gets an existing user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | GetUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsConfigMap | The RPC response. |
GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest, CallSettings)
public override Task<UserWorkloadsConfigMap> GetUserWorkloadsConfigMapAsync(GetUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Gets an existing user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | GetUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsConfigMap | A Task containing the RPC response. |
GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest, CallSettings)
public override UserWorkloadsSecret GetUserWorkloadsSecret(GetUserWorkloadsSecretRequest request, CallSettings callSettings = null)Gets an existing user workloads Secret. Values of the "data" field in the response are cleared.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | GetUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsSecret | The RPC response. |
GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest, CallSettings)
public override Task<UserWorkloadsSecret> GetUserWorkloadsSecretAsync(GetUserWorkloadsSecretRequest request, CallSettings callSettings = null)Gets an existing user workloads Secret. Values of the "data" field in the response are cleared.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | GetUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsSecret | A Task containing the RPC response. |
ListEnvironments(ListEnvironmentsRequest, CallSettings)
public override PagedEnumerable<ListEnvironmentsResponse, Environment> ListEnvironments(ListEnvironmentsRequest request, CallSettings callSettings = null)List environments.
| Parameters | |
|---|---|
| Name | Description |
request | ListEnvironmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListEnvironmentsResponseEnvironment | A pageable sequence of Environment resources. |
ListEnvironmentsAsync(ListEnvironmentsRequest, CallSettings)
public override PagedAsyncEnumerable<ListEnvironmentsResponse, Environment> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallSettings callSettings = null)List environments.
| Parameters | |
|---|---|
| Name | Description |
request | ListEnvironmentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListEnvironmentsResponseEnvironment | A pageable asynchronous sequence of Environment resources. |
ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest, CallSettings)
public override PagedEnumerable<ListUserWorkloadsConfigMapsResponse, UserWorkloadsConfigMap> ListUserWorkloadsConfigMaps(ListUserWorkloadsConfigMapsRequest request, CallSettings callSettings = null)Lists user workloads ConfigMaps.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListUserWorkloadsConfigMapsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListUserWorkloadsConfigMapsResponseUserWorkloadsConfigMap | A pageable sequence of UserWorkloadsConfigMap resources. |
ListUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest, CallSettings)
public override PagedAsyncEnumerable<ListUserWorkloadsConfigMapsResponse, UserWorkloadsConfigMap> ListUserWorkloadsConfigMapsAsync(ListUserWorkloadsConfigMapsRequest request, CallSettings callSettings = null)Lists user workloads ConfigMaps.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListUserWorkloadsConfigMapsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListUserWorkloadsConfigMapsResponseUserWorkloadsConfigMap | A pageable asynchronous sequence of UserWorkloadsConfigMap resources. |
ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest, CallSettings)
public override PagedEnumerable<ListUserWorkloadsSecretsResponse, UserWorkloadsSecret> ListUserWorkloadsSecrets(ListUserWorkloadsSecretsRequest request, CallSettings callSettings = null)Lists user workloads Secrets.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListUserWorkloadsSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListUserWorkloadsSecretsResponseUserWorkloadsSecret | A pageable sequence of UserWorkloadsSecret resources. |
ListUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest, CallSettings)
public override PagedAsyncEnumerable<ListUserWorkloadsSecretsResponse, UserWorkloadsSecret> ListUserWorkloadsSecretsAsync(ListUserWorkloadsSecretsRequest request, CallSettings callSettings = null)Lists user workloads Secrets.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListUserWorkloadsSecretsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListUserWorkloadsSecretsResponseUserWorkloadsSecret | A pageable asynchronous sequence of UserWorkloadsSecret resources. |
ListWorkloads(ListWorkloadsRequest, CallSettings)
public override PagedEnumerable<ListWorkloadsResponse, ListWorkloadsResponse.Types.ComposerWorkload> ListWorkloads(ListWorkloadsRequest request, CallSettings callSettings = null)Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListWorkloadsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListWorkloadsResponseListWorkloadsResponseTypesComposerWorkload | A pageable sequence of ListWorkloadsResponse.Types.ComposerWorkload resources. |
ListWorkloadsAsync(ListWorkloadsRequest, CallSettings)
public override PagedAsyncEnumerable<ListWorkloadsResponse, ListWorkloadsResponse.Types.ComposerWorkload> ListWorkloadsAsync(ListWorkloadsRequest request, CallSettings callSettings = null)Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | ListWorkloadsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListWorkloadsResponseListWorkloadsResponseTypesComposerWorkload | A pageable asynchronous sequence of ListWorkloadsResponse.Types.ComposerWorkload resources. |
LoadSnapshot(LoadSnapshotRequest, CallSettings)
public override Operation<LoadSnapshotResponse, OperationMetadata> LoadSnapshot(LoadSnapshotRequest request, CallSettings callSettings = null)Loads a snapshot of a Cloud Composer environment.
As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.
| Parameters | |
|---|---|
| Name | Description |
request | LoadSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationLoadSnapshotResponseOperationMetadata | The RPC response. |
LoadSnapshotAsync(LoadSnapshotRequest, CallSettings)
public override Task<Operation<LoadSnapshotResponse, OperationMetadata>> LoadSnapshotAsync(LoadSnapshotRequest request, CallSettings callSettings = null)Loads a snapshot of a Cloud Composer environment.
As a result of this operation, a snapshot of environment's specified in LoadSnapshotRequest is loaded into the environment.
| Parameters | |
|---|---|
| Name | Description |
request | LoadSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationLoadSnapshotResponseOperationMetadata | A Task containing the RPC response. |
PollAirflowCommand(PollAirflowCommandRequest, CallSettings)
public override PollAirflowCommandResponse PollAirflowCommand(PollAirflowCommandRequest request, CallSettings callSettings = null)Polls Airflow CLI command execution and fetches logs.
| Parameters | |
|---|---|
| Name | Description |
request | PollAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PollAirflowCommandResponse | The RPC response. |
PollAirflowCommandAsync(PollAirflowCommandRequest, CallSettings)
public override Task<PollAirflowCommandResponse> PollAirflowCommandAsync(PollAirflowCommandRequest request, CallSettings callSettings = null)Polls Airflow CLI command execution and fetches logs.
| Parameters | |
|---|---|
| Name | Description |
request | PollAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPollAirflowCommandResponse | A Task containing the RPC response. |
SaveSnapshot(SaveSnapshotRequest, CallSettings)
public override Operation<SaveSnapshotResponse, OperationMetadata> SaveSnapshot(SaveSnapshotRequest request, CallSettings callSettings = null)Creates a snapshots of a Cloud Composer environment.
As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.
| Parameters | |
|---|---|
| Name | Description |
request | SaveSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSaveSnapshotResponseOperationMetadata | The RPC response. |
SaveSnapshotAsync(SaveSnapshotRequest, CallSettings)
public override Task<Operation<SaveSnapshotResponse, OperationMetadata>> SaveSnapshotAsync(SaveSnapshotRequest request, CallSettings callSettings = null)Creates a snapshots of a Cloud Composer environment.
As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.
| Parameters | |
|---|---|
| Name | Description |
request | SaveSnapshotRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSaveSnapshotResponseOperationMetadata | A Task containing the RPC response. |
StopAirflowCommand(StopAirflowCommandRequest, CallSettings)
public override StopAirflowCommandResponse StopAirflowCommand(StopAirflowCommandRequest request, CallSettings callSettings = null)Stops Airflow CLI command execution.
| Parameters | |
|---|---|
| Name | Description |
request | StopAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
StopAirflowCommandResponse | The RPC response. |
StopAirflowCommandAsync(StopAirflowCommandRequest, CallSettings)
public override Task<StopAirflowCommandResponse> StopAirflowCommandAsync(StopAirflowCommandRequest request, CallSettings callSettings = null)Stops Airflow CLI command execution.
| Parameters | |
|---|---|
| Name | Description |
request | StopAirflowCommandRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskStopAirflowCommandResponse | A Task containing the RPC response. |
UpdateEnvironment(UpdateEnvironmentRequest, CallSettings)
public override Operation<Environment, OperationMetadata> UpdateEnvironment(UpdateEnvironmentRequest request, CallSettings callSettings = null)Update an environment.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEnvironmentOperationMetadata | The RPC response. |
UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallSettings)
public override Task<Operation<Environment, OperationMetadata>> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallSettings callSettings = null)Update an environment.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateEnvironmentRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEnvironmentOperationMetadata | A Task containing the RPC response. |
UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest, CallSettings)
public override UserWorkloadsConfigMap UpdateUserWorkloadsConfigMap(UpdateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Updates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsConfigMap | The RPC response. |
UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest, CallSettings)
public override Task<UserWorkloadsConfigMap> UpdateUserWorkloadsConfigMapAsync(UpdateUserWorkloadsConfigMapRequest request, CallSettings callSettings = null)Updates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateUserWorkloadsConfigMapRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsConfigMap | A Task containing the RPC response. |
UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest, CallSettings)
public override UserWorkloadsSecret UpdateUserWorkloadsSecret(UpdateUserWorkloadsSecretRequest request, CallSettings callSettings = null)Updates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
UserWorkloadsSecret | The RPC response. |
UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest, CallSettings)
public override Task<UserWorkloadsSecret> UpdateUserWorkloadsSecretAsync(UpdateUserWorkloadsSecretRequest request, CallSettings callSettings = null)Updates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateUserWorkloadsSecretRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskUserWorkloadsSecret | A Task containing the RPC response. |