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:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • oAuthParameters

      public final OAuthParameters oAuthParameters()

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

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

    • toBuilder

      public StarburstParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StarburstParameters.Builder,StarburstParameters>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.