Class ListTermsResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
-
- software.amazon.awssdk.services.cognitoidentityprovider.model.ListTermsResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListTermsResponse.Builder,ListTermsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListTermsResponse extends CognitoIdentityProviderResponse implements ToCopyableBuilder<ListTermsResponse.Builder,ListTermsResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListTermsResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListTermsResponse.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTerms()For responses, this returns true if the service returned a value for the Terms property.StringnextToken()This API operation returns a limited number of results.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ListTermsResponse.Builder>serializableBuilderClass()List<TermsDescriptionType>terms()A summary of the requested terms documents.ListTermsResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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
-
hasTerms
public final boolean hasTerms()
For responses, this returns true if the service returned a value for the Terms property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
terms
public final List<TermsDescriptionType> terms()
A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.
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
hasTerms()method.- Returns:
- A summary of the requested terms documents. Includes unique identifiers for later changes to the terms documents.
-
nextToken
public final String nextToken()
This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
- Returns:
- This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
-
toBuilder
public ListTermsResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListTermsResponse.Builder,ListTermsResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static ListTermsResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListTermsResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-