Class PutRecordsResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutRecordsResponse.Builder,
PutRecordsResponse>
PutRecords
results.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PutRecordsResponse.Builder
builder()
final EncryptionType
The encryption type used on the records.final String
The encryption type used on the records.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of unsuccessfully processed records in aPutRecords
request.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 Records property.final List
<PutRecordsResultEntry> records()
An array of successfully and unsuccessfully processed record results.static Class
<? extends PutRecordsResponse.Builder> 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.kinesis.model.KinesisResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
failedRecordCount
The number of unsuccessfully processed records in a
PutRecords
request.- Returns:
- The number of unsuccessfully processed records in a
PutRecords
request.
-
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
An array of successfully and unsuccessfully processed record results. A record that is successfully added to a stream includes
SequenceNumber
andShardId
in the result. A record that fails to be added to a stream includesErrorCode
andErrorMessage
in the result.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:
- An array of successfully and unsuccessfully processed record results. A record that is successfully added
to a stream includes
SequenceNumber
andShardId
in the result. A record that fails to be added to a stream includesErrorCode
andErrorMessage
in the result.
-
encryptionType
The encryption type used on the records. This parameter can be one of the following values:
-
NONE
: Do not encrypt the records. -
KMS
: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- The encryption type used on the records. This parameter can be one of the following values:
-
NONE
: Do not encrypt the records. -
KMS
: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
-
- See Also:
-
-
encryptionTypeAsString
The encryption type used on the records. This parameter can be one of the following values:
-
NONE
: Do not encrypt the records. -
KMS
: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
If the service returns an enum value that is not available in the current SDK version,
encryptionType
will returnEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionTypeAsString()
.- Returns:
- The encryption type used on the records. This parameter can be one of the following values:
-
NONE
: Do not encrypt the records. -
KMS
: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
-
- See Also:
-
-
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<PutRecordsResponse.Builder,
PutRecordsResponse> - 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
-