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

Interface ListAssociatedAssetsRequest.Builder

    • Method Detail

      • assetId

        ListAssociatedAssetsRequest.Builder assetId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • hierarchyId

        ListAssociatedAssetsRequest.Builder hierarchyId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • traversalDirection

        ListAssociatedAssetsRequest.Builder traversalDirection​(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, TraversalDirection

      • traversalDirection

        ListAssociatedAssetsRequest.Builder traversalDirection​(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, TraversalDirection

      • nextToken

        ListAssociatedAssetsRequest.Builder nextToken​(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.

      • maxResults

        ListAssociatedAssetsRequest.Builder maxResults​(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.