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

Class CreateAccessGrantsLocationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessGrantsLocationRequest.Builder,CreateAccessGrantsLocationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAccessGrantsLocationRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The ID of the Amazon Web Services account that is making this request.
static CreateAccessGrantsLocationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	iamRoleArn()	The Amazon Resource Name (ARN) of the IAM role for the registered location.
String	locationScope()	The S3 path to the location that you are registering.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessGrantsLocationRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The Amazon Web Services resource tags that you are adding to the S3 Access Grants location.
CreateAccessGrantsLocationRequest.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.

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.

iamRoleArn

public final String iamRoleArn()

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

Returns:

The Amazon Resource Name (ARN) of the IAM role for the registered location. S3 Access Grants assumes this role to manage access to the registered location.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

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

Returns:

The Amazon Web Services resource tags that you are adding to the S3 Access Grants location. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.

toBuilder

public CreateAccessGrantsLocationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessGrantsLocationRequest.Builder,CreateAccessGrantsLocationRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static CreateAccessGrantsLocationRequest.Builder builder()

serializableBuilderClass

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