Class: VSphereAutomation::VCenter::VmHardwareMemoryApi
- Inherits:
-
Object
- Object
- VSphereAutomation::VCenter::VmHardwareMemoryApi
- Defined in:
- lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get(vm, opts = {}) ⇒ VcenterVmHardwareMemoryResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns the memory-related settings of a virtual machine.
-
#get_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVmHardwareMemoryResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
private
Returns the memory-related settings of a virtual machine.
-
#initialize(api_client = ApiClient.default) ⇒ VmHardwareMemoryApi
constructor
A new instance of VmHardwareMemoryApi.
-
#update(vm, request_body, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil
Updates the memory-related settings of a virtual machine.
-
#update_with_http_info(vm, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>
private
Updates the memory-related settings of a virtual machine.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ VmHardwareMemoryApi
Returns a new instance of VmHardwareMemoryApi.
16 17 18 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 16 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
14 15 16 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 14 def api_client @api_client end |
Instance Method Details
#get(vm, opts = {}) ⇒ VcenterVmHardwareMemoryResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|
Returns the memory-related settings of a virtual machine.
23 24 25 26 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 23 def get(vm, opts = {}) data, _status_code, _headers = get_with_http_info(vm, opts) data end |
#get_with_http_info(vm, opts = {}) ⇒ Array<(VcenterVmHardwareMemoryResult|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|, Fixnum, Hash)>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the memory-related settings of a virtual machine.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 33 def get_with_http_info(vm, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VmHardwareMemoryApi.get ...' end # verify the required parameter 'vm' is set if @api_client.config.client_side_validation && vm.nil? fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareMemoryApi.get" end # resource path local_var_path = '/vcenter/vm/{vm}/hardware/memory'.sub('{' + 'vm' + '}', vm.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => { '200' => 'VCenter::VcenterVmHardwareMemoryResult', '400' => 'VCenter::VapiStdErrorsResourceInaccessibleError', '401' => 'VCenter::VapiStdErrorsUnauthenticatedError', '403' => 'VCenter::VapiStdErrorsUnauthorizedError', '404' => 'VCenter::VapiStdErrorsNotFoundError', '503' => 'VCenter::VapiStdErrorsServiceUnavailableError', }) if @api_client.config.debugging @api_client.config.logger.debug "API called: VmHardwareMemoryApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update(vm, request_body, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil
Updates the memory-related settings of a virtual machine.
82 83 84 85 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 82 def update(vm, request_body, opts = {}) update_with_http_info(vm, request_body, opts) nil end |
#update_with_http_info(vm, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|VapiStdErrorsServiceUnavailableError|nil, Fixnum, Hash)>
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Updates the memory-related settings of a virtual machine.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/vsphere-automation-vcenter/api/vm_hardware_memory_api.rb', line 93 def update_with_http_info(vm, request_body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VmHardwareMemoryApi.update ...' end # verify the required parameter 'vm' is set if @api_client.config.client_side_validation && vm.nil? fail ArgumentError, "Missing the required parameter 'vm' when calling VmHardwareMemoryApi.update" end # verify the required parameter 'request_body' is set if @api_client.config.client_side_validation && request_body.nil? fail ArgumentError, "Missing the required parameter 'request_body' when calling VmHardwareMemoryApi.update" end # resource path local_var_path = '/vcenter/vm/{vm}/hardware/memory'.sub('{' + 'vm' + '}', vm.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request_body) auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: VmHardwareMemoryApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |