Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class ResourceServerScopeType

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

One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType. For more information, see Scopes, M2M, and API authorization with resource servers.

See Also:

  • Method Details

    • scopeName

      public final String scopeName()

      The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName. For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer, you request and receive the scope exampleResourceServer/exampleScope.

      Returns:
      The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName. For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer, you request and receive the scope exampleResourceServer/exampleScope.

    • scopeDescription

      public final String scopeDescription()

      A friendly description of a custom scope.

      Returns:
      A friendly description of a custom scope.

    • toBuilder

      public ResourceServerScopeType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ResourceServerScopeType.Builder,ResourceServerScopeType>

    • builder

      public static ResourceServerScopeType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ResourceServerScopeType.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo