Class ListRecordsResponse
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.ListRecordsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRecordsResponse.Builder,
ListRecordsResponse>
@Generated("software.amazon.awssdk:codegen")
public final class ListRecordsResponse
extends CognitoSyncResponse
implements ToCopyableBuilder<ListRecordsResponse.Builder,ListRecordsResponse>
Returned for a successful ListRecordsRequest.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListRecordsResponse.Builder
builder()
final Integer
count()
Total number of records.final Boolean
A boolean value specifying whether to delete the dataset locally.final Boolean
Indicates whether the dataset exists.final Long
Server sync count for this dataset.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MergedDatasetNames property.final boolean
For responses, this returns true if the service returned a value for the Records property.final String
The user/device that made the last change to this record.Names of merged datasets.final String
A pagination token for obtaining the next page of results.records()
A list of all records.static Class
<? extends ListRecordsResponse.Builder> final String
A token containing a session ID, identity ID, and expiration.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasRecords
public final boolean hasRecords()For responses, this returns true if the service returned a value for the Records property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
records
A list of all records.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRecords()
method.- Returns:
- A list of all records.
-
nextToken
A pagination token for obtaining the next page of results.- Returns:
- A pagination token for obtaining the next page of results.
-
count
Total number of records.- Returns:
- Total number of records.
-
datasetSyncCount
Server sync count for this dataset.- Returns:
- Server sync count for this dataset.
-
lastModifiedBy
The user/device that made the last change to this record.- Returns:
- The user/device that made the last change to this record.
-
hasMergedDatasetNames
public final boolean hasMergedDatasetNames()For responses, this returns true if the service returned a value for the MergedDatasetNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
mergedDatasetNames
Names of merged datasets.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMergedDatasetNames()
method.- Returns:
- Names of merged datasets.
-
datasetExists
Indicates whether the dataset exists.- Returns:
- Indicates whether the dataset exists.
-
datasetDeletedAfterRequestedSyncCount
A boolean value specifying whether to delete the dataset locally.- Returns:
- A boolean value specifying whether to delete the dataset locally.
-
syncSessionToken
A token containing a session ID, identity ID, and expiration.- Returns:
- A token containing a session ID, identity ID, and expiration.
-
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 interfaceToCopyableBuilder<ListRecordsResponse.Builder,
ListRecordsResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-