Class GetBulkPublishDetailsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.cognitosync.model.CognitoSyncResponse
software.amazon.awssdk.services.cognitosync.model.GetBulkPublishDetailsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetBulkPublishDetailsResponse.Builder,GetBulkPublishDetailsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetBulkPublishDetailsResponse extends CognitoSyncResponse implements ToCopyableBuilder<GetBulkPublishDetailsResponse.Builder,GetBulkPublishDetailsResponse>
The output for the GetBulkPublishDetails operation.

  • Method Details

    • identityPoolId

      public final 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 name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

    • bulkPublishStartTime

      public final Instant bulkPublishStartTime()
      The date/time at which the last bulk publish was initiated.
      Returns:
      The date/time at which the last bulk publish was initiated.

    • bulkPublishCompleteTime

      public final Instant bulkPublishCompleteTime()
      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.

    • bulkPublishStatus

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, bulkPublishStatus will return BulkPublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bulkPublishStatusAsString().

      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:

    • bulkPublishStatusAsString

      public final String bulkPublishStatusAsString()
      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.

      If the service returns an enum value that is not available in the current SDK version, bulkPublishStatus will return BulkPublishStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bulkPublishStatusAsString().

      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:

    • failureMessage

      public final String failureMessage()
      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.

    • toBuilder

      public GetBulkPublishDetailsResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetBulkPublishDetailsResponse.Builder,GetBulkPublishDetailsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetBulkPublishDetailsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetBulkPublishDetailsResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.