Class S3Object
- java.lang.Object
-
- software.amazon.awssdk.services.macie2.model.S3Object
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<S3Object.Builder,S3Object>
@Generated("software.amazon.awssdk:codegen") public final class S3Object extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3Object.Builder,S3Object>
Provides information about the S3 object that a finding applies to.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceS3Object.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbucketArn()The Amazon Resource Name (ARN) of the bucket that contains the object.static S3Object.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeTag()The entity tag (ETag) that identifies the affected version of the object.Stringextension()The file name extension of the object.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringkey()The full name (key) of the object, including the object's prefix if applicable.InstantlastModified()The date and time, in UTC and extended ISO 8601 format, when the object was last modified.Stringpath()The full path to the affected object, including the name of the affected bucket and the object's name (key).BooleanpublicAccess()Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends S3Object.Builder>serializableBuilderClass()ServerSideEncryptionserverSideEncryption()The type of server-side encryption that was used to encrypt the object.Longsize()The total storage size, in bytes, of the object.StorageClassstorageClass()The storage class of the object.StringstorageClassAsString()The storage class of the object.List<KeyValuePair>tags()The tags that are associated with the object.S3Object.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringversionId()The identifier for the affected version of the object.-
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
-
bucketArn
public final String bucketArn()
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.
-
eTag
public final 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.
- 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.
-
extension
public final String extension()
The file name extension of the object. If the object doesn't have a file name extension, this value is "".
- Returns:
- The file name extension of the object. If the object doesn't have a file name extension, this value is "".
-
key
public final String key()
The full name (key) of the object, including the object's prefix if applicable.
- Returns:
- The full name (key) of the object, including the object's prefix if applicable.
-
lastModified
public final Instant lastModified()
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.
-
path
public final String path()
The full path to the affected object, including the name of the affected bucket and the object's name (key).
- Returns:
- The full path to the affected object, including the name of the affected bucket and the object's name (key).
-
publicAccess
public final Boolean publicAccess()
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.
-
serverSideEncryption
public final ServerSideEncryption serverSideEncryption()
The type of server-side encryption that was used to encrypt the object.
- Returns:
- The type of server-side encryption that was used to encrypt the object.
-
size
public final Long size()
The total storage size, in bytes, of the object.
- Returns:
- The total storage size, in bytes, of the object.
-
storageClass
public final StorageClass storageClass()
The storage class of the object.
If the service returns an enum value that is not available in the current SDK version,
storageClasswill returnStorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstorageClassAsString().- Returns:
- The storage class of the object.
- See Also:
StorageClass
-
storageClassAsString
public final String storageClassAsString()
The storage class of the object.
If the service returns an enum value that is not available in the current SDK version,
storageClasswill returnStorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstorageClassAsString().- Returns:
- The storage class of the object.
- See Also:
StorageClass
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<KeyValuePair> tags()
The tags that are associated with the object.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags that are associated with the object.
-
versionId
public final String versionId()
The identifier for the affected version of the object.
- Returns:
- The identifier for the affected version of the object.
-
toBuilder
public S3Object.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<S3Object.Builder,S3Object>
-
builder
public static S3Object.Builder builder()
-
serializableBuilderClass
public static Class<? extends S3Object.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-