Package software.amazon.awssdk.services.iotsitewise.model

Class BatchGetAssetPropertyAggregatesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.BatchGetAssetPropertyAggregatesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchGetAssetPropertyAggregatesResponse.Builder,BatchGetAssetPropertyAggregatesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchGetAssetPropertyAggregatesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static BatchGetAssetPropertyAggregatesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<BatchGetAssetPropertyAggregatesErrorEntry>	errorEntries()	A list of the errors (if any) associated with the batch request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasErrorEntries()	For responses, this returns true if the service returned a value for the ErrorEntries property.
int	hashCode()
boolean	hasSkippedEntries()	For responses, this returns true if the service returned a value for the SkippedEntries property.
boolean	hasSuccessEntries()	For responses, this returns true if the service returned a value for the SuccessEntries property.
String	nextToken()	The token for the next set of results, or null if there are no additional results.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchGetAssetPropertyAggregatesResponse.Builder>	serializableBuilderClass()
List<BatchGetAssetPropertyAggregatesSkippedEntry>	skippedEntries()	A list of entries that were not processed by this batch request.
List<BatchGetAssetPropertyAggregatesSuccessEntry>	successEntries()	A list of entries that were processed successfully by this batch request.
BatchGetAssetPropertyAggregatesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

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

hasErrorEntries

public final boolean hasErrorEntries()

For responses, this returns true if the service returned a value for the ErrorEntries 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.

errorEntries

public final List<BatchGetAssetPropertyAggregatesErrorEntry> errorEntries()

A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

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 hasErrorEntries() method.

Returns:

A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

hasSuccessEntries

public final boolean hasSuccessEntries()

For responses, this returns true if the service returned a value for the SuccessEntries 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.

successEntries

public final List<BatchGetAssetPropertyAggregatesSuccessEntry> successEntries()

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query 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 hasSuccessEntries() method.

Returns:

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

hasSkippedEntries

public final boolean hasSkippedEntries()

For responses, this returns true if the service returned a value for the SkippedEntries 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.

skippedEntries

public final List<BatchGetAssetPropertyAggregatesSkippedEntry> skippedEntries()

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

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 hasSkippedEntries() method.

Returns:

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

nextToken

public final String nextToken()

The token for the next set of results, or null if there are no additional results.

Returns:

The token for the next set of results, or null if there are no additional results.

toBuilder

public BatchGetAssetPropertyAggregatesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchGetAssetPropertyAggregatesResponse.Builder,BatchGetAssetPropertyAggregatesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static BatchGetAssetPropertyAggregatesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends BatchGetAssetPropertyAggregatesResponse.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