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

Interface ListAssetRelationshipsRequest.Builder

    • Method Detail

      • assetId

        ListAssetRelationshipsRequest.Builder assetId​(String assetId)

        The ID of 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.

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

      • traversalType

        ListAssetRelationshipsRequest.Builder traversalType​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TraversalType, TraversalType

      • traversalType

        ListAssetRelationshipsRequest.Builder traversalType​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TraversalType, TraversalType

      • nextToken

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

        ListAssetRelationshipsRequest.Builder maxResults​(Integer maxResults)

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

        Parameters:
        maxResults - The maximum number of results to return for each paginated request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.