Package com.vmware.nsx_policy.model

Class LiveTraceStatus

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class LiveTraceStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    See Also:
    Serialized Form

    • Field Detail

      • INVALIDATION_REASON_PORT_DISCONNECT

        public static final java.lang.String INVALIDATION_REASON_PORT_DISCONNECT
        See Also:
        Constant Field Values

      • INVALIDATION_REASON_DP_DESTROY

        public static final java.lang.String INVALIDATION_REASON_DP_DESTROY
        See Also:
        Constant Field Values

      • INVALIDATION_REASON_UNKNOWN

        public static final java.lang.String INVALIDATION_REASON_UNKNOWN
        See Also:
        Constant Field Values

      • INVALIDATION_REASON_PCAP_IO_FAILURE

        public static final java.lang.String INVALIDATION_REASON_PCAP_IO_FAILURE
        See Also:
        Constant Field Values

      • OPERATION_STATE_IN_PROGRESS

        public static final java.lang.String OPERATION_STATE_IN_PROGRESS
        See Also:
        Constant Field Values

      • OPERATION_STATE_FINISHED

        public static final java.lang.String OPERATION_STATE_FINISHED
        See Also:
        Constant Field Values

      • OPERATION_STATE_PARTIAL_FINISHED

        public static final java.lang.String OPERATION_STATE_PARTIAL_FINISHED
        See Also:
        Constant Field Values

      • OPERATION_STATE_CANCELED

        public static final java.lang.String OPERATION_STATE_CANCELED
        See Also:
        Constant Field Values

      • OPERATION_STATE_INVALIDATED

        public static final java.lang.String OPERATION_STATE_INVALIDATED
        See Also:
        Constant Field Values

      • OPERATION_STATE_TIMEOUT

        public static final java.lang.String OPERATION_STATE_TIMEOUT
        See Also:
        Constant Field Values

      • REQUEST_STATUS_SUCCESS_DELIVERED

        public static final java.lang.String REQUEST_STATUS_SUCCESS_DELIVERED
        See Also:
        Constant Field Values

      • REQUEST_STATUS_LCP_FAILURE

        public static final java.lang.String REQUEST_STATUS_LCP_FAILURE
        See Also:
        Constant Field Values

      • REQUEST_STATUS_INVALID_FILTER

        public static final java.lang.String REQUEST_STATUS_INVALID_FILTER
        See Also:
        Constant Field Values

      • REQUEST_STATUS_DATAPATH_FAILURE

        public static final java.lang.String REQUEST_STATUS_DATAPATH_FAILURE
        See Also:
        Constant Field Values

      • REQUEST_STATUS_CONNECTION_ERROR

        public static final java.lang.String REQUEST_STATUS_CONNECTION_ERROR
        See Also:
        Constant Field Values

      • REQUEST_STATUS_TIMEOUT

        public static final java.lang.String REQUEST_STATUS_TIMEOUT
        See Also:
        Constant Field Values

      • REQUEST_STATUS_UNKNOWN

        public static final java.lang.String REQUEST_STATUS_UNKNOWN
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • LiveTraceStatus

        public LiveTraceStatus()
        Default constructor.

      • LiveTraceStatus

        protected LiveTraceStatus​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getLinks

        public java.util.List<ResourceLink> getLinks()
        The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setLinks

        public void setLinks​(java.util.List<ResourceLink> links)
        The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        links - New value for the property.

      • getSchema

        public java.lang.String getSchema()
        Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setSchema

        public void setSchema​(java.lang.String schema)
        Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        schema - New value for the property.

      • getSelf

        public SelfResourceLink getSelf()
        Returns:
        The current value of the property.

      • setSelf

        public void setSelf​(SelfResourceLink self)
        Parameters:
        self - New value for the property.

      • getRevision

        public java.lang.Long getRevision()
        The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
        Returns:
        The current value of the property.

      • setRevision

        public void setRevision​(java.lang.Long revision)
        The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
        Parameters:
        revision - New value for the property.

      • getCreateTime

        public java.lang.Long getCreateTime()
        Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setCreateTime

        public void setCreateTime​(java.lang.Long createTime)
        Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        createTime - New value for the property.

      • getCreateUser

        public java.lang.String getCreateUser()
        ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setCreateUser

        public void setCreateUser​(java.lang.String createUser)
        ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        createUser - New value for the property.

      • getLastModifiedTime

        public java.lang.Long getLastModifiedTime()
        Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setLastModifiedTime

        public void setLastModifiedTime​(java.lang.Long lastModifiedTime)
        Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        lastModifiedTime - New value for the property.

      • getLastModifiedUser

        public java.lang.String getLastModifiedUser()
        ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setLastModifiedUser

        public void setLastModifiedUser​(java.lang.String lastModifiedUser)
        ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        lastModifiedUser - New value for the property.

      • getProtection

        public java.lang.String getProtection()
        Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setProtection

        public void setProtection​(java.lang.String protection)
        Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        protection - New value for the property.

      • getSystemOwned

        public java.lang.Boolean getSystemOwned()
        Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setSystemOwned

        public void setSystemOwned​(java.lang.Boolean systemOwned)
        Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        systemOwned - New value for the property.

      • getDescription

        public java.lang.String getDescription()
        Description of this resource
        Returns:
        The current value of the property.

      • setDescription

        public void setDescription​(java.lang.String description)
        Description of this resource
        Parameters:
        description - New value for the property.

      • getDisplayName

        public java.lang.String getDisplayName()
        Defaults to ID if not set
        Returns:
        The current value of the property.

      • setDisplayName

        public void setDisplayName​(java.lang.String displayName)
        Defaults to ID if not set
        Parameters:
        displayName - New value for the property.

      • getId

        public java.lang.String getId()
        Unique identifier of this resource
        Returns:
        The current value of the property.

      • setId

        public void setId​(java.lang.String id)
        Unique identifier of this resource
        Parameters:
        id - New value for the property.

      • getResourceType

        public java.lang.String getResourceType()
        The type of this resource.
        Returns:
        The current value of the property.

      • setResourceType

        public void setResourceType​(java.lang.String resourceType)
        The type of this resource.
        Parameters:
        resourceType - New value for the property.

      • getTags

        public java.util.List<Tag> getTags()
        Opaque identifiers meaningful to the API user
        Returns:
        The current value of the property.

      • setTags

        public void setTags​(java.util.List<Tag> tags)
        Opaque identifiers meaningful to the API user
        Parameters:
        tags - New value for the property.

      • setActions

        public void setActions​(LiveTraceActionConfig actions)
        Parameters:
        actions - New value for the property.

      • getFilter

        public com.vmware.vapi.bindings.Structure getFilter()
        Returns:
        The current value of the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LiveTraceFilterData. When methods return a value of this class as a return value, the property will contain all the properties defined in LiveTraceFilterData.

      • setFilter

        public void setFilter​(com.vmware.vapi.bindings.Structure filter)
        Parameters:
        filter - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in LiveTraceFilterData. When methods return a value of this class as a return value, the property will contain all the properties defined in LiveTraceFilterData.

      • getFilterInvalidInfo

        public java.util.List<LiveTraceFilterInvalidInfo> getFilterInvalidInfo()
        The detail of invalid filter(s) in a Livetrace session. This field is only applicable for filters of PlainFilterData type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setFilterInvalidInfo

        public void setFilterInvalidInfo​(java.util.List<LiveTraceFilterInvalidInfo> filterInvalidInfo)
        The detail of invalid filter(s) in a Livetrace session. This field is only applicable for filters of PlainFilterData type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        filterInvalidInfo - New value for the property.

      • getInvalidationReason

        public java.lang.String getInvalidationReason()
        Possible values are: The reason of invalidating a Livetrace session. PORT_DISCONNECT - Source or destination logical port of the session is disconnected or disabled. DP_DESTROY - Dataplane is destroyed. UNKNOWN - The invalidation reason cannot be determined. PCAP_IO_FAILURE - Exception occurred when writing captured packets to file. In general, this issue could be caused by insufficient disk partition space of /tmp on ESXi or Edge. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setInvalidationReason

        public void setInvalidationReason​(java.lang.String invalidationReason)
        Possible values are: The reason of invalidating a Livetrace session. PORT_DISCONNECT - Source or destination logical port of the session is disconnected or disabled. DP_DESTROY - Dataplane is destroyed. UNKNOWN - The invalidation reason cannot be determined. PCAP_IO_FAILURE - Exception occurred when writing captured packets to file. In general, this issue could be caused by insufficient disk partition space of /tmp on ESXi or Edge. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        invalidationReason - New value for the property.

      • getIpsecVpnConfig

        public LiveTraceIpsecVpnConfig getIpsecVpnConfig()
        Returns:
        The current value of the property.

      • setIpsecVpnConfig

        public void setIpsecVpnConfig​(LiveTraceIpsecVpnConfig ipsecVpnConfig)
        Parameters:
        ipsecVpnConfig - New value for the property.

      • setOperationState

        public void setOperationState​(java.lang.String operationState)
        Possible values are: The operation state of Livetrace. IN_PROGRESS - collecting the session results. FINISHED - session results collection completes. PARTIAL_FINISHED - session results may be incomplete. CANCELED - session is cancelled by exception. INVALIDATED - session is invalidated by configuration changes such as VM migration. TIMEOUT - session is not completed on time. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        operationState - New value for the property.

      • getSourceLport

        public java.lang.String getSourceLport()
        The source logical port This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setSourceLport

        public void setSourceLport​(java.lang.String sourceLport)
        The source logical port This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        sourceLport - New value for the property.

      • getTimeout

        public java.lang.Long getTimeout()
        Timeout in seconds for livetrace session format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setTimeout

        public void setTimeout​(java.lang.Long timeout)
        Timeout in seconds for livetrace session format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        timeout - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _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 this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static LiveTraceStatus _newInstance​(com.vmware.vapi.data.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 LiveTraceStatus _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.