Package software.amazon.awssdk.services.rbin.model

Class ListRulesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rbin.model.RbinRequest

software.amazon.awssdk.services.rbin.model.ListRulesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListRulesRequest
extends RbinRequest
implements ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRulesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListRulesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceTags()	For responses, this returns true if the service returned a value for the ResourceTags property.
LockState	lockState()	The lock state of the retention rules to list.
String	lockStateAsString()	The lock state of the retention rules to list.
Integer	maxResults()	The maximum number of results to return with a single call.
String	nextToken()	The token for the next page of results.
List<ResourceTag>	resourceTags()	Information about the resource tags used to identify resources that are retained by the retention rule.
ResourceType	resourceType()	The resource type retained by the retention rule.
String	resourceTypeAsString()	The resource type retained by the retention rule.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRulesRequest.Builder>	serializableBuilderClass()
ListRulesRequest.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

maxResults

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

public final String nextToken()

The token for the next page of results.

Returns:

The token for the next page of results.

resourceType

public final ResourceType 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, specify EC2_IMAGE.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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, specify EC2_IMAGE.

See Also:

ResourceType

resourceTypeAsString

public final String 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, specify EC2_IMAGE.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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, specify EC2_IMAGE.

See Also:

ResourceType

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

resourceTags

public final List<ResourceTag> 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

public final LockState 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 return LockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lockStateAsString().

Returns:

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

See Also:

LockState

lockStateAsString

public final String 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 return LockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lockStateAsString().

Returns:

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

See Also:

LockState

toBuilder

public ListRulesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>

Specified by:

toBuilder in class RbinRequest

builder

public static ListRulesRequest.Builder builder()

serializableBuilderClass

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