@Generated(value="software.amazon.awssdk:codegen") public final class DescribeObjectsRequest extends DataPipelineRequest implements ToCopyableBuilder<DescribeObjectsRequest.Builder,DescribeObjectsRequest>
Contains the parameters for DescribeObjects.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeObjectsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeObjectsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
Boolean |
evaluateExpressions()
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
|
<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() |
String |
marker()
The starting point for the results to be returned.
|
List<String> |
objectIds()
The IDs of the pipeline objects that contain the definitions to be described.
|
String |
pipelineId()
The ID of the pipeline that contains the object definitions.
|
static Class<? extends DescribeObjectsRequest.Builder> |
serializableBuilderClass() |
DescribeObjectsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String pipelineId()
The ID of the pipeline that contains the object definitions.
public List<String> objectIds()
The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25
identifiers in a single call to DescribeObjects
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
DescribeObjects
.public Boolean evaluateExpressions()
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
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 DescribeObjects
with the marker value from the previous
call to retrieve the next set of results.
DescribeObjects
with the marker value from
the previous call to retrieve the next set of results.public DescribeObjectsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeObjectsRequest.Builder,DescribeObjectsRequest>
toBuilder
in class DataPipelineRequest
public static DescribeObjectsRequest.Builder builder()
public static Class<? extends DescribeObjectsRequest.Builder> serializableBuilderClass()
public <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 © 2017 Amazon Web Services, Inc. All Rights Reserved.