UserImportJobType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.UserImportJobType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserImportJobType
extends Object
implements Serializable, Cloneable, StructuredPojo

The user import job type.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserImportJobType()

Constructors
Constructor and Description
`UserImportJobType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserImportJobType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCloudWatchLogsRoleArn()` The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job.
`Date`	`getCompletionDate()` The date when the user import job was completed.
`String`	`getCompletionMessage()` The message returned when the user import job is completed.
`Date`	`getCreationDate()` The date and time when the item was created.
`Long`	`getFailedUsers()` The number of users that couldn't be imported.
`Long`	`getImportedUsers()` The number of users that were successfully imported.
`String`	`getJobId()` The job ID for the user import job.
`String`	`getJobName()` The job name for the user import job.
`String`	`getPreSignedUrl()` The pre-signed URL to be used to upload the `.csv` file.
`Long`	`getSkippedUsers()` The number of users that were skipped.
`Date`	`getStartDate()` The date when the user import job was started.
`String`	`getStatus()` The status of the user import job.
`String`	`getUserPoolId()` The user pool ID for the user pool that the users are being imported into.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)` The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job.
`void`	`setCompletionDate(Date completionDate)` The date when the user import job was completed.
`void`	`setCompletionMessage(String completionMessage)` The message returned when the user import job is completed.
`void`	`setCreationDate(Date creationDate)` The date and time when the item was created.
`void`	`setFailedUsers(Long failedUsers)` The number of users that couldn't be imported.
`void`	`setImportedUsers(Long importedUsers)` The number of users that were successfully imported.
`void`	`setJobId(String jobId)` The job ID for the user import job.
`void`	`setJobName(String jobName)` The job name for the user import job.
`void`	`setPreSignedUrl(String preSignedUrl)` The pre-signed URL to be used to upload the `.csv` file.
`void`	`setSkippedUsers(Long skippedUsers)` The number of users that were skipped.
`void`	`setStartDate(Date startDate)` The date when the user import job was started.
`void`	`setStatus(String status)` The status of the user import job.
`void`	`setStatus(UserImportJobStatusType status)` The status of the user import job.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool that the users are being imported into.
`String`	`toString()` Returns a string representation of this object.
`UserImportJobType`	`withCloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)` The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job.
`UserImportJobType`	`withCompletionDate(Date completionDate)` The date when the user import job was completed.
`UserImportJobType`	`withCompletionMessage(String completionMessage)` The message returned when the user import job is completed.
`UserImportJobType`	`withCreationDate(Date creationDate)` The date and time when the item was created.
`UserImportJobType`	`withFailedUsers(Long failedUsers)` The number of users that couldn't be imported.
`UserImportJobType`	`withImportedUsers(Long importedUsers)` The number of users that were successfully imported.
`UserImportJobType`	`withJobId(String jobId)` The job ID for the user import job.
`UserImportJobType`	`withJobName(String jobName)` The job name for the user import job.
`UserImportJobType`	`withPreSignedUrl(String preSignedUrl)` The pre-signed URL to be used to upload the `.csv` file.
`UserImportJobType`	`withSkippedUsers(Long skippedUsers)` The number of users that were skipped.
`UserImportJobType`	`withStartDate(Date startDate)` The date when the user import job was started.
`UserImportJobType`	`withStatus(String status)` The status of the user import job.
`UserImportJobType`	`withStatus(UserImportJobStatusType status)` The status of the user import job.
`UserImportJobType`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool that the users are being imported into.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserImportJobType
```
public UserImportJobType()
```
- Method Detail
  - setJobName
```
public void setJobName(String jobName)
```
    The job name for the user import job.
    
    Parameters:
    
    jobName - The job name for the user import job.
  - getJobName
```
public String getJobName()
```
    The job name for the user import job.
    
    Returns:
    
    The job name for the user import job.
  - withJobName
```
public UserImportJobType withJobName(String jobName)
```
    The job name for the user import job.
    
    Parameters:
    
    jobName - The job name for the user import job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String jobId)
```
    The job ID for the user import job.
    
    Parameters:
    
    jobId - The job ID for the user import job.
  - getJobId
```
public String getJobId()
```
    The job ID for the user import job.
    
    Returns:
    
    The job ID for the user import job.
  - withJobId
```
public UserImportJobType withJobId(String jobId)
```
    The job ID for the user import job.
    
    Parameters:
    
    jobId - The job ID for the user import job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool that the users are being imported into.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool that the users are being imported into.
  - getUserPoolId
```
public String getUserPoolId()
```
    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.
  - withUserPoolId
