Class JwtAdditionalClaim

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

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

An additional claim rule for an issuer.

See Also:
  • Method Details

    • claimName

      public final String claimName()

      The name of the claim to check. The value cannot be empty and cannot be iss, aud, exp, nbf, iat, scope, or scp.

      Returns:
      The name of the claim to check. The value cannot be empty and cannot be iss, aud, exp, nbf, iat, scope, or scp.
    • format

      public final JwtClaimFormat format()

      The format of the claim value. The only valid value is SINGLE_STRING.

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

      Returns:
      The format of the claim value. The only valid value is SINGLE_STRING.
      See Also:
    • formatAsString

      public final String formatAsString()

      The format of the claim value. The only valid value is SINGLE_STRING.

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

      Returns:
      The format of the claim value. The only valid value is SINGLE_STRING.
      See Also:
    • required

      public final Boolean required()

      Specifies whether the claim must be present in the token. Defaults to false. When true, the token must contain the claim.

      Returns:
      Specifies whether the claim must be present in the token. Defaults to false. When true, the token must contain the claim.
    • hasExpectedValues

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

      public final List<String> expectedValues()

      The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.

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

      Returns:
      The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.
    • toBuilder

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

      public static JwtAdditionalClaim.Builder builder()
    • serializableBuilderClass

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