Class: Google::Apis::DeploymentmanagerV2::DeploymentManagerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::DeploymentmanagerV2::DeploymentManagerService
- Defined in:
- generated/google/apis/deploymentmanager_v2/service.rb
Overview
Google Cloud Deployment Manager API
Declares, configures, and deploys complex solutions 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.
-
#user_ip ⇒ String
IP address of the site where the request originates.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Cancels and removes the preview currently associated with the deployment.
-
#delete_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Deletes a deployment and all of the resources in the deployment.
-
#get_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Deployment
Gets information about a specific deployment.
-
#get_manifest(project, deployment, manifest, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Manifest
Gets information about a specific manifest.
-
#get_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Gets information about a specific operation.
-
#get_resource(project, deployment, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Resource
Gets information about a single resource.
-
#initialize ⇒ DeploymentManagerService
constructor
A new instance of DeploymentManagerService.
-
#insert_deployment(project, deployment_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Creates a deployment and all of the resources described by the deployment manifest.
-
#list_deployments(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListDeploymentsResponse
Lists all deployments for a given project.
-
#list_manifests(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListManifestsResponse
Lists all manifests for a given deployment.
-
#list_operations(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListOperationsResponse
Lists all operations for a project.
-
#list_resources(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListResourcesResponse
Lists all resources in a given deployment.
-
#list_types(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListTypesResponse
Lists all resource types for Deployment Manager.
-
#patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Updates a deployment and all of the resources described by the deployment manifest.
-
#stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Stops an ongoing operation.
-
#update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Updates a deployment and all of the resources described by the deployment manifest.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Constructor Details
#initialize ⇒ DeploymentManagerService
Returns a new instance of DeploymentManagerService.
51 52 53 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 51 def initialize super('https://www.googleapis.com/', 'deploymentmanager/v2/projects/') 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/deploymentmanager_v2/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. Overrides userIp if both are provided.
44 45 46 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 49 def user_ip @user_ip end |
Instance Method Details
#cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Cancels and removes the preview currently associated with the deployment.
82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 82 def cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/cancelPreview', ) command.request_representation = Google::Apis::DeploymentmanagerV2::DeploymentsCancelPreviewRequest::Representation command.request_object = deployments_cancel_preview_request_object command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#delete_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Deletes a deployment and all of the resources in the deployment.
122 123 124 125 126 127 128 129 130 131 132 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 122 def delete_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{project}/global/deployments/{deployment}', ) command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Deployment
Gets information about a specific deployment.
160 161 162 163 164 165 166 167 168 169 170 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 160 def get_deployment(project, deployment, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}', ) command.response_representation = Google::Apis::DeploymentmanagerV2::Deployment::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Deployment command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_manifest(project, deployment, manifest, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Manifest
Gets information about a specific manifest.
475 476 477 478 479 480 481 482 483 484 485 486 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 475 def get_manifest(project, deployment, manifest, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests/{manifest}', ) command.response_representation = Google::Apis::DeploymentmanagerV2::Manifest::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Manifest command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.params['manifest'] = manifest unless manifest.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Gets information about a specific operation.
584 585 586 587 588 589 590 591 592 593 594 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 584 def get_operation(project, operation, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations/{operation}', ) command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['operation'] = operation unless operation.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#get_resource(project, deployment, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Resource
Gets information about a single resource.
691 692 693 694 695 696 697 698 699 700 701 702 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 691 def get_resource(project, deployment, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources/{resource}', ) command.response_representation = Google::Apis::DeploymentmanagerV2::Resource::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Resource command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.params['resource'] = resource unless resource.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#insert_deployment(project, deployment_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Creates a deployment and all of the resources described by the deployment manifest.
206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 206 def insert_deployment(project, deployment_object = nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments', ) command.request_representation = Google::Apis::DeploymentmanagerV2::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.query['preview'] = preview unless preview.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_deployments(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListDeploymentsResponse
Lists all deployments for a given project.
273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 273 def list_deployments(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments', ) command.response_representation = Google::Apis::DeploymentmanagerV2::ListDeploymentsResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2::ListDeploymentsResponse command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_manifests(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListManifestsResponse
Lists all manifests for a given deployment.
543 544 545 546 547 548 549 550 551 552 553 554 555 556 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 543 def list_manifests(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/manifests', ) command.response_representation = Google::Apis::DeploymentmanagerV2::ListManifestsResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2::ListManifestsResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_operations(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListOperationsResponse
Lists all operations for a project.
649 650 651 652 653 654 655 656 657 658 659 660 661 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 649 def list_operations(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/operations', ) command.response_representation = Google::Apis::DeploymentmanagerV2::ListOperationsResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2::ListOperationsResponse command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_resources(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListResourcesResponse
Lists all resources in a given deployment.
759 760 761 762 763 764 765 766 767 768 769 770 771 772 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 759 def list_resources(project, deployment, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/deployments/{deployment}/resources', ) command.response_representation = Google::Apis::DeploymentmanagerV2::ListResourcesResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2::ListResourcesResponse command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#list_types(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::ListTypesResponse
Lists all resource types for Deployment Manager.
827 828 829 830 831 832 833 834 835 836 837 838 839 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 827 def list_types(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{project}/global/types', ) command.response_representation = Google::Apis::DeploymentmanagerV2::ListTypesResponse::Representation command.response_class = Google::Apis::DeploymentmanagerV2::ListTypesResponse command.params['project'] = project unless project.nil? command.query['filter'] = filter unless filter.nil? command.query['maxResults'] = max_results unless max_results.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? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Updates a deployment and all of the resources described by the deployment manifest. This method supports patch semantics.
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 329 def patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:patch, '{project}/global/deployments/{deployment}', ) command.request_representation = Google::Apis::DeploymentmanagerV2::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Stops an ongoing operation. This does not roll back any work that has already been completed, but prevents any new work from being started.
374 375 376 377 378 379 380 381 382 383 384 385 386 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 374 def stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{project}/global/deployments/{deployment}/stop', ) command.request_representation = Google::Apis::DeploymentmanagerV2::DeploymentsStopRequest::Representation command.request_object = deployments_stop_request_object command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |
#update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation
Updates a deployment and all of the resources described by the deployment manifest.
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 430 def update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:put, '{project}/global/deployments/{deployment}', ) command.request_representation = Google::Apis::DeploymentmanagerV2::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::DeploymentmanagerV2::Operation::Representation command.response_class = Google::Apis::DeploymentmanagerV2::Operation command.params['project'] = project unless project.nil? command.params['deployment'] = deployment unless deployment.nil? command.query['createPolicy'] = create_policy unless create_policy.nil? command.query['deletePolicy'] = delete_policy unless delete_policy.nil? command.query['preview'] = preview unless preview.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end |