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:

  • Constructor Details

    • GetBulkPublishDetailsResult

      public GetBulkPublishDetailsResult()

  • Method Details

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

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

    • 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.
      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:
      Returns a reference to this object so that method calls can be chained together.

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

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

    • withBulkPublishStartTime

      public GetBulkPublishDetailsResult withBulkPublishStartTime(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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

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

    • withBulkPublishCompleteTime

      public GetBulkPublishDetailsResult withBulkPublishCompleteTime(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

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

      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:

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

      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:

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

      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:

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

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

    • withFailureMessage

      public GetBulkPublishDetailsResult withFailureMessage(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.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public GetBulkPublishDetailsResult clone()
      Overrides:
      clone in class Object