Class: VSphereAutomation::Content::ConfigurationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-content/api/configuration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



16
17
18
 
# File 'lib/vsphere-automation-content/api/configuration_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-content/api/configuration_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get(opts = {}) ⇒ ContentConfigurationResult|

Retrieves the current configuration values.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



22
23
24
25
 
# File 'lib/vsphere-automation-content/api/configuration_api.rb', line 22

def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end

#get_with_http_info(opts = {}) ⇒ Array<(ContentConfigurationResult|, 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.

Retrieves the current configuration values.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



31
32
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
 
# File 'lib/vsphere-automation-content/api/configuration_api.rb', line 31

def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get ...'
  end
  # resource path
  local_var_path = '/com/vmware/content/configuration?~action=get'

  # 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(:POST, 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' => 'Content::ContentConfigurationResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(request_body, opts = {}) ⇒ |VapiStdErrorsInvalidArgumentError|nil

Updates the configuration. The update is incremental. Any field in the ConfigurationModel structure that is unset will not be modified. Note that this update operation doesn’t guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

Parameters:

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



70
71
72
73
 
# File 'lib/vsphere-automation-content/api/configuration_api.rb', line 70

def update(request_body, opts = {})
  update_with_http_info(request_body, opts)
  nil
end

#update_with_http_info(request_body, opts = {}) ⇒ Array<(|VapiStdErrorsInvalidArgumentError|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 configuration. The update is incremental. Any field in the ConfigurationModel structure that is unset will not be modified. Note that this update operation doesn&#39;t guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

Parameters:

  • request_body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/vsphere-automation-content/api/configuration_api.rb', line 80

def update_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.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 ConfigurationApi.update"
  end
  # resource path
  local_var_path = '/com/vmware/content/configuration'

  # 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: ConfigurationApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end