public class UserImportJobType
extends java.lang.Object
implements java.io.Serializable
The user import job type.
| Constructor and Description |
|---|
UserImportJobType() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getCloudWatchLogsRoleArn()
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging
role for the user import job.
|
java.util.Date |
getCompletionDate()
The date when the user import job was completed.
|
java.lang.String |
getCompletionMessage()
The message returned when the user import job is completed.
|
java.util.Date |
getCreationDate()
The date and time, in ISO
8601 format, when the item was created.
|
java.lang.Long |
getFailedUsers()
The number of users that couldn't be imported.
|
java.lang.Long |
getImportedUsers()
The number of users that were successfully imported.
|
java.lang.String |
getJobId()
The job ID for the user import job.
|
java.lang.String |
getJobName()
The job name for the user import job.
|
java.lang.String |
getPreSignedUrl()
The pre-signed URL to be used to upload the
.csv file. |
java.lang.Long |
getSkippedUsers()
The number of users that were skipped.
|
java.util.Date |
getStartDate()
The date when the user import job was started.
|
java.lang.String |
getStatus()
The status of the user import job.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool that the users are being imported
into.
|
int |
hashCode() |
void |
setCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging
role for the user import job.
|
void |
setCompletionDate(java.util.Date completionDate)
The date when the user import job was completed.
|
void |
setCompletionMessage(java.lang.String completionMessage)
The message returned when the user import job is completed.
|
void |
setCreationDate(java.util.Date creationDate)
The date and time, in ISO
8601 format, when the item was created.
|
void |
setFailedUsers(java.lang.Long failedUsers)
The number of users that couldn't be imported.
|
void |
setImportedUsers(java.lang.Long importedUsers)
The number of users that were successfully imported.
|
void |
setJobId(java.lang.String jobId)
The job ID for the user import job.
|
void |
setJobName(java.lang.String jobName)
The job name for the user import job.
|
void |
setPreSignedUrl(java.lang.String preSignedUrl)
The pre-signed URL to be used to upload the
.csv file. |
void |
setSkippedUsers(java.lang.Long skippedUsers)
The number of users that were skipped.
|
void |
setStartDate(java.util.Date startDate)
The date when the user import job was started.
|
void |
setStatus(java.lang.String status)
The status of the user import job.
|
void |
setStatus(UserImportJobStatusType status)
The status of the user import job.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool that the users are being imported
into.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UserImportJobType |
withCloudWatchLogsRoleArn(java.lang.String cloudWatchLogsRoleArn)
The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging
role for the user import job.
|
UserImportJobType |
withCompletionDate(java.util.Date completionDate)
The date when the user import job was completed.
|
UserImportJobType |
withCompletionMessage(java.lang.String completionMessage)
The message returned when the user import job is completed.
|
UserImportJobType |
withCreationDate(java.util.Date creationDate)
The date and time, in ISO
8601 format, when the item was created.
|
UserImportJobType |
withFailedUsers(java.lang.Long failedUsers)
The number of users that couldn't be imported.
|
UserImportJobType |
withImportedUsers(java.lang.Long importedUsers)
The number of users that were successfully imported.
|
UserImportJobType |
withJobId(java.lang.String jobId)
The job ID for the user import job.
|
UserImportJobType |
withJobName(java.lang.String jobName)
The job name for the user import job.
|
UserImportJobType |
withPreSignedUrl(java.lang.String preSignedUrl)
The pre-signed URL to be used to upload the
.csv file. |
UserImportJobType |
withSkippedUsers(java.lang.Long skippedUsers)
The number of users that were skipped.
|
UserImportJobType |
withStartDate(java.util.Date startDate)
The date when the user import job was started.
|
UserImportJobType |
withStatus(java.lang.String status)
The status of the user import job.
|
UserImportJobType |
withStatus(UserImportJobStatusType status)
The status of the user import job.
|
UserImportJobType |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool that the users are being imported
into.
|
public java.lang.String getJobName()
The job name for the user import job.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
The job name for the user import job.
public void setJobName(java.lang.String jobName)
The job name for the user import job.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
jobName - The job name for the user import job.
public UserImportJobType withJobName(java.lang.String jobName)
The job name for the user import job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
jobName - The job name for the user import job.
public java.lang.String getJobId()
The job ID for the user import job.
Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+
The job ID for the user import job.
public void setJobId(java.lang.String jobId)
The job ID for the user import job.
Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+
jobId - The job ID for the user import job.
public UserImportJobType withJobId(java.lang.String jobId)
The job ID for the user import job.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: import-[0-9a-zA-Z-]+
jobId - The job ID for the user import job.
public java.lang.String getUserPoolId()
The user pool ID for the user pool that the users are being imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool that the users are being imported into.
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool that the users are being imported into.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool that the users are being imported into.
public UserImportJobType withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool that the users are being imported into.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool that the users are being imported into.
public java.lang.String getPreSignedUrl()
The pre-signed URL to be used to upload the .csv file.
Constraints:
Length: 0 - 2048
The pre-signed URL to be used to upload the .csv
file.
public void setPreSignedUrl(java.lang.String preSignedUrl)
The pre-signed URL to be used to upload the .csv file.
Constraints:
Length: 0 - 2048
preSignedUrl -
The pre-signed URL to be used to upload the .csv
file.
public UserImportJobType withPreSignedUrl(java.lang.String preSignedUrl)
The pre-signed URL to be used to upload the .csv file.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 2048
preSignedUrl -
The pre-signed URL to be used to upload the .csv
file.
public java.util.Date getCreationDate()
The date and time, in ISO 8601 format, when the item was created.
The date and time, in ISO 8601 format, when the item was created.
public void setCreationDate(java.util.Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
creationDate - The date and time, in ISO 8601 format, when the item was created.
public UserImportJobType withCreationDate(java.util.Date creationDate)
The date and time, in ISO 8601 format, when the item was created.
Returns a reference to this object so that method calls can be chained together.
creationDate - The date and time, in ISO 8601 format, when the item was created.
public java.util.Date getStartDate()
The date when the user import job was started.
The date when the user import job was started.
public void setStartDate(java.util.Date startDate)
The date when the user import job was started.
startDate - The date when the user import job was started.
public UserImportJobType withStartDate(java.util.Date startDate)
The date when the user import job was started.
Returns a reference to this object so that method calls can be chained together.
startDate - The date when the user import job was started.
public java.util.Date getCompletionDate()
The date when the user import job was completed.
The date when the user import job was completed.
public void setCompletionDate(java.util.Date completionDate)
The date when the user import job was completed.
completionDate - The date when the user import job was completed.
public UserImportJobType withCompletionDate(java.util.Date completionDate)
The date when the user import job was completed.
Returns a reference to this object so that method calls can be chained together.
completionDate - The date when the user import job was completed.
public java.lang.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.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
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.
UserImportJobStatusTypepublic void setStatus(java.lang.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.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
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.
UserImportJobStatusTypepublic UserImportJobType withStatus(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
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.
UserImportJobStatusTypepublic 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.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
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.
UserImportJobStatusTypepublic 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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: Created, Pending, InProgress, Stopping, Expired,
Stopped, Failed, Succeeded
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.
UserImportJobStatusTypepublic java.lang.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.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
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.
public void setCloudWatchLogsRoleArn(java.lang.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.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
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.
public UserImportJobType withCloudWatchLogsRoleArn(java.lang.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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 20 - 2048
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=
/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
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.
public java.lang.Long getImportedUsers()
The number of users that were successfully imported.
The number of users that were successfully imported.
public void setImportedUsers(java.lang.Long importedUsers)
The number of users that were successfully imported.
importedUsers - The number of users that were successfully imported.
public UserImportJobType withImportedUsers(java.lang.Long importedUsers)
The number of users that were successfully imported.
Returns a reference to this object so that method calls can be chained together.
importedUsers - The number of users that were successfully imported.
public java.lang.Long getSkippedUsers()
The number of users that were skipped.
The number of users that were skipped.
public void setSkippedUsers(java.lang.Long skippedUsers)
The number of users that were skipped.
skippedUsers - The number of users that were skipped.
public UserImportJobType withSkippedUsers(java.lang.Long skippedUsers)
The number of users that were skipped.
Returns a reference to this object so that method calls can be chained together.
skippedUsers - The number of users that were skipped.
public java.lang.Long getFailedUsers()
The number of users that couldn't be imported.
The number of users that couldn't be imported.
public void setFailedUsers(java.lang.Long failedUsers)
The number of users that couldn't be imported.
failedUsers - The number of users that couldn't be imported.
public UserImportJobType withFailedUsers(java.lang.Long failedUsers)
The number of users that couldn't be imported.
Returns a reference to this object so that method calls can be chained together.
failedUsers - The number of users that couldn't be imported.
public java.lang.String getCompletionMessage()
The message returned when the user import job is completed.
Constraints:
Length: 1 - 128
Pattern: [\w]+
The message returned when the user import job is completed.
public void setCompletionMessage(java.lang.String completionMessage)
The message returned when the user import job is completed.
Constraints:
Length: 1 - 128
Pattern: [\w]+
completionMessage - The message returned when the user import job is completed.
public UserImportJobType withCompletionMessage(java.lang.String completionMessage)
The message returned when the user import job is completed.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w]+
completionMessage - The message returned when the user import job is completed.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object