Interface DsqlUtilities

All Known Implementing Classes:

DefaultDsqlUtilities

public interface DsqlUtilities

Utilities for working with DSQL. An instance of this class can be created by:

1) Using the low-level client DsqlClient.utilities() (or DsqlAsyncClient.utilities()} method. This is recommended as SDK will use the same configuration from the DsqlClient object to create the DsqlUtilities object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DsqlUtilities.Builder	Builder for creating an instance of DsqlUtilities.

Method Summary

Modifier and Type	Method	Description
static DsqlUtilities.Builder	builder()	Create a builder that can be used to configure and create a DsqlUtilities.
default String	generateDbConnectAdminAuthToken(Consumer<GenerateAuthTokenRequest.Builder> request)	Generates an admin authentication token for IAM authentication to an DSQL database.
default String	generateDbConnectAdminAuthToken(GenerateAuthTokenRequest request)	Generates an admin authentication token for IAM authentication to an DSQL database.
default String	generateDbConnectAuthToken(Consumer<GenerateAuthTokenRequest.Builder> request)	Generates an authentication token for IAM authentication to an DSQL database.
default String	generateDbConnectAuthToken(GenerateAuthTokenRequest request)	Generates an authentication token for IAM authentication to an DSQL database.

Method Details

builder

static DsqlUtilities.Builder builder()

Create a builder that can be used to configure and create a DsqlUtilities.

generateDbConnectAuthToken

default String generateDbConnectAuthToken(Consumer<GenerateAuthTokenRequest.Builder> request)

Generates an authentication token for IAM authentication to an DSQL database.

Parameters:

request - The request used to generate the authentication token

Returns:

String to use as the DSQL authentication token

Throws:

IllegalArgumentException - if the required parameters are not valid

generateDbConnectAuthToken

default String generateDbConnectAuthToken(GenerateAuthTokenRequest request)

Generates an authentication token for IAM authentication to an DSQL database.

Parameters:

request - The request used to generate the authentication token

Returns:

String to use as the DSQL authentication token

Throws:

IllegalArgumentException - if the required parameters are not valid

generateDbConnectAdminAuthToken

default String generateDbConnectAdminAuthToken(Consumer<GenerateAuthTokenRequest.Builder> request)

Generates an admin authentication token for IAM authentication to an DSQL database.

Parameters:

request - The request used to generate the admin authentication token

Returns:

String to use as the DSQL authentication token

Throws:

IllegalArgumentException - if the required parameters are not valid

generateDbConnectAdminAuthToken

default String generateDbConnectAdminAuthToken(GenerateAuthTokenRequest request)

Generates an admin authentication token for IAM authentication to an DSQL database.

Parameters:

request - The request used to generate the admin authentication token

Returns:

String to use as the DSQL authentication token

Throws:

IllegalArgumentException - if the required parameters are not valid