Package 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("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	Description
static interface	DescribeObjectsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeObjectsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(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()
boolean	hasObjectIds()	For responses, this returns true if the service returned a value for the ObjectIds property.
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()	Returns a string representation of this object.

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 final String pipelineId()

The ID of the pipeline that contains the object definitions.

Returns:

The ID of the pipeline that contains the object definitions.

hasObjectIds

public final boolean hasObjectIds()

For responses, this returns true if the service returned a value for the ObjectIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

objectIds

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasObjectIds() method.

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 final 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 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 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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo