S3Object (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.macie2.model.S3Object

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3Object
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about an S3 object that a finding applies to.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3Object()

Constructors
Constructor and Description
`S3Object()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`S3Object`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBucketArn()` The Amazon Resource Name (ARN) of the bucket that contains the object.
`String`	`getETag()` The entity tag (ETag) that identifies the affected version of the object.
`String`	`getExtension()` The file extension of the object.
`String`	`getKey()` The full key (name) that's assigned to the object.
`Date`	`getLastModified()` The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
`String`	`getPath()` The path to the object, including the full key (name).
`Boolean`	`getPublicAccess()` Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
`ServerSideEncryption`	`getServerSideEncryption()` The server-side encryption settings for the object.
`Long`	`getSize()` The total storage size, in bytes, of the object.
`String`	`getStorageClass()` The storage class of the object.
`List<KeyValuePair>`	`getTags()` The tags that are associated with the object.
`String`	`getVersionId()` The identifier for the affected version of the object.
`int`	`hashCode()`
`Boolean`	`isPublicAccess()` Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBucketArn(String bucketArn)` The Amazon Resource Name (ARN) of the bucket that contains the object.
`void`	`setETag(String eTag)` The entity tag (ETag) that identifies the affected version of the object.
`void`	`setExtension(String extension)` The file extension of the object.
`void`	`setKey(String key)` The full key (name) that's assigned to the object.
`void`	`setLastModified(Date lastModified)` The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
`void`	`setPath(String path)` The path to the object, including the full key (name).
`void`	`setPublicAccess(Boolean publicAccess)` Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
`void`	`setServerSideEncryption(ServerSideEncryption serverSideEncryption)` The server-side encryption settings for the object.
`void`	`setSize(Long size)` The total storage size, in bytes, of the object.
`void`	`setStorageClass(String storageClass)` The storage class of the object.
`void`	`setTags(Collection<KeyValuePair> tags)` The tags that are associated with the object.
`void`	`setVersionId(String versionId)` The identifier for the affected version of the object.
`String`	`toString()` Returns a string representation of this object.
`S3Object`	`withBucketArn(String bucketArn)` The Amazon Resource Name (ARN) of the bucket that contains the object.
`S3Object`	`withETag(String eTag)` The entity tag (ETag) that identifies the affected version of the object.
`S3Object`	`withExtension(String extension)` The file extension of the object.
`S3Object`	`withKey(String key)` The full key (name) that's assigned to the object.
`S3Object`	`withLastModified(Date lastModified)` The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
`S3Object`	`withPath(String path)` The path to the object, including the full key (name).
`S3Object`	`withPublicAccess(Boolean publicAccess)` Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
`S3Object`	`withServerSideEncryption(ServerSideEncryption serverSideEncryption)` The server-side encryption settings for the object.
`S3Object`	`withSize(Long size)` The total storage size, in bytes, of the object.
`S3Object`	`withStorageClass(StorageClass storageClass)` The storage class of the object.
`S3Object`	`withStorageClass(String storageClass)` The storage class of the object.
`S3Object`	`withTags(Collection<KeyValuePair> tags)` The tags that are associated with the object.
`S3Object`	`withTags(KeyValuePair... tags)` The tags that are associated with the object.
`S3Object`	`withVersionId(String versionId)` The identifier for the affected version of the object.

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

- Constructor Detail
  - S3Object
```
public S3Object()
```
- Method Detail
  - setBucketArn
```
public void setBucketArn(String bucketArn)
```
    The Amazon Resource Name (ARN) of the bucket that contains the object.
    
    Parameters:
    
    bucketArn - The Amazon Resource Name (ARN) of the bucket that contains the object.
  - getBucketArn
```
public String getBucketArn()
```
    The Amazon Resource Name (ARN) of the bucket that contains the object.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the bucket that contains the object.
  - withBucketArn
```
public S3Object withBucketArn(String bucketArn)
```
    The Amazon Resource Name (ARN) of the bucket that contains the object.
    
    Parameters:
    
    bucketArn - The Amazon Resource Name (ARN) of the bucket that contains the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setETag
```
public void setETag(String eTag)
```
    The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
    
    Parameters:
    
    eTag - The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
  - getETag
```
public String getETag()
```
    The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
    
    Returns:
    
    The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
  - withETag
```
public S3Object withETag(String eTag)
```
    The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
    
    Parameters:
    
    eTag - The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExtension
```
public void setExtension(String extension)
```
    The file extension of the object. If the object doesn't have a file extension, this value is "".
    
    Parameters:
    
    extension - The file extension of the object. If the object doesn't have a file extension, this value is "".
  - getExtension
```
public String getExtension()
```
    The file extension of the object. If the object doesn't have a file extension, this value is "".
    
    Returns:
    
    The file extension of the object. If the object doesn't have a file extension, this value is "".
  - withExtension
```
public S3Object withExtension(String extension)
```
    The file extension of the object. If the object doesn't have a file extension, this value is "".
    
    Parameters:
    
    extension - The file extension of the object. If the object doesn't have a file extension, this value is "".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKey
```
public void setKey(String key)
```
    The full key (name) that's assigned to the object.
    
    Parameters:
    
    key - The full key (name) that's assigned to the object.
  - getKey
```
public String getKey()
```
    The full key (name) that's assigned to the object.
    
    Returns:
    
    The full key (name) that's assigned to the object.
  - withKey
```
public S3Object withKey(String key)
```
    The full key (name) that's assigned to the object.
    
    Parameters:
    
    key - The full key (name) that's assigned to the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModified
```
public void setLastModified(Date lastModified)
```
    The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
    
    Parameters:
    
    lastModified - The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
  - getLastModified
```
public Date getLastModified()
```
    The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
    
    Returns:
    
    The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
  - withLastModified
```
public S3Object withLastModified(Date lastModified)
```
    The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
    
    Parameters:
    
    lastModified - The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPath
```
public void setPath(String path)
```
    The path to the object, including the full key (name).
    
    Parameters:
    
    path - The path to the object, including the full key (name).
  - getPath
```
public String getPath()
```
    The path to the object, including the full key (name).
    
    Returns:
    
    The path to the object, including the full key (name).
  - withPath
```
public S3Object withPath(String path)
```
    The path to the object, including the full key (name).
    
    Parameters:
    
    path - The path to the object, including the full key (name).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicAccess
```
public void setPublicAccess(Boolean publicAccess)
```
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
    
    Parameters:
    
    publicAccess - Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
  - getPublicAccess
```
public Boolean getPublicAccess()
```
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
    
    Returns:
    
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
  - withPublicAccess
```
public S3Object withPublicAccess(Boolean publicAccess)
```
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
    
    Parameters:
    
    publicAccess - Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPublicAccess
```
public Boolean isPublicAccess()
```
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
    
    Returns:
    
    Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.
  - setServerSideEncryption
```
public void setServerSideEncryption(ServerSideEncryption serverSideEncryption)
```
    The server-side encryption settings for the object.
    
    Parameters:
    
    serverSideEncryption - The server-side encryption settings for the object.
  - getServerSideEncryption
```
public ServerSideEncryption getServerSideEncryption()
```
    The server-side encryption settings for the object.
    
    Returns:
    
    The server-side encryption settings for the object.
  - withServerSideEncryption
```
public S3Object withServerSideEncryption(ServerSideEncryption serverSideEncryption)
```
    The server-side encryption settings for the object.
    
    Parameters:
    
    serverSideEncryption - The server-side encryption settings for the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSize
```
public void setSize(Long size)
```
    The total storage size, in bytes, of the object.
    
    Parameters:
    
    size - The total storage size, in bytes, of the object.
  - getSize
```
public Long getSize()
```
    The total storage size, in bytes, of the object.
    
    Returns:
    
    The total storage size, in bytes, of the object.
  - withSize
```
public S3Object withSize(Long size)
```
    The total storage size, in bytes, of the object.
    
    Parameters:
    
    size - The total storage size, in bytes, of the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageClass
```
public void setStorageClass(String storageClass)
```
    The storage class of the object.
    
    Parameters:
    
    storageClass - The storage class of the object.
    
    See Also:
    
    StorageClass
  - getStorageClass
```
public String getStorageClass()
```
    The storage class of the object.
    
    Returns:
    
    The storage class of the object.
    
    See Also:
    
    StorageClass
  - withStorageClass
```
public S3Object withStorageClass(String storageClass)
```
    The storage class of the object.
    
    Parameters:
    
    storageClass - The storage class of the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - withStorageClass
```
public S3Object withStorageClass(StorageClass storageClass)
```
    The storage class of the object.
    
    Parameters:
    
    storageClass - The storage class of the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StorageClass
  - getTags
```
public List<KeyValuePair> getTags()
```
    The tags that are associated with the object.
    
    Returns:
    
    The tags that are associated with the object.
  - setTags
```
public void setTags(Collection<KeyValuePair> tags)
```
    The tags that are associated with the object.
    
    Parameters:
    
    tags - The tags that are associated with the object.
  - withTags
```
public S3Object withTags(KeyValuePair... tags)
```
    The tags that are associated with the object.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags that are associated with the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public S3Object withTags(Collection<KeyValuePair> tags)
```
    The tags that are associated with the object.
    
    Parameters:
    
    tags - The tags that are associated with the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersionId
```
public void setVersionId(String versionId)
```
    The identifier for the affected version of the object.
    
    Parameters:
    
    versionId - The identifier for the affected version of the object.
  - getVersionId
```
public String getVersionId()
```
    The identifier for the affected version of the object.
    
    Returns:
    
    The identifier for the affected version of the object.
  - withVersionId
```
public S3Object withVersionId(String versionId)
```
    The identifier for the affected version of the object.
    
    Parameters:
    
    versionId - The identifier for the affected version of the object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 S3Object clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class S3Object

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3Object

Method Detail

setBucketArn

getBucketArn

withBucketArn

setETag

getETag

withETag

setExtension

getExtension

withExtension

setKey

getKey

withKey

setLastModified

getLastModified

withLastModified

setPath

getPath

withPath

setPublicAccess

getPublicAccess

withPublicAccess

isPublicAccess

setServerSideEncryption

getServerSideEncryption

withServerSideEncryption

setSize

getSize

withSize

setStorageClass

getStorageClass

withStorageClass

withStorageClass

getTags

setTags

withTags

withTags

setVersionId

getVersionId

withVersionId

toString

equals

hashCode

clone

marshall