PutObjectAclRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.PutObjectAclRequest

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

@Generated(value="software.amazon.awssdk:codegen")
public final class PutObjectAclRequest
extends S3Request
implements ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutObjectAclRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutObjectAclRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessControlPolicy`	`accessControlPolicy()` Contains the elements that set the ACL permissions for an object per grantee.
`ObjectCannedACL`	`acl()` The canned ACL to apply to the object.
`String`	`aclAsString()` The canned ACL to apply to the object.
`String`	`bucket()`
`static PutObjectAclRequest.Builder`	`builder()`
`String`	`contentMD5()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`String`	`grantFullControl()` Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
`String`	`grantRead()` Allows grantee to list the objects in the bucket.
`String`	`grantReadACP()` Allows grantee to read the bucket ACL.
`String`	`grantWrite()` Allows grantee to create, overwrite, and delete any object in the bucket.
`String`	`grantWriteACP()` Allows grantee to write the ACL for the applicable bucket.
`int`	`hashCode()`
`String`	`key()`
`RequestPayer`	`requestPayer()` Returns the value of the RequestPayer property for this object.
`String`	`requestPayerAsString()` Returns the value of the RequestPayer property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutObjectAclRequest.Builder>`	`serializableBuilderClass()`
`PutObjectAclRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`String`	`versionId()` VersionId used to reference a specific version of the object.

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - acl
```
public ObjectCannedACL acl()
```
    The canned ACL to apply to the object.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the object.
    
    See Also:
    
    ObjectCannedACL
  - aclAsString
```
public String aclAsString()
```
    The canned ACL to apply to the object.
    
    If the service returns an enum value that is not available in the current SDK version, acl will return ObjectCannedACL.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from aclAsString().
    
    Returns:
    
    The canned ACL to apply to the object.
    
    See Also:
    
    ObjectCannedACL
  - accessControlPolicy
```
public AccessControlPolicy accessControlPolicy()
```
    Contains the elements that set the ACL permissions for an object per grantee.
    
    Returns:
    
    Contains the elements that set the ACL permissions for an object per grantee.
  - bucket
```
public String bucket()
```
    Returns:
  - contentMD5
```
public String contentMD5()
```
    Returns:
  - grantFullControl
```
public String grantFullControl()
```
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
    
    Returns:
    
    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
  - grantRead
```
public String grantRead()
```
    Allows grantee to list the objects in the bucket.
    
    Returns:
    
    Allows grantee to list the objects in the bucket.
  - grantReadACP
```
public String grantReadACP()
```
    Allows grantee to read the bucket ACL.
    
    Returns:
    
    Allows grantee to read the bucket ACL.
  - grantWrite
```
public String grantWrite()
```
    Allows grantee to create, overwrite, and delete any object in the bucket.
    
    Returns:
    
    Allows grantee to create, overwrite, and delete any object in the bucket.
  - grantWriteACP
```
public String grantWriteACP()
```
    Allows grantee to write the ACL for the applicable bucket.
    
    Returns:
    
    Allows grantee to write the ACL for the applicable bucket.
  - key
```
public String key()
```
    Returns:
  - requestPayer
```
public RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public String requestPayerAsString()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - versionId
```
public String versionId()
```
    VersionId used to reference a specific version of the object.
    
    Returns:
    
    VersionId used to reference a specific version of the object.
  - toBuilder
```
public PutObjectAclRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static PutObjectAclRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutObjectAclRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class PutObjectAclRequest

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

acl

aclAsString

accessControlPolicy

bucket

contentMD5

grantFullControl

grantRead

grantReadACP

grantWrite

grantWriteACP

key

requestPayer

requestPayerAsString

versionId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields