vsphere-automation-content 0.1.0

data/docs/LibraryItemUpdatesessionFileApi.md

@@ -0,0 +1,233 @@
+# VSphereAutomation::Content::LibraryItemUpdatesessionFileApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add**](LibraryItemUpdatesessionFileApi.md#add) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=add | Requests file content to be changed (either created, or updated). Depending on the source type of the file, this {@term operation} will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this {@term operation} will be used to update the content of the existing file. <p> When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.
+[**get**](LibraryItemUpdatesessionFileApi.md#get) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=get | Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
+[**list**](LibraryItemUpdatesessionFileApi.md#list) | **GET** /com/vmware/content/library/item/updatesession/file | Lists all files in the library item associated with the update session.
+[**remove**](LibraryItemUpdatesessionFileApi.md#remove) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=remove | Requests a file to be removed. The file will only be effectively removed when the update session is completed.
+[**validate**](LibraryItemUpdatesessionFileApi.md#validate) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id}?~action=validate | Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this {@term operation} will return its name in the {@link ValidationResult#missingFiles} set. The user can add the missing files and try re-validating. For other type of errors, {@link ValidationResult#invalidFiles} will contain the list of invalid files.
+
+
+# **add**
+> ContentLibraryItemUpdatesessionFileAddResult add(update_session_id, content_library_item_updatesession_file_add)
+
+Requests file content to be changed (either created, or updated). Depending on the source type of the file, this {@term operation} will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this {@term operation} will be used to update the content of the existing file. <p> When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
+update_session_id = 'update_session_id_example' # String | Identifier of the update session to be modified.
+content_library_item_updatesession_file_add = VSphereAutomation::ContentLibraryItemUpdatesessionFileAdd.new # ContentLibraryItemUpdatesessionFileAdd | 
+
+begin
+  #Requests file content to be changed (either created, or updated). Depending on the source type of the file, this {@term operation} will either return an upload endpoint where the client can push the content, or the server will pull from the provided source endpoint. If a file with the same name already exists in this session, this {@term operation} will be used to update the content of the existing file. <p> When importing a file directly from storage, where the source endpoint is a file or datastore URI, you will need to have the ContentLibrary.ReadStorage privilege on the library item. If the file is located in the same directory as the library storage backing folder, the server will move the file instead of copying it, thereby allowing instantaneous import of files for efficient backup and restore scenarios. In all other cases, a copy is performed rather than a move.
+  result = api_instance.add(update_session_id, content_library_item_updatesession_file_add)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibraryItemUpdatesessionFileApi->add: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_session_id** | **String**| Identifier of the update session to be modified. | 
+ **content_library_item_updatesession_file_add** | [**ContentLibraryItemUpdatesessionFileAdd**](ContentLibraryItemUpdatesessionFileAdd.md)|  | 
+
+### Return type
+
+[**ContentLibraryItemUpdatesessionFileAddResult**](ContentLibraryItemUpdatesessionFileAddResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **get**
+> ContentLibraryItemUpdatesessionFileResult get(update_session_id, content_library_item_updatesession_file_get)
+
+Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
+update_session_id = 'update_session_id_example' # String | Identifier of the update session.
+content_library_item_updatesession_file_get = VSphereAutomation::ContentLibraryItemUpdatesessionFileGet.new # ContentLibraryItemUpdatesessionFileGet | 
+
+begin
+  #Retrieves information about a specific file in the snapshot of the library item at the time when the update session was created.
+  result = api_instance.get(update_session_id, content_library_item_updatesession_file_get)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibraryItemUpdatesessionFileApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_session_id** | **String**| Identifier of the update session. | 
+ **content_library_item_updatesession_file_get** | [**ContentLibraryItemUpdatesessionFileGet**](ContentLibraryItemUpdatesessionFileGet.md)|  | 
+
+### Return type
+
+[**ContentLibraryItemUpdatesessionFileResult**](ContentLibraryItemUpdatesessionFileResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **list**
+> ContentLibraryItemUpdatesessionFileListResult list(update_session_id)
+
+Lists all files in the library item associated with the update session.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
+update_session_id = 'update_session_id_example' # String | Identifier of the update session.
+
+begin
+  #Lists all files in the library item associated with the update session.
+  result = api_instance.list(update_session_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibraryItemUpdatesessionFileApi->list: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_session_id** | **String**| Identifier of the update session. | 
+
+### Return type
+
+[**ContentLibraryItemUpdatesessionFileListResult**](ContentLibraryItemUpdatesessionFileListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **remove**
+> remove(update_session_id, content_library_item_updatesession_file_remove)
+
+Requests a file to be removed. The file will only be effectively removed when the update session is completed.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
+update_session_id = 'update_session_id_example' # String | Identifier of the update session.
+content_library_item_updatesession_file_remove = VSphereAutomation::ContentLibraryItemUpdatesessionFileRemove.new # ContentLibraryItemUpdatesessionFileRemove | 
+
+begin
+  #Requests a file to be removed. The file will only be effectively removed when the update session is completed.
+  api_instance.remove(update_session_id, content_library_item_updatesession_file_remove)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibraryItemUpdatesessionFileApi->remove: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_session_id** | **String**| Identifier of the update session. | 
+ **content_library_item_updatesession_file_remove** | [**ContentLibraryItemUpdatesessionFileRemove**](ContentLibraryItemUpdatesessionFileRemove.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **validate**
+> ContentLibraryItemUpdatesessionFileValidateResult validate(update_session_id)
+
+Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this {@term operation} will return its name in the {@link ValidationResult#missingFiles} set. The user can add the missing files and try re-validating. For other type of errors, {@link ValidationResult#invalidFiles} will contain the list of invalid files.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
+update_session_id = 'update_session_id_example' # String | Identifier of the update session to validate.
+
+begin
+  #Validates the files in the update session with the referenced identifier and ensures all necessary files are received. In the case where a file is missing, this {@term operation} will return its name in the {@link ValidationResult#missingFiles} set. The user can add the missing files and try re-validating. For other type of errors, {@link ValidationResult#invalidFiles} will contain the list of invalid files.
+  result = api_instance.validate(update_session_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibraryItemUpdatesessionFileApi->validate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **update_session_id** | **String**| Identifier of the update session to validate. | 
+
+### Return type
+
+[**ContentLibraryItemUpdatesessionFileValidateResult**](ContentLibraryItemUpdatesessionFileValidateResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/LibrarySubscribedItemApi.md

@@ -0,0 +1,96 @@
+# VSphereAutomation::Content::LibrarySubscribedItemApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**evict**](LibrarySubscribedItemApi.md#evict) | **POST** /com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=evict | Evicts the cached content of a library item in a subscribed library. <p> This {@term operation} allows the cached content of a library item to be removed to free up storage capacity. This {@term 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 {@link ItemModel#cached} to false.
+[**sync**](LibrarySubscribedItemApi.md#sync) | **POST** /com/vmware/content/library/subscribed-item/id:{library_item_id}?~action=sync | 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 {@term operation} will delete the library item from the subscribed library as well. <p> The default behavior of the synchronization is determined by the {@link SubscriptionInfo} of the library which owns the library item. <ul> <li>If {@link 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 {@param.name forceSyncContent} {@term parameter}.</li> <li>If {@link SubscriptionInfo#onDemand} is false, then this call will always synchronize the file content. The {@param.name forceSyncContent} {@term parameter} is ignored when the subscription is not on-demand.</li> </ul> When the file content has been synchronized, the {@link ItemModel#cached} {@term field} will be true. <p> This {@term operation} will return immediately and create an asynchronous task to perform the synchronization.
+
+
+# **evict**
+> evict(library_item_id)
+
+Evicts the cached content of a library item in a subscribed library. <p> This {@term operation} allows the cached content of a library item to be removed to free up storage capacity. This {@term 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 {@link ItemModel#cached} to false.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibrarySubscribedItemApi.new
+library_item_id = 'library_item_id_example' # String | Identifier of the library item whose content should be evicted.
+
+begin
+  #Evicts the cached content of a library item in a subscribed library. <p> This {@term operation} allows the cached content of a library item to be removed to free up storage capacity. This {@term 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 {@link ItemModel#cached} to false.
+  api_instance.evict(library_item_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibrarySubscribedItemApi->evict: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_item_id** | **String**| Identifier of the library item whose content should be evicted. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **sync**
+> sync(library_item_id, content_library_subscribed_item_sync)
+
+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 {@term operation} will delete the library item from the subscribed library as well. <p> The default behavior of the synchronization is determined by the {@link SubscriptionInfo} of the library which owns the library item. <ul> <li>If {@link 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 {@param.name forceSyncContent} {@term parameter}.</li> <li>If {@link SubscriptionInfo#onDemand} is false, then this call will always synchronize the file content. The {@param.name forceSyncContent} {@term parameter} is ignored when the subscription is not on-demand.</li> </ul> When the file content has been synchronized, the {@link ItemModel#cached} {@term field} will be true. <p> This {@term operation} will return immediately and create an asynchronous task to perform the synchronization.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LibrarySubscribedItemApi.new
+library_item_id = 'library_item_id_example' # String | Identifier of the library item to synchronize.
+content_library_subscribed_item_sync = VSphereAutomation::ContentLibrarySubscribedItemSync.new # ContentLibrarySubscribedItemSync | 
+
+begin
+  #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 {@term operation} will delete the library item from the subscribed library as well. <p> The default behavior of the synchronization is determined by the {@link SubscriptionInfo} of the library which owns the library item. <ul> <li>If {@link 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 {@param.name forceSyncContent} {@term parameter}.</li> <li>If {@link SubscriptionInfo#onDemand} is false, then this call will always synchronize the file content. The {@param.name forceSyncContent} {@term parameter} is ignored when the subscription is not on-demand.</li> </ul> When the file content has been synchronized, the {@link ItemModel#cached} {@term field} will be true. <p> This {@term operation} will return immediately and create an asynchronous task to perform the synchronization.
+  api_instance.sync(library_item_id, content_library_subscribed_item_sync)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LibrarySubscribedItemApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_item_id** | **String**| Identifier of the library item to synchronize. | 
+ **content_library_subscribed_item_sync** | [**ContentLibrarySubscribedItemSync**](ContentLibrarySubscribedItemSync.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/LocalLibraryApi.md

@@ -0,0 +1,224 @@
+# VSphereAutomation::Content::LocalLibraryApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](LocalLibraryApi.md#create) | **POST** /com/vmware/content/local-library | Creates a new local library.
+[**delete**](LocalLibraryApi.md#delete) | **DELETE** /com/vmware/content/local-library/id:{library_id} | Deletes the specified local library. <p> Deleting a local 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.
+[**get**](LocalLibraryApi.md#get) | **GET** /com/vmware/content/local-library/id:{library_id} | Returns a given local library.
+[**list**](LocalLibraryApi.md#list) | **GET** /com/vmware/content/local-library | Returns the identifiers of all local libraries in the Content Library.
+[**update**](LocalLibraryApi.md#update) | **PATCH** /com/vmware/content/local-library/id:{library_id} | Updates the properties of a local library. <p> This is an incremental update to the local library. {@term Fields} that are {@term unset} in the update specification will be left unchanged.
+
+
+# **create**
+> ContentLocalLibraryCreateResult create(content_local_library_create)
+
+Creates a new local library.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LocalLibraryApi.new
+content_local_library_create = VSphereAutomation::ContentLocalLibraryCreate.new # ContentLocalLibraryCreate | 
+
+begin
+  #Creates a new local library.
+  result = api_instance.create(content_local_library_create)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LocalLibraryApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_local_library_create** | [**ContentLocalLibraryCreate**](ContentLocalLibraryCreate.md)|  | 
+
+### Return type
+
+[**ContentLocalLibraryCreateResult**](ContentLocalLibraryCreateResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete**
+> delete(library_id)
+
+Deletes the specified local library. <p> Deleting a local 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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LocalLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the local library to delete.
+
+begin
+  #Deletes the specified local library. <p> Deleting a local 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_instance.delete(library_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LocalLibraryApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the local library to delete. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> ContentLocalLibraryResult get(library_id)
+
+Returns a given local library.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LocalLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the local library to return.
+
+begin
+  #Returns a given local library.
+  result = api_instance.get(library_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LocalLibraryApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the local library to return. | 
+
+### Return type
+
+[**ContentLocalLibraryResult**](ContentLocalLibraryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> ContentLocalLibraryListResult list
+
+Returns the identifiers of all local libraries in the Content Library.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LocalLibraryApi.new
+
+begin
+  #Returns the identifiers of all local libraries in the Content Library.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LocalLibraryApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ContentLocalLibraryListResult**](ContentLocalLibraryListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update**
+> update(library_id, content_local_library_update)
+
+Updates the properties of a local library. <p> This is an incremental update to the local library. {@term Fields} that are {@term unset} in the update specification will be left unchanged.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::LocalLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the local library to update.
+content_local_library_update = VSphereAutomation::ContentLocalLibraryUpdate.new # ContentLocalLibraryUpdate | 
+
+begin
+  #Updates the properties of a local library. <p> This is an incremental update to the local library. {@term Fields} that are {@term unset} in the update specification will be left unchanged.
+  api_instance.update(library_id, content_local_library_update)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling LocalLibraryApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the local library to update. | 
+ **content_local_library_update** | [**ContentLocalLibraryUpdate**](ContentLocalLibraryUpdate.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+