public final class Impact extends java.lang.Object implements java.io.Serializable, StaticStructure
Impact
class contains properties that describe the impact during
apply. method. Warning: This class is available as Technology Preview.
These are early access APIs provided to test, automate and provide feedback on
the feature. Since this can change based on feedback, VMware does not guarantee
backwards compatibility and recommends against using them in production
environments. Some Technology Preview APIs might only be applicable to specific
environments.Modifier and Type | Class and Description |
---|---|
static class |
Impact.Builder
Builder class for
Impact . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
Impact()
Default constructor.
|
protected |
Impact(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 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 Impact |
_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 Impact |
_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) |
ApplyImpact |
getApplyImpact()
Impact to the vCenter if the profile is applied.
|
java.util.List<LocalizableMessage> |
getMessage()
Description of the impact.
|
Notifications |
getNotifications()
Notifications returned by the validation operation.
|
StatusType |
getStatus()
Validation status of the appliance.
|
java.util.Set<java.lang.String> |
getSystemServices()
List of the System services to be restarted.
|
java.util.Set<java.lang.String> |
getVcenterServices()
List of the vCenter services to be restarted.
|
int |
hashCode() |
void |
setApplyImpact(ApplyImpact applyImpact)
Impact to the vCenter if the profile is applied.
|
void |
setMessage(java.util.List<LocalizableMessage> message)
Description of the impact.
|
void |
setNotifications(Notifications notifications)
Notifications returned by the validation operation.
|
void |
setStatus(StatusType status)
Validation status of the appliance.
|
void |
setSystemServices(java.util.Set<java.lang.String> systemServices)
List of the System services to be restarted.
|
void |
setVcenterServices(java.util.Set<java.lang.String> vcenterServices)
List of the vCenter services to be restarted.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public Impact()
protected Impact(StructValue __dynamicStructureFields)
public ApplyImpact getApplyImpact()
public void setApplyImpact(ApplyImpact applyImpact)
applyImpact
- New value for the property.public java.util.Set<java.lang.String> getVcenterServices()
null
there no impact on system.public void setVcenterServices(java.util.Set<java.lang.String> vcenterServices)
null
there no impact on system.vcenterServices
- New value for the property.public java.util.Set<java.lang.String> getSystemServices()
null
there no impact on system.public void setSystemServices(java.util.Set<java.lang.String> systemServices)
null
there no impact on system.systemServices
- New value for the property.public java.util.List<LocalizableMessage> getMessage()
public void setMessage(java.util.List<LocalizableMessage> message)
message
- New value for the property.public StatusType getStatus()
public void setStatus(StatusType status)
status
- New value for the property.public Notifications getNotifications()
public void setNotifications(Notifications notifications)
notifications
- 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 Impact _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 Impact _newInstance2(StructValue structValue)