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

Class GetCsvHeaderResponse

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

Represents the response from the server to the request to get the header information of the CSV file for the user import job.

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the requested user pool.

      Returns:
      The ID of the requested user pool.

    • hasCsvHeader

      public final boolean hasCsvHeader()
      For responses, this returns true if the service returned a value for the CSVHeader 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.

    • csvHeader

      public final List<String> csvHeader()

      A comma-separated list of attributes from your user pool. Save this output to a .csv file and populate it with the attributes of the users that you want to import.

      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 hasCsvHeader() method.

      Returns:
      A comma-separated list of attributes from your user pool. Save this output to a .csv file and populate it with the attributes of the users that you want to import.

    • toBuilder

      public GetCsvHeaderResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCsvHeaderResponse.Builder,GetCsvHeaderResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static GetCsvHeaderResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCsvHeaderResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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

    • 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