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

Class ListCallerAccessGrantsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCallerAccessGrantsRequest.Builder,ListCallerAccessGrantsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCallerAccessGrantsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The Amazon Web Services account ID of the S3 Access Grants instance.
Boolean	allowedByApplication()	If this optional parameter is passed in the request, a filter is applied to the results.
static ListCallerAccessGrantsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	grantScope()	The S3 path of the data that you would like to access.
int	hashCode()
Integer	maxResults()	The maximum number of access grants that you would like returned in the List Caller Access Grants response.
String	nextToken()	A pagination token to request the next page of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListCallerAccessGrantsRequest.Builder>	serializableBuilderClass()
ListCallerAccessGrantsRequest.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 Amazon Web Services account ID of the S3 Access Grants instance.

Returns:

The Amazon Web Services account ID of the S3 Access Grants instance.

grantScope

public final String grantScope()

The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

Returns:

The S3 path of the data that you would like to access. Must start with s3://. You can optionally pass only the beginning characters of a path, and S3 Access Grants will search for all applicable grants for the path fragment.

nextToken

public final String nextToken()

A pagination token to request the next page of results. Pass this value into a subsequent List Caller Access Grants 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 Caller Access Grants 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 Caller 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 Caller Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

allowedByApplication

public final Boolean allowedByApplication()

If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications ( ALL).

Returns:

If this optional parameter is passed in the request, a filter is applied to the results. The results will include only the access grants for the caller's Identity Center application or for any other applications (ALL).

toBuilder

public ListCallerAccessGrantsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCallerAccessGrantsRequest.Builder,ListCallerAccessGrantsRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static ListCallerAccessGrantsRequest.Builder builder()

serializableBuilderClass

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