vsphere-automation-content 0.1.0

data/docs/SubscribedLibraryApi.md

@@ -0,0 +1,354 @@
+# VSphereAutomation::Content::SubscribedLibraryApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](SubscribedLibraryApi.md#create) | **POST** /com/vmware/content/subscribed-library | 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.
+[**delete**](SubscribedLibraryApi.md#delete) | **DELETE** /com/vmware/content/subscribed-library/id:{library_id} | 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.
+[**evict**](SubscribedLibraryApi.md#evict) | **POST** /com/vmware/content/subscribed-library/id:{library_id}?~action=evict | 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.
+[**get**](SubscribedLibraryApi.md#get) | **GET** /com/vmware/content/subscribed-library/id:{library_id} | Returns a given subscribed library.
+[**list**](SubscribedLibraryApi.md#list) | **GET** /com/vmware/content/subscribed-library | Returns the identifiers of all subscribed libraries in the Content Library.
+[**probe**](SubscribedLibraryApi.md#probe) | **POST** /com/vmware/content/subscribed-library?~action=probe | 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.
+[**sync**](SubscribedLibraryApi.md#sync) | **POST** /com/vmware/content/subscribed-library/id:{library_id}?~action=sync | 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.
+[**update**](SubscribedLibraryApi.md#update) | **PATCH** /com/vmware/content/subscribed-library/id:{library_id} | 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.
+
+
+# **create**
+> ContentSubscribedLibraryCreateResult create(content_subscribed_library_create)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+content_subscribed_library_create = VSphereAutomation::ContentSubscribedLibraryCreate.new # ContentSubscribedLibraryCreate | 
+
+begin
+  #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.
+  result = api_instance.create(content_subscribed_library_create)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_subscribed_library_create** | [**ContentSubscribedLibraryCreate**](ContentSubscribedLibraryCreate.md)|  | 
+
+### Return type
+
+[**ContentSubscribedLibraryCreateResult**](ContentSubscribedLibraryCreateResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **delete**
+> delete(library_id)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the subscribed library to delete.
+
+begin
+  #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.
+  api_instance.delete(library_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the subscribed library to delete. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **evict**
+> evict(library_id)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the subscribed library whose content should be evicted.
+
+begin
+  #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.
+  api_instance.evict(library_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->evict: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the subscribed library whose content should be evicted. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> ContentSubscribedLibraryResult get(library_id)
+
+Returns a given subscribed library.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the subscribed library to return.
+
+begin
+  #Returns a given subscribed library.
+  result = api_instance.get(library_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the subscribed library to return. | 
+
+### Return type
+
+[**ContentSubscribedLibraryResult**](ContentSubscribedLibraryResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> ContentSubscribedLibraryListResult list
+
+Returns the identifiers of all subscribed libraries in the Content Library.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+
+begin
+  #Returns the identifiers of all subscribed libraries in the Content Library.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ContentSubscribedLibraryListResult**](ContentSubscribedLibraryListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **probe**
+> ContentSubscribedLibraryProbeResult probe(content_subscribed_library_probe)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+content_subscribed_library_probe = VSphereAutomation::ContentSubscribedLibraryProbe.new # ContentSubscribedLibraryProbe | 
+
+begin
+  #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.
+  result = api_instance.probe(content_subscribed_library_probe)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->probe: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **content_subscribed_library_probe** | [**ContentSubscribedLibraryProbe**](ContentSubscribedLibraryProbe.md)|  | 
+
+### Return type
+
+[**ContentSubscribedLibraryProbeResult**](ContentSubscribedLibraryProbeResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+
+# **sync**
+> sync(library_id)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the subscribed library to synchronize.
+
+begin
+  #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.
+  api_instance.sync(library_id)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->sync: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the subscribed library to synchronize. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **update**
+> update(library_id, content_subscribed_library_update)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-content'
+
+api_instance = VSphereAutomation::Content::SubscribedLibraryApi.new
+library_id = 'library_id_example' # String | Identifier of the subscribed library to update.
+content_subscribed_library_update = VSphereAutomation::ContentSubscribedLibraryUpdate.new # ContentSubscribedLibraryUpdate | 
+
+begin
+  #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.
+  api_instance.update(library_id, content_subscribed_library_update)
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling SubscribedLibraryApi->update: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **library_id** | **String**| Identifier of the subscribed library to update. | 
+ **content_subscribed_library_update** | [**ContentSubscribedLibraryUpdate**](ContentSubscribedLibraryUpdate.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: */*
+
+
+

data/docs/VapiStdErrorsConcurrentChange.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsConcurrentChange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+

data/docs/VapiStdErrorsConcurrentChangeError.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsConcurrentChangeError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | [**VapiStdErrorsConcurrentChange**](VapiStdErrorsConcurrentChange.md) |  | [optional] 
+
+

data/docs/VapiStdErrorsInvalidArgument.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidArgument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+

data/docs/VapiStdErrorsInvalidArgumentError.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidArgumentError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | [**VapiStdErrorsInvalidArgument**](VapiStdErrorsInvalidArgument.md) |  | [optional] 
+
+

data/docs/VapiStdErrorsInvalidElementConfiguration.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidElementConfiguration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+

data/docs/VapiStdErrorsInvalidElementConfigurationError.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidElementConfigurationError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | [**VapiStdErrorsInvalidElementConfiguration**](VapiStdErrorsInvalidElementConfiguration.md) |  | [optional] 
+
+

data/docs/VapiStdErrorsInvalidElementType.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidElementType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+

data/docs/VapiStdErrorsInvalidElementTypeError.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsInvalidElementTypeError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | [**VapiStdErrorsInvalidElementType**](VapiStdErrorsInvalidElementType.md) |  | [optional] 
+
+

data/docs/VapiStdErrorsNotAllowedInCurrentState.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::Content::VapiStdErrorsNotAllowedInCurrentState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+