public static final class FileTypes.Info extends java.lang.Object implements java.io.Serializable, StaticStructure
Info
class defines the uploaded file.Modifier and Type | Class and Description |
---|---|
static class |
FileTypes.Info.Builder
Builder class for
FileTypes.Info . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
Info()
Default constructor.
|
protected |
Info(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get dynamic filed value.
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static FileTypes.Info |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static FileTypes.Info |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
long |
getBytesTransferred()
The number of bytes of this file that have been received by the server.
|
FileTypes.ChecksumInfo |
getChecksumInfo()
The checksum information of the file received by the server.
|
LocalizableMessage |
getErrorMessage()
Details about the transfer error.
|
java.lang.Boolean |
getKeepInStorage()
Whether or not the file will be kept in storage upon update session completion.
|
java.lang.String |
getName()
The name of the file.
|
java.lang.Long |
getSize()
The file size, in bytes as received by the server.
|
TransferEndpoint |
getSourceEndpoint()
A source endpoint from which to retrieve the file.
|
FileTypes.SourceType |
getSourceType()
The source type (NONE, PUSH, PULL) from which the file is being retrieved.
|
TransferStatus |
getStatus()
The transfer status (WAITING_FOR_TRANSFER, TRANSFERRING, READY, VALIDATING,
ERROR) of this file.
|
TransferEndpoint |
getUploadEndpoint()
An upload endpoint to which the client can push the content.
|
int |
hashCode() |
void |
setBytesTransferred(long bytesTransferred)
The number of bytes of this file that have been received by the server.
|
void |
setChecksumInfo(FileTypes.ChecksumInfo checksumInfo)
The checksum information of the file received by the server.
|
void |
setErrorMessage(LocalizableMessage errorMessage)
Details about the transfer error.
|
void |
setKeepInStorage(java.lang.Boolean keepInStorage)
Whether or not the file will be kept in storage upon update session completion.
|
void |
setName(java.lang.String name)
The name of the file.
|
void |
setSize(java.lang.Long size)
The file size, in bytes as received by the server.
|
void |
setSourceEndpoint(TransferEndpoint sourceEndpoint)
A source endpoint from which to retrieve the file.
|
void |
setSourceType(FileTypes.SourceType sourceType)
The source type (NONE, PUSH, PULL) from which the file is being retrieved.
|
void |
setStatus(TransferStatus status)
The transfer status (WAITING_FOR_TRANSFER, TRANSFERRING, READY, VALIDATING,
ERROR) of this file.
|
void |
setUploadEndpoint(TransferEndpoint uploadEndpoint)
An upload endpoint to which the client can push the content.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public Info()
protected Info(StructValue __dynamicStructureFields)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- New value for the property.public FileTypes.SourceType getSourceType()
FileTypes.SourceType.NONE
if the
file is not being changed.public void setSourceType(FileTypes.SourceType sourceType)
FileTypes.SourceType.NONE
if the
file is not being changed.sourceType
- New value for the property.public java.lang.Long getSize()
TransferStatus.READY
.public void setSize(java.lang.Long size)
TransferStatus.READY
.size
- New value for the property.public FileTypes.ChecksumInfo getChecksumInfo()
null
, the server does not verify the checksum.public void setChecksumInfo(FileTypes.ChecksumInfo checksumInfo)
null
, the server does not verify the checksum.checksumInfo
- New value for the property.public TransferEndpoint getSourceEndpoint()
getSourceType()
is FileTypes.SourceType.PULL
.public void setSourceEndpoint(TransferEndpoint sourceEndpoint)
getSourceType()
is FileTypes.SourceType.PULL
.sourceEndpoint
- New value for the property.public TransferEndpoint getUploadEndpoint()
getSourceType()
is FileTypes.SourceType.PUSH
.public void setUploadEndpoint(TransferEndpoint uploadEndpoint)
getSourceType()
is FileTypes.SourceType.PUSH
.uploadEndpoint
- New value for the property.public long getBytesTransferred()
public void setBytesTransferred(long bytesTransferred)
bytesTransferred
- New value for the property.public TransferStatus getStatus()
public void setStatus(TransferStatus status)
status
- New value for the property.public LocalizableMessage getErrorMessage()
TransferStatus.ERROR
.public void setErrorMessage(LocalizableMessage errorMessage)
TransferStatus.ERROR
.errorMessage
- New value for the property.public java.lang.Boolean getKeepInStorage()
getKeepInStorage()
set to false will not show up in the list of files returned from File.list(java.lang.String)
upon update session completion. This
property was added in vSphere API 6.8.
If null
, the file will be kept in storage upon update session
completion.public void setKeepInStorage(java.lang.Boolean keepInStorage)
getKeepInStorage()
set to false will not show up in the list of files returned from File.list(java.lang.String)
upon update session completion. This
property was added in vSphere API 6.8.
If null
, the file will be kept in storage upon update session
completion.keepInStorage
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static FileTypes.Info _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static FileTypes.Info _newInstance2(StructValue structValue)