Reference documentation and code samples for the Cloud Composer V1 API class Google::Cloud::Orchestration::Airflow::Service::V1::Environments::Rest::ServiceStub.
REST service stub for the Environments service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.
Inherits
- Object
Methods
#create_environment
def create_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the create_environment REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::CreateEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#database_failover
def database_failover(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the database_failover REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::DatabaseFailoverRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#delete_environment
def delete_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the delete_environment REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::DeleteEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#execute_airflow_command
def execute_airflow_command(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::ExecuteAirflowCommandResponse
Baseline implementation for the execute_airflow_command REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::ExecuteAirflowCommandRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::ExecuteAirflowCommandResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::ExecuteAirflowCommandResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#fetch_database_properties
def fetch_database_properties(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::FetchDatabasePropertiesResponse
Baseline implementation for the fetch_database_properties REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::FetchDatabasePropertiesRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::FetchDatabasePropertiesResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::FetchDatabasePropertiesResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#get_environment
def get_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::Environment
Baseline implementation for the get_environment REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::GetEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::Environment)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::Environment) — A result object deserialized from the server's reply
- (::ArgumentError)
#initialize
def initialize(endpoint:, credentials:) -> ServiceStub
- (ServiceStub) — a new instance of ServiceStub
#list_environments
def list_environments(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::ListEnvironmentsResponse
Baseline implementation for the list_environments REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::ListEnvironmentsRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::ListEnvironmentsResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::ListEnvironmentsResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#load_snapshot
def load_snapshot(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the load_snapshot REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::LoadSnapshotRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#poll_airflow_command
def poll_airflow_command(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::PollAirflowCommandResponse
Baseline implementation for the poll_airflow_command REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::PollAirflowCommandRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::PollAirflowCommandResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::PollAirflowCommandResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#save_snapshot
def save_snapshot(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the save_snapshot REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::SaveSnapshotRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)
#stop_airflow_command
def stop_airflow_command(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::StopAirflowCommandResponse
Baseline implementation for the stop_airflow_command REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::StopAirflowCommandRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Cloud::Orchestration::Airflow::Service::V1::StopAirflowCommandResponse)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Cloud::Orchestration::Airflow::Service::V1::StopAirflowCommandResponse) — A result object deserialized from the server's reply
- (::ArgumentError)
#update_environment
def update_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation
Baseline implementation for the update_environment REST call
- request_pb (::Google::Cloud::Orchestration::Airflow::Service::V1::UpdateEnvironmentRequest) — A request object representing the call parameters. Required.
- options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
- (result, operation) — Access the result along with the TransportOperation object
- result (::Google::Longrunning::Operation)
- operation (::Gapic::Rest::TransportOperation)
- (::Google::Longrunning::Operation) — A result object deserialized from the server's reply
- (::ArgumentError)