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 Summary

Modifier and Type	Method and Description
ListJobsRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return per request.
ListJobsRequest.Builder	nextToken(String nextToken) The token to retrieve the next set of results.
ListJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ListJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ListJobsRequest.Builder	status(JobStatus status) An optional filter that lets you search for jobs that have the specified status.
ListJobsRequest.Builder	status(String status) An optional filter that lets you search for jobs that have the specified status.
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).
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).
ListJobsRequest.Builder	thingGroupId(String thingGroupId) A filter that limits the returned jobs to those for the specified group.
ListJobsRequest.Builder	thingGroupName(String thingGroupName) A filter that limits the returned jobs to those for the specified group.

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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:

JobStatus, JobStatus

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:

JobStatus, JobStatus

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.

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.

Returns:

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

See Also:

TargetSelection, TargetSelection

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.

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.

Returns:

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

See Also:

TargetSelection, TargetSelection

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.

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.