GetObjectAclRequest (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkRequest
- - com.ibm.cos.v2.awscore.AwsRequest
  - - com.ibm.cos.v2.services.s3.model.S3Request
    - - com.ibm.cos.v2.services.s3.model.GetObjectAclRequest

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

@Generated(value="com.ibm.cos.v2:codegen")
public final class GetObjectAclRequest
extends S3Request
implements ToCopyableBuilder<GetObjectAclRequest.Builder,GetObjectAclRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetObjectAclRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucket()` The bucket name that contains the object for which to get the ACL information.
`static GetObjectAclRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`String`	`expectedBucketOwner()` The account ID of the expected bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`key()` The key of the object for which to get the ACL information.
`RequestPayer`	`requestPayer()` Returns the value of the RequestPayer property for this object.
`String`	`requestPayerAsString()` Returns the value of the RequestPayer property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetObjectAclRequest.Builder>`	`serializableBuilderClass()`
`GetObjectAclRequest.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()` Version ID used to reference a specific version of the object.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bucket
```
public final String bucket()
```
    The bucket name that contains the object for which to get the ACL information.
    
    Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
    
    Returns:
    
    The bucket name that contains the object for which to get the ACL information.
    
    Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
  - key
```
public final String key()
```
    The key of the object for which to get the ACL information.
    
    Returns:
    
    The key of the object for which to get the ACL information.
  - versionId
```
public final String versionId()
```
    Version ID used to reference a specific version of the object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Version ID used to reference a specific version of the object.
    
    This functionality is not supported for directory buckets.
  - requestPayer
```
public final 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 final 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
  - expectedBucketOwner
```
public final String expectedBucketOwner()
```
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
    
    Returns:
    
    The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
  - toBuilder
```
public GetObjectAclRequest.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<GetObjectAclRequest.Builder,GetObjectAclRequest>
    
    Specified by:
    
    toBuilder in class S3Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static GetObjectAclRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetObjectAclRequest.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)
```
    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 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)
```
    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 final 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.
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo
    
    Returns:
    
    The mapping between the field name and its corresponding field.

Class GetObjectAclRequest

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

Method Detail

bucket

key

versionId

requestPayer

requestPayerAsString

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField