Class CreateTermsRequest

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.CreateTermsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTermsRequest.Builder,CreateTermsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTermsRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateTermsRequest.Builder,CreateTermsRequest>

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool where you want to create terms documents.

      Returns:
      The ID of the user pool where you want to create terms documents.

    • clientId

      public final String clientId()

      The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.

      Returns:
      The ID of the app client where you want to create terms documents. Must be an app client in the requested user pool.

    • termsName

      public final String termsName()

      A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.

      Returns:
      A friendly name for the document that you want to create in the current request. Must begin with terms-of-use or privacy-policy as identification of the document type. Provide URLs for both terms-of-use and privacy-policy in separate requests.

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 CreateTermsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTermsRequest.Builder,CreateTermsRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTermsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTermsRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.