Class AccessControlApplication

java.lang.Object
software.amazon.awssdk.services.quicksight.model.AccessControlApplication
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AccessControlApplication.Builder,AccessControlApplication>

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

An access control application. It defines how an external client signs in to Quick Sight with OAuth 2.0. Client secret values are never included.

See Also:
  • Method Details

    • applicationId

      public final String applicationId()

      The ID of the access control application.

      Returns:
      The ID of the access control application.
    • arn

      public final String arn()

      The ARN of the access control application.

      Returns:
      The ARN of the access control application.
    • name

      public final String name()

      The name of the access control application.

      Returns:
      The name of the access control application.
    • namespace

      public final String namespace()

      The Quick Sight namespace that the access control application belongs to.

      Returns:
      The Quick Sight namespace that the access control application belongs to.
    • authenticationType

      public final AccessControlApplicationAuthenticationType authenticationType()

      The authentication protocol that the access control application uses.

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

      Returns:
      The authentication protocol that the access control application uses.
      See Also:
    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      The authentication protocol that the access control application uses.

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

      Returns:
      The authentication protocol that the access control application uses.
      See Also:
    • status

      public final AccessControlApplicationStatus status()

      The status of the access control application.

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

      Returns:
      The status of the access control application.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the access control application.

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

      Returns:
      The status of the access control application.
      See Also:
    • createdTime

      public final Instant createdTime()

      The time when the access control application was created.

      Returns:
      The time when the access control application was created.
    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The time when the access control application was last updated.

      Returns:
      The time when the access control application was last updated.
    • tenantUrl

      public final String tenantUrl()

      The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.

      Returns:
      The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.
    • description

      public final String description()

      The description of the access control application.

      Returns:
      The description of the access control application.
    • idcApplicationArn

      public final String idcApplicationArn()

      The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the IdpAuthorizingType is IDC_AUTH_CODE , or when a trusted token issuer is configured.

      Returns:
      The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the IdpAuthorizingType is IDC_AUTH_CODE, or when a trusted token issuer is configured.
    • idpAuthorizingConfiguration

      public final IdpAuthorizingConfig idpAuthorizingConfiguration()

      The identity provider configuration of the access control application. Client secret values are never included.

      Returns:
      The identity provider configuration of the access control application. Client secret values are never included.
    • quickAuthenticationConfiguration

      public final QuickAuthenticationConfig quickAuthenticationConfiguration()

      The Quick Sight authentication configuration of the access control application. Client secret values are never included.

      Returns:
      The Quick Sight authentication configuration of the access control application. Client secret values are never included.
    • 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<AccessControlApplication.Builder,AccessControlApplication>
      Returns:
      a builder for type T
    • builder

      public static AccessControlApplication.Builder builder()
    • serializableBuilderClass

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