UserImportJobType (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.20.3 API)

java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.UserImportJobType

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>

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

The user import job type.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserImportJobType.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserImportJobType.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UserImportJobType.Builder`	`builder()`
`String`	`cloudWatchLogsRoleArn()` The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job.
`Instant`	`completionDate()` The date when the user import job was completed.
`String`	`completionMessage()` The message returned when the user import job is completed.
`Instant`	`creationDate()` The date the user import job was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`failedUsers()` The number of users that couldn't be imported.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Long`	`importedUsers()` The number of users that were successfully imported.
`String`	`jobId()` The job ID for the user import job.
`String`	`jobName()` The job name for the user import job.
`String`	`preSignedUrl()` The pre-signed URL to be used to upload the `.csv` file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserImportJobType.Builder>`	`serializableBuilderClass()`
`Long`	`skippedUsers()` The number of users that were skipped.
`Instant`	`startDate()` The date when the user import job was started.
`UserImportJobStatusType`	`status()` The status of the user import job.
`String`	`statusAsString()` The status of the user import job.
`UserImportJobType.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userPoolId()` The user pool ID for the user pool that the users are being imported into.

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
  - jobName
```
public final String jobName()
```
    The job name for the user import job.
    
    Returns:
    
    The job name for the user import job.
  - jobId
```
public final String jobId()
```
    The job ID for the user import job.
    
    Returns:
    
    The job ID for the user import job.
  - userPoolId
```
public final String userPoolId()
```
    The user pool ID for the user pool that the users are being imported into.
    
    Returns:
    
    The user pool ID for the user pool that the users are being imported into.
  - preSignedUrl
```
public final String preSignedUrl()
```
    The pre-signed URL to be used to upload the .csv file.
    
    Returns:
    
    The pre-signed URL to be used to upload the .csv file.
  - creationDate
```
public final Instant creationDate()
```
    The date the user import job was created.
    
    Returns:
    
    The date the user import job was created.
  - startDate
```
public final Instant startDate()
```
    The date when the user import job was started.
    
    Returns:
    
    The date when the user import job was started.
  - completionDate
```
public final Instant completionDate()
```
    The date when the user import job was completed.
    
    Returns:
    
    The date when the user import job was completed.
  - status
```
public final UserImportJobStatusType status()
```
    The status of the user import job. One of the following:
    - Created - The job was created but not started.
    - Pending - A transition state. You have started the job, but it has not begun importing users yet.
    - InProgress - The job has started, and users are being imported.
    - Stopping - You have stopped the job, but the job has not stopped importing users yet.
    - Stopped - You have stopped the job, and the job has stopped importing users.
    - Succeeded - The job has completed successfully.
    - Failed - The job has stopped due to an error.
    - Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
    If the service returns an enum value that is not available in the current SDK version, status will return UserImportJobStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the user import job. One of the following:
    
    Created - The job was created but not started.
    
    Pending - A transition state. You have started the job, but it has not begun importing users yet.
    
    InProgress - The job has started, and users are being imported.
    
    Stopping - You have stopped the job, but the job has not stopped importing users yet.
    
    Stopped - You have stopped the job, and the job has stopped importing users.
    
    Succeeded - The job has completed successfully.
    
    Failed - The job has stopped due to an error.
    
    Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
    See Also:
    
    UserImportJobStatusType
  - statusAsString
```
public final String statusAsString()
```
    The status of the user import job. One of the following:
    - Created - The job was created but not started.
    - Pending - A transition state. You have started the job, but it has not begun importing users yet.
    - InProgress - The job has started, and users are being imported.
    - Stopping - You have stopped the job, but the job has not stopped importing users yet.
    - Stopped - You have stopped the job, and the job has stopped importing users.
    - Succeeded - The job has completed successfully.
    - Failed - The job has stopped due to an error.
    - Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
    If the service returns an enum value that is not available in the current SDK version, status will return UserImportJobStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    The status of the user import job. One of the following:
    
    Created - The job was created but not started.
    
    Pending - A transition state. You have started the job, but it has not begun importing users yet.
    
    InProgress - The job has started, and users are being imported.
    
    Stopping - You have stopped the job, but the job has not stopped importing users yet.
    
    Stopped - You have stopped the job, and the job has stopped importing users.
    
    Succeeded - The job has completed successfully.
    
    Failed - The job has stopped due to an error.
    
    Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.
    See Also:
    
    UserImportJobStatusType
  - cloudWatchLogsRoleArn
```
public final String cloudWatchLogsRoleArn()
```
    The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
    
    Returns:
    
    The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
  - importedUsers
```
public final Long importedUsers()
```
    The number of users that were successfully imported.
    
    Returns:
    
    The number of users that were successfully imported.
  - skippedUsers
```
public final Long skippedUsers()
```
    The number of users that were skipped.
    
    Returns:
    
    The number of users that were skipped.
  - failedUsers
```
public final Long failedUsers()
```
    The number of users that couldn't be imported.
    
    Returns:
    
    The number of users that couldn't be imported.
  - completionMessage
```
public final String completionMessage()
```
    The message returned when the user import job is completed.
    
    Returns:
    
    The message returned when the user import job is completed.
  - toBuilder
```
public UserImportJobType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>
  - builder
```
public static UserImportJobType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserImportJobType.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

Class UserImportJobType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

jobName

jobId

userPoolId

preSignedUrl

creationDate

startDate

completionDate

status

statusAsString

cloudWatchLogsRoleArn

importedUsers

skippedUsers

failedUsers

completionMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields