@Generated(value="software.amazon.awssdk:codegen") public final class QueryObjectsRequest extends DataPipelineRequest implements ToCopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>
Contains the parameters for QueryObjects.
Modifier and Type | Class and Description |
---|---|
static interface |
QueryObjectsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static QueryObjectsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String pipelineId()
The ID of the pipeline.
public final 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.
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.public final String sphere()
Indicates whether the query applies to components or instances. The possible values are: COMPONENT
,
INSTANCE
, and ATTEMPT
.
COMPONENT
, INSTANCE
, and ATTEMPT
.public final 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.
QueryObjects
with the marker value from the
previous call to retrieve the next set of results.public final Integer limit()
The maximum number of object names that QueryObjects
will return in a single call. The default value
is 100.
QueryObjects
will return in a single call. The
default value is 100.public QueryObjectsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<QueryObjectsRequest.Builder,QueryObjectsRequest>
toBuilder
in class DataPipelineRequest
public static QueryObjectsRequest.Builder builder()
public static Class<? extends QueryObjectsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.