Class: VSphereAutomation::VCenter::CertificateManagementVcenterTrustedRootChainsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CertificateManagementVcenterTrustedRootChainsApi

Returns a new instance of CertificateManagementVcenterTrustedRootChainsApi.



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

def api_client
  @api_client
end

Instance Method Details

#create(request_body, opts = {}) ⇒ VcenterCertificateManagementVcenterTrustedRootChainsCreateResult|VapiStdErrorsAlreadyExistsError|VapiStdErrorsUnauthorizedError|

Creates a new trusted root certificate chain from the CreateSpec.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 23

def create(request_body, opts = {})
  data, _status_code, _headers = create_with_http_info(request_body, opts)
  data
end

#create_with_http_info(request_body, opts = {}) ⇒ Array<(VcenterCertificateManagementVcenterTrustedRootChainsCreateResult|VapiStdErrorsAlreadyExistsError|VapiStdErrorsUnauthorizedError|, 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.

Creates a new trusted root certificate chain from the CreateSpec.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 33

def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificateManagementVcenterTrustedRootChainsApi.create ...'
  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 CertificateManagementVcenterTrustedRootChainsApi.create"
  end
  # resource path
  local_var_path = '/vcenter/certificate-management/vcenter/trusted-root-chains'

  # 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(: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' => 'VCenter::VcenterCertificateManagementVcenterTrustedRootChainsCreateResult',
	  '400' => 'VCenter::VapiStdErrorsAlreadyExistsError',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CertificateManagementVcenterTrustedRootChainsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(chain, opts = {}) ⇒ |VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|nil

Deletes trusted root certificate chain for a given identifier.

Parameters:

  • chain —

    Unique identifier for a trusted root cert chain.

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 80

def delete(chain, opts = {})
  delete_with_http_info(chain, opts)
  nil
end

#delete_with_http_info(chain, opts = {}) ⇒ Array<(|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|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.

Deletes trusted root certificate chain for a given identifier.

Parameters:

  • chain —

    Unique identifier for a trusted root cert chain.

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

    the optional parameters

Returns:



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
118
119
120
121
122
123
124
125
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 90

def delete_with_http_info(chain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificateManagementVcenterTrustedRootChainsApi.delete ...'
  end
  # verify the required parameter 'chain' is set
  if @api_client.config.client_side_validation && chain.nil?
    fail ArgumentError, "Missing the required parameter 'chain' when calling CertificateManagementVcenterTrustedRootChainsApi.delete"
  end
  # resource path
  local_var_path = '/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}'.sub('{' + 'chain' + '}', chain.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(:DELETE, 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: CertificateManagementVcenterTrustedRootChainsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(chain, opts = {}) ⇒ VcenterCertificateManagementVcenterTrustedRootChainsResult|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|

Retrieve a trusted root certificate chain for a given identifier.

Parameters:

  • chain —

    Unique identifier for a trusted root cert chain.

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

    the optional parameters

Returns:



130
131
132
133
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 130

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

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

Retrieve a trusted root certificate chain for a given identifier.

Parameters:

  • chain —

    Unique identifier for a trusted root cert chain.

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

    the optional parameters

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 140

def get_with_http_info(chain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificateManagementVcenterTrustedRootChainsApi.get ...'
  end
  # verify the required parameter 'chain' is set
  if @api_client.config.client_side_validation && chain.nil?
    fail ArgumentError, "Missing the required parameter 'chain' when calling CertificateManagementVcenterTrustedRootChainsApi.get"
  end
  # resource path
  local_var_path = '/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}'.sub('{' + 'chain' + '}', chain.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::VcenterCertificateManagementVcenterTrustedRootChainsResult',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	  '404' => 'VCenter::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CertificateManagementVcenterTrustedRootChainsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ VcenterCertificateManagementVcenterTrustedRootChainsListResult|VapiStdErrorsUnauthorizedError|

Returns summary information for each trusted root certificate chain.

Parameters:

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

    the optional parameters

Returns:



184
185
186
187
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 184

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ Array<(VcenterCertificateManagementVcenterTrustedRootChainsListResult|VapiStdErrorsUnauthorizedError|, 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 summary information for each trusted root certificate chain.

Parameters:

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

    the optional parameters

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/vsphere-automation-vcenter/api/certificate_management_vcenter_trusted_root_chains_api.rb', line 193

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CertificateManagementVcenterTrustedRootChainsApi.list ...'
  end
  # resource path
  local_var_path = '/vcenter/certificate-management/vcenter/trusted-root-chains'

  # 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::VcenterCertificateManagementVcenterTrustedRootChainsListResult',
	  '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CertificateManagementVcenterTrustedRootChainsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end