Class TransientIndication
- java.lang.Object
-
- com.vmware.vapi.std.errors.TransientIndication
-
- All Implemented Interfaces:
StaticStructure
,Structure
,java.io.Serializable
public final class TransientIndication extends java.lang.Object implements java.io.Serializable, StaticStructure
TheTransientIndication
class indicates whether or not the exception is transient.Some types of exceptions are transient in certain situtations and not transient in other situtations. This exception payload can be used to indicate to clients whether a particular exception is transient. See
Error.getData()
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TransientIndication.Builder
Builder class forTransientIndication
.
-
Field Summary
Fields Modifier and Type Field Description protected StructValue
__dynamicStructureFields
-
Constructor Summary
Constructors Modifier Constructor Description TransientIndication()
Default constructor.TransientIndication(boolean isTransient)
This constructor is provided for backwards compatibility purposes only.protected
TransientIndication(StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends Structure>
T_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 thisStructure
represented in the dynamicDataValue
model.DataValue
_getDynamicField(java.lang.String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).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 TransientIndication
_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 TransientIndication
_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 bindingStructure
.boolean
equals(java.lang.Object obj)
boolean
getIsTransient()
Indicates that the exception this class is attached to is transient.int
hashCode()
void
setIsTransient(boolean isTransient)
Indicates that the exception this class is attached to is transient.java.lang.String
toString()
Returns a string representation of this structure.
-
-
-
Field Detail
-
__dynamicStructureFields
protected StructValue __dynamicStructureFields
-
-
Constructor Detail
-
TransientIndication
public TransientIndication(boolean isTransient)
This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.
-
TransientIndication
public TransientIndication()
Default constructor.
-
TransientIndication
protected TransientIndication(StructValue __dynamicStructureFields)
-
-
Method Detail
-
getIsTransient
public boolean getIsTransient()
Indicates that the exception this class is attached to is transient.- Returns:
- The current value of the property.
-
setIsTransient
public void setIsTransient(boolean isTransient)
Indicates that the exception this class is attached to is transient.- Parameters:
isTransient
- New value for the property.
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
Description copied from interface:StaticStructure
WARNING: Internal method, subject to change in future versions. ReturnsStructType
instance representing the static bindings type for thisStructure
.- Specified by:
_getType
in interfaceStaticStructure
- Returns:
- the static bindings
StructType
-
_getDataValue
public StructValue _getDataValue()
Description copied from interface:Structure
Returns thisStructure
represented in the dynamicDataValue
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.- Specified by:
_getDataValue
in interfaceStructure
- Returns:
StructValue
representing this structure
-
_updateDataValue
protected void _updateDataValue(StructValue structValue)
-
_validate
public void _validate()
Description copied from interface:StaticStructure
Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language bindingStructure
.More precisely, for each union: given value of the discriminant/tag field (
@UnionTag
in the IDL) of an union in this structure, validates that:- all fields of the union required for that value of the discriminant are set
- fields of the union that are not allowed for that value of the discriminant are not set
- any other fields of the structure (not participating in the union) do not affect the validation result
- Specified by:
_validate
in interfaceStaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
Description copied from interface:StaticStructure
Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.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.
- Specified by:
toString
in interfaceStaticStructure
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of this static structure instance
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Description copied from interface:Structure
Checks if the runtime type name of this structure matches the type represented by the specified binding class.This can be used as efficient check to determine if this instance can be successfully
converted
to the target type.- Specified by:
_hasTypeNameOf
in interfaceStructure
- Parameters:
clazz
- bindings class for the target structure; must not benull
- Returns:
- true if this structures type name matches exactly the specified class' type name.
-
_convertTo
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Description copied from interface:Structure
Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.- Specified by:
_convertTo
in interfaceStructure
- Parameters:
clazz
- type of the result structure. cannot be null.- Returns:
- an instance of the requested type if conversion is possible.
CoreException
is thrown otherwise.
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
Description copied from interface:StaticStructure
Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static structure definition, i.e. not represented with getter/setter.- Specified by:
_setDynamicField
in interfaceStaticStructure
- Parameters:
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the field
-
_getDynamicField
public DataValue _getDynamicField(java.lang.String fieldName)
Description copied from interface:StaticStructure
Get a dynamic field value, doesn't allow access to static fields (which have getters/setters).- Specified by:
_getDynamicField
in interfaceStaticStructure
- Parameters:
fieldName
- the canonical name of the dynamic field- Returns:
- the
DataValue
of the dynamic field
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
Description copied from interface:StaticStructure
Get the names of the dynamic fields in the structure.- Specified by:
_getDynamicFieldNames
in interfaceStaticStructure
- Returns:
- set of the canonical field names for the dynamic fields
-
_getClassType
public static com.vmware.vapi.bindings.type.StructType _getClassType()
WARNING: Internal method, subject to change in future versions.- Returns:
StructType
instance representing the static bindings type for thisStructure
.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
Description copied from interface:Structure
Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For exampleorg.example.FooBar
would turn intoorg.example.foo_bar
.- Specified by:
_getCanonicalName
in interfaceStructure
- Returns:
- canonical name
-
_getCanonicalTypeName
public static java.lang.String _getCanonicalTypeName()
Returns the canonical type name. See_getCanonicalName()
.- Returns:
- canonical type name
-
_newInstance
public static TransientIndication _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.- Parameters:
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.- Returns:
- the static bindings
StructType
-
_newInstance2
public static TransientIndication _newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-