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

Class ResourceServerType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.ResourceServerType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ResourceServerType.Builder,ResourceServerType>

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

A container for information about a resource server for a user pool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResourceServerType.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceServerType.Builder	builder()
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.
String	identifier()	A unique resource server identifier for the resource server.
String	name()	The name of the resource server.
List<ResourceServerScopeType>	scopes()	A list of scopes that are defined for the resource server.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceServerType.Builder>	serializableBuilderClass()
ResourceServerType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID for the user pool that hosts the resource server.

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

userPoolId

public final String userPoolId()

The user pool ID for the user pool that hosts the resource server.

Returns:

The user pool ID for the user pool that hosts the resource server.

identifier

public final String identifier()

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

Returns:

A unique resource server identifier for the resource server. The identifier can be an API friendly name like solar-system-data. You can also set an API URL like https://solar-system-data-api.example.com as your identifier.

Amazon Cognito represents scopes in the access token in the format $resource-server-identifier/$scope. Longer scope-identifier strings increase the size of your access tokens.

name

public final String name()

The name of the resource server.

Returns:

The name of the resource server.

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<ResourceServerScopeType> scopes()

A list of scopes that are defined for the resource server.

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:

A list of scopes that are defined for the resource server.

toBuilder

public ResourceServerType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceServerType.Builder,ResourceServerType>

builder

public static ResourceServerType.Builder builder()

serializableBuilderClass

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