com.vmware.esx.settings.depots

Interface Offline

All Superinterfaces:

OfflineTypes, Service

All Known Implementing Classes:

OfflineStub

public interface Offline
extends Service, OfflineTypes

The Offline interface provides methods to manage Offline Software Depots used during ESX lifecycle management.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.depots.OfflineTypes

OfflineTypes._VAPI_OPERATIONS, OfflineTypes.CreateResult, OfflineTypes.CreateSpec, OfflineTypes.Info, OfflineTypes.SourceType, OfflineTypes.Summary

Field Summary

Fields inherited from interface com.vmware.esx.settings.depots.OfflineTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(OfflineTypes.CreateSpec spec) Imports a new offline software depot.
void	create_Task(OfflineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Imports a new offline software depot.
void	create_Task(OfflineTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Imports a new offline software depot.
java.lang.String	create_Task(OfflineTypes.CreateSpec spec, InvocationConfig invocationConfig) Imports a new offline software depot.
void	delete(java.lang.String depot) Removes a depot from the list of imported offline software depots.
void	delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback) Removes a depot from the list of imported offline software depots.
void	delete(java.lang.String depot, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a depot from the list of imported offline software depots.
void	delete(java.lang.String depot, InvocationConfig invocationConfig) Removes a depot from the list of imported offline software depots.
OfflineTypes.Info	get(java.lang.String depot) Gets the information about an imported offline software depot.
void	get(java.lang.String depot, AsyncCallback<OfflineTypes.Info> asyncCallback) Gets the information about an imported offline software depot.
void	get(java.lang.String depot, AsyncCallback<OfflineTypes.Info> asyncCallback, InvocationConfig invocationConfig) Gets the information about an imported offline software depot.
OfflineTypes.Info	get(java.lang.String depot, InvocationConfig invocationConfig) Gets the information about an imported offline software depot.
java.util.Map<java.lang.String,OfflineTypes.Summary>	list() Returns currently imported offline software depots.
void	list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback) Returns currently imported offline software depots.
void	list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns currently imported offline software depots.
java.util.Map<java.lang.String,OfflineTypes.Summary>	list(InvocationConfig invocationConfig) Returns currently imported offline software depots.

Method Detail

get

OfflineTypes.Info get(java.lang.String depot)

Gets the information about an imported offline software depot.

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

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Returns:

Information about the imported offline software depot.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

OfflineTypes.Info get(java.lang.String depot,
                      InvocationConfig invocationConfig)

Gets the information about an imported offline software depot.

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:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the imported offline software depot.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String depot,
         AsyncCallback<OfflineTypes.Info> asyncCallback)

Gets the information about an imported offline software depot.

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

Invocation Result:
Information about the imported offline 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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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

get

void get(java.lang.String depot,
         AsyncCallback<OfflineTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Gets the information about an imported offline software depot.

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 imported offline 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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

depot - Identifier for the depot. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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

invocationConfig - Configuration for the method invocation.

list

java.util.Map<java.lang.String,OfflineTypes.Summary> list()

Returns currently imported offline software depots.

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

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

java.util.Map<java.lang.String,OfflineTypes.Summary> list(InvocationConfig invocationConfig)

Returns currently imported offline software depots.

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:

invocationConfig - Configuration for the method invocation.

Returns:

Map of currently imported offline software depots keyed by their identifier. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Throws:

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

list

void list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback)

Returns currently imported offline software depots.

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

Invocation Result:
Map of currently imported offline software depots keyed by their identifier. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

list

void list(AsyncCallback<java.util.Map<java.lang.String,OfflineTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns currently imported offline software depots.

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 imported offline software depots keyed by their identifier. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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:

• Method execution requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

create_Task

java.lang.String create_Task(OfflineTypes.CreateSpec spec)

Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

spec - Depot specification to import an offline depot.

Returns:

identifier for the task created by this API invocation

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid pullLocation is provided.

ServiceUnavailable - If the service is not available.

AlreadyExists - If the depot content of CreateSpec already exists. The value of the data property of Error will be a class that contains existing depot content id as part of depot property defined in OfflineTypes.CreateResult.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

create_Task

java.lang.String create_Task(OfflineTypes.CreateSpec spec,
                             InvocationConfig invocationConfig)

Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.

Parameters:

spec - Depot specification to import an offline depot.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Unauthenticated - if the caller is not authenticated.

InvalidArgument - If an invalid pullLocation is provided.

ServiceUnavailable - If the service is not available.

AlreadyExists - If the depot content of CreateSpec already exists. The value of the data property of Error will be a class that contains existing depot content id as part of depot property defined in OfflineTypes.CreateResult.

Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

create_Task

void create_Task(OfflineTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 an invalid pullLocation is provided.
ServiceUnavailable - If the service is not available.
AlreadyExists - If the depot content of CreateSpec already exists. The value of the data property of Error will be a class that contains existing depot content id as part of depot property defined in OfflineTypes.CreateResult.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

spec - Depot specification to import an offline depot.

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

create_Task

void create_Task(OfflineTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 an invalid pullLocation is provided.
ServiceUnavailable - If the service is not available.
AlreadyExists - If the depot content of CreateSpec already exists. The value of the data property of Error will be a class that contains existing depot content id as part of depot property defined in OfflineTypes.CreateResult.
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.

Parameters:

spec - Depot specification to import an offline depot.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String depot)

Removes a depot from the list of imported offline software depots.

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

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot associated with parameter 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:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

void delete(java.lang.String depot,
            InvocationConfig invocationConfig)

Removes a depot from the list of imported offline software depots.

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:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthenticated - if the caller is not authenticated.

NotFound - If there is no depot associated with parameter 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:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

delete

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

Removes a depot from the list of imported offline software depots.

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

Operation Errors:
Unauthenticated - if the caller is not authenticated.
NotFound - If there is no depot associated with parameter 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:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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

delete

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

Removes a depot from the list of imported offline software depots.

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.
NotFound - If there is no depot associated with parameter 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:

• Method execution requires VcIntegrity.lifecycleSettings.Write.

Parameters:

depot - Identifier of the depot to be removed. The parameter must be an identifier for the resource type: com.vmware.esx.settings.depots.offline.

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

invocationConfig - Configuration for the method invocation.