Package software.amazon.awssdk.services.macie2.model

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:

  • Method Details

    • 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, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

      Returns:
      The storage class of the object.
      See Also:

    • 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, storageClass will return StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().

      Returns:
      The storage class of the object.
      See Also:

    • 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 the isEmpty() 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()
      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<S3Object.Builder,S3Object>
      Returns:
      a builder for type T

    • builder

      public static S3Object.Builder builder()

    • serializableBuilderClass

      public static Class<? extends S3Object.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.