Class RegisterClientRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssooidc.model.SsoOidcRequest
software.amazon.awssdk.services.ssooidc.model.RegisterClientRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterClientRequest.Builder,RegisterClientRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterClientRequest extends SsoOidcRequest implements ToCopyableBuilder<RegisterClientRequest.Builder,RegisterClientRequest>

  • Method Details

    • clientName

      public final String clientName()

      The friendly name of the client.

      Returns:
      The friendly name of the client.

    • clientType

      public final String clientType()

      The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

      Returns:
      The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

    • hasScopes

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

    • scopes

      public final List<String> scopes()

      The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

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

      Returns:
      The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

    • hasRedirectUris

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

    • redirectUris

      public final List<String> redirectUris()

      The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

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

      Returns:
      The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

    • hasGrantTypes

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

    • grantTypes

      public final List<String> grantTypes()

      The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.

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

      Returns:
      The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.

    • issuerUrl

      public final String issuerUrl()

      The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

      Returns:
      The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

    • entitledApplicationArn

      public final String entitledApplicationArn()

      This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

      Returns:
      This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

    • toBuilder

      public RegisterClientRequest.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<RegisterClientRequest.Builder,RegisterClientRequest>
      Specified by:
      toBuilder in class SsoOidcRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterClientRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisterClientRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.