Class DescribeObjectsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeObjectsRequest.Builder,
DescribeObjectsRequest>
Contains the parameters for DescribeObjects.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ObjectIds property.final String
marker()
The starting point for the results to be returned.The IDs of the pipeline objects that contain the definitions to be described.final String
The ID of the pipeline that contains the object definitions.static Class
<? extends DescribeObjectsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeObjectsRequest.Builder,
DescribeObjectsRequest> - Specified by:
toBuilder
in classDataPipelineRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-