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

Class ListAssetsRequest

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.ListAssetsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAssetsRequest.Builder,ListAssetsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAssetsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	assetModelId()	The ID of the asset model by which to filter the list of assets.
static ListAssetsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ListAssetsFilter	filter()	The filter for the requested list of assets.
String	filterAsString()	The filter for the requested list of assets.
<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 ListAssetsRequest.Builder>	serializableBuilderClass()
ListAssetsRequest.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.

Default: 50

Returns:

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

Default: 50

assetModelId

public final String assetModelId()

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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 model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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.

filter

public final ListAssetsFilter filter()

The filter for the requested list of assets. Choose one of the following options:

• ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

• TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

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

Returns:

The filter for the requested list of assets. Choose one of the following options:

• ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

• TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

See Also:

ListAssetsFilter

filterAsString

public final String filterAsString()

The filter for the requested list of assets. Choose one of the following options:

• ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

• TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

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

Returns:

The filter for the requested list of assets. Choose one of the following options:

• ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

• TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

See Also:

ListAssetsFilter

toBuilder

public ListAssetsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAssetsRequest.Builder,ListAssetsRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static ListAssetsRequest.Builder builder()

serializableBuilderClass

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