Class: Google::Apis::DeploymentmanagerV2beta::DeploymentManagerService

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

Overview

Cloud Deployment Manager V2 API

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

Examples:

require 'google/apis/deploymentmanager_v2beta'

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

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =
"https://deploymentmanager.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeDeploymentManagerService

Returns a new instance of DeploymentManagerService.

[View source]

49
50
51
52
53
54
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 49

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-deploymentmanager_v2beta',
        client_version: Google::Apis::DeploymentmanagerV2beta::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


42
43
44
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 42

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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


47
48
49
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::DeploymentsCancelPreviewRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 342

def cancel_deployment_preview(project, deployment, deployments_cancel_preview_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/cancelPreview', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsCancelPreviewRequest::Representation
  command.request_object = deployments_cancel_preview_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['deployment'] = deployment unless deployment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_composite_type(project, composite_type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

def delete_composite_type(project, composite_type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'deploymentmanager/v2beta/projects/{project}/global/compositeTypes/{compositeType}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_deployment(project, deployment, delete_policy: nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 380

def delete_deployment(project, deployment, delete_policy: nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_type_provider(project, type_provider, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

def delete_type_provider(project, type_provider, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders/{typeProvider}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_composite_type(project, composite_type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

def get_composite_type(project, composite_type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/compositeTypes/{compositeType}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::CompositeType
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_deployment(project, deployment, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

416
417
418
419
420
421
422
423
424
425
426
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 416

def get_deployment(project, deployment, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Deployment
  command.params['project'] = project unless project.nil?
  command.params['deployment'] = deployment unless deployment.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_deployment_iam_policy(project, resource, header_bypass_billing_filter: nil, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • options_requested_policy_version (Fixnum) (defaults to: nil)

    Requested IAM Policy version.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

454
455
456
457
458
459
460
461
462
463
464
465
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 454

def get_deployment_iam_policy(project, resource, header_bypass_billing_filter: nil, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{resource}/getIamPolicy', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Policy::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['optionsRequestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_manifest(project, deployment, manifest, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

848
849
850
851
852
853
854
855
856
857
858
859
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 848

def get_manifest(project, deployment, manifest, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/manifests/{manifest}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Manifest::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Manifest
  command.params['project'] = project unless project.nil?
  command.params['deployment'] = deployment unless deployment.nil?
  command.params['manifest'] = manifest unless manifest.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(project, operation, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

969
970
971
972
973
974
975
976
977
978
979
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 969

def get_operation(project, operation, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/operations/{operation}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['operation'] = operation unless operation.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_resource(project, deployment, resource, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1088

def get_resource(project, deployment, resource, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/resources/{resource}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Resource::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Resource
  command.params['project'] = project unless project.nil?
  command.params['deployment'] = deployment unless deployment.nil?
  command.params['resource'] = resource unless resource.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_type_provider(project, type_provider, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1244

def get_type_provider(project, type_provider, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders/{typeProvider}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::TypeProvider
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_type_provider_type(project, type_provider, type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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.

  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1281

def get_type_provider_type(project, type_provider, type, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders/{typeProvider}/types/{type}', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeInfo::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#insert_composite_type(project, composite_type_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::Operation

Creates a composite type.

Parameters:

  • project (String)

    The project ID for this request.

  • composite_type_object (Google::Apis::DeploymentmanagerV2beta::CompositeType) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

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

#insert_deployment(project, deployment_object = nil, create_policy: nil, header_bypass_billing_filter: nil, preview: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::Deployment) (defaults to: nil)
  • create_policy (String) (defaults to: nil)

    Sets the policy to use for creating new resources.

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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 500

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

#insert_type_provider(project, type_provider_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::Operation

Creates a type provider.

Parameters:

  • project (String)

    The project ID for this request.

  • type_provider_object (Google::Apis::DeploymentmanagerV2beta::TypeProvider) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1316

def insert_type_provider(project, type_provider_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation
  command.request_object = type_provider_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_composite_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

def list_composite_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/compositeTypes', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::CompositeTypesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#list_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

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

def list_deployments(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#list_manifests(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

931
932
933
934
935
936
937
938
939
940
941
942
943
944
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 931

def list_manifests(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/manifests', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::ManifestsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#list_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1049

def list_operations(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/operations', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::OperationsListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#list_resources(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1171

def list_resources(project, deployment, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/resources', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::ResourcesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1481

def list_type_provider_types(project, type_provider, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders/{typeProvider}/types', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListTypesResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  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, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1397

def list_type_providers(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvidersListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#list_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either =, != , >, <, <=, >= or :. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. The :* comparison can be used to test whether a key has been defined. For example, to find all objects with owner label use: labels.owner:* You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example: ( cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND ( scheduling.automaticRestart = true) If you want to use a regular expression, use the eq (equal) or ne (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: fieldname eq unquoted literal fieldname eq 'single quoted literal' fieldname eq "double quoted literal" ( fieldname1 eq literal) (fieldname2 ne "literal") The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use name ne .* instance. You cannot combine constraints on multiple fields using regular expressions.

  • max_results (Fixnum) (defaults to: nil)

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

  • order_by (String) (defaults to: nil)

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

  • page_token (String) (defaults to: nil)

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1640

def list_types(project, filter: nil, max_results: nil, order_by: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'deploymentmanager/v2beta/projects/{project}/global/types', options)
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TypesListResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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?
  execute_or_queue_command(command, &block)
end

#patch_composite_type(project, composite_type, composite_type_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::Operation

Patches 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::DeploymentmanagerV2beta::CompositeType) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 267

def patch_composite_type(project, composite_type, composite_type_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'deploymentmanager/v2beta/projects/{project}/global/compositeTypes/{compositeType}', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation
  command.request_object = composite_type_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, header_bypass_billing_filter: nil, preview: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::Operation

Patches a deployment and all of the resources described by the deployment manifest.

Parameters:

  • project (String)

    The project ID for this request.

  • deployment (String)

    The name of the deployment for this request.

  • deployment_object (Google::Apis::DeploymentmanagerV2beta::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.

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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 637

def patch_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, header_bypass_billing_filter: nil, preview: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['preview'] = preview unless preview.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_type_provider(project, type_provider, type_provider_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::Operation

Patches 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::DeploymentmanagerV2beta::TypeProvider) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1520

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

#set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::GlobalSetPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

678
679
680
681
682
683
684
685
686
687
688
689
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 678

def set_deployment_iam_policy(project, resource, global_set_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{resource}/setIamPolicy', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::GlobalSetPolicyRequest::Representation
  command.request_object = global_set_policy_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Policy::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Policy
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::DeploymentsStopRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

715
716
717
718
719
720
721
722
723
724
725
726
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 715

def stop_deployment(project, deployment, deployments_stop_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}/stop', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::DeploymentsStopRequest::Representation
  command.request_object = deployments_stop_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['deployment'] = deployment unless deployment.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::TestPermissionsRequest) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

752
753
754
755
756
757
758
759
760
761
762
763
764
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 752

def test_deployment_iam_permissions(project, resource, test_permissions_request_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{resource}/testIamPermissions', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::TestPermissionsRequest::Representation
  command.request_object = test_permissions_request_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::TestPermissionsResponse::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::TestPermissionsResponse
  command.params['project'] = project unless project.nil?
  command.params['resource'] = resource unless resource.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_composite_type(project, composite_type, composite_type_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::CompositeType) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

305
306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 305

def update_composite_type(project, composite_type, composite_type_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'deploymentmanager/v2beta/projects/{project}/global/compositeTypes/{compositeType}', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::CompositeType::Representation
  command.request_object = composite_type_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['compositeType'] = composite_type unless composite_type.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, header_bypass_billing_filter: nil, preview: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::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.

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

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

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 806

def update_deployment(project, deployment, deployment_object = nil, create_policy: nil, delete_policy: nil, header_bypass_billing_filter: nil, preview: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'deploymentmanager/v2beta/projects/{project}/global/deployments/{deployment}', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::Deployment::Representation
  command.request_object = deployment_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::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['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['preview'] = preview unless preview.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_type_provider(project, type_provider, type_provider_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DeploymentmanagerV2beta::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::DeploymentmanagerV2beta::TypeProvider) (defaults to: nil)
  • header_bypass_billing_filter (Boolean) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

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

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

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError)

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError)

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError)

    Authorization is required

[View source]

1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
# File 'lib/google/apis/deploymentmanager_v2beta/service.rb', line 1558

def update_type_provider(project, type_provider, type_provider_object = nil, header_bypass_billing_filter: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'deploymentmanager/v2beta/projects/{project}/global/typeProviders/{typeProvider}', options)
  command.request_representation = Google::Apis::DeploymentmanagerV2beta::TypeProvider::Representation
  command.request_object = type_provider_object
  command.response_representation = Google::Apis::DeploymentmanagerV2beta::Operation::Representation
  command.response_class = Google::Apis::DeploymentmanagerV2beta::Operation
  command.params['project'] = project unless project.nil?
  command.params['typeProvider'] = type_provider unless type_provider.nil?
  command.query['header.bypassBillingFilter'] = header_bypass_billing_filter unless header_bypass_billing_filter.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end