java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateTermsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateTermsRequest.Builder,UpdateTermsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateTermsRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<UpdateTermsRequest.Builder,UpdateTermsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateTermsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateTermsRequest.Builder`	`builder()`
`TermsEnforcementType`	`enforcement()`	This parameter is reserved for future use and currently accepts only one value.
`String`	`enforcementAsString()`	This parameter is reserved for future use and currently accepts only one value.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLinks()`	For responses, this returns true if the service returned a value for the Links property.
`Map<String,String>`	`links()`	A map of URLs to languages.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateTermsRequest.Builder>`	`serializableBuilderClass()`
`String`	`termsId()`	The ID of the terms document that you want to update.
`String`	`termsName()`	The new name that you want to apply to the requested terms documents.
`TermsSourceType`	`termsSource()`	This parameter is reserved for future use and currently accepts only one value.
`String`	`termsSourceAsString()`	This parameter is reserved for future use and currently accepts only one value.
`UpdateTermsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userPoolId()`	The ID of the user pool that contains the terms that you want to update.

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
  - termsId
```
public final String termsId()
```
    The ID of the terms document that you want to update.
    
    Returns:
    
    The ID of the terms document that you want to update.
  - userPoolId
```
public final String userPoolId()
```
    The ID of the user pool that contains the terms that you want to update.
    
    Returns:
    
    The ID of the user pool that contains the terms that you want to update.
  - termsName
```
public final String termsName()
```
    The new name that you want to apply to the requested terms documents.
    
    Returns:
    
    The new name that you want to apply to the requested terms documents.
  - termsSource
```
public final TermsSourceType termsSource()
```
    This parameter is reserved for future use and currently accepts only one value.
    
    If the service returns an enum value that is not available in the current SDK version, termsSource will return TermsSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from termsSourceAsString().
    
    Returns:
    
    This parameter is reserved for future use and currently accepts only one value.
    
    See Also:
    
    TermsSourceType
  - termsSourceAsString
```
public final String termsSourceAsString()
```
    This parameter is reserved for future use and currently accepts only one value.
    
    If the service returns an enum value that is not available in the current SDK version, termsSource will return TermsSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from termsSourceAsString().
    
    Returns:
    
    This parameter is reserved for future use and currently accepts only one value.
    
    See Also:
    
    TermsSourceType
  - enforcement
```
public final TermsEnforcementType enforcement()
```
    This parameter is reserved for future use and currently accepts only 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 only one value.
    
    See Also:
    
    TermsEnforcementType
  - enforcementAsString
```
public final String enforcementAsString()
```
    This parameter is reserved for future use and currently accepts only 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 only one value.
    
    See Also:
    
    TermsEnforcementType
  - hasLinks
```
public final boolean hasLinks()
```
    For responses, this returns true if the service returned a value for the Links 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.
  - links
```
public final Map<String,String> links()
```
    A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.
    
    For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".
    
    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 hasLinks() method.
    
    Returns:
    
    A map of URLs to languages. For each localized language that will view the requested TermsName, assign a URL. A selection of cognito:default displays for all languages that don't have a language-specific URL.
    
    For example, "cognito:default": "https://terms.example.com", "cognito:spanish": "https://terms.example.com/es".
  - toBuilder
```
public UpdateTermsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateTermsRequest.Builder,UpdateTermsRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static UpdateTermsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateTermsRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateTermsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

termsId

userPoolId

termsName

termsSource

termsSourceAsString

enforcement

enforcementAsString

hasLinks

links

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField