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

Class CreateDataSourceRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.CreateDataSourceRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDataSourceRequest extends QuickSightRequest implements ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account ID.

      Returns:
      The Amazon Web Services account ID.

    • dataSourceId

      public final String dataSourceId()

      An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

      Returns:
      An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

    • name

      public final String name()

      A display name for the data source.

      Returns:
      A display name for the data source.

    • type

      public final DataSourceType type()

      The type of the data source. To return a list of all data sources, use ListDataSources.

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

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

      Returns:
      The type of the data source. To return a list of all data sources, use ListDataSources.

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the data source. To return a list of all data sources, use ListDataSources.

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

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

      Returns:
      The type of the data source. To return a list of all data sources, use ListDataSources.

      Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

      See Also:

    • dataSourceParameters

      public final DataSourceParameters dataSourceParameters()

      The parameters that Amazon QuickSight uses to connect to your underlying source.

      Returns:
      The parameters that Amazon QuickSight uses to connect to your underlying source.

    • credentials

      public final DataSourceCredentials credentials()

      The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

      Returns:
      The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

    • hasPermissions

      public final boolean hasPermissions()
      For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • permissions

      public final List<ResourcePermission> permissions()

      A list of resource permissions on the data source.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPermissions() method.

      Returns:
      A list of resource permissions on the data source.

    • vpcConnectionProperties

      public final VpcConnectionProperties vpcConnectionProperties()

      Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

      Returns:
      Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

    • sslProperties

      public final SslProperties sslProperties()

      Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

      Returns:
      Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

    • hasFolderArns

      public final boolean hasFolderArns()
      For responses, this returns true if the service returned a value for the FolderArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • folderArns

      public final List<String> folderArns()

      When you create the data source, Amazon QuickSight adds the data source to these folders.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFolderArns() method.

      Returns:
      When you create the data source, Amazon QuickSight adds the data source to these folders.

    • toBuilder

      public CreateDataSourceRequest.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<CreateDataSourceRequest.Builder,CreateDataSourceRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDataSourceRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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