Interface ListDevicesRequest.Builder

  • Method Details

    • deviceAggregatedStatusFilter

      ListDevicesRequest.Builder deviceAggregatedStatusFilter(String deviceAggregatedStatusFilter)

      Filter based on a device's status.

      Parameters:
      deviceAggregatedStatusFilter - Filter based on a device's status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • deviceAggregatedStatusFilter

      ListDevicesRequest.Builder deviceAggregatedStatusFilter(DeviceAggregatedStatus deviceAggregatedStatusFilter)

      Filter based on a device's status.

      Parameters:
      deviceAggregatedStatusFilter - Filter based on a device's status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • maxResults

      ListDevicesRequest.Builder maxResults(Integer maxResults)

      The maximum number of devices to return in one page of results.

      Parameters:
      maxResults - The maximum number of devices to return in one page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nameFilter

      ListDevicesRequest.Builder nameFilter(String nameFilter)

      Filter based on device's name. Prefixes supported.

      Parameters:
      nameFilter - Filter based on device's name. Prefixes supported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nextToken

      ListDevicesRequest.Builder nextToken(String nextToken)

      Specify the pagination token from a previous request to retrieve the next page of results.

      Parameters:
      nextToken - Specify the pagination token from a previous request to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sortBy

      The target column to be sorted on. Default column sort is CREATED_TIME.

      Parameters:
      sortBy - The target column to be sorted on. Default column sort is CREATED_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sortBy

      The target column to be sorted on. Default column sort is CREATED_TIME.

      Parameters:
      sortBy - The target column to be sorted on. Default column sort is CREATED_TIME.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sortOrder

      ListDevicesRequest.Builder sortOrder(String sortOrder)

      The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

      Parameters:
      sortOrder - The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sortOrder

      ListDevicesRequest.Builder sortOrder(SortOrder sortOrder)

      The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.

      Parameters:
      sortOrder - The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • overrideConfiguration

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

      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.