Class PipeLogConfigurationParameters

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

Specifies the logging configuration settings for the pipe.

When you call UpdatePipe, EventBridge updates the fields in the PipeLogConfigurationParameters object atomically as one and overrides existing values. This is by design. If you don't specify an optional field in any of the Amazon Web Services service parameters objects ( CloudwatchLogsLogDestinationParameters, FirehoseLogDestinationParameters, or S3LogDestinationParameters), EventBridge sets that field to its system-default value during the update.

For example, suppose when you created the pipe you specified a Firehose stream log destination. You then update the pipe to add an Amazon S3 log destination. In addition to specifying the S3LogDestinationParameters for the new log destination, you must also specify the fields in the FirehoseLogDestinationParameters object in order to retain the Firehose stream log destination.

For more information on generating pipe log records, see Log EventBridge Pipes in the Amazon EventBridge User Guide.

See Also:

  • Method Details

    • s3LogDestination

      public final S3LogDestinationParameters s3LogDestination()

      The Amazon S3 logging configuration settings for the pipe.

      Returns:
      The Amazon S3 logging configuration settings for the pipe.

    • firehoseLogDestination

      public final FirehoseLogDestinationParameters firehoseLogDestination()

      The Amazon Data Firehose logging configuration settings for the pipe.

      Returns:
      The Amazon Data Firehose logging configuration settings for the pipe.

    • cloudwatchLogsLogDestination

      public final CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination()

      The Amazon CloudWatch Logs logging configuration settings for the pipe.

      Returns:
      The Amazon CloudWatch Logs logging configuration settings for the pipe.

    • level

      public final LogLevel level()

      The level of logging detail to include. This applies to all log destinations for the pipe.

      For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

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

      Returns:
      The level of logging detail to include. This applies to all log destinations for the pipe.

      For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

      See Also:

    • levelAsString

      public final String levelAsString()

      The level of logging detail to include. This applies to all log destinations for the pipe.

      For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

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

      Returns:
      The level of logging detail to include. This applies to all log destinations for the pipe.

      For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.

      See Also:

    • includeExecutionData

      public final List<IncludeExecutionDataOption> includeExecutionData()

      Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) in the log messages for this pipe.

      This applies to all log destinations for the pipe.

      For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

      By default, execution data is not included.

      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 hasIncludeExecutionData() method.

      Returns:
      Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) in the log messages for this pipe.

      This applies to all log destinations for the pipe.

      For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

      By default, execution data is not included.

    • hasIncludeExecutionData

      public final boolean hasIncludeExecutionData()
      For responses, this returns true if the service returned a value for the IncludeExecutionData 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.

    • includeExecutionDataAsStrings

      public final List<String> includeExecutionDataAsStrings()

      Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) in the log messages for this pipe.

      This applies to all log destinations for the pipe.

      For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

      By default, execution data is not included.

      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 hasIncludeExecutionData() method.

      Returns:
      Specify ALL to include the execution data (specifically, the payload, awsRequest, and awsResponse fields) in the log messages for this pipe.

      This applies to all log destinations for the pipe.

      For more information, see Including execution data in logs in the Amazon EventBridge User Guide.

      By default, execution data is not included.

    • toBuilder

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

    • builder

      public static PipeLogConfigurationParameters.Builder builder()

    • serializableBuilderClass

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