class VSphereAutomation::Content::SubscribedLibraryApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create(request_body, opts = {}) click to toggle source

Creates a new subscribed library. <p> Once created, the subscribed library will be empty. If the {@link LibraryModel#subscriptionInfo} property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear. @param request_body @param [Hash] opts the optional parameters @return [ContentSubscribedLibraryCreateResult|VapiStdErrorsResourceInaccessibleError|]

# File lib/vsphere-automation-content/api/subscribed_library_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 = {}) click to toggle source

Creates a new subscribed library. &lt;p&gt; Once created, the subscribed library will be empty. If the {@link LibraryModel#subscriptionInfo} property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(ContentSubscribedLibraryCreateResult|VapiStdErrorsResourceInaccessibleError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 33
def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.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 SubscribedLibraryApi.create"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library'

  # 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' => 'Content::ContentSubscribedLibraryCreateResult',
      '400' => 'Content::VapiStdErrorsResourceInaccessibleError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
delete(library_id, opts = {}) click to toggle source

Deletes the specified subscribed library. <p> Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal. @param library_id Identifier of the subscribed library to delete. @param [Hash] opts the optional parameters @return [|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|nil]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 79
def delete(library_id, opts = {})
  delete_with_http_info(library_id, opts)
  nil
end
delete_with_http_info(library_id, opts = {}) click to toggle source

Deletes the specified subscribed library. &lt;p&gt; Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal. @api private @param library_id Identifier of the subscribed library to delete. @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 89
def delete_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.delete ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.delete"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.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: SubscribedLibraryApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
evict(library_id, opts = {}) click to toggle source

Evicts the cached content of an on-demand subscribed library. <p> This {@term operation} allows the cached content of a subscribed library to be removed to free up storage capacity. This {@term operation} will only work when a subscribed library is synchronized on-demand. @param library_id Identifier of the subscribed library whose content should be evicted. @param [Hash] opts the optional parameters @return [|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 129
def evict(library_id, opts = {})
  evict_with_http_info(library_id, opts)
  nil
end
evict_with_http_info(library_id, opts = {}) click to toggle source

Evicts the cached content of an on-demand subscribed library. &lt;p&gt; This {@term operation} allows the cached content of a subscribed library to be removed to free up storage capacity. This {@term operation} will only work when a subscribed library is synchronized on-demand. @api private @param library_id Identifier of the subscribed library whose content should be evicted. @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 139
def evict_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.evict ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.evict"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}?~action=evict'.sub('{' + 'library_id' + '}', library_id.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(: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: SubscribedLibraryApi#evict\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get(library_id, opts = {}) click to toggle source

Returns a given subscribed library. @param library_id Identifier of the subscribed library to return. @param [Hash] opts the optional parameters @return [ContentSubscribedLibraryResult|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|]

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

Returns a given subscribed library. @api private @param library_id Identifier of the subscribed library to return. @param [Hash] opts the optional parameters @return [Array<(ContentSubscribedLibraryResult|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 189
def get_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.get ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.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' => 'Content::ContentSubscribedLibraryResult',
      '400' => 'Content::VapiStdErrorsInvalidElementTypeError',
      '404' => 'Content::VapiStdErrorsNotFoundError',
    })
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

Returns the identifiers of all subscribed libraries in the Content Library. @param [Hash] opts the optional parameters @return [ContentSubscribedLibraryListResult|]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 233
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

Returns the identifiers of all subscribed libraries in the Content Library. @api private @param [Hash] opts the optional parameters @return [Array<(ContentSubscribedLibraryListResult|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 242
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.list ...'
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library'

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

Probes remote library subscription information, including URL, SSL certificate and password. The resulting {@link ProbeResult} {@term structure} describes whether or not the subscription configuration is successful. @param request_body @param [Hash] opts the optional parameters @return [ContentSubscribedLibraryProbeResult|]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 281
def probe(request_body, opts = {})
  data, _status_code, _headers = probe_with_http_info(request_body, opts)
  data
end
probe_with_http_info(request_body, opts = {}) click to toggle source

Probes remote library subscription information, including URL, SSL certificate and password. The resulting {@link ProbeResult} {@term structure} describes whether or not the subscription configuration is successful. @api private @param request_body @param [Hash] opts the optional parameters @return [Array<(ContentSubscribedLibraryProbeResult|, Fixnum, Hash)>] data, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 291
def probe_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.probe ...'
  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 SubscribedLibraryApi.probe"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library?~action=probe'

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

Forces the synchronization of the subscribed library. <p> Synchronizing a subscribed library forcefully with this {@term operation} will perform the same synchronization behavior as would run periodically for the library. The {@link SubscriptionInfo#onDemand} setting is respected. Calling this {@term operation} on a library that is already in the process of synchronizing will have no effect. @param library_id Identifier of the subscribed library to synchronize. @param [Hash] opts the optional parameters @return [|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|nil]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 336
def sync(library_id, opts = {})
  sync_with_http_info(library_id, opts)
  nil
end
sync_with_http_info(library_id, opts = {}) click to toggle source

Forces the synchronization of the subscribed library. &lt;p&gt; Synchronizing a subscribed library forcefully with this {@term operation} will perform the same synchronization behavior as would run periodically for the library. The {@link SubscriptionInfo#onDemand} setting is respected. Calling this {@term operation} on a library that is already in the process of synchronizing will have no effect. @api private @param library_id Identifier of the subscribed library to synchronize. @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 346
def sync_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.sync ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.sync"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}?~action=sync'.sub('{' + 'library_id' + '}', library_id.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(: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: SubscribedLibraryApi#sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update(library_id, request_body, opts = {}) click to toggle source

Updates the properties of a subscribed library. <p> This is an incremental update to the subscribed library. {@term Fields} that are {@term unset} in the update specification will be left unchanged. @param library_id Identifier of the subscribed library to update. @param request_body @param [Hash] opts the optional parameters @return [|VapiStdErrorsConcurrentChangeError|VapiStdErrorsNotFoundError|nil]

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 387
def update(library_id, request_body, opts = {})
  update_with_http_info(library_id, request_body, opts)
  nil
end
update_with_http_info(library_id, request_body, opts = {}) click to toggle source

Updates the properties of a subscribed library. &lt;p&gt; This is an incremental update to the subscribed library. {@term Fields} that are {@term unset} in the update specification will be left unchanged. @api private @param library_id Identifier of the subscribed library to update. @param request_body @param [Hash] opts the optional parameters @return [Array<(|VapiStdErrorsConcurrentChangeError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/vsphere-automation-content/api/subscribed_library_api.rb, line 398
def update_with_http_info(library_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.update ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.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 SubscribedLibraryApi.update"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.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: SubscribedLibraryApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end