```
public UserImportJobType withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool that the users are being imported into.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool that the users are being imported into.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreSignedUrl
```
public void setPreSignedUrl(String preSignedUrl)
```
    The pre-signed URL to be used to upload the .csv file.
    
    Parameters:
    
    preSignedUrl - The pre-signed URL to be used to upload the .csv file.
  - getPreSignedUrl
```
public String getPreSignedUrl()
```
    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.
  - withPreSignedUrl
```
public UserImportJobType withPreSignedUrl(String preSignedUrl)
```
    The pre-signed URL to be used to upload the .csv file.
    
    Parameters:
    
    preSignedUrl - The pre-signed URL to be used to upload the .csv file.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Parameters:
    
    creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
  - withCreationDate
```
public UserImportJobType withCreationDate(Date creationDate)
```
    The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Parameters:
    
    creationDate - The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartDate
```
public void setStartDate(Date startDate)
```
    The date when the user import job was started.
    
    Parameters:
    
    startDate - The date when the user import job was started.
  - getStartDate
```
public Date getStartDate()
```
    The date when the user import job was started.
    
    Returns:
    
    The date when the user import job was started.
  - withStartDate
```
public UserImportJobType withStartDate(Date startDate)
```
    The date when the user import job was started.
    
    Parameters:
    
    startDate - The date when the user import job was started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionDate
```
public void setCompletionDate(Date completionDate)
```
    The date when the user import job was completed.
    
    Parameters:
    
    completionDate - The date when the user import job was completed.
  - getCompletionDate
```
public Date getCompletionDate()
```
    The date when the user import job was completed.
    
    Returns:
    
    The date when the user import job was completed.
  - withCompletionDate
```
public UserImportJobType withCompletionDate(Date completionDate)
```
    The date when the user import job was completed.
    
    Parameters:
    
    completionDate - The date when the user import job was completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    UserImportJobStatusType
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public UserImportJobType withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserImportJobStatusType
  - setStatus
```
public void setStatus(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.
    Parameters:
    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.
    See Also:
    
    UserImportJobStatusType
  - withStatus
```
public UserImportJobType withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserImportJobStatusType
  - setCloudWatchLogsRoleArn
```
public void setCloudWatchLogsRoleArn(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.
    
    Parameters:
    
    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.
  - getCloudWatchLogsRoleArn
```
public String getCloudWatchLogsRoleArn()
```
    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.
  - withCloudWatchLogsRoleArn
```
public UserImportJobType withCloudWatchLogsRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImportedUsers
```
public void setImportedUsers(Long importedUsers)
```
    The number of users that were successfully imported.
    
    Parameters:
    
    importedUsers - The number of users that were successfully imported.
  - getImportedUsers
```
public Long getImportedUsers()
```
    The number of users that were successfully imported.
    
    Returns:
    
    The number of users that were successfully imported.
  - withImportedUsers
```
public UserImportJobType withImportedUsers(Long importedUsers)
```
    The number of users that were successfully imported.
    
    Parameters:
    
    importedUsers - The number of users that were successfully imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSkippedUsers
```
public void setSkippedUsers(Long skippedUsers)
```
    The number of users that were skipped.
    
    Parameters:
    
    skippedUsers - The number of users that were skipped.
  - getSkippedUsers
```
public Long getSkippedUsers()
```
    The number of users that were skipped.
    
    Returns:
    
    The number of users that were skipped.
  - withSkippedUsers
```
public UserImportJobType withSkippedUsers(Long skippedUsers)
```
    The number of users that were skipped.
    
    Parameters:
    
    skippedUsers - The number of users that were skipped.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailedUsers
```
public void setFailedUsers(Long failedUsers)
```
    The number of users that couldn't be imported.
    
    Parameters:
    
    failedUsers - The number of users that couldn't be imported.
  - getFailedUsers
```
public Long getFailedUsers()
```
    The number of users that couldn't be imported.
    
    Returns:
    
    The number of users that couldn't be imported.
  - withFailedUsers
```
public UserImportJobType withFailedUsers(Long failedUsers)
```
    The number of users that couldn't be imported.
    
    Parameters:
    
    failedUsers - The number of users that couldn't be imported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionMessage
```
public void setCompletionMessage(String completionMessage)
```
    The message returned when the user import job is completed.
    
    Parameters:
    
    completionMessage - The message returned when the user import job is completed.
  - getCompletionMessage
```
public String getCompletionMessage()
```
    The message returned when the user import job is completed.
    
    Returns:
    
    The message returned when the user import job is completed.
  - withCompletionMessage
```
public UserImportJobType withCompletionMessage(String completionMessage)
```
    The message returned when the user import job is completed.
    
    Parameters:
    
    completionMessage - The message returned when the user import job is completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserImportJobType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class UserImportJobType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserImportJobType

Method Detail

setJobName

getJobName

withJobName

setJobId

getJobId

withJobId

setUserPoolId

getUserPoolId

withUserPoolId

setPreSignedUrl

getPreSignedUrl

withPreSignedUrl

setCreationDate

getCreationDate

withCreationDate

setStartDate

getStartDate

withStartDate

setCompletionDate

getCompletionDate

withCompletionDate

setStatus

getStatus

withStatus

setStatus

withStatus

setCloudWatchLogsRoleArn

getCloudWatchLogsRoleArn

withCloudWatchLogsRoleArn

setImportedUsers

getImportedUsers

withImportedUsers

setSkippedUsers

getSkippedUsers

withSkippedUsers

setFailedUsers

getFailedUsers

withFailedUsers

setCompletionMessage

getCompletionMessage

withCompletionMessage

toString

equals

hashCode

clone

marshall