Class ApiServiceConfig

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class ApiServiceConfig
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Properties that affect the configuration of the NSX API service.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vmware.vapi.data.StructValue __dynamicStructureFields  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        ApiServiceConfig()
      Default constructor.
      protected ApiServiceConfig​(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 ApiServiceConfig _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 ApiServiceConfig _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.lang.Boolean getBasicAuthenticationEnabled()
      Identifies whether basic authentication is enabled or disabled in API calls.
      java.util.List<CipherSuite> getCipherSuites()
      The TLS cipher suites that the API service will negotiate.
      java.lang.Long getClientApiConcurrencyLimit()
      A per-client concurrency limit.
      java.lang.Long getClientApiRateLimit()
      The maximum number of API requests that will be serviced per second for a given authenticated client.
      java.lang.Long getConnectionTimeout()
      NSX connection timeout, in seconds.
      java.lang.Boolean getCookieBasedAuthenticationEnabled()
      Identifies whether cookie-based authentication is enabled or disabled in API calls.
      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 getGlobalApiConcurrencyLimit()
      The maximum number of concurrent API requests that will be serviced.
      java.lang.String getId()
      Unique identifier of this resource
      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.util.List<java.lang.String> getLockoutImmuneAddresses()
      The list of IP addresses which are not subjected to a lockout on failed login attempts.
      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.util.List<ProtocolVersion> getProtocolVersions()
      The TLS protocol versions that the API service will negotiate.
      java.lang.String getRedirectHost()
      Host name or IP address to use for redirect location headers, or empty string to derive from current request.
      java.lang.String getResourceType()
      The type of this resource.
      java.lang.Long getRevision()
      The _revision property describes the current revision of the resource.
      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()  
      java.lang.Long getSessionTimeout()
      NSX session inactivity timeout format: int64
      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
      int hashCode()  
      void setBasicAuthenticationEnabled​(java.lang.Boolean basicAuthenticationEnabled)
      Identifies whether basic authentication is enabled or disabled in API calls.
      void setCipherSuites​(java.util.List<CipherSuite> cipherSuites)
      The TLS cipher suites that the API service will negotiate.
      void setClientApiConcurrencyLimit​(java.lang.Long clientApiConcurrencyLimit)
      A per-client concurrency limit.
      void setClientApiRateLimit​(java.lang.Long clientApiRateLimit)
      The maximum number of API requests that will be serviced per second for a given authenticated client.
      void setConnectionTimeout​(java.lang.Long connectionTimeout)
      NSX connection timeout, in seconds.
      void setCookieBasedAuthenticationEnabled​(java.lang.Boolean cookieBasedAuthenticationEnabled)
      Identifies whether cookie-based authentication is enabled or disabled in API calls.
      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 setGlobalApiConcurrencyLimit​(java.lang.Long globalApiConcurrencyLimit)
      The maximum number of concurrent API requests that will be serviced.
      void setId​(java.lang.String id)
      Unique identifier of this resource
      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 setLockoutImmuneAddresses​(java.util.List<java.lang.String> lockoutImmuneAddresses)
      The list of IP addresses which are not subjected to a lockout on failed login attempts.
      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 setProtocolVersions​(java.util.List<ProtocolVersion> protocolVersions)
      The TLS protocol versions that the API service will negotiate.
      void setRedirectHost​(java.lang.String redirectHost)
      Host name or IP address to use for redirect location headers, or empty string to derive from current request.
      void setResourceType​(java.lang.String resourceType)
      The type of this resource.
      void setRevision​(java.lang.Long revision)
      The _revision property describes the current revision of the resource.
      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 setSessionTimeout​(java.lang.Long sessionTimeout)
      NSX session inactivity timeout format: int64
      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
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • ApiServiceConfig

        public ApiServiceConfig()
        Default constructor.
      • ApiServiceConfig

        protected ApiServiceConfig​(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.
      • getBasicAuthenticationEnabled

        public java.lang.Boolean getBasicAuthenticationEnabled()
        Identifies whether basic authentication is enabled or disabled in API calls.
        Returns:
        The current value of the property.
      • setBasicAuthenticationEnabled

        public void setBasicAuthenticationEnabled​(java.lang.Boolean basicAuthenticationEnabled)
        Identifies whether basic authentication is enabled or disabled in API calls.
        Parameters:
        basicAuthenticationEnabled - New value for the property.
      • getCipherSuites

        public java.util.List<CipherSuite> getCipherSuites()
        The TLS cipher suites that the API service will negotiate.
        Returns:
        The current value of the property.
      • setCipherSuites

        public void setCipherSuites​(java.util.List<CipherSuite> cipherSuites)
        The TLS cipher suites that the API service will negotiate.
        Parameters:
        cipherSuites - New value for the property.
      • getClientApiConcurrencyLimit

        public java.lang.Long getClientApiConcurrencyLimit()
        A per-client concurrency limit. This is the maximum number of outstanding requests that a client can have. For example, a client can open multiple connections to NSX and submit operations on each connection. When this limit is exceeded, the server returns a 503 Service Unavailable error to the client. To disable API concurrency limiting, set this value to 0. format: int64
        Returns:
        The current value of the property.
      • setClientApiConcurrencyLimit

        public void setClientApiConcurrencyLimit​(java.lang.Long clientApiConcurrencyLimit)
        A per-client concurrency limit. This is the maximum number of outstanding requests that a client can have. For example, a client can open multiple connections to NSX and submit operations on each connection. When this limit is exceeded, the server returns a 503 Service Unavailable error to the client. To disable API concurrency limiting, set this value to 0. format: int64
        Parameters:
        clientApiConcurrencyLimit - New value for the property.
      • getClientApiRateLimit

        public java.lang.Long getClientApiRateLimit()
        The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0. format: int64
        Returns:
        The current value of the property.
      • setClientApiRateLimit

        public void setClientApiRateLimit​(java.lang.Long clientApiRateLimit)
        The maximum number of API requests that will be serviced per second for a given authenticated client. If more API requests are received than can be serviced, a 429 Too Many Requests HTTP response will be returned. To disable API rate limiting, set this value to 0. format: int64
        Parameters:
        clientApiRateLimit - New value for the property.
      • getConnectionTimeout

        public java.lang.Long getConnectionTimeout()
        NSX connection timeout, in seconds. To disable timeout, set to 0. format: int64
        Returns:
        The current value of the property.
      • setConnectionTimeout

        public void setConnectionTimeout​(java.lang.Long connectionTimeout)
        NSX connection timeout, in seconds. To disable timeout, set to 0. format: int64
        Parameters:
        connectionTimeout - New value for the property.
      • getCookieBasedAuthenticationEnabled

        public java.lang.Boolean getCookieBasedAuthenticationEnabled()
        Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.
        Returns:
        The current value of the property.
      • setCookieBasedAuthenticationEnabled

        public void setCookieBasedAuthenticationEnabled​(java.lang.Boolean cookieBasedAuthenticationEnabled)
        Identifies whether cookie-based authentication is enabled or disabled in API calls. When cookie-based authentication is disabled, new sessions cannot be created via /api/session/create.
        Parameters:
        cookieBasedAuthenticationEnabled - New value for the property.
      • getGlobalApiConcurrencyLimit

        public java.lang.Long getGlobalApiConcurrencyLimit()
        The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. format: int64
        Returns:
        The current value of the property.
      • setGlobalApiConcurrencyLimit

        public void setGlobalApiConcurrencyLimit​(java.lang.Long globalApiConcurrencyLimit)
        The maximum number of concurrent API requests that will be serviced. If the number of API requests being processed exceeds this limit, new API requests will be refused and a 503 Service Unavailable response will be returned to the client. To disable API concurrency limiting, set this value to 0. format: int64
        Parameters:
        globalApiConcurrencyLimit - New value for the property.
      • getLockoutImmuneAddresses

        public java.util.List<java.lang.String> getLockoutImmuneAddresses()
        The list of IP addresses which are not subjected to a lockout on failed login attempts. format: ip
        Returns:
        The current value of the property.
      • setLockoutImmuneAddresses

        public void setLockoutImmuneAddresses​(java.util.List<java.lang.String> lockoutImmuneAddresses)
        The list of IP addresses which are not subjected to a lockout on failed login attempts. format: ip
        Parameters:
        lockoutImmuneAddresses - New value for the property.
      • getProtocolVersions

        public java.util.List<ProtocolVersion> getProtocolVersions()
        The TLS protocol versions that the API service will negotiate.
        Returns:
        The current value of the property.
      • setProtocolVersions

        public void setProtocolVersions​(java.util.List<ProtocolVersion> protocolVersions)
        The TLS protocol versions that the API service will negotiate.
        Parameters:
        protocolVersions - New value for the property.
      • getRedirectHost

        public java.lang.String getRedirectHost()
        Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (\"\").
        Returns:
        The current value of the property.
      • setRedirectHost

        public void setRedirectHost​(java.lang.String redirectHost)
        Host name or IP address to use for redirect location headers, or empty string to derive from current request. To disable, set redirect_host to the empty string (\"\").
        Parameters:
        redirectHost - New value for the property.
      • getSessionTimeout

        public java.lang.Long getSessionTimeout()
        NSX session inactivity timeout format: int64
        Returns:
        The current value of the property.
      • setSessionTimeout

        public void setSessionTimeout​(java.lang.Long sessionTimeout)
        NSX session inactivity timeout format: int64
        Parameters:
        sessionTimeout - 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 ApiServiceConfig _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 ApiServiceConfig _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.