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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	S3LogDestinationParameters.Builder

Method Summary

Modifier and Type	Method	Description
String	bucketName()	Specifies the name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
String	bucketOwner()	Specifies the Amazon Web Services account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
static S3LogDestinationParameters.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
S3OutputFormat	outputFormat()	How EventBridge should format the log records.
String	outputFormatAsString()	How EventBridge should format the log records.
String	prefix()	Specifies any prefix text with which to begin Amazon S3 log object names.
List<SdkField<?>>	sdkFields()
static Class<? extends S3LogDestinationParameters.Builder>	serializableBuilderClass()
S3LogDestinationParameters.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

• json: JSON

• plain: Plain text

• w3c: W3C extended logging file format

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.

• json: JSON

• plain: Plain text

• w3c: W3C extended logging file format

See Also:

S3OutputFormat

outputFormatAsString

public final String outputFormatAsString()

How EventBridge should format the log records.

• json: JSON

• plain: Plain text

• w3c: W3C extended logging file format

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.

• json: JSON

• plain: Plain text

• w3c: W3C extended logging file format

See Also:

S3OutputFormat

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

Specified by:

toBuilder in interface ToCopyableBuilder<S3LogDestinationParameters.Builder,S3LogDestinationParameters>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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