software.amazon.awssdk.services.cognitosync.model

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(value="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 and Description
static interface	GetBulkPublishDetailsResponse.Builder

Method Summary

Modifier and Type	Method and 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)
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) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	identityPoolId() A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
List<SdkField<?>>	sdkFields()
static Class<? extends GetBulkPublishDetailsResponse.Builder>	serializableBuilderClass()
GetBulkPublishDetailsResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identityPoolId

public 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 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 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 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 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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