com.amazonaws.services.cognitosync.model

Class GetBulkPublishDetailsResult

java.lang.Object

com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsResult

All Implemented Interfaces:

Serializable, Cloneable

public class GetBulkPublishDetailsResult
extends Object
implements Serializable, Cloneable

The output for the

GetBulkPublishDetails

operation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetBulkPublishDetailsResult()

Method Summary

Methods

Modifier and Type	Method and Description
GetBulkPublishDetailsResult	clone()
boolean	equals(Object obj)
Date	getBulkPublishCompleteTime() If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
Date	getBulkPublishStartTime() The date/time at which the last bulk publish was initiated.
String	getBulkPublishStatus() Status of the last bulk publish operation, valid values are:
String	getFailureMessage() If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
String	getIdentityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
int	hashCode()
void	setBulkPublishCompleteTime(Date bulkPublishCompleteTime) If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
void	setBulkPublishStartTime(Date bulkPublishStartTime) The date/time at which the last bulk publish was initiated.
void	setBulkPublishStatus(BulkPublishStatus bulkPublishStatus) Status of the last bulk publish operation, valid values are:
void	setBulkPublishStatus(String bulkPublishStatus) Status of the last bulk publish operation, valid values are:
void	setFailureMessage(String failureMessage) If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
void	setIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetBulkPublishDetailsResult	withBulkPublishCompleteTime(Date bulkPublishCompleteTime) If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
GetBulkPublishDetailsResult	withBulkPublishStartTime(Date bulkPublishStartTime) The date/time at which the last bulk publish was initiated.
GetBulkPublishDetailsResult	withBulkPublishStatus(BulkPublishStatus bulkPublishStatus) Status of the last bulk publish operation, valid values are:
GetBulkPublishDetailsResult	withBulkPublishStatus(String bulkPublishStatus) Status of the last bulk publish operation, valid values are:
GetBulkPublishDetailsResult	withFailureMessage(String failureMessage) If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
GetBulkPublishDetailsResult	withIdentityPoolId(String identityPoolId) A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetBulkPublishDetailsResult

public GetBulkPublishDetailsResult()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Returns:

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

withIdentityPoolId

public GetBulkPublishDetailsResult withIdentityPoolId(String identityPoolId)

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 50
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId - A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Returns:

A reference to this updated object so that method calls can be chained together.

getBulkPublishStartTime

public Date getBulkPublishStartTime()

The date/time at which the last bulk publish was initiated.

Returns:

The date/time at which the last bulk publish was initiated.

setBulkPublishStartTime

public void setBulkPublishStartTime(Date bulkPublishStartTime)

The date/time at which the last bulk publish was initiated.

Parameters:

bulkPublishStartTime - The date/time at which the last bulk publish was initiated.

withBulkPublishStartTime

public GetBulkPublishDetailsResult withBulkPublishStartTime(Date bulkPublishStartTime)

The date/time at which the last bulk publish was initiated.

Returns a reference to this object so that method calls can be chained together.

Parameters:

bulkPublishStartTime - The date/time at which the last bulk publish was initiated.

Returns:

A reference to this updated object so that method calls can be chained together.

getBulkPublishCompleteTime

public Date getBulkPublishCompleteTime()

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

Returns:

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

setBulkPublishCompleteTime

public void setBulkPublishCompleteTime(Date bulkPublishCompleteTime)

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

Parameters:

bulkPublishCompleteTime - If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

withBulkPublishCompleteTime

public GetBulkPublishDetailsResult withBulkPublishCompleteTime(Date bulkPublishCompleteTime)

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

bulkPublishCompleteTime - If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

Returns:

A reference to this updated object so that method calls can be chained together.

getBulkPublishStatus

public String getBulkPublishStatus()

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED

Returns:

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

See Also:

BulkPublishStatus

setBulkPublishStatus

public void setBulkPublishStatus(String bulkPublishStatus)

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED

Parameters:

bulkPublishStatus - Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

See Also:

BulkPublishStatus

withBulkPublishStatus

public GetBulkPublishDetailsResult withBulkPublishStatus(String bulkPublishStatus)

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED

Parameters:

bulkPublishStatus - Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

BulkPublishStatus

setBulkPublishStatus

public void setBulkPublishStatus(BulkPublishStatus bulkPublishStatus)

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED

Parameters:

bulkPublishStatus - Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

See Also:

BulkPublishStatus

withBulkPublishStatus

public GetBulkPublishDetailsResult withBulkPublishStatus(BulkPublishStatus bulkPublishStatus)

Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: NOT_STARTED, IN_PROGRESS, FAILED, SUCCEEDED

Parameters:

bulkPublishStatus - Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

BulkPublishStatus

getFailureMessage

public String getFailureMessage()

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Returns:

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

setFailureMessage

public void setFailureMessage(String failureMessage)

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Parameters:

failureMessage - If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

withFailureMessage

public GetBulkPublishDetailsResult withFailureMessage(String failureMessage)

If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Returns a reference to this object so that method calls can be chained together.

Parameters:

failureMessage - If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GetBulkPublishDetailsResult clone()

Overrides:

clone in class Object