@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PipeLogConfigurationParameters extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
PipeLogConfigurationParameters() |
Modifier and Type | Method and Description |
---|---|
PipeLogConfigurationParameters |
clone() |
boolean |
equals(Object obj) |
CloudwatchLogsLogDestinationParameters |
getCloudwatchLogsLogDestination()
The Amazon CloudWatch Logs logging configuration settings for the pipe.
|
FirehoseLogDestinationParameters |
getFirehoseLogDestination()
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
|
List<String> |
getIncludeExecutionData()
Specify
ON to include the execution data (specifically, the payload and
awsRequest fields) in the log messages for this pipe. |
String |
getLevel()
The level of logging detail to include.
|
S3LogDestinationParameters |
getS3LogDestination()
The Amazon S3 logging configuration settings for the pipe.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)
The Amazon CloudWatch Logs logging configuration settings for the pipe.
|
void |
setFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
|
void |
setIncludeExecutionData(Collection<String> includeExecutionData)
Specify
ON to include the execution data (specifically, the payload and
awsRequest fields) in the log messages for this pipe. |
void |
setLevel(String level)
The level of logging detail to include.
|
void |
setS3LogDestination(S3LogDestinationParameters s3LogDestination)
The Amazon S3 logging configuration settings for the pipe.
|
String |
toString()
Returns a string representation of this object.
|
PipeLogConfigurationParameters |
withCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)
The Amazon CloudWatch Logs logging configuration settings for the pipe.
|
PipeLogConfigurationParameters |
withFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
|
PipeLogConfigurationParameters |
withIncludeExecutionData(Collection<String> includeExecutionData)
Specify
ON to include the execution data (specifically, the payload and
awsRequest fields) in the log messages for this pipe. |
PipeLogConfigurationParameters |
withIncludeExecutionData(IncludeExecutionDataOption... includeExecutionData)
Specify
ON to include the execution data (specifically, the payload and
awsRequest fields) in the log messages for this pipe. |
PipeLogConfigurationParameters |
withIncludeExecutionData(String... includeExecutionData)
Specify
ON to include the execution data (specifically, the payload and
awsRequest fields) in the log messages for this pipe. |
PipeLogConfigurationParameters |
withLevel(LogLevel level)
The level of logging detail to include.
|
PipeLogConfigurationParameters |
withLevel(String level)
The level of logging detail to include.
|
PipeLogConfigurationParameters |
withS3LogDestination(S3LogDestinationParameters s3LogDestination)
The Amazon S3 logging configuration settings for the pipe.
|
public void setCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)
The Amazon CloudWatch Logs logging configuration settings for the pipe.
cloudwatchLogsLogDestination
- The Amazon CloudWatch Logs logging configuration settings for the pipe.public CloudwatchLogsLogDestinationParameters getCloudwatchLogsLogDestination()
The Amazon CloudWatch Logs logging configuration settings for the pipe.
public PipeLogConfigurationParameters withCloudwatchLogsLogDestination(CloudwatchLogsLogDestinationParameters cloudwatchLogsLogDestination)
The Amazon CloudWatch Logs logging configuration settings for the pipe.
cloudwatchLogsLogDestination
- The Amazon CloudWatch Logs logging configuration settings for the pipe.public void setFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
firehoseLogDestination
- The Amazon Kinesis Data Firehose logging configuration settings for the pipe.public FirehoseLogDestinationParameters getFirehoseLogDestination()
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
public PipeLogConfigurationParameters withFirehoseLogDestination(FirehoseLogDestinationParameters firehoseLogDestination)
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.
firehoseLogDestination
- The Amazon Kinesis Data Firehose logging configuration settings for the pipe.public List<String> getIncludeExecutionData()
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
.
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
.
IncludeExecutionDataOption
public void setIncludeExecutionData(Collection<String> 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
.
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
.
IncludeExecutionDataOption
public PipeLogConfigurationParameters withIncludeExecutionData(String... 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
.
NOTE: This method appends the values to the existing list (if any). Use
setIncludeExecutionData(java.util.Collection)
or withIncludeExecutionData(java.util.Collection)
if you want to override the existing values.
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
.
IncludeExecutionDataOption
public PipeLogConfigurationParameters withIncludeExecutionData(Collection<String> 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
.
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
.
IncludeExecutionDataOption
public PipeLogConfigurationParameters withIncludeExecutionData(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
.
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
.
IncludeExecutionDataOption
public void setLevel(String 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.
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.
LogLevel
public String getLevel()
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.
For more information, see Specifying EventBridge Pipes log level in the Amazon EventBridge User Guide.
LogLevel
public PipeLogConfigurationParameters withLevel(String 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.
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.
LogLevel
public PipeLogConfigurationParameters withLevel(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.
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.
LogLevel
public void setS3LogDestination(S3LogDestinationParameters s3LogDestination)
The Amazon S3 logging configuration settings for the pipe.
s3LogDestination
- The Amazon S3 logging configuration settings for the pipe.public S3LogDestinationParameters getS3LogDestination()
The Amazon S3 logging configuration settings for the pipe.
public PipeLogConfigurationParameters withS3LogDestination(S3LogDestinationParameters s3LogDestination)
The Amazon S3 logging configuration settings for the pipe.
s3LogDestination
- The Amazon S3 logging configuration settings for the pipe.public String toString()
toString
in class Object
Object.toString()
public PipeLogConfigurationParameters clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.