Class ListRulesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRulesRequest.Builder,
ListRulesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListRulesRequest.Builder
builder()
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 ResourceTags property.final LockState
The lock state of the retention rules to list.final String
The lock state of the retention rules to list.final Integer
The maximum number of results to return with a single call.final String
The token for the next page of results.final List
<ResourceTag> Information about the resource tags used to identify resources that are retained by the retention rule.final ResourceType
The resource type retained by the retention rule.final String
The resource type retained by the retention rule.static Class
<? extends ListRulesRequest.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
-
maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
NextToken
value.- Returns:
- The maximum number of results to return with a single call. To retrieve the remaining results, make
another call with the returned
NextToken
value.
-
nextToken
The token for the next page of results.
- Returns:
- The token for the next page of results.
-
resourceType
The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify
EBS_SNAPSHOT
. To list retention rules that retain EBS-backed AMIs, specifyEC2_IMAGE
.If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type retained by the retention rule. Only retention rules that retain the specified resource
type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list
retention rules that retain snapshots, specify
EBS_SNAPSHOT
. To list retention rules that retain EBS-backed AMIs, specifyEC2_IMAGE
. - See Also:
-
resourceTypeAsString
The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify
EBS_SNAPSHOT
. To list retention rules that retain EBS-backed AMIs, specifyEC2_IMAGE
.If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The resource type retained by the retention rule. Only retention rules that retain the specified resource
type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list
retention rules that retain snapshots, specify
EBS_SNAPSHOT
. To list retention rules that retain EBS-backed AMIs, specifyEC2_IMAGE
. - See Also:
-
hasResourceTags
public final boolean hasResourceTags()For responses, this returns true if the service returned a value for the ResourceTags 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. -
resourceTags
Information about the resource tags used to identify resources that are retained by the retention rule.
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
hasResourceTags()
method.- Returns:
- Information about the resource tags used to identify resources that are retained by the retention rule.
-
lockState
The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
If the service returns an enum value that is not available in the current SDK version,
lockState
will returnLockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlockStateAsString()
.- Returns:
- The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
- See Also:
-
lockStateAsString
The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
If the service returns an enum value that is not available in the current SDK version,
lockState
will returnLockState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlockStateAsString()
.- Returns:
- The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
- 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<ListRulesRequest.Builder,
ListRulesRequest> - Specified by:
toBuilder
in classRbinRequest
- 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
-