Class S3LogConfiguration

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

The S3 log configuration.

See Also:

  • Method Details

    • bucket

      public final String bucket()

      The S3 bucket name where logs are delivered.

      Returns:
      The S3 bucket name where logs are delivered.

    • keyPrefix

      public final String keyPrefix()

      The S3 path prefix that determines where log files are stored.

      Returns:
      The S3 path prefix that determines where log files are stored.

    • bucketOwner

      public final String bucketOwner()

      The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

      Returns:
      The expected bucket owner of the target S3 bucket. The caller must have permissions to write to the target bucket.

    • logFileFormat

      public final LogFileFormat logFileFormat()

      The format of the LogFile that is written to S3.

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

      Returns:
      The format of the LogFile that is written to S3.
      See Also:

    • logFileFormatAsString

      public final String logFileFormatAsString()

      The format of the LogFile that is written to S3.

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

      Returns:
      The format of the LogFile that is written to S3.
      See Also:

    • folderStructure

      public final FolderStructure folderStructure()

      The folder structure that defines the organizational structure for log files in S3.

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

      Returns:
      The folder structure that defines the organizational structure for log files in S3.
      See Also:

    • folderStructureAsString

      public final String folderStructureAsString()

      The folder structure that defines the organizational structure for log files in S3.

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

      Returns:
      The folder structure that defines the organizational structure for log files in S3.
      See Also:

    • toBuilder

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

    • builder

      public static S3LogConfiguration.Builder builder()

    • serializableBuilderClass

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