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

Class ListTimeSeriesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.ListTimeSeriesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListTimeSeriesRequest.Builder,ListTimeSeriesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListTimeSeriesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aliasPrefix()	The alias prefix of the time series.
String	assetId()	The ID of the asset in which the asset property was created.
static ListTimeSeriesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return for each paginated request.
String	nextToken()	The token to be used for the next set of paginated results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListTimeSeriesRequest.Builder>	serializableBuilderClass()
ListTimeSeriesType	timeSeriesType()	The type of the time series.
String	timeSeriesTypeAsString()	The type of the time series.
ListTimeSeriesRequest.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

nextToken

public final String nextToken()

The token to be used for the next set of paginated results.

Returns:

The token to be used for the next set of paginated results.

maxResults

public final Integer maxResults()

The maximum number of results to return for each paginated request.

Returns:

The maximum number of results to return for each paginated request.

assetId

public final String assetId()

The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Returns:

The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

aliasPrefix

public final String aliasPrefix()

The alias prefix of the time series.

Returns:

The alias prefix of the time series.

timeSeriesType

public final ListTimeSeriesType timeSeriesType()

The type of the time series. The time series type can be one of the following values:

• ASSOCIATED – The time series is associated with an asset property.

• DISASSOCIATED – The time series isn't associated with any asset property.

If the service returns an enum value that is not available in the current SDK version, timeSeriesType will return ListTimeSeriesType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeSeriesTypeAsString().

Returns:

The type of the time series. The time series type can be one of the following values:

• ASSOCIATED – The time series is associated with an asset property.

• DISASSOCIATED – The time series isn't associated with any asset property.

See Also:

ListTimeSeriesType

timeSeriesTypeAsString

public final String timeSeriesTypeAsString()

The type of the time series. The time series type can be one of the following values:

• ASSOCIATED – The time series is associated with an asset property.

• DISASSOCIATED – The time series isn't associated with any asset property.

If the service returns an enum value that is not available in the current SDK version, timeSeriesType will return ListTimeSeriesType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeSeriesTypeAsString().

Returns:

The type of the time series. The time series type can be one of the following values:

• ASSOCIATED – The time series is associated with an asset property.

• DISASSOCIATED – The time series isn't associated with any asset property.

See Also:

ListTimeSeriesType

toBuilder

public ListTimeSeriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListTimeSeriesRequest.Builder,ListTimeSeriesRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static ListTimeSeriesRequest.Builder builder()

serializableBuilderClass

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