Package software.amazon.awssdk.services.iot.model

Interface ListJobsRequest.Builder

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

  • Method Details

    • status

      ListJobsRequest.Builder status(String status)

      An optional filter that lets you search for jobs that have the specified status.

      Parameters:
      status - An optional filter that lets you search for jobs that have the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ListJobsRequest.Builder status(JobStatus status)

      An optional filter that lets you search for jobs that have the specified status.

      Parameters:
      status - An optional filter that lets you search for jobs that have the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetSelection

      ListJobsRequest.Builder targetSelection(String targetSelection)

      Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

      We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

      Parameters:
      targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

      We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

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

    • targetSelection

      ListJobsRequest.Builder targetSelection(TargetSelection targetSelection)

      Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

      We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

      Parameters:
      targetSelection - Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

      We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

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

    • maxResults

      ListJobsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per request.

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

    • nextToken

      ListJobsRequest.Builder nextToken(String nextToken)

      The token to retrieve the next set of results.

      Parameters:
      nextToken - The token to retrieve the next set of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thingGroupName

      ListJobsRequest.Builder thingGroupName(String thingGroupName)

      A filter that limits the returned jobs to those for the specified group.

      Parameters:
      thingGroupName - A filter that limits the returned jobs to those for the specified group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thingGroupId

      ListJobsRequest.Builder thingGroupId(String thingGroupId)

      A filter that limits the returned jobs to those for the specified group.

      Parameters:
      thingGroupId - A filter that limits the returned jobs to those for the specified group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespaceId

      ListJobsRequest.Builder namespaceId(String namespaceId)

      The namespace used to indicate that a job is a customer-managed job.

      When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

      $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

      The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

      Parameters:
      namespaceId - The namespace used to indicate that a job is a customer-managed job.

      When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

      $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

      The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

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

    • overrideConfiguration

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

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