com.vmware.content.library

Interface Subscriptions

All Superinterfaces:

Service, SubscriptionsTypes

All Known Implementing Classes:

SubscriptionsStub

public interface Subscriptions
extends Service, SubscriptionsTypes

The Subscriptions interface provides methods for managing the subscription information of the subscribers of a published library. This interface was added in vSphere API 6.7.2.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.content.library.SubscriptionsTypes

SubscriptionsTypes.CreateSpec, SubscriptionsTypes.CreateSpecNewSubscribedLibrary, SubscriptionsTypes.CreateSpecPlacement, SubscriptionsTypes.CreateSpecSubscribedLibrary, SubscriptionsTypes.CreateSpecVcenter, SubscriptionsTypes.Info, SubscriptionsTypes.Location, SubscriptionsTypes.PlacementInfo, SubscriptionsTypes.Summary, SubscriptionsTypes.UpdateSpec, SubscriptionsTypes.UpdateSpecPlacement, SubscriptionsTypes.UpdateSpecVcenter, SubscriptionsTypes.VcenterInfo

Field Summary

Fields inherited from interface com.vmware.content.library.SubscriptionsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String clientToken, java.lang.String library, SubscriptionsTypes.CreateSpec spec) Creates a subscription of the published library.
void	create(java.lang.String clientToken, java.lang.String library, SubscriptionsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a subscription of the published library.
void	create(java.lang.String clientToken, java.lang.String library, SubscriptionsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a subscription of the published library.
java.lang.String	create(java.lang.String clientToken, java.lang.String library, SubscriptionsTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a subscription of the published library.
void	delete(java.lang.String library, java.lang.String subscription) Deletes the specified subscription of the published library.
void	delete(java.lang.String library, java.lang.String subscription, AsyncCallback<java.lang.Void> asyncCallback) Deletes the specified subscription of the published library.
void	delete(java.lang.String library, java.lang.String subscription, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the specified subscription of the published library.
void	delete(java.lang.String library, java.lang.String subscription, InvocationConfig invocationConfig) Deletes the specified subscription of the published library.
SubscriptionsTypes.Info	get(java.lang.String library, java.lang.String subscription) Returns information about the specified subscription of the published library.
void	get(java.lang.String library, java.lang.String subscription, AsyncCallback<SubscriptionsTypes.Info> asyncCallback) Returns information about the specified subscription of the published library.
void	get(java.lang.String library, java.lang.String subscription, AsyncCallback<SubscriptionsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about the specified subscription of the published library.
SubscriptionsTypes.Info	get(java.lang.String library, java.lang.String subscription, InvocationConfig invocationConfig) Returns information about the specified subscription of the published library.
java.util.List<SubscriptionsTypes.Summary>	list(java.lang.String library) Lists the subscriptions of the published library.
void	list(java.lang.String library, AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback) Lists the subscriptions of the published library.
void	list(java.lang.String library, AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Lists the subscriptions of the published library.
java.util.List<SubscriptionsTypes.Summary>	list(java.lang.String library, InvocationConfig invocationConfig) Lists the subscriptions of the published library.
void	update(java.lang.String library, java.lang.String subscription, SubscriptionsTypes.UpdateSpec spec) Updates the specified subscription of the published library.
void	update(java.lang.String library, java.lang.String subscription, SubscriptionsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the specified subscription of the published library.
void	update(java.lang.String library, java.lang.String subscription, SubscriptionsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the specified subscription of the published library.
void	update(java.lang.String library, java.lang.String subscription, SubscriptionsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the specified subscription of the published library.

Method Detail

create

java.lang.String create(java.lang.String clientToken,
                        java.lang.String library,
                        SubscriptionsTypes.CreateSpec spec)

Creates a subscription of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

spec - Specification for the subscription.

Returns:

Subscription identifier. The return value will be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Throws:

AlreadyExists - If a subscription of the published library to the specified subscribed library already exists. This is only applicable when subscribedLibrary#subscribedLibrary is specified.

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

NotFound - If the subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter.

ResourceInaccessible - If the vCenter instance specified by subscribedLibrary#vcenter cannot be contacted or found.

InvalidArgument - If SubscriptionsTypes.CreateSpec contains invalid arguments.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription.

create

java.lang.String create(java.lang.String clientToken,
                        java.lang.String library,
                        SubscriptionsTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Creates a subscription of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

spec - Specification for the subscription.

invocationConfig - Configuration for the method invocation.

Returns:

Subscription identifier. The return value will be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Throws:

AlreadyExists - If a subscription of the published library to the specified subscribed library already exists. This is only applicable when subscribedLibrary#subscribedLibrary is specified.

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

NotFound - If the subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter.

ResourceInaccessible - If the vCenter instance specified by subscribedLibrary#vcenter cannot be contacted or found.

InvalidArgument - If SubscriptionsTypes.CreateSpec contains invalid arguments.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription.

create

void create(java.lang.String clientToken,
            java.lang.String library,
            SubscriptionsTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Creates a subscription of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Subscription identifier. The return value will be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Operation Errors:
AlreadyExists - If a subscription of the published library to the specified subscribed library already exists. This is only applicable when subscribedLibrary#subscribedLibrary is specified.
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
NotFound - If the subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter.
ResourceInaccessible - If the vCenter instance specified by subscribedLibrary#vcenter cannot be contacted or found.
InvalidArgument - If SubscriptionsTypes.CreateSpec contains invalid arguments.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

spec - Specification for the subscription.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

create

void create(java.lang.String clientToken,
            java.lang.String library,
            SubscriptionsTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Creates a subscription of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Subscription identifier. The return value will be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Operation Errors:
AlreadyExists - If a subscription of the published library to the specified subscribed library already exists. This is only applicable when subscribedLibrary#subscribedLibrary is specified.
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
NotFound - If the subscribed library specified by subscribedLibrary#subscribedLibrary does not exist at the vCenter instance specified by subscribedLibrary#vcenter.
ResourceInaccessible - If the vCenter instance specified by subscribedLibrary#vcenter cannot be contacted or found.
InvalidArgument - If SubscriptionsTypes.CreateSpec contains invalid arguments.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription.

Parameters:

clientToken - A unique token generated on the client for each creation request. The token should be a universally unique identifier (UUID), for example: b8a2a2e3-2314-43cd-a871-6ede0f429751. This token can be used to guarantee idempotent creation. If not specified, creation is not idempotent.

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

spec - Specification for the subscription.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String library,
            java.lang.String subscription)

Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Throws:

Error - If the system reports an error while responding to the request.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

NotFound - If the library specified by library does not exist.

NotFound - If the subscription specified by subscription does not exist for the library specified by library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription.

delete

void delete(java.lang.String library,
            java.lang.String subscription,
            InvocationConfig invocationConfig)

Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If the system reports an error while responding to the request.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

NotFound - If the library specified by library does not exist.

NotFound - If the subscription specified by subscription does not exist for the library specified by library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription.

delete

void delete(java.lang.String library,
            java.lang.String subscription,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
NotFound - If the library specified by library does not exist.
NotFound - If the subscription specified by subscription does not exist for the library specified by library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String library,
            java.lang.String subscription,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes the specified subscription of the published library. The subscribed library associated with the subscription will not be deleted. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
NotFound - If the library specified by library does not exist.
NotFound - If the subscription specified by subscription does not exist for the library specified by library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<SubscriptionsTypes.Summary> list(java.lang.String library)

Lists the subscriptions of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

Returns:

List of commonly used information about subscriptions of the published library.

Throws:

Error - If the system reports an error while responding to the request.

InvalidElementType - If the library specified by library is a subscribed library.

NotFound - If the library specified by library does not exist.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

list

java.util.List<SubscriptionsTypes.Summary> list(java.lang.String library,
                                                InvocationConfig invocationConfig)

Lists the subscriptions of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

invocationConfig - Configuration for the method invocation.

Returns:

List of commonly used information about subscriptions of the published library.

Throws:

Error - If the system reports an error while responding to the request.

InvalidElementType - If the library specified by library is a subscribed library.

NotFound - If the library specified by library does not exist.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

list

void list(java.lang.String library,
          AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback)

Lists the subscriptions of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
List of commonly used information about subscriptions of the published library.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidElementType - If the library specified by library is a subscribed library.
NotFound - If the library specified by library does not exist.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String library,
          AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Lists the subscriptions of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
List of commonly used information about subscriptions of the published library.

Operation Errors:
Error - If the system reports an error while responding to the request.
InvalidElementType - If the library specified by library is a subscribed library.
NotFound - If the library specified by library does not exist.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String library,
            java.lang.String subscription,
            SubscriptionsTypes.UpdateSpec spec)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the SubscriptionsTypes.UpdateSpecPlacement class, properties that are null in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all properties of the current subscribed library placement will be replaced by this placement.

. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

spec - Specification of the new property values to set on the subscription.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

NotFound - If the subscription specified by subscription does not exist for the library specified by library.

ResourceInaccessible - If the subscribed library cannot be contacted or found.

InvalidArgument - If SubscriptionsTypes.UpdateSpec contains invalid arguments.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.

update

void update(java.lang.String library,
            java.lang.String subscription,
            SubscriptionsTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the SubscriptionsTypes.UpdateSpecPlacement class, properties that are null in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all properties of the current subscribed library placement will be replaced by this placement.

. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

spec - Specification of the new property values to set on the subscription.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

NotFound - If the subscription specified by subscription does not exist for the library specified by library.

ResourceInaccessible - If the subscribed library cannot be contacted or found.

InvalidArgument - If SubscriptionsTypes.UpdateSpec contains invalid arguments.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.

update

void update(java.lang.String library,
            java.lang.String subscription,
            SubscriptionsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the SubscriptionsTypes.UpdateSpecPlacement class, properties that are null in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all properties of the current subscribed library placement will be replaced by this placement.

. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
NotFound - If the subscription specified by subscription does not exist for the library specified by library.
ResourceInaccessible - If the subscribed library cannot be contacted or found.
InvalidArgument - If SubscriptionsTypes.UpdateSpec contains invalid arguments.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

spec - Specification of the new property values to set on the subscription.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String library,
            java.lang.String subscription,
            SubscriptionsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the specified subscription of the published library.

This is an incremental update to the subscription. Except for the SubscriptionsTypes.UpdateSpecPlacement class, properties that are null in the update specification will be left unchanged. If spec#subscribedLibraryPlacement is specified, all properties of the current subscribed library placement will be replaced by this placement.

. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
NotFound - If the subscription specified by subscription does not exist for the library specified by library.
ResourceInaccessible - If the subscribed library cannot be contacted or found.
InvalidArgument - If SubscriptionsTypes.UpdateSpec contains invalid arguments.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - subscription identifier. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

spec - Specification of the new property values to set on the subscription.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

SubscriptionsTypes.Info get(java.lang.String library,
                            java.lang.String subscription)

Returns information about the specified subscription of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Identifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

Returns:

Information about the subscription.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

InvalidArgument - If the subscription is not valid.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

get

SubscriptionsTypes.Info get(java.lang.String library,
                            java.lang.String subscription,
                            InvocationConfig invocationConfig)

Returns information about the specified subscription of the published library. This method was added in vSphere API 6.7.2.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Identifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the subscription.

Throws:

Error - If the system reports an error while responding to the request.

NotFound - If the library specified by library does not exist.

InvalidArgument - If the subscription is not valid.

InvalidElementType - If the library specified by library is a subscribed library.

NotAllowedInCurrentState - If the library specified by library is not a published library.

Unauthenticated - If the user that requested the method cannot be authenticated.

Unauthorized - If the user that requested the method is not authorized to perform the method.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

get

void get(java.lang.String library,
         java.lang.String subscription,
         AsyncCallback<SubscriptionsTypes.Info> asyncCallback)

Returns information about the specified subscription of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about the subscription.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
InvalidArgument - If the subscription is not valid.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Identifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String library,
         java.lang.String subscription,
         AsyncCallback<SubscriptionsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about the specified subscription of the published library. This method was added in vSphere API 6.7.2.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Information about the subscription.

Operation Errors:
Error - If the system reports an error while responding to the request.
NotFound - If the library specified by library does not exist.
InvalidArgument - If the subscription is not valid.
InvalidElementType - If the library specified by library is a subscribed library.
NotAllowedInCurrentState - If the library specified by library is not a published library.
Unauthenticated - If the user that requested the method cannot be authenticated.
Unauthorized - If the user that requested the method is not authorized to perform the method.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource com.vmware.content.Library referenced by the parameter library requires System.Read.

Parameters:

library - Identifier of the published library. The parameter must be an identifier for the resource type: com.vmware.content.Library.

subscription - Identifier of the subscription. The parameter must be an identifier for the resource type: com.vmware.content.library.Subscriptions.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.