Class: Google::Apis::BaremetalsolutionV1alpha1::BaremetalsolutionService

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

Overview

Bare Metal Solution API

Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.

Examples:

require 'google/apis/baremetalsolution_v1alpha1'

Baremetalsolution = Google::Apis::BaremetalsolutionV1alpha1 # Alias the module
service = Baremetalsolution::BaremetalsolutionService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BaremetalsolutionService

Returns a new instance of BaremetalsolutionService.



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

def initialize
  super('https://baremetalsolution.googleapis.com/', '',
        client_name: 'google-apis-baremetalsolution_v1alpha1',
        client_version: Google::Apis::BaremetalsolutionV1alpha1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

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

Returns:

  • (String) —

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



39
40
41
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

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

Returns:

  • (String) —

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



44
45
46
 
# File 'lib/google/apis/baremetalsolution_v1alpha1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#list_project_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ListProvisioningQuotasResponse

List the budget details to provision resources on a given project.

Parameters:

  • parent (String) —

    Required. The parent project containing the provisioning quotas.

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

    The maximum number of items to return.

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

    The next_page_token value returned from a previous List request, if any.

  • 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



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

def list_project_provisioning_quotas(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+parent}/provisioningQuotas', options)
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ListProvisioningQuotasResponse::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ListProvisioningQuotasResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.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

#submit_location_provisioning_config(project, location, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig

Submit a provisiong configuration for a given project.

Parameters:

  • project (String) —

    Required. The target project of the provisioning request.

  • location (String) —

    Required. The target location of the provisioning request.

  • submit_provisioning_config_request_object (Google::Apis::BaremetalsolutionV1alpha1::SubmitProvisioningConfigRequest) (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



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

def submit_location_provisioning_config(project, location, submit_provisioning_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+project}/{+location}:submitProvisioningConfig', options)
  command.request_representation = Google::Apis::BaremetalsolutionV1alpha1::SubmitProvisioningConfigRequest::Representation
  command.request_object = submit_provisioning_config_request_object
  command.response_representation = Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig::Representation
  command.response_class = Google::Apis::BaremetalsolutionV1alpha1::ProvisioningConfig
  command.params['project'] = project unless project.nil?
  command.params['location'] = location unless location.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end