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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetDataAccessRequest.Builder,GetDataAccessRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetDataAccessRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accountId()`	The ID of the Amazon Web Services account that is making this request.
`static GetDataAccessRequest.Builder`	`builder()`
`Integer`	`durationSeconds()`	The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Permission`	`permission()`	The type of permission granted to your S3 data, which can be set to one of the following values:
`String`	`permissionAsString()`	The type of permission granted to your S3 data, which can be set to one of the following values:
`Privilege`	`privilege()`	The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
`String`	`privilegeAsString()`	The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetDataAccessRequest.Builder>`	`serializableBuilderClass()`
`String`	`target()`	The S3 URI path of the data to which you are requesting temporary access credentials.
`S3PrefixType`	`targetType()`	The type of `Target`.
`String`	`targetTypeAsString()`	The type of `Target`.
`GetDataAccessRequest.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.
  - target
```
public final String target()
```
    The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.
    
    Returns:
    
    The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.
  - permission
```
public final Permission permission()
```
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - permissionAsString
```
public final String permissionAsString()
```
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    If the service returns an enum value that is not available in the current SDK version, permission will return Permission.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionAsString().
    Returns:
    
    The type of permission granted to your S3 data, which can be set to one of the following values:
    
    READ – Grant read-only access to the S3 data.
    
    WRITE – Grant write-only access to the S3 data.
    
    READWRITE – Grant both read and write access to the S3 data.
    
    See Also:
    
    Permission
  - durationSeconds
```
public final Integer durationSeconds()
```
    The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.
    
    Returns:
    
    The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.
  - privilege
```
public final Privilege privilege()
```
    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
    
    Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
    
    Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.
    
    If the service returns an enum value that is not available in the current SDK version, privilege will return Privilege.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privilegeAsString().
    Returns:
    
    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
    
    Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
    
    Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.
    
    See Also:
    
    Privilege
  - privilegeAsString
```
public final String privilegeAsString()
```
    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
    
    Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
    
    Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.
    
    If the service returns an enum value that is not available in the current SDK version, privilege will return Privilege.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from privilegeAsString().
    Returns:
    
    The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
    
    Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.
    
    Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.
    
    See Also:
    
    Privilege
  - targetType
```
public final S3PrefixType targetType()
```
    The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return S3PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.
    
    See Also:
    
    S3PrefixType
  - targetTypeAsString
```
public final String targetTypeAsString()
```
    The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.
    
    If the service returns an enum value that is not available in the current SDK version, targetType will return S3PrefixType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().
    
    Returns:
    
    The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.
    
    See Also:
    
    S3PrefixType
  - toBuilder
```
public GetDataAccessRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetDataAccessRequest.Builder,GetDataAccessRequest>
    
    Specified by:
    
    toBuilder in class S3ControlRequest
  - builder
```
public static GetDataAccessRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetDataAccessRequest.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

Class GetDataAccessRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

accountId

target

permission

permissionAsString

durationSeconds

privilege

privilegeAsString

targetType

targetTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields