yandex.cloud.sdk.auth.Auth Maven / Gradle / Ivy

Go to download
package yandex.cloud.sdk.auth;

import yandex.cloud.sdk.auth.provider.ApiKeyCredentialProvider;
import yandex.cloud.sdk.auth.provider.ComputeEngineCredentialProvider;
import yandex.cloud.sdk.auth.provider.IamTokenCredentialProvider;
import yandex.cloud.sdk.auth.provider.OauthCredentialProvider;
import yandex.cloud.sdk.auth.provider.CredentialProvider;

/**
 * Helper functions to work with {@link CredentialProvider}.
 */
public class Auth {
    private Auth() {/*noninstantiable helper class*/}

    /**
     * Creates an {@link OauthCredentialProvider.Builder} to build a provider that provides credentials from oauth token
     *
     * @return OauthCredentialProvider.Builder object
     */
    public static OauthCredentialProvider.Builder oauthTokenBuilder() {
        return OauthCredentialProvider.builder();
    }

    /**
     * Creates an {@link ApiKeyCredentialProvider.Builder} to build a provider that provides credentials from service account's api key
     *
     * @return ApiKeyCredentialProvider.Builder object
     */
    public static ApiKeyCredentialProvider.Builder apiKeyBuilder() {
        return ApiKeyCredentialProvider.builder();
    }

    /**
     * Creates a {@link ComputeEngineCredentialProvider.Builder} to build a provider that uses a compute metadata server
     *
     * @return ComputeEngineCredentialProvider.Builder object
     */
    public static ComputeEngineCredentialProvider.Builder computeEngineBuilder() {
        return ComputeEngineCredentialProvider.builder();
    }

    /**
     * Creates a {@link IamTokenCredentialProvider.Builder} to build a provider that provides credentials from iam token
     *
     * @return ComputeEngineCredentialProvider.Builder object
     */
    public static IamTokenCredentialProvider.Builder iamTokenBuilder() {
        return IamTokenCredentialProvider.builder();
    }
}