public class EntriesStub extends com.vmware.vapi.internal.bindings.Stub implements Entries
Entries
API service.
WARNING: Internal class, subject to change in future versions.
apiProvider, converter, ifaceId, retryPolicy, securityContext
_VAPI_SERVICE_ID
Constructor and Description |
---|
EntriesStub(ApiProvider apiProvider,
StubConfigurationBase config) |
EntriesStub(ApiProvider apiProvider,
com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
StubConfigurationBase config) |
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.
|
public EntriesStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)
public EntriesStub(ApiProvider apiProvider, StubConfigurationBase config)
public void set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value)
Entries
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.
set
in interface Entries
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.public void set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value, InvocationConfig invocationConfig)
Entries
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.
set
in interface Entries
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.public void set(java.lang.String vm, java.lang.String dataSet, java.lang.String key, java.lang.String value, AsyncCallback<java.lang.Void> asyncCallback)
Entries
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
. set
in interface Entries
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.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)
Entries
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
. set
in interface Entries
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.public java.lang.String get(java.lang.String vm, java.lang.String dataSet, java.lang.String key)
Entries
Synchronous method overload. Result of the invocation will be reported as a method return value.
get
in interface Entries
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
.public java.lang.String get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, InvocationConfig invocationConfig)
Entries
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
get
in interface Entries
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.public void get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.String> asyncCallback)
Entries
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
. get
in interface Entries
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.public void get(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Entries
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
. get
in interface Entries
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.public void delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key)
Entries
Synchronous method overload. Result of the invocation will be reported as a method return value.
delete
in interface Entries
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
.public void delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, InvocationConfig invocationConfig)
Entries
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
delete
in interface Entries
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.public void delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.Void> asyncCallback)
Entries
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
. delete
in interface Entries
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.public void delete(java.lang.String vm, java.lang.String dataSet, java.lang.String key, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Entries
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
. delete
in interface Entries
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.public java.util.Set<java.lang.String> list(java.lang.String vm, java.lang.String dataSet)
Entries
Synchronous method overload. Result of the invocation will be reported as a method return value.
list
in interface Entries
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
.public java.util.Set<java.lang.String> list(java.lang.String vm, java.lang.String dataSet, InvocationConfig invocationConfig)
Entries
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
list
in interface Entries
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
.public void list(java.lang.String vm, java.lang.String dataSet, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback)
Entries
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
. list
in interface Entries
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.public void list(java.lang.String vm, java.lang.String dataSet, AsyncCallback<java.util.Set<java.lang.String>> asyncCallback, InvocationConfig invocationConfig)
Entries
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
. list
in interface Entries
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.