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.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetBulkPublishDetailsResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetBulkPublishDetailsResponse.Builder`	`builder()`
`Instant`	`bulkPublishCompleteTime()`	If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
`Instant`	`bulkPublishStartTime()`	The date/time at which the last bulk publish was initiated.
`BulkPublishStatus`	`bulkPublishStatus()`	Status of the last bulk publish operation, valid values are:
`String`	`bulkPublishStatusAsString()`	Status of the last bulk publish operation, valid values are:
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureMessage()`	If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`identityPoolId()`	A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetBulkPublishDetailsResponse.Builder>`	`serializableBuilderClass()`
`GetBulkPublishDetailsResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cognitosync.model.CognitoSyncResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    BulkPublishStatus
  - 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:
    
    BulkPublishStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetBulkPublishDetailsResponse.Builder,GetBulkPublishDetailsResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetBulkPublishDetailsResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cognitosync.model.CognitoSyncResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityPoolId

bulkPublishStartTime

bulkPublishCompleteTime

bulkPublishStatus

bulkPublishStatusAsString

failureMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField