com.amazonaws.services.ecs.model.TimeoutConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ecs Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.ecs.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TimeoutConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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.
*
*/
private 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.
*
*/
private Integer 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.
*
*
* @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.
*/
public void setIdleTimeoutSeconds(Integer idleTimeoutSeconds) {
this.idleTimeoutSeconds = 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 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 Integer getIdleTimeoutSeconds() {
return this.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.
*
*
* @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.
*/
public TimeoutConfiguration withIdleTimeoutSeconds(Integer idleTimeoutSeconds) {
setIdleTimeoutSeconds(idleTimeoutSeconds);
return this;
}
/**
*
* 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.
*/
public void setPerRequestTimeoutSeconds(Integer perRequestTimeoutSeconds) {
this.perRequestTimeoutSeconds = 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 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 Integer getPerRequestTimeoutSeconds() {
return this.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.
*
*
* @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.
*/
public TimeoutConfiguration withPerRequestTimeoutSeconds(Integer perRequestTimeoutSeconds) {
setPerRequestTimeoutSeconds(perRequestTimeoutSeconds);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getIdleTimeoutSeconds() != null)
sb.append("IdleTimeoutSeconds: ").append(getIdleTimeoutSeconds()).append(",");
if (getPerRequestTimeoutSeconds() != null)
sb.append("PerRequestTimeoutSeconds: ").append(getPerRequestTimeoutSeconds());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TimeoutConfiguration == false)
return false;
TimeoutConfiguration other = (TimeoutConfiguration) obj;
if (other.getIdleTimeoutSeconds() == null ^ this.getIdleTimeoutSeconds() == null)
return false;
if (other.getIdleTimeoutSeconds() != null && other.getIdleTimeoutSeconds().equals(this.getIdleTimeoutSeconds()) == false)
return false;
if (other.getPerRequestTimeoutSeconds() == null ^ this.getPerRequestTimeoutSeconds() == null)
return false;
if (other.getPerRequestTimeoutSeconds() != null && other.getPerRequestTimeoutSeconds().equals(this.getPerRequestTimeoutSeconds()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdleTimeoutSeconds() == null) ? 0 : getIdleTimeoutSeconds().hashCode());
hashCode = prime * hashCode + ((getPerRequestTimeoutSeconds() == null) ? 0 : getPerRequestTimeoutSeconds().hashCode());
return hashCode;
}
@Override
public TimeoutConfiguration clone() {
try {
return (TimeoutConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.ecs.model.transform.TimeoutConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}