software.amazon.awssdk.services.ecs.model.TimeoutConfiguration Maven / Gradle / Ivy
Show all versions of ecs Show documentation
/*
* 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.ecs.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;
/**
*
* An object that represents the timeout configurations for Service Connect.
*
*
*
* If idleTimeout is set to a time that is less than perRequestTimeout, the connection will
* close when the idleTimeout is reached and not the perRequestTimeout.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class TimeoutConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField IDLE_TIMEOUT_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("idleTimeoutSeconds").getter(getter(TimeoutConfiguration::idleTimeoutSeconds))
.setter(setter(Builder::idleTimeoutSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("idleTimeoutSeconds").build())
.build();
private static final SdkField PER_REQUEST_TIMEOUT_SECONDS_FIELD = SdkField
. builder(MarshallingType.INTEGER).memberName("perRequestTimeoutSeconds")
.getter(getter(TimeoutConfiguration::perRequestTimeoutSeconds)).setter(setter(Builder::perRequestTimeoutSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("perRequestTimeoutSeconds").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(IDLE_TIMEOUT_SECONDS_FIELD,
PER_REQUEST_TIMEOUT_SECONDS_FIELD));
private static final long serialVersionUID = 1L;
private final Integer idleTimeoutSeconds;
private final Integer perRequestTimeoutSeconds;
private TimeoutConfiguration(BuilderImpl builder) {
this.idleTimeoutSeconds = builder.idleTimeoutSeconds;
this.perRequestTimeoutSeconds = builder.perRequestTimeoutSeconds;
}
/**
*
* The amount of time in seconds a connection will stay active while idle. A value of 0 can be set to
* disable idleTimeout.
*
*
* The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.
*
*
* The idleTimeout default for TCP is 1 hour.
*
*
* @return The amount of time in seconds a connection will stay active while idle. A value of 0 can be
* set to disable idleTimeout.
*
* The idleTimeout default for HTTP/HTTP2/GRPC is 5
* minutes.
*
*
* The idleTimeout default for TCP is 1 hour.
*/
public final Integer idleTimeoutSeconds() {
return idleTimeoutSeconds;
}
/**
*
* The amount of time waiting for the upstream to respond with a complete response per request. A value of
* 0 can be set to disable perRequestTimeout. perRequestTimeout can only be
* set if Service Connect appProtocol isn't TCP. Only idleTimeout is allowed
* for TCP appProtocol.
*
*
* @return The amount of time waiting for the upstream to respond with a complete response per request. A value of
* 0 can be set to disable perRequestTimeout. perRequestTimeout can
* only be set if Service Connect appProtocol isn't TCP. Only
* idleTimeout is allowed for TCP appProtocol.
*/
public final Integer perRequestTimeoutSeconds() {
return perRequestTimeoutSeconds;
}
@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(idleTimeoutSeconds());
hashCode = 31 * hashCode + Objects.hashCode(perRequestTimeoutSeconds());
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 TimeoutConfiguration)) {
return false;
}
TimeoutConfiguration other = (TimeoutConfiguration) obj;
return Objects.equals(idleTimeoutSeconds(), other.idleTimeoutSeconds())
&& Objects.equals(perRequestTimeoutSeconds(), other.perRequestTimeoutSeconds());
}
/**
* 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("TimeoutConfiguration").add("IdleTimeoutSeconds", idleTimeoutSeconds())
.add("PerRequestTimeoutSeconds", perRequestTimeoutSeconds()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "idleTimeoutSeconds":
return Optional.ofNullable(clazz.cast(idleTimeoutSeconds()));
case "perRequestTimeoutSeconds":
return Optional.ofNullable(clazz.cast(perRequestTimeoutSeconds()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((TimeoutConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The amount of time in seconds a connection will stay active while idle. A value of 0 can be set
* to disable idleTimeout.
*
*
* The idleTimeout default for HTTP/HTTP2/GRPC is 5 minutes.
*
*
* The idleTimeout default for TCP is 1 hour.
*
*
* @param idleTimeoutSeconds
* The amount of time in seconds a connection will stay active while idle. A value of 0 can
* be set to disable idleTimeout.
*
* The idleTimeout default for HTTP/HTTP2/GRPC is 5
* minutes.
*
*
* The idleTimeout default for TCP is 1 hour.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder idleTimeoutSeconds(Integer idleTimeoutSeconds);
/**
*
* The amount of time waiting for the upstream to respond with a complete response per request. A value of
* 0 can be set to disable perRequestTimeout. perRequestTimeout can only
* be set if Service Connect appProtocol isn't TCP. Only idleTimeout is
* allowed for TCP appProtocol.
*
*
* @param perRequestTimeoutSeconds
* The amount of time waiting for the upstream to respond with a complete response per request. A value
* of 0 can be set to disable perRequestTimeout. perRequestTimeout
* can only be set if Service Connect appProtocol isn't TCP. Only
* idleTimeout is allowed for TCP appProtocol.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder perRequestTimeoutSeconds(Integer perRequestTimeoutSeconds);
}
static final class BuilderImpl implements Builder {
private Integer idleTimeoutSeconds;
private Integer perRequestTimeoutSeconds;
private BuilderImpl() {
}
private BuilderImpl(TimeoutConfiguration model) {
idleTimeoutSeconds(model.idleTimeoutSeconds);
perRequestTimeoutSeconds(model.perRequestTimeoutSeconds);
}
public final Integer getIdleTimeoutSeconds() {
return idleTimeoutSeconds;
}
public final void setIdleTimeoutSeconds(Integer idleTimeoutSeconds) {
this.idleTimeoutSeconds = idleTimeoutSeconds;
}
@Override
public final Builder idleTimeoutSeconds(Integer idleTimeoutSeconds) {
this.idleTimeoutSeconds = idleTimeoutSeconds;
return this;
}
public final Integer getPerRequestTimeoutSeconds() {
return perRequestTimeoutSeconds;
}
public final void setPerRequestTimeoutSeconds(Integer perRequestTimeoutSeconds) {
this.perRequestTimeoutSeconds = perRequestTimeoutSeconds;
}
@Override
public final Builder perRequestTimeoutSeconds(Integer perRequestTimeoutSeconds) {
this.perRequestTimeoutSeconds = perRequestTimeoutSeconds;
return this;
}
@Override
public TimeoutConfiguration build() {
return new TimeoutConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}