Package software.amazon.awssdk.services.ssooidc.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegisterClientRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RegisterClientRequest.Builder	builder()
String	clientName()	The friendly name of the client.
String	clientType()	The type of client.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasScopes()	For responses, this returns true if the service returned a value for the Scopes property.
List<String>	scopes()	The list of scopes that are defined by the client.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterClientRequest.Builder>	serializableBuilderClass()
RegisterClientRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

toBuilder

public RegisterClientRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterClientRequest.Builder,RegisterClientRequest>

Specified by:

toBuilder in class SsoOidcRequest

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)

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo