Package software.amazon.awssdk.services.lightsail.model

Class GetBucketsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.GetBucketsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetBucketsRequest.Builder,GetBucketsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetBucketsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketName()	The name of the bucket for which to return information.
static GetBucketsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeConnectedResources()	A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.
String	pageToken()	The token to advance to the next page of results from your request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetBucketsRequest.Builder>	serializableBuilderClass()
GetBucketsRequest.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

bucketName

public final String bucketName()

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

Returns:

The name of the bucket for which to return information.

When omitted, the response includes all of your buckets in the Amazon Web Services Region where the request is made.

pageToken

public final String pageToken()

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Returns:

The token to advance to the next page of results from your request.

To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

includeConnectedResources

public final Boolean includeConnectedResources()

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

Returns:

A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action.

toBuilder

public GetBucketsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetBucketsRequest.Builder,GetBucketsRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static GetBucketsRequest.Builder builder()

serializableBuilderClass

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