public class Environments.EnvironmentsClient : ClientBase<Environments.EnvironmentsClient>
Reference documentation and code samples for the Cloud Composer v1 API class Environments.EnvironmentsClient.
Client for Environments
Inheritance
object > ClientBase > ClientBaseEnvironmentsEnvironmentsClient > Environments.EnvironmentsClientNamespace
Google.Cloud.Orchestration.Airflow.Service.V1Assembly
Google.Cloud.Orchestration.Airflow.Service.V1.dll
Constructors
EnvironmentsClient()
protected EnvironmentsClient()
Protected parameterless constructor to allow creation of test doubles.
EnvironmentsClient(CallInvoker)
public EnvironmentsClient(CallInvoker callInvoker)
Creates a new client for Environments that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker | CallInvoker The callInvoker to use to make remote calls. |
EnvironmentsClient(ChannelBase)
public EnvironmentsClient(ChannelBase channel)
Creates a new client for Environments
Parameter | |
---|---|
Name | Description |
channel | ChannelBase The channel to use to make remote calls. |
EnvironmentsClient(ClientBaseConfiguration)
protected EnvironmentsClient(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration | ClientBaseClientBaseConfiguration The client configuration. |
Methods
CreateEnvironment(CreateEnvironmentRequest, CallOptions)
public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, CallOptions options)
Create a new environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateEnvironment(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateEnvironment(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create a new environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
CreateEnvironmentAsync(CreateEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, CallOptions options)
Create a new environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
CreateEnvironmentAsync(CreateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateEnvironmentAsync(CreateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Create a new environment.
Parameters | |
---|---|
Name | Description |
request | CreateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()
Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
Returns | |
---|---|
Type | Description |
OperationsOperationsClient | A new Operations client for the same target as this client. |
DatabaseFailover(DatabaseFailoverRequest, CallOptions)
public virtual Operation DatabaseFailover(DatabaseFailoverRequest request, CallOptions options)
Triggers database failover (only for highly resilient environments).
Parameters | |
---|---|
Name | Description |
request | DatabaseFailoverRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DatabaseFailover(DatabaseFailoverRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DatabaseFailover(DatabaseFailoverRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Triggers database failover (only for highly resilient environments).
Parameters | |
---|---|
Name | Description |
request | DatabaseFailoverRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DatabaseFailoverAsync(DatabaseFailoverRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DatabaseFailoverAsync(DatabaseFailoverRequest request, CallOptions options)
Triggers database failover (only for highly resilient environments).
Parameters | |
---|---|
Name | Description |
request | DatabaseFailoverRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
DatabaseFailoverAsync(DatabaseFailoverRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DatabaseFailoverAsync(DatabaseFailoverRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Triggers database failover (only for highly resilient environments).
Parameters | |
---|---|
Name | Description |
request | DatabaseFailoverRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
DeleteEnvironment(DeleteEnvironmentRequest, CallOptions)
public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, CallOptions options)
Delete an environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteEnvironment(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteEnvironment(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete an environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, CallOptions options)
Delete an environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
DeleteEnvironmentAsync(DeleteEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteEnvironmentAsync(DeleteEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Delete an environment.
Parameters | |
---|---|
Name | Description |
request | DeleteEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
ExecuteAirflowCommand(ExecuteAirflowCommandRequest, CallOptions)
public virtual ExecuteAirflowCommandResponse ExecuteAirflowCommand(ExecuteAirflowCommandRequest request, CallOptions options)
Executes Airflow CLI command.
Parameters | |
---|---|
Name | Description |
request | ExecuteAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ExecuteAirflowCommandResponse | The response received from the server. |
ExecuteAirflowCommand(ExecuteAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual ExecuteAirflowCommandResponse ExecuteAirflowCommand(ExecuteAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Executes Airflow CLI command.
Parameters | |
---|---|
Name | Description |
request | ExecuteAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ExecuteAirflowCommandResponse | The response received from the server. |
ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, CallOptions)
public virtual AsyncUnaryCall<ExecuteAirflowCommandResponse> ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest request, CallOptions options)
Executes Airflow CLI command.
Parameters | |
---|---|
Name | Description |
request | ExecuteAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExecuteAirflowCommandResponse | The call object. |
ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ExecuteAirflowCommandResponse> ExecuteAirflowCommandAsync(ExecuteAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Executes Airflow CLI command.
Parameters | |
---|---|
Name | Description |
request | ExecuteAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallExecuteAirflowCommandResponse | The call object. |
FetchDatabaseProperties(FetchDatabasePropertiesRequest, CallOptions)
public virtual FetchDatabasePropertiesResponse FetchDatabaseProperties(FetchDatabasePropertiesRequest request, CallOptions options)
Fetches database properties.
Parameters | |
---|---|
Name | Description |
request | FetchDatabasePropertiesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
FetchDatabasePropertiesResponse | The response received from the server. |
FetchDatabaseProperties(FetchDatabasePropertiesRequest, Metadata, DateTime?, CancellationToken)
public virtual FetchDatabasePropertiesResponse FetchDatabaseProperties(FetchDatabasePropertiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Fetches database properties.
Parameters | |
---|---|
Name | Description |
request | FetchDatabasePropertiesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
FetchDatabasePropertiesResponse | The response received from the server. |
FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, CallOptions)
public virtual AsyncUnaryCall<FetchDatabasePropertiesResponse> FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest request, CallOptions options)
Fetches database properties.
Parameters | |
---|---|
Name | Description |
request | FetchDatabasePropertiesRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallFetchDatabasePropertiesResponse | The call object. |
FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<FetchDatabasePropertiesResponse> FetchDatabasePropertiesAsync(FetchDatabasePropertiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Fetches database properties.
Parameters | |
---|---|
Name | Description |
request | FetchDatabasePropertiesRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallFetchDatabasePropertiesResponse | The call object. |
GetEnvironment(GetEnvironmentRequest, CallOptions)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, CallOptions options)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Environment | The response received from the server. |
GetEnvironment(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Environment GetEnvironment(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Environment | The response received from the server. |
GetEnvironmentAsync(GetEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, CallOptions options)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEnvironment | The call object. |
GetEnvironmentAsync(GetEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Environment> GetEnvironmentAsync(GetEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
request | GetEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallEnvironment | The call object. |
ListEnvironments(ListEnvironmentsRequest, CallOptions)
public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, CallOptions options)
List environments.
Parameters | |
---|---|
Name | Description |
request | ListEnvironmentsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
ListEnvironmentsResponse | The response received from the server. |
ListEnvironments(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListEnvironmentsResponse ListEnvironments(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List environments.
Parameters | |
---|---|
Name | Description |
request | ListEnvironmentsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
ListEnvironmentsResponse | The response received from the server. |
ListEnvironmentsAsync(ListEnvironmentsRequest, CallOptions)
public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, CallOptions options)
List environments.
Parameters | |
---|---|
Name | Description |
request | ListEnvironmentsRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListEnvironmentsResponse | The call object. |
ListEnvironmentsAsync(ListEnvironmentsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListEnvironmentsResponse> ListEnvironmentsAsync(ListEnvironmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List environments.
Parameters | |
---|---|
Name | Description |
request | ListEnvironmentsRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallListEnvironmentsResponse | The call object. |
LoadSnapshot(LoadSnapshotRequest, CallOptions)
public virtual Operation LoadSnapshot(LoadSnapshotRequest request, CallOptions options)
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 | LoadSnapshotRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
LoadSnapshot(LoadSnapshotRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation LoadSnapshot(LoadSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 | LoadSnapshotRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
LoadSnapshotAsync(LoadSnapshotRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> LoadSnapshotAsync(LoadSnapshotRequest request, CallOptions options)
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 | LoadSnapshotRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
LoadSnapshotAsync(LoadSnapshotRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> LoadSnapshotAsync(LoadSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 | LoadSnapshotRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
NewInstance(ClientBaseConfiguration)
protected override Environments.EnvironmentsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration | ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
EnvironmentsEnvironmentsClient |
PollAirflowCommand(PollAirflowCommandRequest, CallOptions)
public virtual PollAirflowCommandResponse PollAirflowCommand(PollAirflowCommandRequest request, CallOptions options)
Polls Airflow CLI command execution and fetches logs.
Parameters | |
---|---|
Name | Description |
request | PollAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
PollAirflowCommandResponse | The response received from the server. |
PollAirflowCommand(PollAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual PollAirflowCommandResponse PollAirflowCommand(PollAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Polls Airflow CLI command execution and fetches logs.
Parameters | |
---|---|
Name | Description |
request | PollAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
PollAirflowCommandResponse | The response received from the server. |
PollAirflowCommandAsync(PollAirflowCommandRequest, CallOptions)
public virtual AsyncUnaryCall<PollAirflowCommandResponse> PollAirflowCommandAsync(PollAirflowCommandRequest request, CallOptions options)
Polls Airflow CLI command execution and fetches logs.
Parameters | |
---|---|
Name | Description |
request | PollAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPollAirflowCommandResponse | The call object. |
PollAirflowCommandAsync(PollAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<PollAirflowCommandResponse> PollAirflowCommandAsync(PollAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Polls Airflow CLI command execution and fetches logs.
Parameters | |
---|---|
Name | Description |
request | PollAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallPollAirflowCommandResponse | The call object. |
SaveSnapshot(SaveSnapshotRequest, CallOptions)
public virtual Operation SaveSnapshot(SaveSnapshotRequest request, CallOptions options)
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 | SaveSnapshotRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
SaveSnapshot(SaveSnapshotRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation SaveSnapshot(SaveSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 | SaveSnapshotRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
SaveSnapshotAsync(SaveSnapshotRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> SaveSnapshotAsync(SaveSnapshotRequest request, CallOptions options)
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 | SaveSnapshotRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
SaveSnapshotAsync(SaveSnapshotRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> SaveSnapshotAsync(SaveSnapshotRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 | SaveSnapshotRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
StopAirflowCommand(StopAirflowCommandRequest, CallOptions)
public virtual StopAirflowCommandResponse StopAirflowCommand(StopAirflowCommandRequest request, CallOptions options)
Stops Airflow CLI command execution.
Parameters | |
---|---|
Name | Description |
request | StopAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
StopAirflowCommandResponse | The response received from the server. |
StopAirflowCommand(StopAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual StopAirflowCommandResponse StopAirflowCommand(StopAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops Airflow CLI command execution.
Parameters | |
---|---|
Name | Description |
request | StopAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
StopAirflowCommandResponse | The response received from the server. |
StopAirflowCommandAsync(StopAirflowCommandRequest, CallOptions)
public virtual AsyncUnaryCall<StopAirflowCommandResponse> StopAirflowCommandAsync(StopAirflowCommandRequest request, CallOptions options)
Stops Airflow CLI command execution.
Parameters | |
---|---|
Name | Description |
request | StopAirflowCommandRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallStopAirflowCommandResponse | The call object. |
StopAirflowCommandAsync(StopAirflowCommandRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<StopAirflowCommandResponse> StopAirflowCommandAsync(StopAirflowCommandRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Stops Airflow CLI command execution.
Parameters | |
---|---|
Name | Description |
request | StopAirflowCommandRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallStopAirflowCommandResponse | The call object. |
UpdateEnvironment(UpdateEnvironmentRequest, CallOptions)
public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, CallOptions options)
Update an environment.
Parameters | |
---|---|
Name | Description |
request | UpdateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
UpdateEnvironment(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateEnvironment(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Update an environment.
Parameters | |
---|---|
Name | Description |
request | UpdateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
Operation | The response received from the server. |
UpdateEnvironmentAsync(UpdateEnvironmentRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, CallOptions options)
Update an environment.
Parameters | |
---|---|
Name | Description |
request | UpdateEnvironmentRequest The request to send to the server. |
options | CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |
UpdateEnvironmentAsync(UpdateEnvironmentRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateEnvironmentAsync(UpdateEnvironmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Update an environment.
Parameters | |
---|---|
Name | Description |
request | UpdateEnvironmentRequest The request to send to the server. |
headers | Metadata The initial metadata to send with the call. This parameter is optional. |
deadline | DateTime An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationToken An optional token for canceling the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallOperation | The call object. |