Class ListOperationsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListOperationsRequest.Builder,
ListOperationsRequest>
The ListOperations request includes the following elements.
-
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 <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 Status property.final boolean
hasType()
For responses, this returns true if the service returned a value for the Type property.final String
marker()
For an initial request for a list of operations, omit this element.final Integer
maxItems()
Number of domains to be returned.static Class
<? extends ListOperationsRequest.Builder> sortBy()
The sort type for returned values.final String
The sort type for returned values.final SortOrder
The sort order for returned values, either ascending or descending.final String
The sort order for returned values, either ascending or descending.final List
<OperationStatus> status()
The status of the operations.The status of the operations.final Instant
An optional parameter that lets you get information about all the operations that you submitted after a specified date and time.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.final List
<OperationType> type()
An arrays of the domains operation types.An arrays of the domains operation types.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
submittedSince
An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
- Returns:
- An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Unix time format and Coordinated Universal time (UTC).
-
marker
For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for
MaxItems
, you can useMarker
to return additional operations. Get the value ofNextPageMarker
from the previous response, and submit another request that includes the value ofNextPageMarker
in theMarker
element.- Returns:
- For an initial request for a list of operations, omit this element. If the number of operations that are
not yet complete is greater than the value that you specified for
MaxItems
, you can useMarker
to return additional operations. Get the value ofNextPageMarker
from the previous response, and submit another request that includes the value ofNextPageMarker
in theMarker
element.
-
maxItems
Number of domains to be returned.
Default: 20
- Returns:
- Number of domains to be returned.
Default: 20
-
status
The status of the operations.
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
hasStatus()
method.- Returns:
- The status of the operations.
-
hasStatus
public final boolean hasStatus()For responses, this returns true if the service returned a value for the Status 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. -
statusAsStrings
The status of the operations.
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
hasStatus()
method.- Returns:
- The status of the operations.
-
type
An arrays of the domains operation types.
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
hasType()
method.- Returns:
- An arrays of the domains operation types.
-
hasType
public final boolean hasType()For responses, this returns true if the service returned a value for the Type 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. -
typeAsStrings
An arrays of the domains operation types.
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
hasType()
method.- Returns:
- An arrays of the domains operation types.
-
sortBy
The sort type for returned values.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnListOperationsSortAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The sort type for returned values.
- See Also:
-
sortByAsString
The sort type for returned values.
If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnListOperationsSortAttributeName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The sort type for returned values.
- See Also:
-
sortOrder
The sort order for returned values, either ascending or descending.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for returned values, either ascending or descending.
- See Also:
-
sortOrderAsString
The sort order for returned values, either ascending or descending.
If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for returned values, either ascending or descending.
- See Also:
-
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<ListOperationsRequest.Builder,
ListOperationsRequest> - Specified by:
toBuilder
in classRoute53DomainsRequest
- 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
-