class Google::Apis::ManagerV1beta2::ManagerService
Deployment Manager API
The Deployment Manager API allows users to declaratively configure, deploy and
run complex solutions on the Google Cloud Platform.
@example
require 'google/apis/manager_v1beta2' Manager = Google::Apis::ManagerV1beta2 # Alias the module service = Manager::ManagerService.new
Attributes
@return [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.
@return [String]
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@return [String]
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
Public Class Methods
# File generated/google/apis/manager_v1beta2/service.rb, line 52 def initialize super('https://www.googleapis.com/', 'manager/v1beta2/projects/') end
Public Instance Methods
@param [String] project_id @param [String] region @param [String] deployment_name @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 81 def delete_deployment(project_id, region, deployment_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{projectId}/regions/{region}/deployments/{deploymentName}', options) command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['deploymentName'] = deployment_name unless deployment_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [String] template_name @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [NilClass] No result returned for this method @yieldparam err [StandardError] error object if request failed
@return [void]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 237 def delete_template(project_id, template_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:delete, '{projectId}/templates/{templateName}', options) command.params['projectId'] = project_id unless project_id.nil? command.params['templateName'] = template_name unless template_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [String] region @param [String] deployment_name @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::Deployment] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::Deployment]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 117 def get_deployment(project_id, region, deployment_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{projectId}/regions/{region}/deployments/{deploymentName}', options) command.response_representation = Google::Apis::ManagerV1beta2::Deployment::Representation command.response_class = Google::Apis::ManagerV1beta2::Deployment command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.params['deploymentName'] = deployment_name unless deployment_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [String] template_name @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::Template] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::Template]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 271 def get_template(project_id, template_name, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{projectId}/templates/{templateName}', options) command.response_representation = Google::Apis::ManagerV1beta2::Template::Representation command.response_class = Google::Apis::ManagerV1beta2::Template command.params['projectId'] = project_id unless project_id.nil? command.params['templateName'] = template_name unless template_name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [String] region @param [Google::Apis::ManagerV1beta2::Deployment] deployment_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::Deployment] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::Deployment]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 155 def insert_deployment(project_id, region, deployment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{projectId}/regions/{region}/deployments', options) command.request_representation = Google::Apis::ManagerV1beta2::Deployment::Representation command.request_object = deployment_object command.response_representation = Google::Apis::ManagerV1beta2::Deployment::Representation command.response_class = Google::Apis::ManagerV1beta2::Deployment command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [Google::Apis::ManagerV1beta2::Template] template_object @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::Template] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::Template]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 307 def insert_template(project_id, template_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:post, '{projectId}/templates', options) command.request_representation = Google::Apis::ManagerV1beta2::Template::Representation command.request_object = template_object command.response_representation = Google::Apis::ManagerV1beta2::Template::Representation command.response_class = Google::Apis::ManagerV1beta2::Template command.params['projectId'] = project_id unless project_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [String] region @param [Fixnum] max_results
Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
@param [String] page_token
Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::ListDeploymentsResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::ListDeploymentsResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 199 def list_deployments(project_id, region, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{projectId}/regions/{region}/deployments', options) command.response_representation = Google::Apis::ManagerV1beta2::ListDeploymentsResponse::Representation command.response_class = Google::Apis::ManagerV1beta2::ListDeploymentsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['region'] = region unless region.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
@param [String] project_id @param [Fixnum] max_results
Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
@param [String] page_token
Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] #quota_user
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
@param [String] #user_ip
IP address of the site where the request originates. Use this if you want to enforce per-user limits.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::ManagerV1beta2::ListTemplatesResponse] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::ManagerV1beta2::ListTemplatesResponse]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File generated/google/apis/manager_v1beta2/service.rb, line 349 def list_templates(project_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, '{projectId}/templates', options) command.response_representation = Google::Apis::ManagerV1beta2::ListTemplatesResponse::Representation command.response_class = Google::Apis::ManagerV1beta2::ListTemplatesResponse command.params['projectId'] = project_id unless project_id.nil? command.query['maxResults'] = max_results unless max_results.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end
Protected Instance Methods
# File generated/google/apis/manager_v1beta2/service.rb, line 364 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end