vsphere-automation-content 0.2.2 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +6 -6
- data/README.md +15 -16
- data/docs/ConfigurationApi.md +4 -8
- data/docs/LibraryApi.md +3 -5
- data/docs/LibraryItemApi.md +6 -10
- data/docs/LibraryItemDownloadSessionApi.md +3 -5
- data/docs/LibraryItemDownloadsessionFileApi.md +3 -5
- data/docs/LibraryItemFileApi.md +3 -5
- data/docs/LibraryItemStorageApi.md +3 -5
- data/docs/LibraryItemUpdateSessionApi.md +3 -5
- data/docs/LibraryItemUpdatesessionFileApi.md +3 -5
- data/docs/LibrarySubscribedItemApi.md +3 -5
- data/docs/LocalLibraryApi.md +3 -5
- data/docs/SubscribedLibraryApi.md +3 -5
- data/lib/vsphere-automation-content/api/configuration_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_api.rb +8 -30
- data/lib/vsphere-automation-content/api/library_item_download_session_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_downloadsession_file_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_file_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_storage_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_update_session_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_item_updatesession_file_api.rb +4 -15
- data/lib/vsphere-automation-content/api/library_subscribed_item_api.rb +4 -15
- data/lib/vsphere-automation-content/api/local_library_api.rb +4 -15
- data/lib/vsphere-automation-content/api/subscribed_library_api.rb +4 -15
- data/lib/vsphere-automation-content/api_client.rb +1 -1
- data/lib/vsphere-automation-content/version.rb +1 -1
- data/pkg/vsphere-automation-content-0.2.2.gem +0 -0
- data/vsphere-automation-content.gemspec +2 -2
- metadata +7 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e98366bb020ae8ec5bd039b37a95823347ce7dd315e330dd453984fc5850a45f
|
4
|
+
data.tar.gz: 06f0ff2aeb603145065048bc929ce0b19455dfdcb2b14d3b8f9043e591463a50
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 659e3294f30e95bc60814879b1ca5b08020d59cd0bd6b20fc64192b2f4f01a793264ed02ada6c5a062ce6ff83a1961e7b590d01c842dca118bb9ebece238d609
|
7
|
+
data.tar.gz: 88d5db50ea3f3d4ead2c289cd3db9d0430f3292cfe564b2d1b7da7f06c026483872ed0c5261bea20145611673e875adc2c2198dcebfd09fd8280a82340752ef9
|
data/Gemfile.lock
CHANGED
@@ -1,21 +1,21 @@
|
|
1
1
|
PATH
|
2
2
|
remote: ../cis
|
3
3
|
specs:
|
4
|
-
vsphere-automation-cis (0.
|
5
|
-
vsphere-automation-runtime (~> 0.
|
4
|
+
vsphere-automation-cis (0.3.0)
|
5
|
+
vsphere-automation-runtime (~> 0.3.0)
|
6
6
|
|
7
7
|
PATH
|
8
8
|
remote: ../runtime
|
9
9
|
specs:
|
10
|
-
vsphere-automation-runtime (0.
|
10
|
+
vsphere-automation-runtime (0.3.0)
|
11
11
|
typhoeus (~> 1.3)
|
12
12
|
|
13
13
|
PATH
|
14
14
|
remote: .
|
15
15
|
specs:
|
16
|
-
vsphere-automation-content (0.
|
17
|
-
vsphere-automation-cis (~> 0.
|
18
|
-
vsphere-automation-runtime (~> 0.
|
16
|
+
vsphere-automation-content (0.3.0)
|
17
|
+
vsphere-automation-cis (~> 0.3.0)
|
18
|
+
vsphere-automation-runtime (~> 0.3.0)
|
19
19
|
|
20
20
|
GEM
|
21
21
|
remote: https://rubygems.org/
|
data/README.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
The Ruby gem for the vSphere Content API
|
4
4
|
|
5
5
|
- API version: 2.0.0
|
6
|
-
- Package version: 0.
|
6
|
+
- Package version: 0.3.0
|
7
7
|
|
8
8
|
## Installation
|
9
9
|
|
@@ -38,11 +38,10 @@ VSphereAutomation.configure do |config|
|
|
38
38
|
end
|
39
39
|
|
40
40
|
api_instance = VSphereAutomation::Content::ConfigurationApi.new
|
41
|
-
action = 'action_example' # String | ~action=get
|
42
41
|
|
43
42
|
begin
|
44
43
|
#Retrieves the current configuration values.
|
45
|
-
result = api_instance.get
|
44
|
+
result = api_instance.get
|
46
45
|
p result
|
47
46
|
rescue VSphereAutomation::ApiError => e
|
48
47
|
puts "Exception when calling ConfigurationApi->get: #{e}"
|
@@ -56,36 +55,36 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
56
55
|
|
57
56
|
Class | Method | HTTP request | Description
|
58
57
|
------------ | ------------- | ------------- | -------------
|
59
|
-
`VSphereAutomation::Content::ConfigurationApi` | [**get**](docs/ConfigurationApi.md#get) | **POST** /com/vmware/content/configuration | Retrieves the current configuration values.
|
58
|
+
`VSphereAutomation::Content::ConfigurationApi` | [**get**](docs/ConfigurationApi.md#get) | **POST** /com/vmware/content/configuration?~action=get | Retrieves the current configuration values.
|
60
59
|
`VSphereAutomation::Content::ConfigurationApi` | [**update**](docs/ConfigurationApi.md#update) | **PATCH** /com/vmware/content/configuration | Updates the configuration. The update is incremental. Any {@term field} in the {@link ConfigurationModel} {@term structure} that is {@term unset} will not be modified. Note that this update {@term operation} doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.
|
61
|
-
`VSphereAutomation::Content::LibraryApi` | [**find**](docs/LibraryApi.md#find) | **POST** /com/vmware/content/library | Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
60
|
+
`VSphereAutomation::Content::LibraryApi` | [**find**](docs/LibraryApi.md#find) | **POST** /com/vmware/content/library?~action=find | Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
62
61
|
`VSphereAutomation::Content::LibraryApi` | [**get**](docs/LibraryApi.md#get) | **GET** /com/vmware/content/library/id:{library_id} | Returns a given {@link LibraryModel}.
|
63
62
|
`VSphereAutomation::Content::LibraryApi` | [**list**](docs/LibraryApi.md#list) | **GET** /com/vmware/content/library | Returns the identifiers of all libraries of any type in the Content Library.
|
64
63
|
`VSphereAutomation::Content::LibraryApi` | [**update**](docs/LibraryApi.md#update) | **PATCH** /com/vmware/content/library/id:{library_id} | Updates the properties of a library. <p> This is an incremental update to the library. Any {@term field} in the {@link LibraryModel} {@term structure} that is {@term unset} will not be modified. <p> This {@term operation} will only update the common properties for all library types. This will not, for example, update the {@link LibraryModel#publishInfo} of a local library, nor the {@link LibraryModel#subscriptionInfo} of a subscribed library. Specific properties are updated in {@link LocalLibrary#update} and {@link SubscribedLibrary#update}.
|
65
|
-
`VSphereAutomation::Content::LibraryItemApi` | [**copy**](docs/LibraryItemApi.md#copy) | **POST** /com/vmware/content/library/item/id:{source_library_item_id} | Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
64
|
+
`VSphereAutomation::Content::LibraryItemApi` | [**copy**](docs/LibraryItemApi.md#copy) | **POST** /com/vmware/content/library/item/id:{source_library_item_id}?~action=copy | Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
66
65
|
`VSphereAutomation::Content::LibraryItemApi` | [**create**](docs/LibraryItemApi.md#create) | **POST** /com/vmware/content/library/item | Creates a new library item. <p> A new library item is created without any content. After creation, content can be added through the {@link UpdateSession} and {@link File} {@term services}. <p> A library item cannot be created in a subscribed library.
|
67
66
|
`VSphereAutomation::Content::LibraryItemApi` | [**delete**](docs/LibraryItemApi.md#delete) | **DELETE** /com/vmware/content/library/item/id:{library_item_id} | Deletes a library item. <p> This {@term operation} will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing. <p> This {@term operation} cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.
|
68
67
|
`VSphereAutomation::Content::LibraryItemApi` | [**find**](docs/LibraryItemApi.md#find) | **POST** /com/vmware/content/library/item?~action=find | Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested {@link Item.FindSpec}.
|
69
68
|
`VSphereAutomation::Content::LibraryItemApi` | [**get**](docs/LibraryItemApi.md#get) | **GET** /com/vmware/content/library/item/id:{library_item_id} | Returns the {@link ItemModel} with the given identifier.
|
70
69
|
`VSphereAutomation::Content::LibraryItemApi` | [**list**](docs/LibraryItemApi.md#list) | **GET** /com/vmware/content/library/item | Returns the identifiers of all items in the given library.
|
71
|
-
`VSphereAutomation::Content::LibraryItemApi` | [**publish**](docs/LibraryItemApi.md#publish) | **POST** /com/vmware/content/library/item/id:{library_item_id} | Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
70
|
+
`VSphereAutomation::Content::LibraryItemApi` | [**publish**](docs/LibraryItemApi.md#publish) | **POST** /com/vmware/content/library/item/id:{library_item_id}?~action=publish | Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
72
71
|
`VSphereAutomation::Content::LibraryItemApi` | [**update**](docs/LibraryItemApi.md#update) | **PATCH** /com/vmware/content/library/item/id:{library_item_id} | Updates the specified properties of a library item. <p> This is an incremental update to the library item. {@term Fields} that are {@term unset} in the update specification are left unchanged. <p> This {@term operation} cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.
|
73
72
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**cancel**](docs/LibraryItemDownloadSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel | Cancels the download session. This {@term operation} will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.
|
74
73
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**create**](docs/LibraryItemDownloadSessionApi.md#create) | **POST** /com/vmware/content/library/item/download-session | Creates a new download session.
|
75
74
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**delete**](docs/LibraryItemDownloadSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/download-session/id:{download_session_id} | Deletes a download session. This removes the session and all information associated with it. <p> Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. <p> Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.
|
76
|
-
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**fail**](docs/LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id} | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
75
|
+
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**fail**](docs/LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
77
76
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**get**](docs/LibraryItemDownloadSessionApi.md#get) | **GET** /com/vmware/content/library/item/download-session/id:{download_session_id} | Gets the download session with the specified identifier, including the most up-to-date status information for the session.
|
78
77
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**keep_alive**](docs/LibraryItemDownloadSessionApi.md#keep_alive) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive | Keeps a download session alive. This operation is allowed only if the session is in the {@link DownloadSessionModel.State#ACTIVE} state. <p> If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this {@term operation} enables a client to specifically extend the lifetime of an active download session.
|
79
78
|
`VSphereAutomation::Content::LibraryItemDownloadSessionApi` | [**list**](docs/LibraryItemDownloadSessionApi.md#list) | **GET** /com/vmware/content/library/item/download-session | Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.
|
80
79
|
`VSphereAutomation::Content::LibraryItemDownloadsessionFileApi` | [**get**](docs/LibraryItemDownloadsessionFileApi.md#get) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get | Retrieves file download information for a specific file.
|
81
80
|
`VSphereAutomation::Content::LibraryItemDownloadsessionFileApi` | [**list**](docs/LibraryItemDownloadsessionFileApi.md#list) | **GET** /com/vmware/content/library/item/downloadsession/file | Lists the information of all the files in the library item associated with the download session.
|
82
|
-
`VSphereAutomation::Content::LibraryItemDownloadsessionFileApi` | [**prepare**](docs/LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id} | Requests a file to be prepared for download.
|
83
|
-
`VSphereAutomation::Content::LibraryItemFileApi` | [**get**](docs/LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id} | Retrieves the information for a single file in a library item by its name.
|
81
|
+
`VSphereAutomation::Content::LibraryItemDownloadsessionFileApi` | [**prepare**](docs/LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare | Requests a file to be prepared for download.
|
82
|
+
`VSphereAutomation::Content::LibraryItemFileApi` | [**get**](docs/LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id}?~action=get | Retrieves the information for a single file in a library item by its name.
|
84
83
|
`VSphereAutomation::Content::LibraryItemFileApi` | [**list**](docs/LibraryItemFileApi.md#list) | **GET** /com/vmware/content/library/item/file | Lists all of the files that are stored within a given library item.
|
85
|
-
`VSphereAutomation::Content::LibraryItemStorageApi` | [**get**](docs/LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id} | Retrieves the storage information for a specific file in a library item.
|
84
|
+
`VSphereAutomation::Content::LibraryItemStorageApi` | [**get**](docs/LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id}?~action=get | Retrieves the storage information for a specific file in a library item.
|
86
85
|
`VSphereAutomation::Content::LibraryItemStorageApi` | [**list**](docs/LibraryItemStorageApi.md#list) | **GET** /com/vmware/content/library/item/storage | Lists all storage items for a given library item.
|
87
86
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**cancel**](docs/LibraryItemUpdateSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=cancel | Cancels the update session and sets its state to {@link UpdateSessionModel.State#CANCELED}. This {@term operation} will free up any temporary resources currently associated with the session. <p> This {@term operation} is not allowed if the session has been already completed. <p> Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.
|
88
|
-
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**complete**](docs/LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id} | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
87
|
+
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**complete**](docs/LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=complete | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
89
88
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**create**](docs/LibraryItemUpdateSessionApi.md#create) | **POST** /com/vmware/content/library/item/update-session | Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. <p> Content Library Service allows only one single update session to be active for a specific library item.
|
90
89
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**delete**](docs/LibraryItemUpdateSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/update-session/id:{update_session_id} | Deletes an update session. This removes the session and all information associated with it. <p> Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item. <p> Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.
|
91
90
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**fail**](docs/LibraryItemUpdateSessionApi.md#fail) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail | Terminates the update session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
|
@@ -93,12 +92,12 @@ Class | Method | HTTP request | Description
|
|
93
92
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**keep_alive**](docs/LibraryItemUpdateSessionApi.md#keep_alive) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=keep-alive | Keeps an update session alive. <p> If there is no activity for an update session after a period of time, the update session will expire, then be deleted. The update session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this {@term operation} enables a client to specifically extend the lifetime of the update session.
|
94
93
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**list**](docs/LibraryItemUpdateSessionApi.md#list) | **GET** /com/vmware/content/library/item/update-session | Lists the identifiers of the update session created by the calling user. Optionally may filter by library item.
|
95
94
|
`VSphereAutomation::Content::LibraryItemUpdateSessionApi` | [**update**](docs/LibraryItemUpdateSessionApi.md#update) | **PATCH** /com/vmware/content/library/item/update-session/id:{update_session_id} | Updates the properties of an update session. <p> This is an incremental update to the update session. Any {@term field} in the {@link UpdateSessionModel} {@term structure} that is {@term unset} will not be modified. <p> This {@term operation} will only update the property {@link UpdateSessionModel#warningBehavior} of the update session. This will not, for example, update the {@link UpdateSessionModel#libraryItemId} or {@link UpdateSessionModel#state} of an update session. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state.
|
96
|
-
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**add**](docs/LibraryItemUpdatesessionFileApi.md#add) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id} | 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.
|
95
|
+
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**add**](docs/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.
|
97
96
|
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**get**](docs/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.
|
98
97
|
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**list**](docs/LibraryItemUpdatesessionFileApi.md#list) | **GET** /com/vmware/content/library/item/updatesession/file | Lists all files in the library item associated with the update session.
|
99
98
|
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**remove**](docs/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.
|
100
99
|
`VSphereAutomation::Content::LibraryItemUpdatesessionFileApi` | [**validate**](docs/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.
|
101
|
-
`VSphereAutomation::Content::LibrarySubscribedItemApi` | [**evict**](docs/LibrarySubscribedItemApi.md#evict) | **POST** /com/vmware/content/library/subscribed-item/id:{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.
|
100
|
+
`VSphereAutomation::Content::LibrarySubscribedItemApi` | [**evict**](docs/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.
|
102
101
|
`VSphereAutomation::Content::LibrarySubscribedItemApi` | [**sync**](docs/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.
|
103
102
|
`VSphereAutomation::Content::LibrarySubscriptionsApi` | [**create**](docs/LibrarySubscriptionsApi.md#create) | **POST** /com/vmware/content/library/subscriptions/id:{library} | Creates a subscription of the published library.
|
104
103
|
`VSphereAutomation::Content::LibrarySubscriptionsApi` | [**delete**](docs/LibrarySubscriptionsApi.md#delete) | **POST** /com/vmware/content/library/subscriptions/id:{library}?~action=delete | Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted.
|
@@ -109,7 +108,7 @@ Class | Method | HTTP request | Description
|
|
109
108
|
`VSphereAutomation::Content::LocalLibraryApi` | [**delete**](docs/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.
|
110
109
|
`VSphereAutomation::Content::LocalLibraryApi` | [**get**](docs/LocalLibraryApi.md#get) | **GET** /com/vmware/content/local-library/id:{library_id} | Returns a given local library.
|
111
110
|
`VSphereAutomation::Content::LocalLibraryApi` | [**list**](docs/LocalLibraryApi.md#list) | **GET** /com/vmware/content/local-library | Returns the identifiers of all local libraries in the Content Library.
|
112
|
-
`VSphereAutomation::Content::LocalLibraryApi` | [**publish**](docs/LocalLibraryApi.md#publish) | **POST** /com/vmware/content/local-library/id:{library_id} | Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions.
|
111
|
+
`VSphereAutomation::Content::LocalLibraryApi` | [**publish**](docs/LocalLibraryApi.md#publish) | **POST** /com/vmware/content/local-library/id:{library_id}?~action=publish | Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions.
|
113
112
|
`VSphereAutomation::Content::LocalLibraryApi` | [**update**](docs/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.
|
114
113
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**create**](docs/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.
|
115
114
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**delete**](docs/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.
|
@@ -117,7 +116,7 @@ Class | Method | HTTP request | Description
|
|
117
116
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**get**](docs/SubscribedLibraryApi.md#get) | **GET** /com/vmware/content/subscribed-library/id:{library_id} | Returns a given subscribed library.
|
118
117
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**list**](docs/SubscribedLibraryApi.md#list) | **GET** /com/vmware/content/subscribed-library | Returns the identifiers of all subscribed libraries in the Content Library.
|
119
118
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**probe**](docs/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.
|
120
|
-
`VSphereAutomation::Content::SubscribedLibraryApi` | [**sync**](docs/SubscribedLibraryApi.md#sync) | **POST** /com/vmware/content/subscribed-library/id:{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.
|
119
|
+
`VSphereAutomation::Content::SubscribedLibraryApi` | [**sync**](docs/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.
|
121
120
|
`VSphereAutomation::Content::SubscribedLibraryApi` | [**update**](docs/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.
|
122
121
|
|
123
122
|
|
data/docs/ConfigurationApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get**](ConfigurationApi.md#get) | **POST** /com/vmware/content/configuration | Retrieves the current configuration values.
|
7
|
+
[**get**](ConfigurationApi.md#get) | **POST** /com/vmware/content/configuration?~action=get | Retrieves the current configuration values.
|
8
8
|
[**update**](ConfigurationApi.md#update) | **PATCH** /com/vmware/content/configuration | Updates the configuration. The update is incremental. Any {@term field} in the {@link ConfigurationModel} {@term structure} that is {@term unset} will not be modified. Note that this update {@term operation} doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.
|
9
9
|
|
10
10
|
|
11
11
|
# **get**
|
12
|
-
> ContentConfigurationResult get
|
12
|
+
> ContentConfigurationResult get
|
13
13
|
|
14
14
|
Retrieves the current configuration values.
|
15
15
|
|
@@ -26,11 +26,10 @@ VSphereAutomation::Configuration.new.tap do |config|
|
|
26
26
|
end
|
27
27
|
|
28
28
|
api_instance = VSphereAutomation::Content::ConfigurationApi.new
|
29
|
-
action = 'action_example' # String | ~action=get
|
30
29
|
|
31
30
|
begin
|
32
31
|
#Retrieves the current configuration values.
|
33
|
-
result = api_instance.get
|
32
|
+
result = api_instance.get
|
34
33
|
p result
|
35
34
|
rescue VSphereAutomation::ApiError => e
|
36
35
|
puts "Exception when calling ConfigurationApi->get: #{e}"
|
@@ -38,10 +37,7 @@ end
|
|
38
37
|
```
|
39
38
|
|
40
39
|
### Parameters
|
41
|
-
|
42
|
-
Name | Type | Description | Notes
|
43
|
-
------------- | ------------- | ------------- | -------------
|
44
|
-
**action** | **String**| ~action=get |
|
40
|
+
This endpoint does not need any parameter.
|
45
41
|
|
46
42
|
### Return type
|
47
43
|
|
data/docs/LibraryApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**find**](LibraryApi.md#find) | **POST** /com/vmware/content/library | Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
7
|
+
[**find**](LibraryApi.md#find) | **POST** /com/vmware/content/library?~action=find | Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
8
8
|
[**get**](LibraryApi.md#get) | **GET** /com/vmware/content/library/id:{library_id} | Returns a given {@link LibraryModel}.
|
9
9
|
[**list**](LibraryApi.md#list) | **GET** /com/vmware/content/library | Returns the identifiers of all libraries of any type in the Content Library.
|
10
10
|
[**update**](LibraryApi.md#update) | **PATCH** /com/vmware/content/library/id:{library_id} | Updates the properties of a library. <p> This is an incremental update to the library. Any {@term field} in the {@link LibraryModel} {@term structure} that is {@term unset} will not be modified. <p> This {@term operation} will only update the common properties for all library types. This will not, for example, update the {@link LibraryModel#publishInfo} of a local library, nor the {@link LibraryModel#subscriptionInfo} of a subscribed library. Specific properties are updated in {@link LocalLibrary#update} and {@link SubscribedLibrary#update}.
|
11
11
|
|
12
12
|
|
13
13
|
# **find**
|
14
|
-
> ContentLibraryFindResult find(
|
14
|
+
> ContentLibraryFindResult find(request_body)
|
15
15
|
|
16
16
|
Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
17
17
|
|
@@ -28,12 +28,11 @@ VSphereAutomation::Configuration.new.tap do |config|
|
|
28
28
|
end
|
29
29
|
|
30
30
|
api_instance = VSphereAutomation::Content::LibraryApi.new
|
31
|
-
action = 'action_example' # String | ~action=find
|
32
31
|
request_body = Content::ContentLibraryFind.new # ContentLibraryFind |
|
33
32
|
|
34
33
|
begin
|
35
34
|
#Returns a list of all the visible (as determined by authorization policy) libraries matching the requested {@link Library.FindSpec}.
|
36
|
-
result = api_instance.find(
|
35
|
+
result = api_instance.find(request_body)
|
37
36
|
p result
|
38
37
|
rescue VSphereAutomation::ApiError => e
|
39
38
|
puts "Exception when calling LibraryApi->find: #{e}"
|
@@ -44,7 +43,6 @@ end
|
|
44
43
|
|
45
44
|
Name | Type | Description | Notes
|
46
45
|
------------- | ------------- | ------------- | -------------
|
47
|
-
**action** | **String**| ~action=find |
|
48
46
|
**request_body** | [**ContentLibraryFind**](ContentLibraryFind.md)| |
|
49
47
|
|
50
48
|
### Return type
|
data/docs/LibraryItemApi.md
CHANGED
@@ -4,18 +4,18 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**copy**](LibraryItemApi.md#copy) | **POST** /com/vmware/content/library/item/id:{source_library_item_id} | Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
7
|
+
[**copy**](LibraryItemApi.md#copy) | **POST** /com/vmware/content/library/item/id:{source_library_item_id}?~action=copy | Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
8
8
|
[**create**](LibraryItemApi.md#create) | **POST** /com/vmware/content/library/item | Creates a new library item. <p> A new library item is created without any content. After creation, content can be added through the {@link UpdateSession} and {@link File} {@term services}. <p> A library item cannot be created in a subscribed library.
|
9
9
|
[**delete**](LibraryItemApi.md#delete) | **DELETE** /com/vmware/content/library/item/id:{library_item_id} | Deletes a library item. <p> This {@term operation} will immediately remove the item from the library that owns it. The content of the item will be asynchronously removed from the storage backings. The content deletion can be tracked with a task. In the event that the task fails, an administrator may need to manually remove the files from the storage backing. <p> This {@term operation} cannot be used to delete a library item that is a member of a subscribed library. Removing an item from a subscribed library requires deleting the item from the original published local library and syncing the subscribed library.
|
10
10
|
[**find**](LibraryItemApi.md#find) | **POST** /com/vmware/content/library/item?~action=find | Returns identifiers of all the visible (as determined by authorization policy) library items matching the requested {@link Item.FindSpec}.
|
11
11
|
[**get**](LibraryItemApi.md#get) | **GET** /com/vmware/content/library/item/id:{library_item_id} | Returns the {@link ItemModel} with the given identifier.
|
12
12
|
[**list**](LibraryItemApi.md#list) | **GET** /com/vmware/content/library/item | Returns the identifiers of all items in the given library.
|
13
|
-
[**publish**](LibraryItemApi.md#publish) | **POST** /com/vmware/content/library/item/id:{library_item_id} | Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
13
|
+
[**publish**](LibraryItemApi.md#publish) | **POST** /com/vmware/content/library/item/id:{library_item_id}?~action=publish | Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
14
14
|
[**update**](LibraryItemApi.md#update) | **PATCH** /com/vmware/content/library/item/id:{library_item_id} | Updates the specified properties of a library item. <p> This is an incremental update to the library item. {@term Fields} that are {@term unset} in the update specification are left unchanged. <p> This {@term operation} cannot update a library item that is a member of a subscribed library. Those items must be updated in the source published library and synchronized to the subscribed library.
|
15
15
|
|
16
16
|
|
17
17
|
# **copy**
|
18
|
-
> ContentLibraryItemCopyResult copy(source_library_item_id,
|
18
|
+
> ContentLibraryItemCopyResult copy(source_library_item_id, request_body)
|
19
19
|
|
20
20
|
Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
21
21
|
|
@@ -33,12 +33,11 @@ end
|
|
33
33
|
|
34
34
|
api_instance = VSphereAutomation::Content::LibraryItemApi.new
|
35
35
|
source_library_item_id = 'source_library_item_id_example' # String | Identifier of the existing library item from which the content will be copied.
|
36
|
-
action = 'action_example' # String | ~action=copy
|
37
36
|
request_body = Content::ContentLibraryItemCopy.new # ContentLibraryItemCopy |
|
38
37
|
|
39
38
|
begin
|
40
39
|
#Copies a library item. <p> Copying a library item allows a duplicate to be made within the same or different library. The copy occurs by first creating a new library item, whose identifier is returned. The content of the library item is then copied asynchronously. This copy can be tracked as a task. <p> If the copy fails, Content Library Service will roll back the copy by deleting any content that was already copied, and removing the new library item. A failure during rollback may require manual cleanup by an administrator. <p> A library item cannot be copied into a subscribed library.
|
41
|
-
result = api_instance.copy(source_library_item_id,
|
40
|
+
result = api_instance.copy(source_library_item_id, request_body)
|
42
41
|
p result
|
43
42
|
rescue VSphereAutomation::ApiError => e
|
44
43
|
puts "Exception when calling LibraryItemApi->copy: #{e}"
|
@@ -50,7 +49,6 @@ end
|
|
50
49
|
Name | Type | Description | Notes
|
51
50
|
------------- | ------------- | ------------- | -------------
|
52
51
|
**source_library_item_id** | **String**| Identifier of the existing library item from which the content will be copied. |
|
53
|
-
**action** | **String**| ~action=copy |
|
54
52
|
**request_body** | [**ContentLibraryItemCopy**](ContentLibraryItemCopy.md)| |
|
55
53
|
|
56
54
|
### Return type
|
@@ -318,7 +316,7 @@ Name | Type | Description | Notes
|
|
318
316
|
|
319
317
|
|
320
318
|
# **publish**
|
321
|
-
> publish(library_item_id,
|
319
|
+
> publish(library_item_id, request_body)
|
322
320
|
|
323
321
|
Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
324
322
|
|
@@ -336,12 +334,11 @@ end
|
|
336
334
|
|
337
335
|
api_instance = VSphereAutomation::Content::LibraryItemApi.new
|
338
336
|
library_item_id = 'library_item_id_example' # String | Library item identifier.
|
339
|
-
action = 'action_example' # String | ~action=publish
|
340
337
|
request_body = Content::ContentLibraryItemPublish.new # ContentLibraryItemPublish |
|
341
338
|
|
342
339
|
begin
|
343
340
|
#Publishes the library item to specified subscriptions of the library. If no subscriptions are specified, then publishes the library item to all subscriptions of the library.
|
344
|
-
api_instance.publish(library_item_id,
|
341
|
+
api_instance.publish(library_item_id, request_body)
|
345
342
|
rescue VSphereAutomation::ApiError => e
|
346
343
|
puts "Exception when calling LibraryItemApi->publish: #{e}"
|
347
344
|
end
|
@@ -352,7 +349,6 @@ end
|
|
352
349
|
Name | Type | Description | Notes
|
353
350
|
------------- | ------------- | ------------- | -------------
|
354
351
|
**library_item_id** | **String**| Library item identifier. |
|
355
|
-
**action** | **String**| ~action=publish |
|
356
352
|
**request_body** | [**ContentLibraryItemPublish**](ContentLibraryItemPublish.md)| |
|
357
353
|
|
358
354
|
### Return type
|
@@ -7,7 +7,7 @@ Method | HTTP request | Description
|
|
7
7
|
[**cancel**](LibraryItemDownloadSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=cancel | Cancels the download session. This {@term operation} will abort any ongoing transfers and invalidate transfer urls that the client may be downloading from.
|
8
8
|
[**create**](LibraryItemDownloadSessionApi.md#create) | **POST** /com/vmware/content/library/item/download-session | Creates a new download session.
|
9
9
|
[**delete**](LibraryItemDownloadSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/download-session/id:{download_session_id} | Deletes a download session. This removes the session and all information associated with it. <p> Removing a download session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the transfers will be able to complete). However there will no longer be a means of inspecting the status of those downloads except by seeing the effect on the library item. <p> Download sessions for which there is no download activity or which are complete will automatically be expired and then deleted after a period of time.
|
10
|
-
[**fail**](LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id} | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
10
|
+
[**fail**](LibraryItemDownloadSessionApi.md#fail) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=fail | Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
11
11
|
[**get**](LibraryItemDownloadSessionApi.md#get) | **GET** /com/vmware/content/library/item/download-session/id:{download_session_id} | Gets the download session with the specified identifier, including the most up-to-date status information for the session.
|
12
12
|
[**keep_alive**](LibraryItemDownloadSessionApi.md#keep_alive) | **POST** /com/vmware/content/library/item/download-session/id:{download_session_id}?~action=keep-alive | Keeps a download session alive. This operation is allowed only if the session is in the {@link DownloadSessionModel.State#ACTIVE} state. <p> If there is no activity for a download session for a certain period of time, the download session will expire. The download session expiration timeout is configurable in the Content Library Service system configuration. The default is five minutes. Invoking this {@term operation} enables a client to specifically extend the lifetime of an active download session.
|
13
13
|
[**list**](LibraryItemDownloadSessionApi.md#list) | **GET** /com/vmware/content/library/item/download-session | Lists the identifiers of the download sessions created by the calling user. Optionally may filter by library item.
|
@@ -162,7 +162,7 @@ nil (empty response body)
|
|
162
162
|
|
163
163
|
|
164
164
|
# **fail**
|
165
|
-
> fail(download_session_id,
|
165
|
+
> fail(download_session_id, request_body)
|
166
166
|
|
167
167
|
Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
168
168
|
|
@@ -180,12 +180,11 @@ end
|
|
180
180
|
|
181
181
|
api_instance = VSphereAutomation::Content::LibraryItemDownloadSessionApi.new
|
182
182
|
download_session_id = 'download_session_id_example' # String | Identifier of the download session to fail.
|
183
|
-
action = 'action_example' # String | ~action=fail
|
184
183
|
request_body = Content::ContentLibraryItemDownloadSessionFail.new # ContentLibraryItemDownloadSessionFail |
|
185
184
|
|
186
185
|
begin
|
187
186
|
#Terminates the download session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to download a file) to the server side.
|
188
|
-
api_instance.fail(download_session_id,
|
187
|
+
api_instance.fail(download_session_id, request_body)
|
189
188
|
rescue VSphereAutomation::ApiError => e
|
190
189
|
puts "Exception when calling LibraryItemDownloadSessionApi->fail: #{e}"
|
191
190
|
end
|
@@ -196,7 +195,6 @@ end
|
|
196
195
|
Name | Type | Description | Notes
|
197
196
|
------------- | ------------- | ------------- | -------------
|
198
197
|
**download_session_id** | **String**| Identifier of the download session to fail. |
|
199
|
-
**action** | **String**| ~action=fail |
|
200
198
|
**request_body** | [**ContentLibraryItemDownloadSessionFail**](ContentLibraryItemDownloadSessionFail.md)| |
|
201
199
|
|
202
200
|
### Return type
|
@@ -6,7 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get**](LibraryItemDownloadsessionFileApi.md#get) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=get | Retrieves file download information for a specific file.
|
8
8
|
[**list**](LibraryItemDownloadsessionFileApi.md#list) | **GET** /com/vmware/content/library/item/downloadsession/file | Lists the information of all the files in the library item associated with the download session.
|
9
|
-
[**prepare**](LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id} | Requests a file to be prepared for download.
|
9
|
+
[**prepare**](LibraryItemDownloadsessionFileApi.md#prepare) | **POST** /com/vmware/content/library/item/downloadsession/file/id:{download_session_id}?~action=prepare | Requests a file to be prepared for download.
|
10
10
|
|
11
11
|
|
12
12
|
# **get**
|
@@ -112,7 +112,7 @@ Name | Type | Description | Notes
|
|
112
112
|
|
113
113
|
|
114
114
|
# **prepare**
|
115
|
-
> ContentLibraryItemDownloadsessionFilePrepareResult prepare(download_session_id,
|
115
|
+
> ContentLibraryItemDownloadsessionFilePrepareResult prepare(download_session_id, request_body)
|
116
116
|
|
117
117
|
Requests a file to be prepared for download.
|
118
118
|
|
@@ -130,12 +130,11 @@ end
|
|
130
130
|
|
131
131
|
api_instance = VSphereAutomation::Content::LibraryItemDownloadsessionFileApi.new
|
132
132
|
download_session_id = 'download_session_id_example' # String | Identifier of the download session.
|
133
|
-
action = 'action_example' # String | ~action=prepare
|
134
133
|
request_body = Content::ContentLibraryItemDownloadsessionFilePrepare.new # ContentLibraryItemDownloadsessionFilePrepare |
|
135
134
|
|
136
135
|
begin
|
137
136
|
#Requests a file to be prepared for download.
|
138
|
-
result = api_instance.prepare(download_session_id,
|
137
|
+
result = api_instance.prepare(download_session_id, request_body)
|
139
138
|
p result
|
140
139
|
rescue VSphereAutomation::ApiError => e
|
141
140
|
puts "Exception when calling LibraryItemDownloadsessionFileApi->prepare: #{e}"
|
@@ -147,7 +146,6 @@ end
|
|
147
146
|
Name | Type | Description | Notes
|
148
147
|
------------- | ------------- | ------------- | -------------
|
149
148
|
**download_session_id** | **String**| Identifier of the download session. |
|
150
|
-
**action** | **String**| ~action=prepare |
|
151
149
|
**request_body** | [**ContentLibraryItemDownloadsessionFilePrepare**](ContentLibraryItemDownloadsessionFilePrepare.md)| |
|
152
150
|
|
153
151
|
### Return type
|
data/docs/LibraryItemFileApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get**](LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id} | Retrieves the information for a single file in a library item by its name.
|
7
|
+
[**get**](LibraryItemFileApi.md#get) | **POST** /com/vmware/content/library/item/file/id:{library_item_id}?~action=get | Retrieves the information for a single file in a library item by its name.
|
8
8
|
[**list**](LibraryItemFileApi.md#list) | **GET** /com/vmware/content/library/item/file | Lists all of the files that are stored within a given library item.
|
9
9
|
|
10
10
|
|
11
11
|
# **get**
|
12
|
-
> ContentLibraryItemFileResult get(library_item_id,
|
12
|
+
> ContentLibraryItemFileResult get(library_item_id, request_body)
|
13
13
|
|
14
14
|
Retrieves the information for a single file in a library item by its name.
|
15
15
|
|
@@ -27,12 +27,11 @@ end
|
|
27
27
|
|
28
28
|
api_instance = VSphereAutomation::Content::LibraryItemFileApi.new
|
29
29
|
library_item_id = 'library_item_id_example' # String | Identifier of the library item whose file information should be returned.
|
30
|
-
action = 'action_example' # String | ~action=get
|
31
30
|
request_body = Content::ContentLibraryItemFileGet.new # ContentLibraryItemFileGet |
|
32
31
|
|
33
32
|
begin
|
34
33
|
#Retrieves the information for a single file in a library item by its name.
|
35
|
-
result = api_instance.get(library_item_id,
|
34
|
+
result = api_instance.get(library_item_id, request_body)
|
36
35
|
p result
|
37
36
|
rescue VSphereAutomation::ApiError => e
|
38
37
|
puts "Exception when calling LibraryItemFileApi->get: #{e}"
|
@@ -44,7 +43,6 @@ end
|
|
44
43
|
Name | Type | Description | Notes
|
45
44
|
------------- | ------------- | ------------- | -------------
|
46
45
|
**library_item_id** | **String**| Identifier of the library item whose file information should be returned. |
|
47
|
-
**action** | **String**| ~action=get |
|
48
46
|
**request_body** | [**ContentLibraryItemFileGet**](ContentLibraryItemFileGet.md)| |
|
49
47
|
|
50
48
|
### Return type
|
@@ -4,12 +4,12 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get**](LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id} | Retrieves the storage information for a specific file in a library item.
|
7
|
+
[**get**](LibraryItemStorageApi.md#get) | **POST** /com/vmware/content/library/item/storage/id:{library_item_id}?~action=get | Retrieves the storage information for a specific file in a library item.
|
8
8
|
[**list**](LibraryItemStorageApi.md#list) | **GET** /com/vmware/content/library/item/storage | Lists all storage items for a given library item.
|
9
9
|
|
10
10
|
|
11
11
|
# **get**
|
12
|
-
> ContentLibraryItemStorageResult get(library_item_id,
|
12
|
+
> ContentLibraryItemStorageResult get(library_item_id, request_body)
|
13
13
|
|
14
14
|
Retrieves the storage information for a specific file in a library item.
|
15
15
|
|
@@ -27,12 +27,11 @@ end
|
|
27
27
|
|
28
28
|
api_instance = VSphereAutomation::Content::LibraryItemStorageApi.new
|
29
29
|
library_item_id = 'library_item_id_example' # String | Identifier of the library item whose storage information should be retrieved.
|
30
|
-
action = 'action_example' # String | ~action=get
|
31
30
|
request_body = Content::ContentLibraryItemStorageGet.new # ContentLibraryItemStorageGet |
|
32
31
|
|
33
32
|
begin
|
34
33
|
#Retrieves the storage information for a specific file in a library item.
|
35
|
-
result = api_instance.get(library_item_id,
|
34
|
+
result = api_instance.get(library_item_id, request_body)
|
36
35
|
p result
|
37
36
|
rescue VSphereAutomation::ApiError => e
|
38
37
|
puts "Exception when calling LibraryItemStorageApi->get: #{e}"
|
@@ -44,7 +43,6 @@ end
|
|
44
43
|
Name | Type | Description | Notes
|
45
44
|
------------- | ------------- | ------------- | -------------
|
46
45
|
**library_item_id** | **String**| Identifier of the library item whose storage information should be retrieved. |
|
47
|
-
**action** | **String**| ~action=get |
|
48
46
|
**request_body** | [**ContentLibraryItemStorageGet**](ContentLibraryItemStorageGet.md)| |
|
49
47
|
|
50
48
|
### Return type
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**cancel**](LibraryItemUpdateSessionApi.md#cancel) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=cancel | Cancels the update session and sets its state to {@link UpdateSessionModel.State#CANCELED}. This {@term operation} will free up any temporary resources currently associated with the session. <p> This {@term operation} is not allowed if the session has been already completed. <p> Cancelling an update session will cancel any in progress transfers (either uploaded by the client or pulled by the server). Any content that has been already received will be scheduled for deletion.
|
8
|
-
[**complete**](LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id} | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
8
|
+
[**complete**](LibraryItemUpdateSessionApi.md#complete) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=complete | Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
9
9
|
[**create**](LibraryItemUpdateSessionApi.md#create) | **POST** /com/vmware/content/library/item/update-session | Creates a new update session. An update session is used to make modifications to a library item. Modifications are not visible to other clients unless the session is completed and all necessary files have been received. <p> Content Library Service allows only one single update session to be active for a specific library item.
|
10
10
|
[**delete**](LibraryItemUpdateSessionApi.md#delete) | **DELETE** /com/vmware/content/library/item/update-session/id:{update_session_id} | Deletes an update session. This removes the session and all information associated with it. <p> Removing an update session leaves any current transfers for that session in an indeterminate state (there is no guarantee that the server will terminate the transfers, or that the transfers can be completed). However there will no longer be a means of inspecting the status of those uploads except by seeing the effect on the library item. <p> Update sessions for which there is no upload activity or which are complete will automatically be deleted after a period of time.
|
11
11
|
[**fail**](LibraryItemUpdateSessionApi.md#fail) | **POST** /com/vmware/content/library/item/update-session/id:{update_session_id}?~action=fail | Terminates the update session with a client specified error message. <p> This is useful in transmitting client side failures (for example, not being able to access a file) to the server side.
|
@@ -65,7 +65,7 @@ nil (empty response body)
|
|
65
65
|
|
66
66
|
|
67
67
|
# **complete**
|
68
|
-
> complete(update_session_id
|
68
|
+
> complete(update_session_id)
|
69
69
|
|
70
70
|
Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
71
71
|
|
@@ -83,11 +83,10 @@ end
|
|
83
83
|
|
84
84
|
api_instance = VSphereAutomation::Content::LibraryItemUpdateSessionApi.new
|
85
85
|
update_session_id = 'update_session_id_example' # String | Identifier of the update session that should be completed.
|
86
|
-
action = 'action_example' # String | ~action=complete
|
87
86
|
|
88
87
|
begin
|
89
88
|
#Completes the update session. This indicates that the client has finished making all the changes required to the underlying library item. If the client is pushing the content to the server, the library item will be updated once this call returns. If the server is pulling the content, the call may return before the changes become visible. In that case, the client can track the session to know when the server is done. <p> This {@term operation} requires the session to be in the {@link UpdateSessionModel.State#ACTIVE} state. <p> Depending on the type of the library item associated with this session, a type adapter may be invoked to verify the validity of the files uploaded. The user can explicitly validate the session before completing the session by using the {@link content.library.item.updatesession.File#validate} {@term operation}. <p> Modifications are not visible to other clients unless the session is completed and all necessary files have been received.
|
90
|
-
api_instance.complete(update_session_id
|
89
|
+
api_instance.complete(update_session_id)
|
91
90
|
rescue VSphereAutomation::ApiError => e
|
92
91
|
puts "Exception when calling LibraryItemUpdateSessionApi->complete: #{e}"
|
93
92
|
end
|
@@ -98,7 +97,6 @@ end
|
|
98
97
|
Name | Type | Description | Notes
|
99
98
|
------------- | ------------- | ------------- | -------------
|
100
99
|
**update_session_id** | **String**| Identifier of the update session that should be completed. |
|
101
|
-
**action** | **String**| ~action=complete |
|
102
100
|
|
103
101
|
### Return type
|
104
102
|
|
@@ -4,7 +4,7 @@ All URIs are relative to *https://<vcenter>/rest*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**add**](LibraryItemUpdatesessionFileApi.md#add) | **POST** /com/vmware/content/library/item/updatesession/file/id:{update_session_id} | 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.
|
7
|
+
[**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.
|
8
8
|
[**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.
|
9
9
|
[**list**](LibraryItemUpdatesessionFileApi.md#list) | **GET** /com/vmware/content/library/item/updatesession/file | Lists all files in the library item associated with the update session.
|
10
10
|
[**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.
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
12
12
|
|
13
13
|
|
14
14
|
# **add**
|
15
|
-
> ContentLibraryItemUpdatesessionFileAddResult add(update_session_id,
|
15
|
+
> ContentLibraryItemUpdatesessionFileAddResult add(update_session_id, request_body)
|
16
16
|
|
17
17
|
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.
|
18
18
|
|
@@ -30,12 +30,11 @@ end
|
|
30
30
|
|
31
31
|
api_instance = VSphereAutomation::Content::LibraryItemUpdatesessionFileApi.new
|
32
32
|
update_session_id = 'update_session_id_example' # String | Identifier of the update session to be modified.
|
33
|
-
action = 'action_example' # String | ~action=add
|
34
33
|
request_body = Content::ContentLibraryItemUpdatesessionFileAdd.new # ContentLibraryItemUpdatesessionFileAdd |
|
35
34
|
|
36
35
|
begin
|
37
36
|
#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.
|
38
|
-
result = api_instance.add(update_session_id,
|
37
|
+
result = api_instance.add(update_session_id, request_body)
|
39
38
|
p result
|
40
39
|
rescue VSphereAutomation::ApiError => e
|
41
40
|
puts "Exception when calling LibraryItemUpdatesessionFileApi->add: #{e}"
|
@@ -47,7 +46,6 @@ end
|
|
47
46
|
Name | Type | Description | Notes
|
48
47
|
------------- | ------------- | ------------- | -------------
|
49
48
|
**update_session_id** | **String**| Identifier of the update session to be modified. |
|
50
|
-
**action** | **String**| ~action=add |
|
51
49
|
**request_body** | [**ContentLibraryItemUpdatesessionFileAdd**](ContentLibraryItemUpdatesessionFileAdd.md)| |
|
52
50
|
|
53
51
|
### Return type
|