software.amazon.awssdk.services.datapipeline.model

Class QueryObjectsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest

software.amazon.awssdk.services.datapipeline.model.QueryObjectsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryObjectsRequest
extends DataPipelineRequest
implements ToCopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>

Contains the parameters for QueryObjects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryObjectsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static QueryObjectsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit() The maximum number of object names that QueryObjects will return in a single call.
String	marker() The starting point for the results to be returned.
String	pipelineId() The ID of the pipeline.
Query	query() The query that defines the objects to be returned.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryObjectsRequest.Builder>	serializableBuilderClass()
String	sphere() Indicates whether the query applies to components or instances.
QueryObjectsRequest.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineId

public String pipelineId()

The ID of the pipeline.

Returns:

The ID of the pipeline.

query

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

Returns:

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.

sphere

public String sphere()

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

Returns:

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

marker

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

Returns:

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.

limit

public Integer limit()

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

Returns:

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

toBuilder

public QueryObjectsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>

Specified by:

toBuilder in class DataPipelineRequest

builder

public static QueryObjectsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends QueryObjectsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo