Package software.amazon.awssdk.services.quicksight.model

Class StarburstParameters

java.lang.Object

software.amazon.awssdk.services.quicksight.model.StarburstParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StarburstParameters.Builder,StarburstParameters>

@Generated("software.amazon.awssdk:codegen")
public final class StarburstParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StarburstParameters.Builder,StarburstParameters>

The parameters that are required to connect to a Starburst data source.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StarburstParameters.Builder

Method Summary

Modifier and Type	Method	Description
AuthenticationType	authenticationType()	The authentication type that you want to use for your connection.
String	authenticationTypeAsString()	The authentication type that you want to use for your connection.
static StarburstParameters.Builder	builder()
String	catalog()	The catalog name for the Starburst data source.
String	databaseAccessControlRole()	The database access control role.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	host()	The host name of the Starburst data source.
OAuthParameters	oAuthParameters()	An object that contains information needed to create a data source connection between an QuickSight account and Starburst.
Integer	port()	The port for the Starburst data source.
StarburstProductType	productType()	The product type for the Starburst data source.
String	productTypeAsString()	The product type for the Starburst data source.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StarburstParameters.Builder>	serializableBuilderClass()
StarburstParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

host

public final String host()

The host name of the Starburst data source.

Returns:

The host name of the Starburst data source.

port

public final Integer port()

The port for the Starburst data source.

Returns:

The port for the Starburst data source.

catalog

public final String catalog()

The catalog name for the Starburst data source.

Returns:

The catalog name for the Starburst data source.

productType

public final StarburstProductType productType()

The product type for the Starburst data source.

If the service returns an enum value that is not available in the current SDK version, productType will return StarburstProductType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productTypeAsString().

Returns:

The product type for the Starburst data source.

See Also:

StarburstProductType

productTypeAsString

public final String productTypeAsString()

The product type for the Starburst data source.

If the service returns an enum value that is not available in the current SDK version, productType will return StarburstProductType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from productTypeAsString().

Returns:

The product type for the Starburst data source.

See Also:

StarburstProductType

databaseAccessControlRole

public final String databaseAccessControlRole()

The database access control role.

Returns:

The database access control role.

authenticationType

public final AuthenticationType authenticationType()

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

See Also:

AuthenticationType

authenticationTypeAsString

public final String authenticationTypeAsString()

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

Returns:

The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.

See Also:

AuthenticationType

oAuthParameters

public final OAuthParameters oAuthParameters()

An object that contains information needed to create a data source connection between an QuickSight account and Starburst.

Returns:

An object that contains information needed to create a data source connection between an QuickSight account and Starburst.

toBuilder

public StarburstParameters.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StarburstParameters.Builder,StarburstParameters>

builder

public static StarburstParameters.Builder builder()

serializableBuilderClass

public static Class<? extends StarburstParameters.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo