Package software.amazon.awssdk.services.s3control.model

Class ListAccessGrantsLocationsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3control.model.S3ControlRequest

software.amazon.awssdk.services.s3control.model.ListAccessGrantsLocationsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAccessGrantsLocationsRequest.Builder,ListAccessGrantsLocationsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListAccessGrantsLocationsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The ID of the Amazon Web Services account that is making this request.
static ListAccessGrantsLocationsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	locationScope()	The S3 path to the location that you are registering.
Integer	maxResults()	The maximum number of access grants that you would like returned in the List Access Grants response.
String	nextToken()	A pagination token to request the next page of results.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAccessGrantsLocationsRequest.Builder>	serializableBuilderClass()
ListAccessGrantsLocationsRequest.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

accountId

public final String accountId()

The ID of the Amazon Web Services account that is making this request.

Returns:

The ID of the Amazon Web Services account that is making this request.

nextToken

public final String nextToken()

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

Returns:

A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants Locations request in order to retrieve the next page of results.

maxResults

public final Integer maxResults()

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

Returns:

The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

locationScope

public final String locationScope()

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

Returns:

The S3 path to the location that you are registering. The location scope can be the default S3 location s3://, the S3 path to a bucket s3://<bucket>, or the S3 path to a bucket and prefix s3://<bucket>/<prefix>. A prefix in S3 is a string of characters at the beginning of an object key name used to organize the objects that you store in your S3 buckets. For example, object key names that start with the engineering/ prefix or object key names that start with the marketing/campaigns/ prefix.

toBuilder

public ListAccessGrantsLocationsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAccessGrantsLocationsRequest.Builder,ListAccessGrantsLocationsRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static ListAccessGrantsLocationsRequest.Builder builder()

serializableBuilderClass

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