software.amazon.awssdk.services.appmesh.model.HttpTimeout Maven / Gradle / Ivy
/*
* 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.appmesh.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.Consumer;
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;
/**
*
* An object that represents types of timeouts.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HttpTimeout implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField IDLE_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("idle")
.getter(getter(HttpTimeout::idle)).setter(setter(Builder::idle)).constructor(Duration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("idle").build()).build();
private static final SdkField PER_REQUEST_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("perRequest").getter(getter(HttpTimeout::perRequest)).setter(setter(Builder::perRequest))
.constructor(Duration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("perRequest").build()).build();
private static final List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(IDLE_FIELD, PER_REQUEST_FIELD));
private static final long serialVersionUID = 1L;
private final Duration idle;
private final Duration perRequest;
private HttpTimeout(BuilderImpl builder) {
this.idle = builder.idle;
this.perRequest = builder.perRequest;
}
/**
*
* An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
* idle. The default value is none.
*
*
* @return An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection
* may be idle. The default value is none.
*/
public final Duration idle() {
return idle;
}
/**
*
* An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout,
* then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a
* virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be
* greater than 15 seconds for the source and destination virtual node and the route.
*
*
* @return An object that represents a per request timeout. The default value is 15 seconds. If you set a higher
* timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For
* example, if a virtual node backend uses a virtual router provider to route to another virtual node, then
* the timeout should be greater than 15 seconds for the source and destination virtual node and the route.
*/
public final Duration perRequest() {
return perRequest;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(idle());
hashCode = 31 * hashCode + Objects.hashCode(perRequest());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof HttpTimeout)) {
return false;
}
HttpTimeout other = (HttpTimeout) obj;
return Objects.equals(idle(), other.idle()) && Objects.equals(perRequest(), other.perRequest());
}
/**
* 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 final String toString() {
return ToString.builder("HttpTimeout").add("Idle", idle()).add("PerRequest", perRequest()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "idle":
return Optional.ofNullable(clazz.cast(idle()));
case "perRequest":
return Optional.ofNullable(clazz.cast(perRequest()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HttpTimeout) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
* idle. The default value is none.
*
*
* @param idle
* An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection
* may be idle. The default value is none.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder idle(Duration idle);
/**
*
* An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be
* idle. The default value is none.
*
* This is a convenience method that creates an instance of the {@link Duration.Builder} avoiding the need to
* create one manually via {@link Duration#builder()}.
*
*
* When the {@link Consumer} completes, {@link Duration.Builder#build()} is called immediately and its result is
* passed to {@link #idle(Duration)}.
*
* @param idle
* a consumer that will call methods on {@link Duration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #idle(Duration)
*/
default Builder idle(Consumer idle) {
return idle(Duration.builder().applyMutation(idle).build());
}
/**
*
* An object that represents a per request timeout. The default value is 15 seconds. If you set a higher
* timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For
* example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the
* timeout should be greater than 15 seconds for the source and destination virtual node and the route.
*
*
* @param perRequest
* An object that represents a per request timeout. The default value is 15 seconds. If you set a higher
* timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For
* example, if a virtual node backend uses a virtual router provider to route to another virtual node,
* then the timeout should be greater than 15 seconds for the source and destination virtual node and the
* route.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder perRequest(Duration perRequest);
/**
*
* An object that represents a per request timeout. The default value is 15 seconds. If you set a higher
* timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For
* example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the
* timeout should be greater than 15 seconds for the source and destination virtual node and the route.
*
* This is a convenience method that creates an instance of the {@link Duration.Builder} avoiding the need to
* create one manually via {@link Duration#builder()}.
*
*
* When the {@link Consumer} completes, {@link Duration.Builder#build()} is called immediately and its result is
* passed to {@link #perRequest(Duration)}.
*
* @param perRequest
* a consumer that will call methods on {@link Duration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #perRequest(Duration)
*/
default Builder perRequest(Consumer perRequest) {
return perRequest(Duration.builder().applyMutation(perRequest).build());
}
}
static final class BuilderImpl implements Builder {
private Duration idle;
private Duration perRequest;
private BuilderImpl() {
}
private BuilderImpl(HttpTimeout model) {
idle(model.idle);
perRequest(model.perRequest);
}
public final Duration.Builder getIdle() {
return idle != null ? idle.toBuilder() : null;
}
public final void setIdle(Duration.BuilderImpl idle) {
this.idle = idle != null ? idle.build() : null;
}
@Override
public final Builder idle(Duration idle) {
this.idle = idle;
return this;
}
public final Duration.Builder getPerRequest() {
return perRequest != null ? perRequest.toBuilder() : null;
}
public final void setPerRequest(Duration.BuilderImpl perRequest) {
this.perRequest = perRequest != null ? perRequest.build() : null;
}
@Override
public final Builder perRequest(Duration perRequest) {
this.perRequest = perRequest;
return this;
}
@Override
public HttpTimeout build() {
return new HttpTimeout(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}