Class ApiServiceConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()
        Constructor with parameters for the required properties of ApiServiceConfig.
    • Method Detail

      • setLinks

        public ApiServiceConfig.Builder 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.
      • setSchema

        public ApiServiceConfig.Builder 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.
      • setRevision

        public ApiServiceConfig.Builder 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.
      • setCreateTime

        public ApiServiceConfig.Builder 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.
      • setCreateUser

        public ApiServiceConfig.Builder 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.
      • setLastModifiedTime

        public ApiServiceConfig.Builder 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.
      • setLastModifiedUser

        public ApiServiceConfig.Builder 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.
      • setProtection

        public ApiServiceConfig.Builder 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.
      • setSystemOwned

        public ApiServiceConfig.Builder 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.
      • setDescription

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

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

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

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

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

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

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

        public ApiServiceConfig.Builder 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.
      • setClientApiRateLimit

        public ApiServiceConfig.Builder 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.
      • setConnectionTimeout

        public ApiServiceConfig.Builder 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.
      • setCookieBasedAuthenticationEnabled

        public ApiServiceConfig.Builder 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.
      • setGlobalApiConcurrencyLimit

        public ApiServiceConfig.Builder 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.
      • setLockoutImmuneAddresses

        public ApiServiceConfig.Builder 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.
      • setProtocolVersions

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

        public ApiServiceConfig.Builder 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.
      • setSessionTimeout

        public ApiServiceConfig.Builder setSessionTimeout​(java.lang.Long sessionTimeout)
        NSX session inactivity timeout format: int64
        Parameters:
        sessionTimeout - New value for the property.