/*
* Copyright 2010-2016 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.elasticloadbalancing.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* <p>
* Generates a stickiness policy with sticky session lifetimes controlled by the
* lifetime of the browser (user-agent) or a specified expiration period. This
* policy can be associated only with HTTP/HTTPS listeners.
* </p>
* <p>
* When a load balancer implements this policy, the load balancer uses a special
* cookie to track the back-end server instance for each request. When the load
* balancer receives a request, it first checks to see if this cookie is present
* in the request. If so, the load balancer sends the request to the application
* server specified in the cookie. If not, the load balancer sends the request
* to a server that is chosen based on the existing load-balancing algorithm.
* </p>
* <p>
* A cookie is inserted into the response for binding subsequent requests from
* the same user to that server. The validity of the cookie is based on the
* cookie expiration time, which is specified in the policy configuration.
* </p>
* <p>
* For more information, see <a href=
* "http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-sticky-sessions.html#enable-sticky-sessions-duration"
* >Duration-Based Session Stickiness</a> in the <i>Elastic Load Balancing
* Developer Guide</i>.
* </p>
*/
public class CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements
Serializable {
/**
* <p>
* The name of the load balancer.
* </p>
*/
private String loadBalancerName;
/**
* <p>
* The name of the policy being created. Policy names must consist of
* alphanumeric characters and dashes (-). This name must be unique within
* the set of policies for this load balancer.
* </p>
*/
private String policyName;
/**
* <p>
* The time period, in seconds, after which the cookie should be considered
* stale. If you do not specify this parameter, the sticky session lasts for
* the duration of the browser session.
* </p>
*/
private Long cookieExpirationPeriod;
/**
* Default constructor for CreateLBCookieStickinessPolicyRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*/
public CreateLBCookieStickinessPolicyRequest() {
}
/**
* Constructs a new CreateLBCookieStickinessPolicyRequest object. Callers
* should use the setter or fluent setter (with...) methods to initialize
* any additional object members.
*
* @param loadBalancerName <p>
* The name of the load balancer.
* </p>
* @param policyName <p>
* The name of the policy being created. Policy names must
* consist of alphanumeric characters and dashes (-). This name
* must be unique within the set of policies for this load
* balancer.
* </p>
*/
public CreateLBCookieStickinessPolicyRequest(String loadBalancerName, String policyName) {
setLoadBalancerName(loadBalancerName);
setPolicyName(policyName);
}
/**
* <p>
* The name of the load balancer.
* </p>
*
* @return <p>
* The name of the load balancer.
* </p>
*/
public String getLoadBalancerName() {
return loadBalancerName;
}
/**
* <p>
* The name of the load balancer.
* </p>
*
* @param loadBalancerName <p>
* The name of the load balancer.
* </p>
*/
public void setLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
* <p>
* The name of the load balancer.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param loadBalancerName <p>
* The name of the load balancer.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public CreateLBCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
return this;
}
/**
* <p>
* The name of the policy being created. Policy names must consist of
* alphanumeric characters and dashes (-). This name must be unique within
* the set of policies for this load balancer.
* </p>
*
* @return <p>
* The name of the policy being created. Policy names must consist
* of alphanumeric characters and dashes (-). This name must be
* unique within the set of policies for this load balancer.
* </p>
*/
public String getPolicyName() {
return policyName;
}
/**
* <p>
* The name of the policy being created. Policy names must consist of
* alphanumeric characters and dashes (-). This name must be unique within
* the set of policies for this load balancer.
* </p>
*
* @param policyName <p>
* The name of the policy being created. Policy names must
* consist of alphanumeric characters and dashes (-). This name
* must be unique within the set of policies for this load
* balancer.
* </p>
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* <p>
* The name of the policy being created. Policy names must consist of
* alphanumeric characters and dashes (-). This name must be unique within
* the set of policies for this load balancer.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param policyName <p>
* The name of the policy being created. Policy names must
* consist of alphanumeric characters and dashes (-). This name
* must be unique within the set of policies for this load
* balancer.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public CreateLBCookieStickinessPolicyRequest withPolicyName(String policyName) {
this.policyName = policyName;
return this;
}
/**
* <p>
* The time period, in seconds, after which the cookie should be considered
* stale. If you do not specify this parameter, the sticky session lasts for
* the duration of the browser session.
* </p>
*
* @return <p>
* The time period, in seconds, after which the cookie should be
* considered stale. If you do not specify this parameter, the
* sticky session lasts for the duration of the browser session.
* </p>
*/
public Long getCookieExpirationPeriod() {
return cookieExpirationPeriod;
}
/**
* <p>
* The time period, in seconds, after which the cookie should be considered
* stale. If you do not specify this parameter, the sticky session lasts for
* the duration of the browser session.
* </p>
*
* @param cookieExpirationPeriod <p>
* The time period, in seconds, after which the cookie should be
* considered stale. If you do not specify this parameter, the
* sticky session lasts for the duration of the browser session.
* </p>
*/
public void setCookieExpirationPeriod(Long cookieExpirationPeriod) {
this.cookieExpirationPeriod = cookieExpirationPeriod;
}
/**
* <p>
* The time period, in seconds, after which the cookie should be considered
* stale. If you do not specify this parameter, the sticky session lasts for
* the duration of the browser session.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param cookieExpirationPeriod <p>
* The time period, in seconds, after which the cookie should be
* considered stale. If you do not specify this parameter, the
* sticky session lasts for the duration of the browser session.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public CreateLBCookieStickinessPolicyRequest withCookieExpirationPeriod(
Long cookieExpirationPeriod) {
this.cookieExpirationPeriod = cookieExpirationPeriod;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLoadBalancerName() != null)
sb.append("LoadBalancerName: " + getLoadBalancerName() + ",");
if (getPolicyName() != null)
sb.append("PolicyName: " + getPolicyName() + ",");
if (getCookieExpirationPeriod() != null)
sb.append("CookieExpirationPeriod: " + getCookieExpirationPeriod());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getLoadBalancerName() == null) ? 0 : getLoadBalancerName().hashCode());
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime
* hashCode
+ ((getCookieExpirationPeriod() == null) ? 0 : getCookieExpirationPeriod()
.hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateLBCookieStickinessPolicyRequest == false)
return false;
CreateLBCookieStickinessPolicyRequest other = (CreateLBCookieStickinessPolicyRequest) obj;
if (other.getLoadBalancerName() == null ^ this.getLoadBalancerName() == null)
return false;
if (other.getLoadBalancerName() != null
&& other.getLoadBalancerName().equals(this.getLoadBalancerName()) == false)
return false;
if (other.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null
&& other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getCookieExpirationPeriod() == null ^ this.getCookieExpirationPeriod() == null)
return false;
if (other.getCookieExpirationPeriod() != null
&& other.getCookieExpirationPeriod().equals(this.getCookieExpirationPeriod()) == false)
return false;
return true;
}
}