Class: Google::Apis::ComposerV1beta1::CloudComposerService
- Inherits:
-
Google::Apis::Core::BaseService
- Object
- Google::Apis::Core::BaseService
- Google::Apis::ComposerV1beta1::CloudComposerService
- Defined in:
- generated/google/apis/composer_v1beta1/service.rb
Overview
Cloud Composer API
Manages Apache Airflow environments on Google Cloud Platform.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#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.
-
#delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation
Delete an environment.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Empty
Deletes a long-running operation.
-
#get_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Environment
Get an existing environment.
-
#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.
-
#initialize ⇒ CloudComposerService
constructor
A new instance of CloudComposerService.
-
#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.
-
#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.
-
#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.
-
#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.
-
#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.
Constructor Details
#initialize ⇒ CloudComposerService
Returns a new instance of CloudComposerService.
45 46 47 48 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 45 def initialize super('https://composer.googleapis.com/', '') @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.
38 39 40 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 38 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.
43 44 45 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#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.
71 72 73 74 75 76 77 78 79 80 81 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 71 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', ) 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 |
#delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Operation
Delete an environment.
104 105 106 107 108 109 110 111 112 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 104 def delete_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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_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
.
386 387 388 389 390 391 392 393 394 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 386 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta1/{+name}', ) 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 |
#get_project_location_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::Environment
Get an existing environment.
135 136 137 138 139 140 141 142 143 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 135 def get_project_location_environment(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) 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_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.
417 418 419 420 421 422 423 424 425 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 417 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+name}', ) 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_environments(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ComposerV1beta1::ListEnvironmentsResponse
List environments.
170 171 172 173 174 175 176 177 178 179 180 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 170 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', ) 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.
350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 350 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', ) 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
. NOTE: the name
binding allows API services to override the binding to use different resource
name schemes, such as users/*/operations
. To override the binding, API
services can add a binding such as "/v1/
name=users/*/operations"
to their
service configuration. For backwards compatibility, the default name includes
the operations collection id, however overriding users must ensure the name
binding is the parent resource, without the operations collection id.
460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 460 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', ) 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 |
#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.
275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 275 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}', ) 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 |
#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.
311 312 313 314 315 316 317 318 319 320 321 |
# File 'generated/google/apis/composer_v1beta1/service.rb', line 311 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', ) 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 |