Class DataAccessorAuthenticationDetail

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

Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.

See Also:

  • Method Details

    • authenticationType

      public final DataAccessorAuthenticationType authenticationType()

      The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

      • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

      • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

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

      Returns:
      The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

      • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

      • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

      • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

      • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

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

      Returns:
      The type of authentication to use for the data accessor. This determines how the ISV authenticates when accessing data. You can use one of two authentication types:

      • AWS_IAM_IDC_TTI - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.

      • AWS_IAM_IDC_AUTH_CODE - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.

      See Also:

    • authenticationConfiguration

      public final DataAccessorAuthenticationConfiguration authenticationConfiguration()

      The specific authentication configuration based on the authentication type.

      Returns:
      The specific authentication configuration based on the authentication type.

    • hasExternalIds

      public final boolean hasExternalIds()
      For responses, this returns true if the service returned a value for the ExternalIds 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.

    • externalIds

      public final List<String> externalIds()

      A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.

      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 hasExternalIds() method.

      Returns:
      A list of external identifiers associated with this authentication configuration. These are used to correlate the data accessor with external systems.

    • toBuilder

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

    • builder

      public static DataAccessorAuthenticationDetail.Builder builder()

    • serializableBuilderClass

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