com.amazonaws.services.s3control.model

Class GetDataAccessRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3control.model.GetDataAccessRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDataAccessRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetDataAccessRequest()

Method Summary

Modifier and Type	Method and Description
GetDataAccessRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The ID of the Amazon Web Services account that is making this request.
Integer	getDurationSeconds() The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application.
String	getPermission() The type of permission granted to your S3 data, which can be set to one of the following values:
String	getPrivilege() The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
String	getTarget() The S3 URI path of the data to which you are requesting temporary access credentials.
String	getTargetType() The type of Target.
int	hashCode()
void	setAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
void	setDurationSeconds(Integer durationSeconds) The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application.
void	setPermission(String permission) The type of permission granted to your S3 data, which can be set to one of the following values:
void	setPrivilege(String privilege) The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
void	setTarget(String target) The S3 URI path of the data to which you are requesting temporary access credentials.
void	setTargetType(String targetType) The type of Target.
String	toString() Returns a string representation of this object.
GetDataAccessRequest	withAccountId(String accountId) The ID of the Amazon Web Services account that is making this request.
GetDataAccessRequest	withDurationSeconds(Integer durationSeconds) The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application.
GetDataAccessRequest	withPermission(Permission permission) The type of permission granted to your S3 data, which can be set to one of the following values:
GetDataAccessRequest	withPermission(String permission) The type of permission granted to your S3 data, which can be set to one of the following values:
GetDataAccessRequest	withPrivilege(Privilege privilege) The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
GetDataAccessRequest	withPrivilege(String privilege) The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.
GetDataAccessRequest	withTarget(String target) The S3 URI path of the data to which you are requesting temporary access credentials.
GetDataAccessRequest	withTargetType(S3PrefixType targetType) The type of Target.
GetDataAccessRequest	withTargetType(String targetType) The type of Target.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetDataAccessRequest

public GetDataAccessRequest()

Method Detail

setAccountId

public void setAccountId(String accountId)

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

Parameters:

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

getAccountId

public String getAccountId()

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.

withAccountId

public GetDataAccessRequest withAccountId(String accountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setTarget

public void setTarget(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.

Parameters:

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.

getTarget

public String getTarget()

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.

withTarget

public GetDataAccessRequest withTarget(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPermission

public void setPermission(String 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.

Parameters:

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.

See Also:

Permission

getPermission

public String getPermission()

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.

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

withPermission

public GetDataAccessRequest withPermission(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Permission

withPermission

public GetDataAccessRequest withPermission(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Permission

setDurationSeconds

public void setDurationSeconds(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.

Parameters:

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.

getDurationSeconds

public Integer getDurationSeconds()

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.

withDurationSeconds

public GetDataAccessRequest withDurationSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPrivilege

public void setPrivilege(String 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.

Parameters:

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.

See Also:

Privilege

getPrivilege

public String getPrivilege()

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.

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

withPrivilege

public GetDataAccessRequest withPrivilege(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Privilege

withPrivilege

public GetDataAccessRequest withPrivilege(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Privilege

setTargetType

public void setTargetType(String 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.

Parameters:

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.

See Also:

S3PrefixType

getTargetType

public String getTargetType()

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.

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

withTargetType

public GetDataAccessRequest withTargetType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

S3PrefixType

withTargetType

public GetDataAccessRequest withTargetType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

S3PrefixType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetDataAccessRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()