Package software.amazon.awssdk.services.macie2.model

Class BucketSortCriteria

java.lang.Object

software.amazon.awssdk.services.macie2.model.BucketSortCriteria

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BucketSortCriteria.Builder,BucketSortCriteria>

@Generated("software.amazon.awssdk:codegen")
public final class BucketSortCriteria
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BucketSortCriteria.Builder,BucketSortCriteria>

Specifies criteria for sorting the results of a query for information about S3 buckets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BucketSortCriteria.Builder

Method Summary

Modifier and Type	Method	Description
String	attributeName()	The name of the bucket property to sort the results by.
static BucketSortCriteria.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
OrderBy	orderBy()	The sort order to apply to the results, based on the value specified by the attributeName property.
String	orderByAsString()	The sort order to apply to the results, based on the value specified by the attributeName property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends BucketSortCriteria.Builder>	serializableBuilderClass()
BucketSortCriteria.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

attributeName

public final String attributeName()

The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, sensitivityScore, or sizeInBytes.

Returns:

The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, sensitivityScore, or sizeInBytes.

orderBy

public final OrderBy orderBy()

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

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

Returns:

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

See Also:

OrderBy

orderByAsString

public final String orderByAsString()

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

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

Returns:

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

See Also:

OrderBy

toBuilder

public BucketSortCriteria.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BucketSortCriteria.Builder,BucketSortCriteria>

builder

public static BucketSortCriteria.Builder builder()

serializableBuilderClass

public static Class<? extends BucketSortCriteria.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo