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

Interface ListAssetsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListAssetsRequest.Builder,ListAssetsRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<ListAssetsRequest.Builder,ListAssetsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListAssetsRequest
public static interface ListAssetsRequest.Builder extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<ListAssetsRequest.Builder,ListAssetsRequest>

  • Method Details

    • nextToken

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

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

    • assetModelId

      ListAssetsRequest.Builder assetModelId(String assetModelId)

      The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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:
      assetModelId - The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 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.

    • filter

      ListAssetsRequest.Builder filter(String filter)

      The filter for the requested list of assets. Choose one of the following options:

      • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

      • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

      Default: ALL

      Parameters:
      filter - The filter for the requested list of assets. Choose one of the following options:

      • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

      • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

      Default: ALL

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

    • filter

      ListAssetsRequest.Builder filter(ListAssetsFilter filter)

      The filter for the requested list of assets. Choose one of the following options:

      • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

      • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

      Default: ALL

      Parameters:
      filter - The filter for the requested list of assets. Choose one of the following options:

      • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

      • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

      Default: ALL

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

    • overrideConfiguration

      ListAssetsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListAssetsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.