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

Class TermsDescriptionType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.TermsDescriptionType

All Implemented Interfaces:

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

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

The details of a set of terms documents. For more information, see Terms documents.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TermsDescriptionType.Builder

Method Summary

Modifier and Type	Method	Description
static TermsDescriptionType.Builder	builder()
Instant	creationDate()	The date and time when the item was created.
TermsEnforcementType	enforcement()	This parameter is reserved for future use and currently accepts one value.
String	enforcementAsString()	This parameter is reserved for future use and currently accepts one value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedDate()	The date and time when the item was modified.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TermsDescriptionType.Builder>	serializableBuilderClass()
String	termsId()	The ID of the requested terms documents.
String	termsName()	The type and friendly name of the requested terms documents.
TermsDescriptionType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

termsId

public final String termsId()

The ID of the requested terms documents.

Returns:

The ID of the requested terms documents.

termsName

public final String termsName()

The type and friendly name of the requested terms documents.

Returns:

The type and friendly name of the requested terms documents.

enforcement

public final TermsEnforcementType enforcement()

This parameter is reserved for future use and currently accepts one value.

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

Returns:

This parameter is reserved for future use and currently accepts one value.

See Also:

TermsEnforcementType

enforcementAsString

public final String enforcementAsString()

This parameter is reserved for future use and currently accepts one value.

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

Returns:

This parameter is reserved for future use and currently accepts one value.

See Also:

TermsEnforcementType

creationDate

public final Instant creationDate()

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

lastModifiedDate

public final Instant lastModifiedDate()

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

toBuilder

public TermsDescriptionType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TermsDescriptionType.Builder,TermsDescriptionType>

builder

public static TermsDescriptionType.Builder builder()

serializableBuilderClass

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