software.amazon.awssdk.services.iotsitewise.model

Class ListAssetRelationshipsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAssetRelationshipsRequest.Builder,ListAssetRelationshipsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAssetRelationshipsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	assetId() The ID of the asset.
static ListAssetRelationshipsRequest.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 ListAssetRelationshipsRequest.Builder>	serializableBuilderClass()
ListAssetRelationshipsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TraversalType	traversalType() The type of traversal to use to identify asset relationships.
String	traversalTypeAsString() The type of traversal to use to identify asset relationships.

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.

Returns:

The ID of the asset.

traversalType

public final TraversalType traversalType()

The type of traversal to use to identify asset relationships. Choose the following option:

• PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

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

Returns:

The type of traversal to use to identify asset relationships. Choose the following option:

• PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

See Also:

TraversalType

traversalTypeAsString

public final String traversalTypeAsString()

The type of traversal to use to identify asset relationships. Choose the following option:

• PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

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

Returns:

The type of traversal to use to identify asset relationships. Choose the following option:

• PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

See Also:

TraversalType

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.

toBuilder

public ListAssetRelationshipsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAssetRelationshipsRequest.Builder,ListAssetRelationshipsRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static ListAssetRelationshipsRequest.Builder builder()

serializableBuilderClass

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