Class: Google::Apis::DeploymentmanagerV2::DeploymentManagerService

Inherits:
Core::BaseService
  • Object
show all
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.

Examples:

require 'google/apis/deploymentmanager_v2'

Deploymentmanager = Google::Apis::DeploymentmanagerV2 # Alias the module
service = Deploymentmanager::DeploymentManagerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeDeploymentManagerService

Returns a new instance of DeploymentManagerService



49
50
51
52
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'deploymentmanager/v2/projects/')
  @batch_path = 'batch/deploymentmanager/v2'
end

Instance Attribute Details

#keyString

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.



38
39
40
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 38

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



43
44
45
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.



47
48
49
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 47

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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • deployments_cancel_preview_request_object (Google::Apis::DeploymentmanagerV2::DeploymentsCancelPreviewRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 79

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', options)
  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, delete_policy: nil, 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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • delete_policy (String)

    Sets the policy to use for deleting resources.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



119
120
121
122
123
124
125
126
127
128
129
130
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 119

def delete_deployment(project, deployment, delete_policy: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, '{project}/global/deployments/{deployment}', options)
  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['deletePolicy'] = delete_policy unless delete_policy.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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



156
157
158
159
160
161
162
163
164
165
166
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 156

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}', options)
  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_deployment_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name or id of the resource for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



193
194
195
196
197
198
199
200
201
202
203
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 193

def get_deployment_iam_policy(project, resource, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/deployments/{resource}/getIamPolicy', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2::Policy::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2::Policy
  command.params['project'] = project unless project.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

#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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • manifest (String)

    The name of the manifest for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



584
585
586
587
588
589
590
591
592
593
594
595
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 584

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}', options)
  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.

Parameters:

  • project (String)

    The project ID for this request.

  • operation (String)

    The name of the operation for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



695
696
697
698
699
700
701
702
703
704
705
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 695

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}', options)
  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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • resource (String)

    The name of the resource for this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



804
805
806
807
808
809
810
811
812
813
814
815
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 804

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}', options)
  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, create_policy: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment_object (Google::Apis::DeploymentmanagerV2::Deployment) (defaults to: nil)
  • create_policy (String)

    Sets the policy to use for creating new resources.

  • preview (Boolean)

    If set to true, creates a deployment and creates "shell" resources but does not actually instantiate these resources. This allows you to preview what your deployment looks like. After previewing a deployment, you can deploy your resources by making a request with the update() method or you can use the cancelPreview() method to cancel the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 239

def insert_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/deployments', options)
  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['createPolicy'] = create_policy unless create_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

#list_deployments(project, filter: nil, max_results: nil, order_by: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • filter (String)

    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling. automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. automaticRestart = true).

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 310

def list_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/deployments', options)
  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['orderBy'] = order_by unless order_by.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, order_by: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • filter (String)

    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling. automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. automaticRestart = true).

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 655

def list_manifests(project, deployment, filter: nil, max_results: nil, order_by: 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', options)
  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['orderBy'] = order_by unless order_by.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, order_by: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • filter (String)

    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling. automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. automaticRestart = true).

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



763
764
765
766
767
768
769
770
771
772
773
774
775
776
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 763

def list_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/operations', options)
  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['orderBy'] = order_by unless order_by.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, order_by: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • filter (String)

    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling. automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. automaticRestart = true).

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 875

def list_resources(project, deployment, filter: nil, max_results: nil, order_by: 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', options)
  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['orderBy'] = order_by unless order_by.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, order_by: 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.

Parameters:

  • project (String)

    The project ID for this request.

  • filter (String)

    A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling. automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = " Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling. automaticRestart = true).

  • max_results (Fixnum)

    The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

  • order_by (String)

    Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported.

  • page_token (String)

    Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



947
948
949
950
951
952
953
954
955
956
957
958
959
960
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 947

def list_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, '{project}/global/types', options)
  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['orderBy'] = order_by unless order_by.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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • deployment_object (Google::Apis::DeploymentmanagerV2::Deployment) (defaults to: nil)
  • create_policy (String)

    Sets the policy to use for creating new resources.

  • delete_policy (String)

    Sets the policy to use for deleting resources.

  • preview (Boolean)

    If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 365

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}', options)
  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

#set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name or id of the resource for this request.

  • global_set_policy_request_object (Google::Apis::DeploymentmanagerV2::GlobalSetPolicyRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



408
409
410
411
412
413
414
415
416
417
418
419
420
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 408

def set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/deployments/{resource}/setIamPolicy', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2::GlobalSetPolicyRequest::Representation
  command.request_object = global_set_policy_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2::Policy::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2::Policy
  command.params['project'] = project unless project.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

#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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • deployments_stop_request_object (Google::Apis::DeploymentmanagerV2::DeploymentsStopRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 448

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', options)
  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

#test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

Parameters:

  • project (String)

    Project ID for this request.

  • resource (String)

    Name or id of the resource for this request.

  • test_permissions_request_object (Google::Apis::DeploymentmanagerV2::TestPermissionsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 487

def test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, '{project}/global/deployments/{resource}/testIamPermissions', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2::TestPermissionsRequest::Representation
  command.request_object = test_permissions_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2::TestPermissionsResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2::TestPermissionsResponse
  command.params['project'] = project unless project.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

#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.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • deployment_object (Google::Apis::DeploymentmanagerV2::Deployment) (defaults to: nil)
  • create_policy (String)

    Sets the policy to use for creating new resources.

  • delete_policy (String)

    Sets the policy to use for deleting resources.

  • preview (Boolean)

    If set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 541

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}', options)
  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