software.amazon.awssdk.services.redshift.model

Class EnableLoggingRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshift.model.RedshiftRequest

software.amazon.awssdk.services.redshift.model.EnableLoggingRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class EnableLoggingRequest
extends RedshiftRequest
implements ToCopyableBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EnableLoggingRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucketName() The name of an existing S3 bucket where the log files are to be stored.
static EnableLoggingRequest.Builder	builder()
String	clusterIdentifier() The identifier of the cluster on which logging is to be started.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogExports() For responses, this returns true if the service returned a value for the LogExports property.
LogDestinationType	logDestinationType() The log destination type.
String	logDestinationTypeAsString() The log destination type.
List<String>	logExports() The collection of exported log types.
String	s3KeyPrefix() The prefix applied to the log file names.
List<SdkField<?>>	sdkFields()
static Class<? extends EnableLoggingRequest.Builder>	serializableBuilderClass()
EnableLoggingRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clusterIdentifier

public final String clusterIdentifier()

The identifier of the cluster on which logging is to be started.

Example: examplecluster

Returns:

The identifier of the cluster on which logging is to be started.

Example: examplecluster

bucketName

public final String bucketName()

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

• Must be in the same region as the cluster

• The cluster must have read bucket and put object permissions

Returns:

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

• Must be in the same region as the cluster

• The cluster must have read bucket and put object permissions

s3KeyPrefix

public final String s3KeyPrefix()

The prefix applied to the log file names.

Constraints:

• Cannot exceed 512 characters

• Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

  • x00 to x20

  • x22

  • x27

  • x5c

  • x7f or larger

Returns:

The prefix applied to the log file names.

Constraints:

• Cannot exceed 512 characters

• Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:

  • x00 to x20

  • x22

  • x27

  • x5c

  • x7f or larger

logDestinationType

public final LogDestinationType logDestinationType()

The log destination type. An enum with possible values of s3 and cloudwatch.

If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

Returns:

The log destination type. An enum with possible values of s3 and cloudwatch.

See Also:

LogDestinationType

logDestinationTypeAsString

public final String logDestinationTypeAsString()

The log destination type. An enum with possible values of s3 and cloudwatch.

If the service returns an enum value that is not available in the current SDK version, logDestinationType will return LogDestinationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logDestinationTypeAsString().

Returns:

The log destination type. An enum with possible values of s3 and cloudwatch.

See Also:

LogDestinationType

hasLogExports

public final boolean hasLogExports()

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

logExports

public final List<String> logExports()

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

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 hasLogExports() method.

Returns:

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

toBuilder

public EnableLoggingRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnableLoggingRequest.Builder,EnableLoggingRequest>

Specified by:

toBuilder in class RedshiftRequest

builder

public static EnableLoggingRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableLoggingRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo