public class SubscriptionsStub extends com.vmware.vapi.internal.bindings.Stub implements Subscriptions
Subscriptions
API service.
WARNING: Internal class, subject to change in future versions.
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.VcenterInfoapiProvider, converter, ifaceId, retryPolicy, securityContext_VAPI_SERVICE_ID, RESOURCE_TYPE| Constructor and Description |
|---|
SubscriptionsStub(ApiProvider apiProvider,
StubConfigurationBase config) |
SubscriptionsStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
| 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.
|
public SubscriptionsStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public SubscriptionsStub(ApiProvider apiProvider, StubConfigurationBase config)
public java.lang.String create(java.lang.String clientToken,
java.lang.String library,
SubscriptionsTypes.CreateSpec spec)
SubscriptionsSynchronous method overload. Result of the invocation will be reported as a method return value.
create in interface SubscriptionsclientToken - 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.com.vmware.content.library.Subscriptions.public java.lang.String create(java.lang.String clientToken,
java.lang.String library,
SubscriptionsTypes.CreateSpec spec,
InvocationConfig invocationConfig)
SubscriptionsSynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
create in interface SubscriptionsclientToken - 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.com.vmware.content.library.Subscriptions.public void create(java.lang.String clientToken,
java.lang.String library,
SubscriptionsTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription. create in interface SubscriptionsclientToken - 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.public void create(java.lang.String clientToken,
java.lang.String library,
SubscriptionsTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.AddSubscription. create in interface SubscriptionsclientToken - 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.public void delete(java.lang.String library,
java.lang.String subscription)
SubscriptionsSynchronous method overload. Result of the invocation will be reported as a method return value.
delete in interface Subscriptionslibrary - 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.public void delete(java.lang.String library,
java.lang.String subscription,
InvocationConfig invocationConfig)
SubscriptionsSynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
delete in interface Subscriptionslibrary - 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.public void delete(java.lang.String library,
java.lang.String subscription,
AsyncCallback<java.lang.Void> asyncCallback)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription. delete in interface Subscriptionslibrary - 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.public void delete(java.lang.String library,
java.lang.String subscription,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.DeleteSubscription. delete in interface Subscriptionslibrary - 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.public java.util.List<SubscriptionsTypes.Summary> list(java.lang.String library)
SubscriptionsSynchronous method overload. Result of the invocation will be reported as a method return value.
list in interface Subscriptionslibrary - Identifier of the published library.
The parameter must be an identifier for the resource type: com.vmware.content.Library.public java.util.List<SubscriptionsTypes.Summary> list(java.lang.String library, InvocationConfig invocationConfig)
SubscriptionsSynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
list in interface Subscriptionslibrary - 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.public void list(java.lang.String library,
AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires System.Read. list in interface Subscriptionslibrary - 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.public void list(java.lang.String library,
AsyncCallback<java.util.List<SubscriptionsTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires System.Read. list in interface Subscriptionslibrary - 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.public void update(java.lang.String library,
java.lang.String subscription,
SubscriptionsTypes.UpdateSpec spec)
Subscriptions 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.
Synchronous method overload. Result of the invocation will be reported as a method return value.
update in interface Subscriptionslibrary - 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.public void update(java.lang.String library,
java.lang.String subscription,
SubscriptionsTypes.UpdateSpec spec,
InvocationConfig invocationConfig)
Subscriptions 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.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
update in interface Subscriptionslibrary - 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.public void update(java.lang.String library,
java.lang.String subscription,
SubscriptionsTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Subscriptions 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.
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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription. update in interface Subscriptionslibrary - 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.public void update(java.lang.String library,
java.lang.String subscription,
SubscriptionsTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Subscriptions 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.
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:
com.vmware.content.Library referenced by the parameter library requires ContentLibrary.UpdateSubscription. update in interface Subscriptionslibrary - 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.public SubscriptionsTypes.Info get(java.lang.String library, java.lang.String subscription)
SubscriptionsSynchronous method overload. Result of the invocation will be reported as a method return value.
get in interface Subscriptionslibrary - 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.public SubscriptionsTypes.Info get(java.lang.String library, java.lang.String subscription, InvocationConfig invocationConfig)
SubscriptionsSynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
get in interface Subscriptionslibrary - 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.public void get(java.lang.String library,
java.lang.String subscription,
AsyncCallback<SubscriptionsTypes.Info> asyncCallback)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires System.Read. get in interface Subscriptionslibrary - 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.public void get(java.lang.String library,
java.lang.String subscription,
AsyncCallback<SubscriptionsTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
SubscriptionsAsynchronous 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:
com.vmware.content.Library referenced by the parameter library requires System.Read. get in interface Subscriptionslibrary - 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.