Package com.ibm.cloud.sdk.core.security

Class IamAssumeAuthenticator.Builder

  • Enclosing class:
    IamAssumeAuthenticator
    public static class IamAssumeAuthenticator.Builder
extends java.lang.Object
    This Builder class is used to construct IamAssumeAuthenticator instances.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • build

        public IamAssumeAuthenticator build()
        Constructs a new instance of IamAuthenticator from the builder's configuration.
        Returns:
        the IamAuthenticator instance

      • iamProfileCrn

        public IamAssumeAuthenticator.Builder iamProfileCrn​(java.lang.String iamProfileCrn)
        Sets the iamProfileCrn property.
        Parameters:
        iamProfileCrn - iamProfileCrn value to use
        Returns:
        the Builder

      • iamProfileId

        public IamAssumeAuthenticator.Builder iamProfileId​(java.lang.String iamProfileId)
        Sets the iamProfileId property.
        Parameters:
        iamProfileId - iamProfileId value to use
        Returns:
        the Builder

      • iamProfileName

        public IamAssumeAuthenticator.Builder iamProfileName​(java.lang.String iamProfileName)
        Sets the iamProfileName property.
        Parameters:
        iamProfileName - iamProfileName value to use
        Returns:
        the Builder

      • iamAccountId

        public IamAssumeAuthenticator.Builder iamAccountId​(java.lang.String iamAccountId)
        Sets the iamAccountId property.
        Parameters:
        iamAccountId - iamAccountId value to use
        Returns:
        the Builder

      • apikey

        public IamAssumeAuthenticator.Builder apikey​(java.lang.String apikey)
        Sets the apikey property.
        Parameters:
        apikey - the apikey to use when retrieving an access token
        Returns:
        the Builder

      • clientId

        public IamAssumeAuthenticator.Builder clientId​(java.lang.String clientId)
        Sets the clientId property.
        Parameters:
        clientId - the clientId to use when retrieving an access token
        Returns:
        the Builder

      • clientSecret

        public IamAssumeAuthenticator.Builder clientSecret​(java.lang.String clientSecret)
        Sets the clientSecret property.
        Parameters:
        clientSecret - the clientSecret to use when retrieving an access token
        Returns:
        the Builder

      • scope

        public IamAssumeAuthenticator.Builder scope​(java.lang.String scope)
        Sets the scope property.
        Parameters:
        scope - the scope to use when retrieving an access token
        Returns:
        the Builder

      • url

        public IamAssumeAuthenticator.Builder url​(java.lang.String url)
        Sets the url property.
        Parameters:
        url - the base url to use with the IAM token service
        Returns:
        the Builder

      • disableSSLVerification

        public IamAssumeAuthenticator.Builder disableSSLVerification​(boolean disableSSLVerification)
        Sets the disableSSLVerification property.
        Parameters:
        disableSSLVerification - a boolean flag indicating whether or not SSL verification should be disabled when interacting with the IAM token service
        Returns:
        the Builder

      • headers

        public IamAssumeAuthenticator.Builder headers​(java.util.Map<java.lang.String,​java.lang.String> headers)
        Sets the headers property.
        Parameters:
        headers - the set of custom headers to include in requests sent to the IAM token service
        Returns:
        the Builder

      • proxy

        public IamAssumeAuthenticator.Builder proxy​(java.net.Proxy proxy)
        Sets the proxy property.
        Parameters:
        proxy - the java.net.Proxy instance to be used when interacting with the IAM token server
        Returns:
        the Builder

      • proxyAuthenticator

        public IamAssumeAuthenticator.Builder proxyAuthenticator​(okhttp3.Authenticator proxyAuthenticator)
        Sets the proxyAuthenticator property.
        Parameters:
        proxyAuthenticator - the okhttp3.Authenticator instance to be used with the proxy when interacting with the IAM token service
        Returns:
        the Builder

      • client

        public IamAssumeAuthenticator.Builder client​(okhttp3.OkHttpClient client)
        Sets the OkHttpClient instance to be used when interacting with the IAM token service.
        Parameters:
        client - the OkHttpClient instance to use
        Returns:
        the Builder