software.amazon.awssdk.services.datapipeline.model

Interface QueryObjectsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>, DataPipelineRequest.Builder, SdkBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>, SdkRequest.Builder

Enclosing class:

QueryObjectsRequest

public static interface QueryObjectsRequest.Builder
extends DataPipelineRequest.Builder, CopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>

Method Summary

Modifier and Type	Method and Description
QueryObjectsRequest.Builder	limit(Integer limit) The maximum number of object names that QueryObjects will return in a single call.
QueryObjectsRequest.Builder	marker(String marker) The starting point for the results to be returned.
QueryObjectsRequest.Builder	pipelineId(String pipelineId) The ID of the pipeline.
default QueryObjectsRequest.Builder	query(Consumer<Query.Builder> query) The query that defines the objects to be returned.
QueryObjectsRequest.Builder	query(Query query) The query that defines the objects to be returned.
QueryObjectsRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
QueryObjectsRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
QueryObjectsRequest.Builder	sphere(String sphere) Indicates whether the query applies to components or instances.

Methods inherited from interface software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest.Builder

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

pipelineId

QueryObjectsRequest.Builder pipelineId(String pipelineId)

The ID of the pipeline.

Parameters:

pipelineId - The ID of the pipeline.

Returns:

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

query

QueryObjectsRequest.Builder query(Query query)

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Parameters:

query - The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

Returns:

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

query

default QueryObjectsRequest.Builder query(Consumer<Query.Builder> query)

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

This is a convenience that creates an instance of the Query.Builder avoiding the need to create one manually via Query.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to query(Query).

Parameters:

query - a consumer that will call methods on Query.Builder

Returns:

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

See Also:

query(Query)

sphere

QueryObjectsRequest.Builder sphere(String sphere)

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Parameters:

sphere - Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

Returns:

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

marker

QueryObjectsRequest.Builder marker(String marker)

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Parameters:

marker - The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

Returns:

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

limit

QueryObjectsRequest.Builder limit(Integer limit)

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Parameters:

limit - The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

Returns:

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

requestOverrideConfig

QueryObjectsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

QueryObjectsRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.