public interface Online extends Service, OnlineTypes
Online
interface provides methods to manage online software depots
used during ESX lifecycle management.OnlineTypes._VAPI_OPERATIONS, OnlineTypes.CreateSpec, OnlineTypes.DeleteResult, OnlineTypes.FlushResult, OnlineTypes.Info, OnlineTypes.PrecheckResult, OnlineTypes.Summary, OnlineTypes.UpdateSpec
_VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
java.lang.String |
create(OnlineTypes.CreateSpec spec)
Adds a new online software depot to the list of currently configured online
software depots.
|
void |
create(OnlineTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Adds a new online software depot to the list of currently configured online
software depots.
|
void |
create(OnlineTypes.CreateSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Adds a new online software depot to the list of currently configured online
software depots.
|
java.lang.String |
create(OnlineTypes.CreateSpec spec,
InvocationConfig invocationConfig)
Adds a new online software depot to the list of currently configured online
software depots.
|
java.lang.String |
delete_Task(java.lang.String depot)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
java.lang.String |
delete_Task(java.lang.String depot,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete(java.lang.String depot)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete(java.lang.String depot,
AsyncCallback<java.lang.Void> asyncCallback)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete(java.lang.String depot,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
void |
delete(java.lang.String depot,
InvocationConfig invocationConfig)
The task-based
delete() method removes content of a user-imported online
depot from vLCM completely. |
java.lang.String |
flush_Task(java.lang.String depot)
The task-based
flush() method removes content of a system-defined online
depot from vLCM completely. |
void |
flush_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback)
The task-based
flush() method removes content of a system-defined online
depot from vLCM completely. |
void |
flush_Task(java.lang.String depot,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
The task-based
flush() method removes content of a system-defined online
depot from vLCM completely. |
java.lang.String |
flush_Task(java.lang.String depot,
InvocationConfig invocationConfig)
The task-based
flush() method removes content of a system-defined online
depot from vLCM completely. |
OnlineTypes.Info |
get(java.lang.String depot)
Gets the information about a currently configured online software depot.
|
void |
get(java.lang.String depot,
AsyncCallback<OnlineTypes.Info> asyncCallback)
Gets the information about a currently configured online software depot.
|
void |
get(java.lang.String depot,
AsyncCallback<OnlineTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Gets the information about a currently configured online software depot.
|
OnlineTypes.Info |
get(java.lang.String depot,
InvocationConfig invocationConfig)
Gets the information about a currently configured online software depot.
|
java.util.Map<java.lang.String,OnlineTypes.Summary> |
list()
Returns a list of currently configured online software depots.
|
void |
list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback)
Returns a list of currently configured online software depots.
|
void |
list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns a list of currently configured online software depots.
|
java.util.Map<java.lang.String,OnlineTypes.Summary> |
list(InvocationConfig invocationConfig)
Returns a list of currently configured online software depots.
|
void |
update(java.lang.String depot,
OnlineTypes.UpdateSpec spec)
Updates the configuration of a currently configured online software depot.
|
void |
update(java.lang.String depot,
OnlineTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
Updates the configuration of a currently configured online software depot.
|
void |
update(java.lang.String depot,
OnlineTypes.UpdateSpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Updates the configuration of a currently configured online software depot.
|
void |
update(java.lang.String depot,
OnlineTypes.UpdateSpec spec,
InvocationConfig invocationConfig)
Updates the configuration of a currently configured online software depot.
|
java.util.Map<java.lang.String,OnlineTypes.Summary> list()
Synchronous method overload. Result of the invocation will be reported as a method return value.
Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- if the caller is not authenticated.ServiceUnavailable
- If the service is not available.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. java.util.Map<java.lang.String,OnlineTypes.Summary> list(InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
invocationConfig
- Configuration for the method invocation.Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- if the caller is not authenticated.ServiceUnavailable
- If the service is not available.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. void list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Map of currently configured online software depots keyed by their identifiers.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.online
.
Operation Errors:
Unauthenticated
- if the caller is not authenticated.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(AsyncCallback<java.util.Map<java.lang.String,OnlineTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
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:
Map of currently configured online software depots keyed by their identifiers.
The key in the return value Map
will be an identifier for the
resource type: com.vmware.esx.settings.depots.online
.
Operation Errors:
Unauthenticated
- if the caller is not authenticated.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.OnlineTypes.Info get(java.lang.String depot)
Synchronous method overload. Result of the invocation will be reported as a method return value.
depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no depot with given identifier depot
in the system.ServiceUnavailable
- If the service is not available.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. OnlineTypes.Info get(java.lang.String depot, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.NotFound
- If there is no depot with given identifier depot
in the system.ServiceUnavailable
- If the service is not available.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. void get(java.lang.String depot, AsyncCallback<OnlineTypes.Info> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information of the currently configured online software depot.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no depot with given identifier depot
in the system.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String depot, AsyncCallback<OnlineTypes.Info> asyncCallback, InvocationConfig invocationConfig)
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 of the currently configured online software depot.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
NotFound
- If there is no depot with given identifier depot
in the system.
ServiceUnavailable
- If the service is not available.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. depot
- Identifier for the depot.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String create(OnlineTypes.CreateSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
spec
- Depot information.com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If an invalid location is provided.AlreadyExists
- If depot with given location already exists.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.ServiceUnavailable
- If the service is not available.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. java.lang.String create(OnlineTypes.CreateSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
spec
- Depot information.invocationConfig
- Configuration for the method invocation.com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If an invalid location is provided.AlreadyExists
- If depot with given location already exists.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.ServiceUnavailable
- If the service is not available.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. void create(OnlineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Identifier of the currently configured online depot.
The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online
.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If an invalid location is provided.
AlreadyExists
- If depot with given location already exists.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
ServiceUnavailable
- If the service is not available.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. spec
- Depot information.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void create(OnlineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
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:
Identifier of the currently configured online depot.
The return value will be an identifier for the resource type: com.vmware.esx.settings.depots.online
.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If an invalid location is provided.
AlreadyExists
- If depot with given location already exists.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
ServiceUnavailable
- If the service is not available.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. spec
- Depot information.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String depot)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Synchronous method overload. Result of the invocation will be reported as a method return value.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. void delete(java.lang.String depot, InvocationConfig invocationConfig)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. java.lang.String delete_Task(java.lang.String depot)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. java.lang.String delete_Task(java.lang.String depot, InvocationConfig invocationConfig)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleDepots.Delete
. void delete_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
delete()
method removes content of a user-imported online
depot from vLCM completely. As a result, the URL of the user-imported online
depot will also be removed. Note: 1. To remove content of system-defined online
depots, use flush()
method. 2. The non task-based delete()
method has been deprecated. It only deletes the record of depot from the list of
imported online software depots, instead of removing the depot's content from
the system.
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:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is system-defined. This error is applicable to the task-based
delete()
method only.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states. This error is applicable to the task-based delete()
method only.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. For task-based delete()
method, once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the DeleteResult class that
lists all the errors encountered.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleDepots.Delete
. depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String flush_Task(java.lang.String depot)
flush()
method removes content of a system-defined online
depot from vLCM completely. As a result, the system-defined online depot will be
disabled. Note: To remove content of user-imported online depots, use the
task-based delete()
method.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is NOT system-defined.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. flush()
is a task-based method. Once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the FlushResult class that
lists all the errors encountered.java.lang.String flush_Task(java.lang.String depot, InvocationConfig invocationConfig)
flush()
method removes content of a system-defined online
depot from vLCM completely. As a result, the system-defined online depot will be
disabled. Note: To remove content of user-imported online depots, use the
task-based delete()
method.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
Use invocationConfig
to specify configuration for this particular invocation.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If the given depot is NOT system-defined.NotFound
- If there is no depot associated with parameter depot
in the system.ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states.ServiceUnavailable
- If the service is not available.Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. flush()
is a task-based method. Once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the FlushResult class that
lists all the errors encountered.void flush_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback)
flush()
method removes content of a system-defined online
depot from vLCM completely. As a result, the system-defined online depot will be
disabled. Note: To remove content of user-imported online depots, use the
task-based delete()
method.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is NOT system-defined.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. flush()
is a task-based method. Once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the FlushResult class that
lists all the errors encountered.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void flush_Task(java.lang.String depot, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
flush()
method removes content of a system-defined online
depot from vLCM completely. As a result, the system-defined online depot will be
disabled. Note: To remove content of user-imported online depots, use the
task-based delete()
method.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If the given depot is NOT system-defined.
NotFound
- If there is no depot associated with parameter depot
in the system.
ResourceInUse
- If the content of depot to be deleted is used in some baseline or desired state.
The value of the data property of Error
will
be the PrecheckResult class that lists the information of affected baselines and
desired states.
ServiceUnavailable
- If the service is not available.
Error
- If there some unknown internal error. The accompanying error message will give
more details about the failure. flush()
is a task-based method. Once the
task is started, it does NOT stop if encountering an error. Instead, it will
continuously run to completion. In this case, the value of the data property of
Error
will be the FlushResult class that
lists all the errors encountered.
depot
- Identifier of the depot to be removed.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void update(java.lang.String depot, OnlineTypes.UpdateSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
depot
- Identifier of the depot to be updated.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.spec
- Update specification.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If given depot is system defined.NotFound
- If there is no depot associated with parameter depot
in the system.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.ServiceUnavailable
- If the service is not available.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. void update(java.lang.String depot, OnlineTypes.UpdateSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
depot
- Identifier of the depot to be updated.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.spec
- Update specification.invocationConfig
- Configuration for the method invocation.Unauthenticated
- If the caller is not authenticated.InvalidArgument
- If given depot is system defined.NotFound
- If there is no depot associated with parameter depot
in the system.Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.ServiceUnavailable
- If the service is not available.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. void update(java.lang.String depot, OnlineTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If given depot is system defined.
NotFound
- If there is no depot associated with parameter depot
in the system.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
ServiceUnavailable
- If the service is not available.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. depot
- Identifier of the depot to be updated.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.spec
- Update specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void update(java.lang.String depot, OnlineTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
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:
Unauthenticated
- If the caller is not authenticated.
InvalidArgument
- If given depot is system defined.
NotFound
- If there is no depot associated with parameter depot
in the system.
Error
- If there is some unknown internal error. The accompanying error message will
give more details about the failure.
ServiceUnavailable
- If the service is not available.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. depot
- Identifier of the depot to be updated.
The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.online
.spec
- Update specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.