Class: VSphereAutomation::Content::LibrarySubscribedItemApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LibrarySubscribedItemApi

Returns a new instance of LibrarySubscribedItemApi.



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

def api_client
  @api_client
end

Instance Method Details

#evict(library_item_id, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil

Evicts the cached content of a library item in a subscribed library. <p> This operation allows the cached content of a library item to be removed to free up storage capacity. This operation will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel#cached to false.

Parameters:

  • library_item_id —

    Identifier of the library item whose content should be evicted.

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

    the optional parameters

Returns:



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

def evict(library_item_id, opts = {})
  evict_with_http_info(library_item_id, opts)
  nil
end

#evict_with_http_info(library_item_id, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|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.

Evicts the cached content of a library item in a subscribed library. &lt;p&gt; This operation allows the cached content of a library item to be removed to free up storage capacity. This operation will only work when a library item is synchronized on-demand. When a library is not synchronized on-demand, it always attempts to keep its cache up-to-date with the published source. Evicting the library item will set ItemModel#cached to false.

Parameters:

  • library_item_id —

    Identifier of the library item whose content should be evicted.

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

def evict_with_http_info(library_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibrarySubscribedItemApi.evict ...'
  end
  # verify the required parameter 'library_item_id' is set
  if @api_client.config.client_side_validation && library_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_id' when calling LibrarySubscribedItemApi.evict"
  end
  # resource path
  local_var_path = '/com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=evict'.sub('{' + 'library_item_id' + '}', library_item_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: LibrarySubscribedItemApi#evict\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync(library_item_id, request_body, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil

Forces the synchronization of an individual library item in a subscribed library. <p> Synchronizing an individual item will update that item’s metadata from the remote source. If the source library item on the remote library has been deleted, this operation will delete the library item from the subscribed library as well. <p> The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item. <ul> <li>If SubscriptionInfo#onDemand is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.</li> <li>If SubscriptionInfo#onDemand is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.</li> </ul> When the file content has been synchronized, the ItemModel#cached field will be true. <p> This operation will return immediately and create an asynchronous task to perform the synchronization.

Parameters:

  • library_item_id —

    Identifier of the library item to synchronize.

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

    the optional parameters

Returns:



74
75
76
77
 
# File 'lib/vsphere-automation-content/api/library_subscribed_item_api.rb', line 74

def sync(library_item_id, request_body, opts = {})
  sync_with_http_info(library_item_id, request_body, opts)
  nil
end

#sync_with_http_info(library_item_id, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|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.

Forces the synchronization of an individual library item in a subscribed library. &lt;p&gt; Synchronizing an individual item will update that item&#39;s metadata from the remote source. If the source library item on the remote library has been deleted, this operation will delete the library item from the subscribed library as well. &lt;p&gt; The default behavior of the synchronization is determined by the SubscriptionInfo of the library which owns the library item. &lt;ul&gt; &lt;li&gt;If SubscriptionInfo#onDemand is true, then the file content is not synchronized by default. In this case, only the library item metadata is synchronized. The file content may still be forcefully synchronized by passing true for the forceSyncContent parameter.&lt;/li&gt; &lt;li&gt;If SubscriptionInfo#onDemand is false, then this call will always synchronize the file content. The forceSyncContent parameter is ignored when the subscription is not on-demand.&lt;/li&gt; &lt;/ul&gt; When the file content has been synchronized, the ItemModel#cached field will be true. &lt;p&gt; This operation will return immediately and create an asynchronous task to perform the synchronization.

Parameters:

  • library_item_id —

    Identifier of the library item to synchronize.

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

    the optional parameters

Returns:



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

def sync_with_http_info(library_item_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibrarySubscribedItemApi.sync ...'
  end
  # verify the required parameter 'library_item_id' is set
  if @api_client.config.client_side_validation && library_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_item_id' when calling LibrarySubscribedItemApi.sync"
  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 LibrarySubscribedItemApi.sync"
  end
  # resource path
  local_var_path = '/com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=sync'.sub('{' + 'library_item_id' + '}', library_item_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(: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: LibrarySubscribedItemApi#sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end