com.amazonaws.services.iotsitewise.model

Class ListAssociatedAssetsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotsitewise.model.ListAssociatedAssetsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListAssociatedAssetsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListAssociatedAssetsRequest()

Method Summary

Modifier and Type	Method and Description
ListAssociatedAssetsRequest	clone()
boolean	equals(Object obj)
String	getAssetId() The ID of the asset to query.
String	getHierarchyId() The ID of the hierarchy by which child assets are associated to the asset.
Integer	getMaxResults() The maximum number of results to return for each paginated request.
String	getNextToken() The token to be used for the next set of paginated results.
String	getTraversalDirection() The direction to list associated assets.
int	hashCode()
void	setAssetId(String assetId) The ID of the asset to query.
void	setHierarchyId(String hierarchyId) The ID of the hierarchy by which child assets are associated to the asset.
void	setMaxResults(Integer maxResults) The maximum number of results to return for each paginated request.
void	setNextToken(String nextToken) The token to be used for the next set of paginated results.
void	setTraversalDirection(String traversalDirection) The direction to list associated assets.
String	toString() Returns a string representation of this object.
ListAssociatedAssetsRequest	withAssetId(String assetId) The ID of the asset to query.
ListAssociatedAssetsRequest	withHierarchyId(String hierarchyId) The ID of the hierarchy by which child assets are associated to the asset.
ListAssociatedAssetsRequest	withMaxResults(Integer maxResults) The maximum number of results to return for each paginated request.
ListAssociatedAssetsRequest	withNextToken(String nextToken) The token to be used for the next set of paginated results.
ListAssociatedAssetsRequest	withTraversalDirection(String traversalDirection) The direction to list associated assets.
ListAssociatedAssetsRequest	withTraversalDirection(TraversalDirection traversalDirection) The direction to list associated assets.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListAssociatedAssetsRequest

public ListAssociatedAssetsRequest()

Method Detail

setAssetId

public void setAssetId(String assetId)

The ID of the asset to query.

Parameters:

assetId - The ID of the asset to query.

getAssetId

public String getAssetId()

The ID of the asset to query.

Returns:

The ID of the asset to query.

withAssetId

public ListAssociatedAssetsRequest withAssetId(String assetId)

The ID of the asset to query.

Parameters:

assetId - The ID of the asset to query.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHierarchyId

public void setHierarchyId(String hierarchyId)

The ID of the hierarchy by which child assets are associated to the asset. 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.

Parameters:

hierarchyId - The ID of the hierarchy by which child assets are associated to the asset. 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.

getHierarchyId

public String getHierarchyId()

The ID of the hierarchy by which child assets are associated to the asset. 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. 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.

withHierarchyId

public ListAssociatedAssetsRequest withHierarchyId(String hierarchyId)

The ID of the hierarchy by which child assets are associated to the asset. 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.

Parameters:

hierarchyId - The ID of the hierarchy by which child assets are associated to the asset. 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:

Returns a reference to this object so that method calls can be chained together.

setTraversalDirection

public void setTraversalDirection(String 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

Parameters:

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

See Also:

TraversalDirection

getTraversalDirection

public String getTraversalDirection()

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

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

withTraversalDirection

public ListAssociatedAssetsRequest withTraversalDirection(String 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TraversalDirection

withTraversalDirection

public ListAssociatedAssetsRequest withTraversalDirection(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TraversalDirection

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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.

withNextToken

public ListAssociatedAssetsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

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

Default: 50

Parameters:

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

Default: 50

getMaxResults

public Integer getMaxResults()

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

withMaxResults

public ListAssociatedAssetsRequest withMaxResults(Integer maxResults)

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

Default: 50

Parameters:

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

Default: 50

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListAssociatedAssetsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest