Class PartitionedPrefix

java.lang.Object
software.amazon.awssdk.services.s3.model.PartitionedPrefix
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PartitionedPrefix.Builder,PartitionedPrefix>
@Generated("software.amazon.awssdk:codegen") public final class PartitionedPrefix extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PartitionedPrefix.Builder,PartitionedPrefix>

Amazon S3 keys for log objects are partitioned in the following format:

[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.

See Also:

  • Method Details

    • partitionDateSource

      public final PartitionDateSource partitionDateSource()

      Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

      For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

      For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

      If the service returns an enum value that is not available in the current SDK version, partitionDateSource will return PartitionDateSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partitionDateSourceAsString().

      Returns:
      Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

      For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

      For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

      See Also:

    • partitionDateSourceAsString

      public final String partitionDateSourceAsString()

      Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

      For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

      For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

      If the service returns an enum value that is not available in the current SDK version, partitionDateSource will return PartitionDateSource.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from partitionDateSourceAsString().

      Returns:
      Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

      For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

      For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

      See Also:

    • toBuilder

      public PartitionedPrefix.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<PartitionedPrefix.Builder,PartitionedPrefix>
      Returns:
      a builder for type T

    • builder

      public static PartitionedPrefix.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PartitionedPrefix.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.