Class: Google::Apis::ComposerV1beta1::CloudComposerService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/composer_v1beta1/service.rb

Overview

Cloud Composer API

Manages Apache Airflow environments on Google Cloud Platform.

Examples:

require 'google/apis/composer_v1beta1'

Composer = Google::Apis::ComposerV1beta1 # Alias the module
service = Composer::CloudComposerService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://composer.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudComposerService

Returns a new instance of CloudComposerService.



47
48
49
50
51
52
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-composer_v1beta1',
        client_version: Google::Apis::ComposerV1beta1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#check_environment_upgrade(environment, check_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.

Parameters:

  • environment (String) —

    The resource name of the environment to check upgrade for, in the form: " projects/projectId/locations/locationId/environments/environmentId"

  • check_upgrade_request_object (Google::Apis::ComposerV1beta1::CheckUpgradeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 77

def check_environment_upgrade(environment, check_upgrade_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:checkUpgrade', options)
  command.request_representation = Google::Apis::ComposerV1beta1::CheckUpgradeRequest::Representation
  command.request_object = check_upgrade_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_environment(parent, environment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Create a new environment.

Parameters:

  • parent (String) —

    The parent must be of the form "projects/projectId/locations/locationId".

  • environment_object (Google::Apis::ComposerV1beta1::Environment) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 110

def create_project_location_environment(parent, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/environments', options)
  command.request_representation = Google::Apis::ComposerV1beta1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_environment_user_workloads_config_map(parent, user_workloads_config_map_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap

Creates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • parent (String) —

    Required. The environment name to create a ConfigMap for, in the form: " projects/projectId/locations/locationId/environments/environmentId"

  • user_workloads_config_map_object (Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



638
639
640
641
642
643
644
645
646
647
648
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 638

def create_project_location_environment_user_workloads_config_map(parent, user_workloads_config_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/userWorkloadsConfigMaps', options)
  command.request_representation = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap::Representation
  command.request_object = user_workloads_config_map_object
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_environment_user_workloads_secret(parent, user_workloads_secret_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsSecret

Creates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • parent (String) —

    Required. The environment name to create a Secret for, in the form: "projects/ projectId/locations/locationId/environments/environmentId"

  • user_workloads_secret_object (Google::Apis::ComposerV1beta1::UserWorkloadsSecret) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 814

def create_project_location_environment_user_workloads_secret(parent, user_workloads_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/userWorkloadsSecrets', options)
  command.request_representation = Google::Apis::ComposerV1beta1::UserWorkloadsSecret::Representation
  command.request_object = user_workloads_secret_object
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsSecret::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsSecret
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#database_environment_failover(environment, database_failover_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Triggers database failover (only for highly resilient environments).

Parameters:

  • environment (String) —

    Target environment: "projects/projectId/locations/locationId/environments/ environmentId"

  • database_failover_request_object (Google::Apis::ComposerV1beta1::DatabaseFailoverRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 144

def database_environment_failover(environment, database_failover_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:databaseFailover', options)
  command.request_representation = Google::Apis::ComposerV1beta1::DatabaseFailoverRequest::Representation
  command.request_object = database_failover_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Delete an environment.

Parameters:

  • name (String) —

    The environment to delete, in the form: "projects/projectId/locations/ locationId/environments/environmentId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



177
178
179
180
181
182
183
184
185
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 177

def delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_environment_user_workloads_config_map(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Empty

Deletes a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • name (String) —

    Required. The ConfigMap to delete, in the form: "projects/projectId/ locations/locationId/environments/environmentId/userWorkloadsConfigMaps/ userWorkloadsConfigMapId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



673
674
675
676
677
678
679
680
681
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 673

def delete_project_location_environment_user_workloads_config_map(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Empty::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_environment_user_workloads_secret(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Empty

Deletes a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • name (String) —

    Required. The Secret to delete, in the form: "projects/projectId/locations/ locationId/environments/environmentId/userWorkloadsSecrets/ userWorkloadsSecretId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



849
850
851
852
853
854
855
856
857
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 849

def delete_project_location_environment_user_workloads_secret(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Empty::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1078
1079
1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 1078

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Empty::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#execute_environment_airflow_command(environment, execute_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ExecuteAirflowCommandResponse

Executes Airflow CLI command.

Parameters:

  • environment (String) —

    The resource name of the environment in the form: "projects/projectId/ locations/locationId/environments/environmentId".

  • execute_airflow_command_request_object (Google::Apis::ComposerV1beta1::ExecuteAirflowCommandRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 209

def execute_environment_airflow_command(environment, execute_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:executeAirflowCommand', options)
  command.request_representation = Google::Apis::ComposerV1beta1::ExecuteAirflowCommandRequest::Representation
  command.request_object = execute_airflow_command_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::ExecuteAirflowCommandResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ExecuteAirflowCommandResponse
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#fetch_project_location_environment_database_properties(environment, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::FetchDatabasePropertiesResponse

Fetches database properties.

Parameters:

  • environment (String) —

    Required. The resource name of the environment, in the form: "projects/ projectId/locations/locationId/environments/environmentId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



242
243
244
245
246
247
248
249
250
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 242

def fetch_project_location_environment_database_properties(environment, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+environment}:fetchDatabaseProperties', options)
  command.response_representation = Google::Apis::ComposerV1beta1::FetchDatabasePropertiesResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::FetchDatabasePropertiesResponse
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Environment

Get an existing environment.

Parameters:

  • name (String) —

    The resource name of the environment to get, in the form: "projects/projectId /locations/locationId/environments/environmentId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



273
274
275
276
277
278
279
280
281
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 273

def get_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Environment::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_environment_user_workloads_config_map(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap

Gets an existing user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • name (String) —

    Required. The resource name of the ConfigMap to get, in the form: "projects/ projectId/locations/locationId/environments/environmentId/ userWorkloadsConfigMaps/userWorkloadsConfigMapId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



706
707
708
709
710
711
712
713
714
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 706

def get_project_location_environment_user_workloads_config_map(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_environment_user_workloads_secret(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsSecret

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 (String) —

    Required. The resource name of the Secret to get, in the form: "projects/ projectId/locations/locationId/environments/environmentId/ userWorkloadsSecrets/userWorkloadsSecretId"

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



883
884
885
886
887
888
889
890
891
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 883

def get_project_location_environment_user_workloads_secret(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsSecret::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsSecret
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 1109

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_environment_user_workloads_config_maps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListUserWorkloadsConfigMapsResponse

Lists user workloads ConfigMaps. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • parent (String) —

    Required. List ConfigMaps in the given environment, in the form: "projects/ projectId/locations/locationId/environments/environmentId"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of ConfigMaps to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



743
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 743

def list_project_location_environment_user_workloads_config_maps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/userWorkloadsConfigMaps', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListUserWorkloadsConfigMapsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListUserWorkloadsConfigMapsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_environment_user_workloads_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListUserWorkloadsSecretsResponse

Lists user workloads Secrets. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • parent (String) —

    Required. List Secrets in the given environment, in the form: "projects/ projectId/locations/locationId/environments/environmentId"

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of Secrets to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 920

def list_project_location_environment_user_workloads_secrets(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/userWorkloadsSecrets', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListUserWorkloadsSecretsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListUserWorkloadsSecretsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_environment_workloads(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListWorkloadsResponse

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:

  • parent (String) —

    Required. The environment name to get workloads for, in the form: "projects/ projectId/locations/locationId/environments/environmentId"

  • filter (String) (defaults to: nil) —

    Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using " OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned.

  • page_size (Fixnum) (defaults to: nil) —

    Optional. The maximum number of environments to return.

  • page_token (String) (defaults to: nil) —

    Optional. The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 1002

def list_project_location_environment_workloads(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/workloads', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListWorkloadsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListWorkloadsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListEnvironmentsResponse

List environments.

Parameters:

  • parent (String) —

    List environments in the given project and location, in the form: "projects/ projectId/locations/locationId"

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of environments to return.

  • page_token (String) (defaults to: nil) —

    The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 308

def list_project_location_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/environments', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListEnvironmentsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListEnvironmentsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_image_versions(parent, include_past_releases: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListImageVersionsResponse

List ImageVersions for provided location.

Parameters:

  • parent (String) —

    List ImageVersions in the given project and location, in the form: "projects/ projectId/locations/locationId"

  • include_past_releases (Boolean) (defaults to: nil) —

    Whether or not image versions from old releases should be included.

  • page_size (Fixnum) (defaults to: nil) —

    The maximum number of image_versions to return.

  • page_token (String) (defaults to: nil) —

    The next_page_token value returned from a previous List request, if any.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 1042

def list_project_location_image_versions(parent, include_past_releases: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/imageVersions', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListImageVersionsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListImageVersionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['includePastReleases'] = include_past_releases unless include_past_releases.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil) —

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil) —

    The standard list page size.

  • page_token (String) (defaults to: nil) —

    The standard list page token.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 1146

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}/operations', options)
  command.response_representation = Google::Apis::ComposerV1beta1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#load_environment_snapshot(environment, load_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

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:

  • environment (String) —

    The resource name of the target environment in the form: "projects/projectId/ locations/locationId/environments/environmentId"

  • load_snapshot_request_object (Google::Apis::ComposerV1beta1::LoadSnapshotRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 344

def load_environment_snapshot(environment, load_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:loadSnapshot', options)
  command.request_representation = Google::Apis::ComposerV1beta1::LoadSnapshotRequest::Representation
  command.request_object = load_snapshot_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_environment(name, environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Update an environment.

Parameters:

  • name (String) —

    The relative resource name of the environment to update, in the form: " projects/projectId/locations/locationId/environments/environmentId"

  • environment_object (Google::Apis::ComposerV1beta1::Environment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Required. A comma-separated list of paths, relative to Environment, of fields to update. For example, to set the version of scikit-learn to install in the environment to 0.19.0 and to remove an existing installation of argparse, the updateMask parameter would include the following two paths values: "config.softwareConfig.pypiPackages.scikit-learn" and "config. softwareConfig.pypiPackages.argparse". The included patch environment would specify the scikit-learn version as follows: "config": "softwareConfig":" pypiPackages": "scikit-learn":"==0.19.0" Note that in the above example, any existing PyPI packages other than scikit-learn and argparse will be unaffected. Only one update type may be included in a single request's updateMask. For example, one cannot update both the PyPI packages and labels in the same request. However, it is possible to update multiple members of a map field simultaneously in the same request. For example, to set the labels " label1" and "label2" while clearing "label3" (assuming it already exists), one can provide the paths "labels.label1", "labels.label2", and "labels.label3" and populate the patch environment as follows: "labels": "label1":"new- label1-value" "label2":"new-label2-value" Note that in the above example, any existing labels that are not included in the updateMask will be unaffected. It is also possible to replace an entire map field by providing the map field's path in the updateMask. The new value of the field will be that which is provided in the patch environment. For example, to delete all pre-existing user-specified PyPI packages and install botocore at version 1.7. 14, the updateMask would contain the path "config.softwareConfig. pypiPackages", and the patch environment would be the following: "config": " softwareConfig":"pypiPackages": "botocore":"==1.7.14" Note: Only the following fields can be updated: * config.softwareConfig. pypiPackages * Replace all custom custom PyPI packages. If a replacement package map is not included in environment, all custom PyPI packages are cleared. It is an error to provide both this mask and a mask specifying an individual package. * config.softwareConfig.pypiPackages.packagename * Update the custom PyPI package packagename, preserving other packages. To delete the package, include it in updateMask, and omit the mapping for it in environment.config.softwareConfig.pypiPackages. It is an error to provide both a mask of this form and the config.softwareConfig.pypiPackages mask. * labels * Replace all environment labels. If a replacement labels map is not included in environment, all labels are cleared. It is an error to provide both this mask and a mask specifying one or more individual labels. * labels. labelName * Set the label named labelName, while preserving other labels. To delete the label, include it in updateMask and omit its mapping in environment.labels. It is an error to provide both a mask of this form and the labels mask. * config.nodeCount * Horizontally scale the number of nodes in the environment. An integer greater than or equal to 3 must be provided in the config.nodeCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-..*. * config. webServerNetworkAccessControl * Replace the environment's current WebServerNetworkAccessControl. * config.softwareConfig.airflowConfigOverrides

    • Replace all Apache Airflow config overrides. If a replacement config overrides map is not included in environment, all config overrides are cleared. It is an error to provide both this mask and a mask specifying one or more individual config overrides. * config.softwareConfig. airflowConfigOverrides.section-name * Override the Apache Airflow config property name in the section named section, preserving other properties. To delete the property override, include it in updateMask and omit its mapping in environment.config.softwareConfig.airflowConfigOverrides. It is an error to provide both a mask of this form and the config.softwareConfig. airflowConfigOverrides mask. * config.softwareConfig.envVariables * Replace all environment variables. If a replacement environment variable map is not included in environment, all custom environment variables are cleared. * config.softwareConfig.imageVersion * Upgrade the version of the environment in-place. Refer to SoftwareConfig.image_version for information on how to format the new image version. Additionally, the new image version cannot effect a version downgrade, and must match the current image version's Composer and Airflow major versions. Consult the Cloud Composer version list for valid values. * config.softwareConfig.schedulerCount * Horizontally scale the number of schedulers in Airflow. A positive integer not greater than the number of nodes must be provided in the config.softwareConfig.schedulerCount field. Supported for Cloud Composer environments in versions composer-1..-airflow-2. .. * config.softwareConfig.cloudDataLineageIntegration * Configuration for Cloud Data Lineage integration. * config.databaseConfig.machineType * Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard- 2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. Supported for Cloud Composer environments in versions composer-1..-airflow-... * config.webServerConfig.machineType * Machine type on which Airflow web server is running. It has to be one of: composer-n1-webserver-2, composer-n1- webserver-4 or composer-n1-webserver-8. Supported for Cloud Composer environments in versions composer-1..-airflow-... * config. maintenanceWindow * Maintenance window during which Cloud Composer components may be under maintenance. * config.workloadsConfig * The workloads configuration settings for the GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2.* .-airflow-.. and newer. * config.environmentSize * The size of the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer.
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 463

def patch_project_location_environment(name, environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ComposerV1beta1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#poll_environment_airflow_command(environment, poll_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::PollAirflowCommandResponse

Polls Airflow CLI command execution and fetches logs.

Parameters:

  • environment (String) —

    The resource name of the environment in the form: "projects/projectId/ locations/locationId/environments/environmentId"

  • poll_airflow_command_request_object (Google::Apis::ComposerV1beta1::PollAirflowCommandRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 498

def poll_environment_airflow_command(environment, poll_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:pollAirflowCommand', options)
  command.request_representation = Google::Apis::ComposerV1beta1::PollAirflowCommandRequest::Representation
  command.request_object = poll_airflow_command_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::PollAirflowCommandResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::PollAirflowCommandResponse
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#restart_environment_web_server(name, restart_web_server_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

Restart Airflow web server.

Parameters:

  • name (String) —

    The resource name of the environment to restart the web server for, in the form: "projects/projectId/locations/locationId/environments/environmentId "

  • restart_web_server_request_object (Google::Apis::ComposerV1beta1::RestartWebServerRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 533

def restart_environment_web_server(name, restart_web_server_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+name}:restartWebServer', options)
  command.request_representation = Google::Apis::ComposerV1beta1::RestartWebServerRequest::Representation
  command.request_object = restart_web_server_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#save_environment_snapshot(environment, save_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation

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:

  • environment (String) —

    The resource name of the source environment in the form: "projects/projectId/ locations/locationId/environments/environmentId"

  • save_snapshot_request_object (Google::Apis::ComposerV1beta1::SaveSnapshotRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 569

def save_environment_snapshot(environment, save_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:saveSnapshot', options)
  command.request_representation = Google::Apis::ComposerV1beta1::SaveSnapshotRequest::Representation
  command.request_object = save_snapshot_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::Operation::Representation
  command.response_class = Google::Apis::ComposerV1beta1::Operation
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_environment_airflow_command(environment, stop_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::StopAirflowCommandResponse

Stops Airflow CLI command execution.

Parameters:

  • environment (String) —

    The resource name of the environment in the form: "projects/projectId/ locations/locationId/environments/environmentId".

  • stop_airflow_command_request_object (Google::Apis::ComposerV1beta1::StopAirflowCommandRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 603

def stop_environment_airflow_command(environment, stop_airflow_command_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+environment}:stopAirflowCommand', options)
  command.request_representation = Google::Apis::ComposerV1beta1::StopAirflowCommandRequest::Representation
  command.request_object = stop_airflow_command_request_object
  command.response_representation = Google::Apis::ComposerV1beta1::StopAirflowCommandResponse::Representation
  command.response_class = Google::Apis::ComposerV1beta1::StopAirflowCommandResponse
  command.params['environment'] = environment unless environment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_environment_user_workloads_config_map(name, user_workloads_config_map_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap

Updates a user workloads ConfigMap. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • name (String) —

    Identifier. The resource name of the ConfigMap, in the form: "projects/ projectId/locations/locationId/environments/environmentId/ userWorkloadsConfigMaps/userWorkloadsConfigMapId"

  • user_workloads_config_map_object (Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 779

def update_project_location_environment_user_workloads_config_map(name, user_workloads_config_map_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap::Representation
  command.request_object = user_workloads_config_map_object
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsConfigMap
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_project_location_environment_user_workloads_secret(name, user_workloads_secret_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::UserWorkloadsSecret

Updates a user workloads Secret. This method is supported for Cloud Composer environments in versions composer-3..-airflow-..* and newer.

Parameters:

  • name (String) —

    Identifier. The resource name of the Secret, in the form: "projects/projectId /locations/locationId/environments/environmentId/userWorkloadsSecrets/ userWorkloadsSecretId"

  • user_workloads_secret_object (Google::Apis::ComposerV1beta1::UserWorkloadsSecret) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



956
957
958
959
960
961
962
963
964
965
966
 
# File 'lib/google/apis/composer_v1beta1/service.rb', line 956

def update_project_location_environment_user_workloads_secret(name, user_workloads_secret_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ComposerV1beta1::UserWorkloadsSecret::Representation
  command.request_object = user_workloads_secret_object
  command.response_representation = Google::Apis::ComposerV1beta1::UserWorkloadsSecret::Representation
  command.response_class = Google::Apis::ComposerV1beta1::UserWorkloadsSecret
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end