Class AuthScope

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

Contains the scope configuration for an authorization code. Defines the permissions and access boundaries for the session.

See Also:

  • Method Details

    • hasSecurityProfileIds

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

    • securityProfileIds

      public final List<String> securityProfileIds()

      The list of security profile identifiers to scope the session to. Maximum of 10 security profiles.

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

      Returns:
      The list of security profile identifiers to scope the session to. Maximum of 10 security profiles.

    • entityType

      public final AuthCodeEntityType entityType()

      The type of entity to scope the session to.

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

      Returns:
      The type of entity to scope the session to.
      See Also:

    • entityTypeAsString

      public final String entityTypeAsString()

      The type of entity to scope the session to.

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

      Returns:
      The type of entity to scope the session to.
      See Also:

    • entityId

      public final String entityId()

      The identifier of the entity to scope the session to.

      Returns:
      The identifier of the entity to scope the session to.

    • domainName

      public final String domainName()

      The name of the Customer Profiles domain to scope the session to.

      Returns:
      The name of the Customer Profiles domain to scope the session to.

    • toBuilder

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

    • builder

      public static AuthScope.Builder builder()

    • serializableBuilderClass

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