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

Class DescribeBucketsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.macie2.model.Macie2Request

software.amazon.awssdk.services.macie2.model.DescribeBucketsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeBucketsRequest.Builder,DescribeBucketsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeBucketsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeBucketsRequest.Builder	builder()
Map<String,BucketCriteriaAdditionalProperties>	criteria()	The criteria to use to filter the query results.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCriteria()	For responses, this returns true if the service returned a value for the Criteria property.
int	hashCode()
Integer	maxResults()	The maximum number of items to include in each page of the response.
String	nextToken()	The nextToken string that specifies which page of results to return in a paginated response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeBucketsRequest.Builder>	serializableBuilderClass()
BucketSortCriteria	sortCriteria()	The criteria to use to sort the query results.
DescribeBucketsRequest.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

hasCriteria

public final boolean hasCriteria()

For responses, this returns true if the service returned a value for the Criteria 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.

criteria

public final Map<String,BucketCriteriaAdditionalProperties> criteria()

The criteria to use to filter the query results.

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 hasCriteria() method.

Returns:

The criteria to use to filter the query results.

maxResults

public final Integer maxResults()

The maximum number of items to include in each page of the response. The default value is 50.

Returns:

The maximum number of items to include in each page of the response. The default value is 50.

nextToken

public final String nextToken()

The nextToken string that specifies which page of results to return in a paginated response.

Returns:

The nextToken string that specifies which page of results to return in a paginated response.

sortCriteria

public final BucketSortCriteria sortCriteria()

The criteria to use to sort the query results.

Returns:

The criteria to use to sort the query results.

toBuilder

public DescribeBucketsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeBucketsRequest.Builder,DescribeBucketsRequest>

Specified by:

toBuilder in class Macie2Request

builder

public static DescribeBucketsRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo