Class: Google::Apis::DeploymentmanagerAlpha::DeploymentManagerAlphaService

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

Overview

Google Cloud Deployment Manager Alpha API

The Deployment Manager API allows users to declaratively configure, deploy and run complex solutions on the Google Cloud Platform.

Examples:

require 'google/apis/deploymentmanager_alpha'

Deploymentmanager = Google::Apis::DeploymentmanagerAlpha # Alias the module
service = Deploymentmanager::DeploymentManagerAlphaService.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 ⇒ DeploymentManagerAlphaService

Returns a new instance of DeploymentManagerAlphaService.



50
51
52
53
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 50

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



39
40
41
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



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

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String) —

    Deprecated. Please use quotaUser instead.



48
49
50
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 48

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 337

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::DeploymentmanagerAlpha::DeploymentsCancelPreviewRequest::Representation
  command.request_object = deployments_cancel_preview_request_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Deletes a composite type.

Parameters:

  • project (String) —

    The project ID for this request.

  • composite_type (String) —

    The name of the type for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

def delete_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{project}/global/compositeTypes/{compositeType}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 377

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::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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

#delete_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Deletes a type and all of the resources in the type.

Parameters:

  • project (String) —

    The project ID for this request.

  • type (String) —

    The name of the type for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1543

def delete_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{project}/global/types/{type}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['type'] = type unless type.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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Deletes a type provider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1173

def delete_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:delete, '{project}/global/typeProviders/{typeProvider}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.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_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::CompositeType

Gets information about a specific composite type.

Parameters:

  • project (String) —

    The project ID for this request.

  • composite_type (String) —

    The name of the composite type for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



115
116
117
118
119
120
121
122
123
124
125
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 115

def get_composite_type(project, composite_type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/global/compositeTypes/{compositeType}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::CompositeType
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



414
415
416
417
418
419
420
421
422
423
424
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 414

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::DeploymentmanagerAlpha::Deployment::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::Policy

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

Parameters:

  • project (String) —

    Project ID for this request.

  • resource (String) —

    Name or id of the resource for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



451
452
453
454
455
456
457
458
459
460
461
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 451

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::DeploymentmanagerAlpha::Policy::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 842

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::DeploymentmanagerAlpha::Manifest::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



953
954
955
956
957
958
959
960
961
962
963
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 953

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::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1062

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::DeploymentmanagerAlpha::Resource::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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

#get_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Type

Gets information about a specific type.

Parameters:

  • project (String) —

    The project ID for this request.

  • type (String) —

    The name of the type for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1579

def get_type(project, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/global/types/{type}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Type
  command.params['project'] = project unless project.nil?
  command.params['type'] = type unless type.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_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::TypeProvider

Gets information about a specific type provider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1209

def get_type_provider(project, type_provider, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvider
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.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_type_provider_type(project, type_provider, type, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::TypeInfo

Gets a type info for a type provided by a TypeProvider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

  • type (String) —

    The name of the type provider type for this request.

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

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1247

def get_type_provider_type(project, type_provider, type, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:get, '{project}/global/typeProviders/{typeProvider}/types/{type}', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeInfo::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeInfo
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.nil?
  command.params['type'] = type unless type.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_composite_type(project, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Creates a composite type.

Parameters:

  • project (String) —

    The project ID for this request.

  • composite_type_object (Google::Apis::DeploymentmanagerAlpha::CompositeType) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 150

def insert_composite_type(project, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{project}/global/compositeTypes', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation
  command.request_object = composite_type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 497

def insert_deployment(project, deployment_object = nil, create_policy: nil, preview: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{project}/global/deployments', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.query['createPolicy'] = create_policy unless create_policy.nil?
  command.query['preview'] = preview unless preview.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_type(project, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Creates a type.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_object (Google::Apis::DeploymentmanagerAlpha::Type) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1614

def insert_type(project, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{project}/global/types', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation
  command.request_object = type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.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_type_provider(project, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Creates a type provider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider_object (Google::Apis::DeploymentmanagerAlpha::TypeProvider) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1283

def insert_type_provider(project, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:post, '{project}/global/typeProviders', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation
  command.request_object = type_provider_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.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_composite_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::DeploymentmanagerAlpha::CompositeTypesListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 219

def list_composite_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/compositeTypes', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::CompositeTypesListResponse
  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_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::DeploymentmanagerAlpha::DeploymentsListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::DeploymentmanagerAlpha::DeploymentsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::DeploymentsListResponse
  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::DeploymentmanagerAlpha::ManifestsListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 913

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::DeploymentmanagerAlpha::ManifestsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::ManifestsListResponse
  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::DeploymentmanagerAlpha::OperationsListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1021

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::DeploymentmanagerAlpha::OperationsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::OperationsListResponse
  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::DeploymentmanagerAlpha::ResourcesListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1133

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::DeploymentmanagerAlpha::ResourcesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::ResourcesListResponse
  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_type_provider_types(project, type_provider, 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::DeploymentmanagerAlpha::TypeProvidersListTypesResponse

Lists all the type info for a TypeProvider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

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

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1425

def list_type_provider_types(project, type_provider, 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/typeProviders/{typeProvider}/types', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListTypesResponse
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.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_type_providers(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::DeploymentmanagerAlpha::TypeProvidersListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1352

def list_type_providers(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/typeProviders', options)
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::TypeProvidersListResponse
  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_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::DeploymentmanagerAlpha::TypesListResponse

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

  • max_results (Fixnum) (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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1683

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::DeploymentmanagerAlpha::TypesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::TypesListResponse
  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_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a composite type. This method supports patch semantics.

Parameters:

  • project (String) —

    The project ID for this request.

  • composite_type (String) —

    The name of the composite type for this request.

  • composite_type_object (Google::Apis::DeploymentmanagerAlpha::CompositeType) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 259

def patch_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{project}/global/compositeTypes/{compositeType}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation
  command.request_object = composite_type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.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::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 623

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::DeploymentmanagerAlpha::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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

#patch_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a type. This method supports patch semantics.

Parameters:

  • project (String) —

    The project ID for this request.

  • type (String) —

    The name of the type for this request.

  • type_object (Google::Apis::DeploymentmanagerAlpha::Type) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1723

def patch_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{project}/global/types/{type}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation
  command.request_object = type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['type'] = type unless type.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_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a type provider. This method supports patch semantics.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

  • type_provider_object (Google::Apis::DeploymentmanagerAlpha::TypeProvider) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1466

def patch_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:patch, '{project}/global/typeProviders/{typeProvider}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation
  command.request_object = type_provider_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 666

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 706

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::DeploymentmanagerAlpha::DeploymentsStopRequest::Representation
  command.request_object = deployments_stop_request_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



745
746
747
748
749
750
751
752
753
754
755
756
757
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 745

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::DeploymentmanagerAlpha::TestPermissionsRequest::Representation
  command.request_object = test_permissions_request_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::TestPermissionsResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a composite type.

Parameters:

  • project (String) —

    The project ID for this request.

  • composite_type (String) —

    The name of the composite type for this request.

  • composite_type_object (Google::Apis::DeploymentmanagerAlpha::CompositeType) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 298

def update_composite_type(project, composite_type, composite_type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, '{project}/global/compositeTypes/{compositeType}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::CompositeType::Representation
  command.request_object = composite_type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.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::DeploymentmanagerAlpha::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::DeploymentmanagerAlpha::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) —

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 799

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::DeploymentmanagerAlpha::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::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

#update_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a type.

Parameters:

  • project (String) —

    The project ID for this request.

  • type (String) —

    The name of the type for this request.

  • type_object (Google::Apis::DeploymentmanagerAlpha::Type) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1762

def update_type(project, type, type_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, '{project}/global/types/{type}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::Type::Representation
  command.request_object = type_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['type'] = type unless type.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_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerAlpha::Operation

Updates a type provider.

Parameters:

  • project (String) —

    The project ID for this request.

  • type_provider (String) —

    The name of the type provider for this request.

  • type_provider_object (Google::Apis::DeploymentmanagerAlpha::TypeProvider) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

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

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

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'generated/google/apis/deploymentmanager_alpha/service.rb', line 1505

def update_type_provider(project, type_provider, type_provider_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command = make_simple_command(:put, '{project}/global/typeProviders/{typeProvider}', options)
  command.request_representation = Google::Apis::DeploymentmanagerAlpha::TypeProvider::Representation
  command.request_object = type_provider_object
  command.response_representation = Google::Apis::DeploymentmanagerAlpha::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerAlpha::Operation
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.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