software.amazon.awssdk.services.apigateway.model.AccessLogSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of apigateway Show documentation
Show all versions of apigateway Show documentation
The AWS Java SDK for Amazon API Gateway module holds the client classes that are used for communicating
with Amazon API
Gateway
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.apigateway.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Access log settings, including the access log format and access log destination ARN.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AccessLogSettings implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(AccessLogSettings::format)).setter(setter(Builder::format))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("format").build()).build();
private static final SdkField DESTINATION_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(AccessLogSettings::destinationArn)).setter(setter(Builder::destinationArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("destinationArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FORMAT_FIELD,
DESTINATION_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final String format;
private final String destinationArn;
private AccessLogSettings(BuilderImpl builder) {
this.format = builder.format;
this.destinationArn = builder.destinationArn;
}
/**
*
* A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
*
*
* @return A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
*/
public String format() {
return format;
}
/**
*
* 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-.
*
*
* @return 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-.
*/
public String destinationArn() {
return destinationArn;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(format());
hashCode = 31 * hashCode + Objects.hashCode(destinationArn());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AccessLogSettings)) {
return false;
}
AccessLogSettings other = (AccessLogSettings) obj;
return Objects.equals(format(), other.format()) && Objects.equals(destinationArn(), other.destinationArn());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("AccessLogSettings").add("Format", format()).add("DestinationArn", destinationArn()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "format":
return Optional.ofNullable(clazz.cast(format()));
case "destinationArn":
return Optional.ofNullable(clazz.cast(destinationArn()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AccessLogSettings) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder format(String format);
/**
*
* 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-.
*
*
* @param 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-.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationArn(String destinationArn);
}
static final class BuilderImpl implements Builder {
private String format;
private String destinationArn;
private BuilderImpl() {
}
private BuilderImpl(AccessLogSettings model) {
format(model.format);
destinationArn(model.destinationArn);
}
public final String getFormat() {
return format;
}
@Override
public final Builder format(String format) {
this.format = format;
return this;
}
public final void setFormat(String format) {
this.format = format;
}
public final String getDestinationArn() {
return destinationArn;
}
@Override
public final Builder destinationArn(String destinationArn) {
this.destinationArn = destinationArn;
return this;
}
public final void setDestinationArn(String destinationArn) {
this.destinationArn = destinationArn;
}
@Override
public AccessLogSettings build() {
return new AccessLogSettings(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}