class VSphereAutomation::VCenter::DeploymentImportHistoryApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

cancel(opts = {}) click to toggle source

Cancels the task for importing vCenter historical data. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil]

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 22
def cancel(opts = {})
  cancel_with_http_info(opts)
  nil
end
cancel_with_http_info(opts = {}) click to toggle source

Cancels the task for importing vCenter historical data. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 31
def cancel_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentImportHistoryApi.cancel ...'
  end
  # resource path
  local_var_path = '/vcenter/deployment/history?action=cancel'

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentImportHistoryApi#cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(opts = {}) click to toggle source

Get the current status of the vCenter historical data import. @param [Hash] opts the optional parameters @return [VcenterDeploymentImportHistoryResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|]

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 66
def get(opts = {})
  data, _status_code, _headers = get_with_http_info(opts)
  data
end
get_with_http_info(opts = {}) click to toggle source

Get the current status of the vCenter historical data import. @api private @param [Hash] opts the optional parameters @return [Array<(VcenterDeploymentImportHistoryResult|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 75
def get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentImportHistoryApi.get ...'
  end
  # resource path
  local_var_path = '/vcenter/deployment/history'

  # 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::VcenterDeploymentImportHistoryResult',
      '400' => 'VCenter::VapiStdErrorsErrorError',
      '401' => 'VCenter::VapiStdErrorsUnauthenticatedError',
      '403' => 'VCenter::VapiStdErrorsUnauthorizedError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentImportHistoryApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
pause(opts = {}) click to toggle source

Pauses the task for importing vCenter historical data. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil]

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 116
def pause(opts = {})
  pause_with_http_info(opts)
  nil
end
pause_with_http_info(opts = {}) click to toggle source

Pauses the task for importing vCenter historical data. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 125
def pause_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentImportHistoryApi.pause ...'
  end
  # resource path
  local_var_path = '/vcenter/deployment/history?action=pause'

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentImportHistoryApi#pause\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
resume(opts = {}) click to toggle source

Resumes the task for importing vCenter historical data. @param [Hash] opts the optional parameters @return [|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil]

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 160
def resume(opts = {})
  resume_with_http_info(opts)
  nil
end
resume_with_http_info(opts = {}) click to toggle source

Resumes the task for importing vCenter historical data. @api private @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 169
def resume_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentImportHistoryApi.resume ...'
  end
  # resource path
  local_var_path = '/vcenter/deployment/history?action=resume'

  # 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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentImportHistoryApi#resume\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
start(opts = {}) click to toggle source

Creates and starts task for importing vCenter historical data. @param [Hash] opts the optional parameters @option opts [VcenterDeploymentImportHistoryStart] :request_body @return [|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil]

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 205
def start(opts = {})
  start_with_http_info(opts)
  nil
end
start_with_http_info(opts = {}) click to toggle source

Creates and starts task for importing vCenter historical data. @api private @param [Hash] opts the optional parameters @option opts [VcenterDeploymentImportHistoryStart] :request_body @return [Array<(|VapiStdErrorsErrorError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-vcenter/api/deployment_import_history_api.rb, line 215
def start_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeploymentImportHistoryApi.start ...'
  end
  # resource path
  local_var_path = '/vcenter/deployment/history?action=start'

  # 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(opts[:'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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DeploymentImportHistoryApi#start\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end