public interface Entries extends Service, EntriesTypes
Entries interface provides methods for manipulating individual
entries in a data set. This interface was added in vSphere API 8.0.0.0._VAPI_SERVICE_ID| 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.
|
void set(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
java.lang.String value)
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.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntrySet. void set(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
java.lang.String value,
InvocationConfig invocationConfig)
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.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntrySet. void set(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
java.lang.String value,
AsyncCallback<java.lang.Void> asyncCallback)
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntrySet. 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.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)
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntrySet. 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.java.lang.String get(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryGet. java.lang.String get(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
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.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryGet. void get(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
AsyncCallback<java.lang.String> asyncCallback)
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryGet. 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.void get(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
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:
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryGet. 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.void delete(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryDelete. void delete(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
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.
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.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryDelete. void delete(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
AsyncCallback<java.lang.Void> asyncCallback)
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryDelete. 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.void delete(java.lang.String vm,
java.lang.String dataSet,
java.lang.String key,
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:
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryDelete. 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.java.util.Set<java.lang.String> list(java.lang.String vm,
java.lang.String dataSet)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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.com.vmware.vcenter.vm.data_sets.Entry.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryList. java.util.Set<java.lang.String> list(java.lang.String vm,
java.lang.String dataSet,
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.
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.com.vmware.vcenter.vm.data_sets.Entry.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 DataSetsUnsupported - if the ESXi host version does not support DataSetsUnauthorized - if you do not have all of the privileges described as follows: VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryList. void list(java.lang.String vm,
java.lang.String dataSet,
AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryList. 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.void list(java.lang.String vm,
java.lang.String dataSet,
AsyncCallback<java.util.Set<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:
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:
VirtualMachine referenced by the parameter vm requires
VirtualMachine.DataSets.DataSetEntryList. 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.