com.vmware.vcenter.vm.data_sets

Class EntriesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.data_sets.EntriesStub

All Implemented Interfaces:

Service, Entries, EntriesTypes

public class EntriesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Entries

Remote stub implementation of the Entries API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.vcenter.vm.data_sets.EntriesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
EntriesStub(ApiProvider apiProvider, StubConfigurationBase config)
EntriesStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key) Deletes an entry in a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.Void> asyncCallback) Deletes an entry in a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes an entry in a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, InvocationConfig invocationConfig) Deletes an entry in a data set.
java.lang.String	get(java.lang.String vm, java.lang.String dataSet, java.lang.String key) Retrieves the value of an entry in a data set.
void	get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.String> asyncCallback) Retrieves the value of an entry in a data set.
void	get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Retrieves the value of an entry in a data set.
java.lang.String	get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, InvocationConfig invocationConfig) Retrieves the value of an entry in a data set.
java.util.Set<java.lang.String>	list(java.lang.String vm, java.lang.String dataSet) Lists all entry keys in a data set.
void	list(java.lang.String vm, java.lang.String dataSet, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback) Lists all entry keys in a data set.
void	list(java.lang.String vm, java.lang.String dataSet, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback, InvocationConfig invocationConfig) Lists all entry keys in a data set.
java.util.Set<java.lang.String>	list(java.lang.String vm, java.lang.String dataSet, InvocationConfig invocationConfig) Lists all entry keys in a data set.
void	set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value) Creates or updates an entry in a data set.
void	set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value, AsyncCallback<java.lang.Void> asyncCallback) Creates or updates an entry in a data set.
void	set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Creates or updates an entry in a data set.
void	set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value, InvocationConfig invocationConfig) Creates or updates an entry in a data set.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EntriesStub

public EntriesStub(ApiProvider apiProvider,
                   com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                   StubConfigurationBase config)

EntriesStub

public EntriesStub(ApiProvider apiProvider,
                   StubConfigurationBase config)

Method Detail

set

public void set(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                java.lang.String value)

Description copied from interface: Entries

Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. This method was added in vSphere API 8.0.0.0.

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

Specified by:

set in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to set. A key can be at most 4096 bytes. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

value - The value of the entry to set. A value can be at most 1MB.

set

public void set(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                java.lang.String value,
                InvocationConfig invocationConfig)

Description copied from interface: Entries

Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. This method was added in vSphere API 8.0.0.0.

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

Specified by:

set in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to set. A key can be at most 4096 bytes. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

value - The value of the entry to set. A value can be at most 1MB.

invocationConfig - Configuration for the method invocation.

set

public void set(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                java.lang.String value,
                AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Entries

Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. This method was added in vSphere API 8.0.0.0.

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.
InvalidArgument - if the key is too large.
InvalidArgument - if the value is too large.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set requires more resources than are available.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntrySet.

Specified by:

set in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to set. A key can be at most 4096 bytes. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

value - The value of the entry to set. A value can be at most 1MB.

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

set

public void set(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                java.lang.String value,
                AsyncCallback<java.lang.Void> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Entries

Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. This method was added in vSphere API 8.0.0.0.

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.
InvalidArgument - if the key is too large.
InvalidArgument - if the value is too large.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set requires more resources than are available.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntrySet.

Specified by:

set in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to set. A key can be at most 4096 bytes. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

value - The value of the entry to set. A value can be at most 1MB.

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

invocationConfig - Configuration for the method invocation.

get

public java.lang.String get(java.lang.String vm,
                            java.lang.String dataSet,
                            java.lang.String key)

Description copied from interface: Entries

Retrieves the value of an entry in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

get in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to retrieve. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

Returns:

the value of the entry.

get

public java.lang.String get(java.lang.String vm,
                            java.lang.String dataSet,
                            java.lang.String key,
                            InvocationConfig invocationConfig)

Description copied from interface: Entries

Retrieves the value of an entry in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

get in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to retrieve. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

invocationConfig - Configuration for the method invocation.

Returns:

the value of the entry.

get

public void get(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Entries

Retrieves the value of an entry in a data set. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
the value of the entry.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
NotFound - if there is no entry associated with key in the dataSet.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryGet.

Specified by:

get in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to retrieve. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

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

get

public void get(java.lang.String vm,
                java.lang.String dataSet,
                java.lang.String key,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Entries

Retrieves the value of an entry in a data set. This method was added in vSphere API 8.0.0.0.

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:
the value of the entry.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
NotFound - if there is no entry associated with key in the dataSet.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryGet.

Specified by:

get in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to retrieve. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String vm,
                   java.lang.String dataSet,
                   java.lang.String key)

Description copied from interface: Entries

Deletes an entry in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

delete in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to delete. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

delete

public void delete(java.lang.String vm,
                   java.lang.String dataSet,
                   java.lang.String key,
                   InvocationConfig invocationConfig)

Description copied from interface: Entries

Deletes an entry in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

delete in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to delete. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String vm,
                   java.lang.String dataSet,
                   java.lang.String key,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Entries

Deletes an entry in a data set. This method was added in vSphere API 8.0.0.0.

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.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
NotFound - if there is no entry associated with key in the dataSet.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryDelete.

Specified by:

delete in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to delete. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

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

delete

public void delete(java.lang.String vm,
                   java.lang.String dataSet,
                   java.lang.String key,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Entries

Deletes an entry in a data set. This method was added in vSphere API 8.0.0.0.

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.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
NotFound - if there is no entry associated with key in the dataSet.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryDelete.

Specified by:

delete in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

key - The key of the entry to delete. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

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

invocationConfig - Configuration for the method invocation.

list

public java.util.Set<java.lang.String> list(java.lang.String vm,
                                            java.lang.String dataSet)

Description copied from interface: Entries

Lists all entry keys in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

list in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Returns:

The keys belonging to the data set. The return value will contain identifiers for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

list

public java.util.Set<java.lang.String> list(java.lang.String vm,
                                            java.lang.String dataSet,
                                            InvocationConfig invocationConfig)

Description copied from interface: Entries

Lists all entry keys in a data set. This method was added in vSphere API 8.0.0.0.

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

Specified by:

list in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

invocationConfig - Configuration for the method invocation.

Returns:

The keys belonging to the data set. The return value will contain identifiers for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

list

public void list(java.lang.String vm,
                 java.lang.String dataSet,
                 AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)

Description copied from interface: Entries

Lists all entry keys in a data set. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
The keys belonging to the data set. The return value will contain identifiers for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryList.

Specified by:

list in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

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

list

public void list(java.lang.String vm,
                 java.lang.String dataSet,
                 AsyncCallback<java.util.Set<java.lang.String>> asyncCallback,
                 InvocationConfig invocationConfig)

Description copied from interface: Entries

Lists all entry keys in a data set. This method was added in vSphere API 8.0.0.0.

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:
The keys belonging to the data set. The return value will contain identifiers for the resource type: com.vmware.vcenter.vm.data_sets.Entry.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the data set access mode prevents the operation.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntryList.

Specified by:

list in interface Entries

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

dataSet - Identifier of the data set. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

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

invocationConfig - Configuration for the method invocation.