com.amazonaws.services.apigateway.model

Class AccessLogSettings

java.lang.Object

com.amazonaws.services.apigateway.model.AccessLogSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AccessLogSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AccessLogSettings()

Method Summary

Modifier and Type	Method and Description
AccessLogSettings	clone()
boolean	equals(Object obj)
String	getDestinationArn() The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
String	getFormat() A single line format of the access logs of data, as specified by selected $context variables.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDestinationArn(String destinationArn) The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
void	setFormat(String format) A single line format of the access logs of data, as specified by selected $context variables.
String	toString() Returns a string representation of this object.
AccessLogSettings	withDestinationArn(String destinationArn) The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
AccessLogSettings	withFormat(String format) A single line format of the access logs of data, as specified by selected $context variables.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccessLogSettings

public AccessLogSettings()

Method Detail

setFormat

public void setFormat(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.

Parameters:

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.

getFormat

public String getFormat()

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.

withFormat

public AccessLogSettings withFormat(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDestinationArn

public void setDestinationArn(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-.

Parameters:

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-.

getDestinationArn

public String getDestinationArn()

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-.

withDestinationArn

public AccessLogSettings withDestinationArn(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-.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AccessLogSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.