Package software.amazon.awssdk.services.timestreamwrite.model

Class WriteRecordsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.timestreamwrite.model.TimestreamWriteRequest

software.amazon.awssdk.services.timestreamwrite.model.WriteRecordsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<WriteRecordsRequest.Builder,WriteRecordsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class WriteRecordsRequest
extends TimestreamWriteRequest
implements ToCopyableBuilder<WriteRecordsRequest.Builder,WriteRecordsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WriteRecordsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static WriteRecordsRequest.Builder	builder()
Record	commonAttributes()	A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request.
String	databaseName()	The name of the Timestream database.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecords()	For responses, this returns true if the service returned a value for the Records property.
List<Record>	records()	An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends WriteRecordsRequest.Builder>	serializableBuilderClass()
String	tableName()	The name of the Timestream table.
WriteRecordsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

databaseName

public final String databaseName()

The name of the Timestream database.

Returns:

The name of the Timestream database.

tableName

public final String tableName()

The name of the Timestream table.

Returns:

The name of the Timestream table.

commonAttributes

public final Record commonAttributes()

A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a ValidationException will be thrown. In other words, a record must contain dimensions with unique names.

Returns:

A record that contains the common measure, dimension, time, and version attributes shared across all the records in the request. The measure and dimension attributes specified will be merged with the measure and dimension attributes in the records object when the data is written into Timestream. Dimensions may not overlap, or a ValidationException will be thrown. In other words, a record must contain dimensions with unique names.

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 the isEmpty() 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

public final List<Record> records()

An array of records that contain the unique measure, dimension, time, and version attributes for each time-series data point.

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 records that contain the unique measure, dimension, time, and version attributes for each time-series data point.

toBuilder

public WriteRecordsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WriteRecordsRequest.Builder,WriteRecordsRequest>

Specified by:

toBuilder in class TimestreamWriteRequest

builder

public static WriteRecordsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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