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

Class ListAssociatedAssetsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAssociatedAssetsRequest.Builder,ListAssociatedAssetsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAssociatedAssetsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	assetId()	The ID of the asset to query.
static ListAssociatedAssetsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	hierarchyId()	The ID of the hierarchy by which child assets are associated to the asset.
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 ListAssociatedAssetsRequest.Builder>	serializableBuilderClass()
ListAssociatedAssetsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TraversalDirection	traversalDirection()	The direction to list associated assets.
String	traversalDirectionAsString()	The direction to list associated assets.

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

assetId

public final String assetId()

The ID of the asset to query. 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 to query. 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.

hierarchyId

public final String hierarchyId()

The ID of the hierarchy by which child assets are associated to the asset. (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.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

Returns:

The ID of the hierarchy by which child assets are associated to the asset. (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.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the IoT SiteWise User Guide.

traversalDirection

public final TraversalDirection traversalDirection()

The direction to list associated assets. Choose one of the following options:

• CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

• PARENT – The list includes the asset's parent asset.

Default: CHILD

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

Returns:

The direction to list associated assets. Choose one of the following options:

• CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

• PARENT – The list includes the asset's parent asset.

Default: CHILD

See Also:

TraversalDirection

traversalDirectionAsString

public final String traversalDirectionAsString()

The direction to list associated assets. Choose one of the following options:

• CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

• PARENT – The list includes the asset's parent asset.

Default: CHILD

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

Returns:

The direction to list associated assets. Choose one of the following options:

• CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

• PARENT – The list includes the asset's parent asset.

Default: CHILD

See Also:

TraversalDirection

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

toBuilder

public ListAssociatedAssetsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAssociatedAssetsRequest.Builder,ListAssociatedAssetsRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static ListAssociatedAssetsRequest.Builder builder()

serializableBuilderClass

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