Class S3LogDestinationParameters

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

The Amazon S3 logging configuration settings for the pipe.

See Also:

  • Method Details

    • bucketName

      public final String bucketName()

      Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

      Returns:
      Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

    • bucketOwner

      public final String bucketOwner()

      Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

      Returns:
      Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

    • outputFormat

      public final S3OutputFormat outputFormat()

      How EventBridge should format the log records.

      EventBridge currently only supports json formatting.

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

      Returns:
      How EventBridge should format the log records.

      EventBridge currently only supports json formatting.

      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()

      How EventBridge should format the log records.

      EventBridge currently only supports json formatting.

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

      Returns:
      How EventBridge should format the log records.

      EventBridge currently only supports json formatting.

      See Also:

    • prefix

      public final String prefix()

      Specifies any prefix text with which to begin Amazon S3 log object names.

      You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.

      Returns:
      Specifies any prefix text with which to begin Amazon S3 log object names.

      You can use prefixes to organize the data that you store in Amazon S3 buckets. A prefix is a string of characters at the beginning of the object key name. A prefix can be any length, subject to the maximum length of the object key name (1,024 bytes). For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide.

    • toBuilder

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

    • builder

      public static S3LogDestinationParameters.Builder builder()

    • serializableBuilderClass

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