Package software.amazon.awssdk.services.apigateway.model

Class AccessLogSettings

java.lang.Object

software.amazon.awssdk.services.apigateway.model.AccessLogSettings

All Implemented Interfaces:

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

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

Access log settings, including the access log format and access log destination ARN.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AccessLogSettings.Builder

Method Summary

Modifier and Type	Method	Description
static AccessLogSettings.Builder	builder()
String	destinationArn()	The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	format()	A single line format of the access logs of data, as specified by selected $context variables.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AccessLogSettings.Builder>	serializableBuilderClass()
AccessLogSettings.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

format

public final String format()

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

Returns:

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

destinationArn

public final String destinationArn()

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

Returns:

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

toBuilder

public AccessLogSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccessLogSettings.Builder,AccessLogSettings>

builder

public static AccessLogSettings.Builder builder()

serializableBuilderClass

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