Package com.vmware.nsx_policy.model

Class LBHttpsMonitorProfile

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class LBHttpsMonitorProfile
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Active healthchecks are deactivated by default and can be activated for a server pool by binding a health monitor to the Group through the LBRule object. This represents active health monitoring over HTTPS. Active healthchecks are initiated periodically, at a configurable interval, to each member of the Group. Only if a healthcheck fails consecutively for a specified number of times (fall_count) to a member will the member status be marked DOWN. Once a member is DOWN, a specified number of consecutive successful healthchecks (rise_count) will bring the member back to UP state. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. LBHttpsMonitorProfile is deprecated as NSX-T Load Balancer is deprecated.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        LBHttpsMonitorProfile()
      Default constructor.
      protected LBHttpsMonitorProfile​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      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.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static LBHttpsMonitorProfile _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.
      static LBHttpsMonitorProfile _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
      Subtree for this type within policy tree containing nested elements.
      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.
      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.
      java.lang.String getDescription()
      Description of this resource
      java.lang.String getDisplayName()
      Defaults to ID if not set
      java.lang.Long getFallCount()
      Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.
      java.lang.String getId()
      Unique identifier of this resource
      java.lang.Long getInterval()
      Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
      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.
      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.
      java.util.List<ResourceLink> getLinks()
      The server will populate this field when returing the resource.
      java.lang.Boolean getMarkedForDelete()
      Intent objects are not directly deleted from the system when a delete is invoked on them.
      java.lang.Long getMonitorPort()
      Typically, monitors perform healthchecks to Group members using the member IP address and pool_port.
      java.lang.String getOriginSiteId()
      This is a UUID generated by the system for knowing which site owns an object.
      java.lang.Boolean getOverridden()
      Global intent objects cannot be modified by the user.
      java.lang.String getOwnerId()
      This is a UUID generated by the system for knowing who owns this object.
      java.lang.String getParentPath()
      Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getPath()
      Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getProtection()
      Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
      java.lang.String getRealizationId()
      This is a UUID generated by the system for realizing the entity object.
      java.lang.String getRelativePath()
      Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getRemotePath()
      This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
      java.lang.String getRequestBody()
      String to send as part of HTTP health check request body.
      java.util.List<LbHttpRequestHeader> getRequestHeaders()
      Array of HTTP request headers.
      java.lang.String getRequestMethod()
      Possible values are: REQUEST_METHOD_GET REQUEST_METHOD_OPTIONS REQUEST_METHOD_POST REQUEST_METHOD_HEAD REQUEST_METHOD_PUT The health check method for HTTP monitor type.
      java.lang.String getRequestUrl()
      For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
      java.lang.String getRequestVersion()
      Possible values are: REQUEST_VERSION_0 REQUEST_VERSION_1 HTTP request version.
      java.lang.String getResourceType()
      Possible values are: LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE There are two types of healthchecks: active and passive.
      java.lang.String getResponseBody()
      If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match.
      java.util.List<java.lang.Long> getResponseStatusCodes()
      The HTTP response status code should be a valid HTTP status code.
      java.lang.Long getRevision()
      The _revision property describes the current revision of the resource.
      java.lang.Long getRiseCount()
      Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.
      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.
      SelfResourceLink getSelf()  
      LBServerSslProfileBinding getServerSslProfileBinding()  
      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.
      java.util.List<Tag> getTags()
      Opaque identifiers meaningful to the API user
      java.lang.Long getTimeout()
      Timeout specified in seconds.
      java.lang.String getUniqueId()
      This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
      int hashCode()  
      void setChildren​(java.util.List<com.vmware.vapi.bindings.Structure> children)
      Subtree for this type within policy tree containing nested elements.
      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.
      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.
      void setDescription​(java.lang.String description)
      Description of this resource
      void setDisplayName​(java.lang.String displayName)
      Defaults to ID if not set
      void setFallCount​(java.lang.Long fallCount)
      Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN.
      void setId​(java.lang.String id)
      Unique identifier of this resource
      void setInterval​(java.lang.Long interval)
      Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group.
      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.
      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.
      void setLinks​(java.util.List<ResourceLink> links)
      The server will populate this field when returing the resource.
      void setMarkedForDelete​(java.lang.Boolean markedForDelete)
      Intent objects are not directly deleted from the system when a delete is invoked on them.
      void setMonitorPort​(java.lang.Long monitorPort)
      Typically, monitors perform healthchecks to Group members using the member IP address and pool_port.
      void setOriginSiteId​(java.lang.String originSiteId)
      This is a UUID generated by the system for knowing which site owns an object.
      void setOverridden​(java.lang.Boolean overridden)
      Global intent objects cannot be modified by the user.
      void setOwnerId​(java.lang.String ownerId)
      This is a UUID generated by the system for knowing who owns this object.
      void setParentPath​(java.lang.String parentPath)
      Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setPath​(java.lang.String path)
      Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      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.
      void setRealizationId​(java.lang.String realizationId)
      This is a UUID generated by the system for realizing the entity object.
      void setRelativePath​(java.lang.String relativePath)
      Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setRemotePath​(java.lang.String remotePath)
      This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
      void setRequestBody​(java.lang.String requestBody)
      String to send as part of HTTP health check request body.
      void setRequestHeaders​(java.util.List<LbHttpRequestHeader> requestHeaders)
      Array of HTTP request headers.
      void setRequestMethod​(java.lang.String requestMethod)
      Possible values are: REQUEST_METHOD_GET REQUEST_METHOD_OPTIONS REQUEST_METHOD_POST REQUEST_METHOD_HEAD REQUEST_METHOD_PUT The health check method for HTTP monitor type.
      void setRequestUrl​(java.lang.String requestUrl)
      For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
      void setRequestVersion​(java.lang.String requestVersion)
      Possible values are: REQUEST_VERSION_0 REQUEST_VERSION_1 HTTP request version.
      void setResourceType​(java.lang.String resourceType)
      Possible values are: LBMonitorProfile.RESOURCE_TYPE_LBTCPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBUDPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBICMPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBHTTPMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBHTTPSMONITORPROFILE LBMonitorProfile.RESOURCE_TYPE_LBPASSIVEMONITORPROFILE There are two types of healthchecks: active and passive.
      void setResponseBody​(java.lang.String responseBody)
      If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match.
      void setResponseStatusCodes​(java.util.List<java.lang.Long> responseStatusCodes)
      The HTTP response status code should be a valid HTTP status code.
      void setRevision​(java.lang.Long revision)
      The _revision property describes the current revision of the resource.
      void setRiseCount​(java.lang.Long riseCount)
      Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state.
      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.
      void setSelf​(SelfResourceLink self)  
      void setServerSslProfileBinding​(LBServerSslProfileBinding serverSslProfileBinding)  
      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.
      void setTags​(java.util.List<Tag> tags)
      Opaque identifiers meaningful to the API user
      void setTimeout​(java.lang.Long timeout)
      Timeout specified in seconds.
      void setUniqueId​(java.lang.String uniqueId)
      This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • REQUEST_METHOD_GET

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

      • REQUEST_METHOD_OPTIONS

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

      • REQUEST_METHOD_POST

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

      • REQUEST_METHOD_HEAD

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

      • REQUEST_METHOD_PUT

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

      • REQUEST_VERSION_0

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

      • REQUEST_VERSION_1

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

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • LBHttpsMonitorProfile

        public LBHttpsMonitorProfile()
        Default constructor.

      • LBHttpsMonitorProfile

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

    • Method Detail

      • getRequestBody

        public java.lang.String getRequestBody()
        String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
        Returns:
        The current value of the property.

      • setRequestBody

        public void setRequestBody​(java.lang.String requestBody)
        String to send as part of HTTP health check request body. Valid only for certain HTTP methods like POST.
        Parameters:
        requestBody - New value for the property.

      • getRequestHeaders

        public java.util.List<LbHttpRequestHeader> getRequestHeaders()
        Array of HTTP request headers.
        Returns:
        The current value of the property.

      • setRequestHeaders

        public void setRequestHeaders​(java.util.List<LbHttpRequestHeader> requestHeaders)
        Array of HTTP request headers.
        Parameters:
        requestHeaders - New value for the property.

      • getRequestUrl

        public java.lang.String getRequestUrl()
        For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
        Returns:
        The current value of the property.

      • setRequestUrl

        public void setRequestUrl​(java.lang.String requestUrl)
        For HTTPS active healthchecks, the HTTPS request url sent can be customized and can include query parameters.
        Parameters:
        requestUrl - New value for the property.

      • getRequestVersion

        public java.lang.String getRequestVersion()
        Possible values are: HTTP request version.
        Returns:
        The current value of the property.

      • setRequestVersion

        public void setRequestVersion​(java.lang.String requestVersion)
        Possible values are: HTTP request version.
        Parameters:
        requestVersion - New value for the property.

      • getResponseBody

        public java.lang.String getResponseBody()
        If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
        Returns:
        The current value of the property.

      • setResponseBody

        public void setResponseBody​(java.lang.String responseBody)
        If HTTP response body match string (regular expressions not supported) is specified (using LBHttpMonitor.response_body) then the healthcheck HTTP response body is matched against the specified string and server is considered healthy only if there is a match. If the response body string is not specified, HTTP healthcheck is considered successful if the HTTP response status code is 2xx, but it can be configured to accept other status codes as successful.
        Parameters:
        responseBody - New value for the property.

      • getResponseStatusCodes

        public java.util.List<java.lang.Long> getResponseStatusCodes()
        The HTTP response status code should be a valid HTTP status code. format: int32
        Returns:
        The current value of the property.

      • setResponseStatusCodes

        public void setResponseStatusCodes​(java.util.List<java.lang.Long> responseStatusCodes)
        The HTTP response status code should be a valid HTTP status code. format: int32
        Parameters:
        responseStatusCodes - New value for the property.

      • getServerSslProfileBinding

        public LBServerSslProfileBinding getServerSslProfileBinding()
        Returns:
        The current value of the property.

      • setServerSslProfileBinding

        public void setServerSslProfileBinding​(LBServerSslProfileBinding serverSslProfileBinding)
        Parameters:
        serverSslProfileBinding - New value for the property.

      • getFallCount

        public java.lang.Long getFallCount()
        Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
        Returns:
        The current value of the property.

      • setFallCount

        public void setFallCount​(java.lang.Long fallCount)
        Only if a healthcheck fails consecutively for a specified number of times, given with fall_count, to a member will the member status be marked DOWN. format: int64
        Parameters:
        fallCount - New value for the property.

      • getInterval

        public java.lang.Long getInterval()
        Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
        Returns:
        The current value of the property.

      • setInterval

        public void setInterval​(java.lang.Long interval)
        Active healthchecks are initiated periodically, at a configurable interval (in seconds), to each member of the Group. format: int64
        Parameters:
        interval - New value for the property.

      • getMonitorPort

        public java.lang.Long getMonitorPort()
        Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
        Returns:
        The current value of the property.

      • setMonitorPort

        public void setMonitorPort​(java.lang.Long monitorPort)
        Typically, monitors perform healthchecks to Group members using the member IP address and pool_port. However, in some cases, customers prefer to run healthchecks against a different port than the pool member port which handles actual application traffic. In such cases, the port to run healthchecks against can be specified in the monitor_port value. For ICMP monitor, monitor_port is not required. format: int32
        Parameters:
        monitorPort - New value for the property.

      • getRiseCount

        public java.lang.Long getRiseCount()
        Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
        Returns:
        The current value of the property.

      • setRiseCount

        public void setRiseCount​(java.lang.Long riseCount)
        Once a member is DOWN, a specified number of consecutive successful healthchecks specified by rise_count will bring the member back to UP state. format: int64
        Parameters:
        riseCount - New value for the property.

      • getTimeout

        public java.lang.Long getTimeout()
        Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
        Returns:
        The current value of the property.

      • setTimeout

        public void setTimeout​(java.lang.Long timeout)
        Timeout specified in seconds. After a healthcheck is initiated, if it does not complete within a certain period, then also the healthcheck is considered to be unsuccessful. Completing a healthcheck within timeout means establishing a connection (TCP or SSL), if applicable, sending the request and receiving the response, all within the configured timeout. format: int64
        Parameters:
        timeout - New value for the property.

      • 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.

      • 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.

      • getOriginSiteId

        public java.lang.String getOriginSiteId()
        This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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.

      • setOriginSiteId

        public void setOriginSiteId​(java.lang.String originSiteId)
        This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:
        originSiteId - New value for the property.

      • getOwnerId

        public java.lang.String getOwnerId()
        This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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.

      • setOwnerId

        public void setOwnerId​(java.lang.String ownerId)
        This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:
        ownerId - New value for the property.

      • getParentPath

        public java.lang.String getParentPath()
        Path of its parent 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.

      • setParentPath

        public void setParentPath​(java.lang.String parentPath)
        Path of its parent 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:
        parentPath - New value for the property.

      • getPath

        public java.lang.String getPath()
        Absolute path of this object 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.

      • setPath

        public void setPath​(java.lang.String path)
        Absolute path of this object 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:
        path - New value for the property.

      • getRealizationId

        public java.lang.String getRealizationId()
        This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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.

      • setRealizationId

        public void setRealizationId​(java.lang.String realizationId)
        This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:
        realizationId - New value for the property.

      • getRelativePath

        public java.lang.String getRelativePath()
        Path relative from its parent 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.

      • setRelativePath

        public void setRelativePath​(java.lang.String relativePath)
        Path relative from its parent 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:
        relativePath - New value for the property.

      • getRemotePath

        public java.lang.String getRemotePath()
        This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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.

      • setRemotePath

        public void setRemotePath​(java.lang.String remotePath)
        This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:
        remotePath - New value for the property.

      • getUniqueId

        public java.lang.String getUniqueId()
        This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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.

      • setUniqueId

        public void setUniqueId​(java.lang.String uniqueId)
        This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:
        uniqueId - New value for the property.

      • getChildren

        public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
        Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
        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 ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

      • setChildren

        public void setChildren​(java.util.List<com.vmware.vapi.bindings.Structure> children)
        Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
        Parameters:
        children - 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 ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

      • getMarkedForDelete

        public java.lang.Boolean getMarkedForDelete()
        Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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.

      • setMarkedForDelete

        public void setMarkedForDelete​(java.lang.Boolean markedForDelete)
        Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:
        markedForDelete - New value for the property.

      • getOverridden

        public java.lang.Boolean getOverridden()
        Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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.

      • setOverridden

        public void setOverridden​(java.lang.Boolean overridden)
        Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:
        overridden - 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 LBHttpsMonitorProfile _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 LBHttpsMonitorProfile _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.