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

#initialize ⇒ DeploymentManagerService

Returns a new instance of DeploymentManagerService



51
52
53
54
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', 'deploymentmanager/v2/projects/')
  @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.



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

def key
  @key
end

#quota_user ⇒ String

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

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. Overrides userIp if both are provided.



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns:

  • (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.



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

def user_ip
  @user_ip
end

Instance Method Details

#cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2::Operation

Cancels and removes the preview currently associated with the deployment.

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 83

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 125

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



164
165
166
167
168
169
170
171
172
173
174
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 164

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 of the resource for this request.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



203
204
205
206
207
208
209
210
211
212
213
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 203

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 611

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



730
731
732
733
734
735
736
737
738
739
740
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 730

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 847

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, 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)
  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 249

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

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 325

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

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 688

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

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • 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
816
817
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 804

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

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 924

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

    Sets a filter expression for filtering listed resources, in the form filter= expression. Your expression must be in the format: field_name comparison_string literal_string. The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. For example, to filter for instances that do not have a name of example- instance, you would use filter=name ne example-instance. You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us- central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.

  • 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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 1002

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 382

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, policy_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 of the resource for this request.

  • policy_object (Google::Apis::DeploymentmanagerV2::Policy) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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. Overrides userIp if both are provided.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 427

def set_deployment_iam_policy(project, resource, policy_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::Policy::Representation
  command.request_object = policy_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) —

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 469

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 510

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

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

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'generated/google/apis/deploymentmanager_v2/service.rb', line 566

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