Package software.amazon.awssdk.services.s3.model

Class LoggingEnabled

java.lang.Object

software.amazon.awssdk.services.s3.model.LoggingEnabled

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<LoggingEnabled.Builder,LoggingEnabled>

@Generated("software.amazon.awssdk:codegen")
public final class LoggingEnabled
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LoggingEnabled.Builder,LoggingEnabled>

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LoggingEnabled.Builder

Method Summary

Modifier and Type	Method	Description
static LoggingEnabled.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTargetGrants()	For responses, this returns true if the service returned a value for the TargetGrants property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends LoggingEnabled.Builder>	serializableBuilderClass()
String	targetBucket()	Specifies the bucket where you want Amazon S3 to store server access logs.
List<TargetGrant>	targetGrants()	Container for granting information.
TargetObjectKeyFormat	targetObjectKeyFormat()	Amazon S3 key format for log objects.
String	targetPrefix()	A prefix for all log object keys.
LoggingEnabled.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

targetBucket

public final String targetBucket()

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

Returns:

Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

hasTargetGrants

public final boolean hasTargetGrants()

For responses, this returns true if the service returned a value for the TargetGrants 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.

targetGrants

public final List<TargetGrant> targetGrants()

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 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 hasTargetGrants() method.

Returns:

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

targetPrefix

public final String targetPrefix()

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

Returns:

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

targetObjectKeyFormat

public final TargetObjectKeyFormat targetObjectKeyFormat()

Amazon S3 key format for log objects.

Returns:

Amazon S3 key format for log objects.

toBuilder

public LoggingEnabled.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LoggingEnabled.Builder,LoggingEnabled>

builder

public static LoggingEnabled.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo