Package software.amazon.awssdk.services.pipes.model

Class 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 Kinesis Data 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 Kinesis Data Firehose stream log destination.

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

    See Also:
    Serialized Form

    • Method Detail

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

      • firehoseLogDestination

        public final FirehoseLogDestinationParameters firehoseLogDestination()

        The Amazon Kinesis Data Firehose logging configuration settings for the pipe.

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

      • includeExecutionData

        public final List<IncludeExecutionDataOption> includeExecutionData()

        Specify ON to include the execution data (specifically, the payload and awsRequest 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.

        The default is OFF.

        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 ON to include the execution data (specifically, the payload and awsRequest 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.

        The default is OFF.

      • 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 ON to include the execution data (specifically, the payload and awsRequest 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.

        The default is OFF.

        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 ON to include the execution data (specifically, the payload and awsRequest 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.

        The default is OFF.

      • s3LogDestination

        public final S3LogDestinationParameters s3LogDestination()

        The Amazon S3 logging configuration settings for the pipe.

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

      • hashCode

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

      • equals

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

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