Class PipeLogConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PipeLogConfiguration.Builder,
PipeLogConfiguration>
The logging configuration settings for the pipe.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PipeLogConfiguration.Builder
builder()
The Amazon CloudWatch Logs logging configuration settings for the pipe.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FirehoseLogDestination
The Amazon Kinesis Data Firehose logging configuration settings for the pipe.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IncludeExecutionData property.final List
<IncludeExecutionDataOption> Whether the execution data (specifically, thepayload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.Whether the execution data (specifically, thepayload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.final LogLevel
level()
The level of logging detail to include.final String
The level of logging detail to include.final S3LogDestination
The Amazon S3 logging configuration settings for the pipe.static Class
<? extends PipeLogConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
cloudwatchLogsLogDestination
The Amazon CloudWatch Logs logging configuration settings for the pipe.
- Returns:
- The Amazon CloudWatch Logs logging configuration settings for the pipe.
-
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
Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included 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.
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:
- Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included 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.
-
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 theisEmpty()
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
Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included 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.
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:
- Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included 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.
-
level
The level of logging detail to include. This applies to all log destinations for the pipe.
If the service returns an enum value that is not available in the current SDK version,
level
will returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- The level of logging detail to include. This applies to all log destinations for the pipe.
- See Also:
-
levelAsString
The level of logging detail to include. This applies to all log destinations for the pipe.
If the service returns an enum value that is not available in the current SDK version,
level
will returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlevelAsString()
.- Returns:
- The level of logging detail to include. This applies to all log destinations for the pipe.
- See Also:
-
s3LogDestination
The Amazon S3 logging configuration settings for the pipe.
- Returns:
- The Amazon S3 logging configuration settings for the pipe.
-
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 interfaceToCopyableBuilder<PipeLogConfiguration.Builder,
PipeLogConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-