Class S3KnowledgeBaseParameters

java.lang.Object
software.amazon.awssdk.services.quicksight.model.S3KnowledgeBaseParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3KnowledgeBaseParameters.Builder,S3KnowledgeBaseParameters>
@Generated("software.amazon.awssdk:codegen") public final class S3KnowledgeBaseParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3KnowledgeBaseParameters.Builder,S3KnowledgeBaseParameters>

The parameters that are required to connect to a S3 Knowledge Base data source.

See Also:

  • Method Details

    • roleArn

      public final String roleArn()

      Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

      Returns:
      Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

    • bucketUrl

      public final String bucketUrl()

      The URL of the S3 bucket that contains the knowledge base data.

      Returns:
      The URL of the S3 bucket that contains the knowledge base data.

    • metadataFilesLocation

      public final String metadataFilesLocation()

      The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.

      Returns:
      The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.

    • toBuilder

      public S3KnowledgeBaseParameters.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<S3KnowledgeBaseParameters.Builder,S3KnowledgeBaseParameters>
      Returns:
      a builder for type T

    • builder

      public static S3KnowledgeBaseParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3KnowledgeBaseParameters.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.