Managed Apache Airflow Environments.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
EnvironmentsClient(EnvironmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EnvironmentsClient const &
|
EnvironmentsClient(EnvironmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EnvironmentsClient &&
|
EnvironmentsClient(std::shared_ptr< EnvironmentsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< EnvironmentsConnection >
|
opts |
Options
|
Operators
operator=(EnvironmentsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EnvironmentsClient const &
|
Returns | |
---|---|
Type | Description |
EnvironmentsClient & |
operator=(EnvironmentsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
EnvironmentsClient &&
|
Returns | |
---|---|
Type | Description |
EnvironmentsClient & |
Functions
CreateEnvironment(std::string const &, google::cloud::orchestration::airflow::service::v1::Environment const &, Options)
Create a new environment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
The parent must be of the form "projects/{projectId}/locations/{locationId}". |
environment |
google::cloud::orchestration::airflow::service::v1::Environment const &
The environment to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
A |
CreateEnvironment(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::orchestration::airflow::service::v1::Environment const &, Options)
Create a new environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
parent |
std::string const &
|
environment |
google::cloud::orchestration::airflow::service::v1::Environment const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEnvironment(google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &, Options)
Create a new environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
A |
CreateEnvironment(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &, Options)
Create a new environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::CreateEnvironmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEnvironment(ExperimentalTag, google::longrunning::Operation const &, Options)
Create a new environment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
GetEnvironment(std::string const &, Options)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The resource name of the environment to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEnvironment(google::cloud::orchestration::airflow::service::v1::GetEnvironmentRequest const &, Options)
Get an existing environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::GetEnvironmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.Environment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListEnvironments(std::string const &, Options)
List environments.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
List environments in the given project and location, in the form: "projects/{projectId}/locations/{locationId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::Environment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEnvironments(google::cloud::orchestration::airflow::service::v1::ListEnvironmentsRequest, Options)
List environments.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::ListEnvironmentsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::Environment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateEnvironment(std::string const &, google::cloud::orchestration::airflow::service::v1::Environment const &, google::protobuf::FieldMask const &, Options)
Update an environment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The relative resource name of the environment to update, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
environment |
google::cloud::orchestration::airflow::service::v1::Environment const &
A patch environment. Fields specified by the |
update_mask |
google::protobuf::FieldMask const &
Required. A comma-separated list of paths, relative to |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
A |
UpdateEnvironment(ExperimentalTag, NoAwaitTag, std::string const &, google::cloud::orchestration::airflow::service::v1::Environment const &, google::protobuf::FieldMask const &, Options)
Update an environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
environment |
google::cloud::orchestration::airflow::service::v1::Environment const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateEnvironment(google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &, Options)
Update an environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
A |
UpdateEnvironment(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &, Options)
Update an environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::UpdateEnvironmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateEnvironment(ExperimentalTag, google::longrunning::Operation const &, Options)
Update an environment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::Environment > > |
DeleteEnvironment(std::string const &, Options)
Delete an environment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The environment to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::OperationMetadata > > |
A |
DeleteEnvironment(ExperimentalTag, NoAwaitTag, std::string const &, Options)
Delete an environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteEnvironment(google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &, Options)
Delete an environment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::OperationMetadata > > |
A |
DeleteEnvironment(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &, Options)
Delete an environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::DeleteEnvironmentRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteEnvironment(ExperimentalTag, google::longrunning::Operation const &, Options)
Delete an environment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::OperationMetadata > > |
ExecuteAirflowCommand(google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandRequest const &, Options)
Executes Airflow CLI command.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::ExecuteAirflowCommandResponse > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.ExecuteAirflowCommandResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
StopAirflowCommand(google::cloud::orchestration::airflow::service::v1::StopAirflowCommandRequest const &, Options)
Stops Airflow CLI command execution.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::StopAirflowCommandRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::StopAirflowCommandResponse > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.StopAirflowCommandResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
PollAirflowCommand(google::cloud::orchestration::airflow::service::v1::PollAirflowCommandRequest const &, Options)
Polls Airflow CLI command execution and fetches logs.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::PollAirflowCommandRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::PollAirflowCommandResponse > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.PollAirflowCommandResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListWorkloads(std::string const &, Options)
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 |
parent |
std::string const &
Required. The environment name to get workloads for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::ListWorkloadsResponse::ComposerWorkload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListWorkloads(google::cloud::orchestration::airflow::service::v1::ListWorkloadsRequest, Options)
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 |
google::cloud::orchestration::airflow::service::v1::ListWorkloadsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::ListWorkloadsResponse::ComposerWorkload > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateUserWorkloadsSecret(std::string const &, google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret const &, Options)
Creates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The environment name to create a Secret for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
user_workloads_secret |
google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret const &
Required. User workloads Secret to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsSecretRequest const &, Options)
Creates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsSecretRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetUserWorkloadsSecret(std::string const &, Options)
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 |
name |
std::string const &
Required. The resource name of the Secret to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsSecretRequest const &, Options)
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 |
google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsSecretRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListUserWorkloadsSecrets(std::string const &, Options)
Lists user workloads Secrets.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. List Secrets in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUserWorkloadsSecrets(google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsSecretsRequest, Options)
Lists user workloads Secrets.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsSecretsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret const &, Options)
Updates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
user_workloads_secret |
google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret const &
Optional. User workloads Secret to override. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsSecretRequest const &, Options)
Updates a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsSecretRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsSecret > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsSecret) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteUserWorkloadsSecret(std::string const &, Options)
Deletes a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The Secret to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsSecrets/{userWorkloadsSecretId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteUserWorkloadsSecret(google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsSecretRequest const &, Options)
Deletes a user workloads Secret.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsSecretRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateUserWorkloadsConfigMap(std::string const &, google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap const &, Options)
Creates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The environment name to create a ConfigMap for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
user_workloads_config_map |
google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap const &
Required. User workloads ConfigMap to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsConfigMapRequest const &, Options)
Creates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::CreateUserWorkloadsConfigMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetUserWorkloadsConfigMap(std::string const &, Options)
Gets an existing user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the ConfigMap to get, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsConfigMapRequest const &, Options)
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 |
google::cloud::orchestration::airflow::service::v1::GetUserWorkloadsConfigMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListUserWorkloadsConfigMaps(std::string const &, Options)
Lists user workloads ConfigMaps.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. List ConfigMaps in the given environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListUserWorkloadsConfigMaps(google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsConfigMapsRequest, Options)
Lists user workloads ConfigMaps.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::ListUserWorkloadsConfigMapsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap const &, Options)
Updates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
user_workloads_config_map |
google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap const &
Optional. User workloads ConfigMap to override. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsConfigMapRequest const &, Options)
Updates a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::UpdateUserWorkloadsConfigMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::UserWorkloadsConfigMap > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.UserWorkloadsConfigMap) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteUserWorkloadsConfigMap(std::string const &, Options)
Deletes a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The ConfigMap to delete, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId}" |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteUserWorkloadsConfigMap(google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsConfigMapRequest const &, Options)
Deletes a user workloads ConfigMap.
This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::DeleteUserWorkloadsConfigMapRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
SaveSnapshot(google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &, 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 |
google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::SaveSnapshotResponse > > |
A |
SaveSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &, Options)
Creates a snapshots of a Cloud Composer environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::SaveSnapshotRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
SaveSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)
Creates a snapshots of a Cloud Composer environment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::SaveSnapshotResponse > > |
LoadSnapshot(google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &, 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 |
google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::LoadSnapshotResponse > > |
A |
LoadSnapshot(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &, Options)
Loads a snapshot of a Cloud Composer environment.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::LoadSnapshotRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
LoadSnapshot(ExperimentalTag, google::longrunning::Operation const &, Options)
Loads a snapshot of a Cloud Composer environment.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::LoadSnapshotResponse > > |
DatabaseFailover(google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &, Options)
Triggers database failover (only for highly resilient environments).
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::DatabaseFailoverResponse > > |
A |
DatabaseFailover(ExperimentalTag, NoAwaitTag, google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &, Options)
Triggers database failover (only for highly resilient environments).
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::orchestration::airflow::service::v1::DatabaseFailoverRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DatabaseFailover(ExperimentalTag, google::longrunning::Operation const &, Options)
Triggers database failover (only for highly resilient environments).
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::orchestration::airflow::service::v1::DatabaseFailoverResponse > > |
FetchDatabaseProperties(google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesRequest const &, Options)
Fetches database properties.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::orchestration::airflow::service::v1::FetchDatabasePropertiesResponse > |
the result of the RPC. The response message type (google.cloud.orchestration.airflow.service.v1.FetchDatabasePropertiesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |