Cloud Composer V1 API - Class Google::Cloud::Orchestration::Airflow::Service::V1::Environments::Rest::ServiceStub (v1.0.1)

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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_user_workloads_config_map

def create_user_workloads_config_map(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsConfigMap

Baseline implementation for the create_user_workloads_config_map REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_user_workloads_secret

def create_user_workloads_secret(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsSecret

Baseline implementation for the create_user_workloads_secret REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#database_failover

def database_failover(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the database_failover REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_environment

def delete_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_environment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_user_workloads_config_map

def delete_user_workloads_config_map(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_user_workloads_config_map REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_user_workloads_secret

def delete_user_workloads_secret(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_user_workloads_secret REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_user_workloads_config_map

def get_user_workloads_config_map(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsConfigMap

Baseline implementation for the get_user_workloads_config_map REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_user_workloads_secret

def get_user_workloads_secret(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsSecret

Baseline implementation for the get_user_workloads_secret REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub
Returns

#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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_user_workloads_config_maps

def list_user_workloads_config_maps(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::ListUserWorkloadsConfigMapsResponse

Baseline implementation for the list_user_workloads_config_maps REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_user_workloads_secrets

def list_user_workloads_secrets(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::ListUserWorkloadsSecretsResponse

Baseline implementation for the list_user_workloads_secrets REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_workloads

def list_workloads(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::ListWorkloadsResponse

Baseline implementation for the list_workloads REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#load_snapshot

def load_snapshot(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the load_snapshot REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#save_snapshot

def save_snapshot(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the save_snapshot REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::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

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_environment

def update_environment(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_environment REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_user_workloads_config_map

def update_user_workloads_config_map(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsConfigMap

Baseline implementation for the update_user_workloads_config_map REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_user_workloads_secret

def update_user_workloads_secret(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Orchestration::Airflow::Service::V1::UserWorkloadsSecret

Baseline implementation for the update_user_workloads_secret REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)