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

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

Overview

Cloud Deployment Manager V2 API

The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.

Examples:

require 'google/apis/deploymentmanager_v2'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DeploymentManagerService

Returns a new instance of DeploymentManagerService.

[View source]

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

def initialize
  super('https://deploymentmanager.googleapis.com/', '',
        client_name: 'google-apis-deploymentmanager_v2',
        client_version: Google::Apis::DeploymentmanagerV2::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/deploymentmanager_v2/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/deploymentmanager_v2/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: 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) (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

[View source]

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

def cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#delete_deployment(project, deployment, delete_policy: nil, fields: nil, quota_user: 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) (defaults to: nil) —

    Sets the policy to use for deleting resources.

  • 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

[View source]

114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 114

def delete_deployment(project, deployment, delete_policy: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_deployment(project, deployment, fields: nil, quota_user: 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) (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

[View source]

148
149
150
151
152
153
154
155
156
157
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 148

def get_deployment(project, deployment, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_deployment_iam_policy(project, resource, options_requested_policy_version: nil, fields: nil, quota_user: 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.

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

    Requested IAM Policy version.

  • 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

[View source]

184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 184

def get_deployment_iam_policy(project, resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.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_manifest(project, deployment, manifest, fields: nil, quota_user: 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) (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

[View source]

567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 567

def get_manifest(project, deployment, manifest, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_operation(project, operation, fields: nil, quota_user: 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) (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

[View source]

685
686
687
688
689
690
691
692
693
694
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 685

def get_operation(project, operation, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#get_resource(project, deployment, resource, fields: nil, quota_user: 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) (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

[View source]

801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 801

def get_resource(project, deployment, resource, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#insert_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: 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) (defaults to: nil) —

    Sets the policy to use for creating new resources.

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

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

[View source]

228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 228

def insert_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

[View source]

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

def list_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

[View source]

648
649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 648

def list_manifests(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

[View source]

763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/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, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

[View source]

882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 882

def list_resources(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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. The : operator can be used with string fields to match substrings. For non-string fields it is equivalent to the = operator. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* 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) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" (fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .*instance.

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

    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) (defaults to: nil) —

    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) (defaults to: nil) —

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

[View source]

964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 964

def list_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2/projects/{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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation

Patches 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) (defaults to: nil) —

    Sets the policy to use for creating new resources.

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

    Sets the policy to use for deleting resources.

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

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

[View source]

362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 362

def patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: 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) (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

[View source]

402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 402

def set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: 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) (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

[View source]

439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 439

def stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end

#test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: 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) (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

[View source]

475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 475

def test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2/projects/{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?
  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, 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) (defaults to: nil) —

    Sets the policy to use for creating new resources.

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

    Sets the policy to use for deleting resources.

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

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

[View source]

527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/google/apis/deploymentmanager_v2/service.rb', line 527

def update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, preview: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'deploymentmanager/v2/projects/{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?
  execute_or_queue_command(command, &block)
end