software.amazon.awssdk.services.datapipeline.model

Class DescribeObjectsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeObjectsRequest.Builder,DescribeObjectsRequest>

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

Contains the parameters for DescribeObjects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeObjectsRequest.Builder

Method Summary

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)
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeObjectsRequest.Builder>	serializableBuilderClass()
DescribeObjectsRequest.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 that contains the object definitions.

Returns:

The ID of the pipeline that contains the object definitions.

objectIds

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.

Returns:

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.

evaluateExpressions

public Boolean evaluateExpressions()

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

Returns:

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

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 DescribeObjects 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 DescribeObjects with the marker value from the previous call to retrieve the next set of results.

toBuilder

public DescribeObjectsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeObjectsRequest.Builder,DescribeObjectsRequest>

Specified by:

toBuilder in class DataPipelineRequest

builder

public static DescribeObjectsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeObjectsRequest.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