com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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;
/**
* Container for the parameters to the {@link com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest) CreateAppCookieStickinessPolicy operation}.
*
* Generates a stickiness policy with sticky session lifetimes that
* follow that of an application-generated cookie. This policy can be
* associated only with HTTP/HTTPS listeners.
*
*
* This policy is similar to the policy created by
* CreateLBCookieStickinessPolicy, except that the lifetime of the
* special Elastic Load Balancing cookie follows the lifetime of the
* application-generated cookie specified in the policy configuration.
* The load balancer only inserts a new stickiness cookie when the
* application response includes a new application cookie.
*
*
* If the application cookie is explicitly removed or expires, the
* session stops being sticky until a new application cookie is issued.
*
*
* NOTE: An application client must receive and send two cookies:
* the application-generated cookie and the special Elastic Load
* Balancing cookie named AWSELB. This is the default behavior for many
* common web browsers.
*
*
* For more information, see
* Enabling Application-Controlled Session Stickiness
* in the Elastic Load Balancing Developer Guide .
*
*
* @see com.amazonaws.services.elasticloadbalancing.AmazonElasticLoadBalancing#createAppCookieStickinessPolicy(CreateAppCookieStickinessPolicyRequest)
*/
public class CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the load balancer.
*/
private String loadBalancerName;
/**
* The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*/
private String policyName;
/**
* Name of the application cookie used for stickiness.
*/
private String cookieName;
/**
* Default constructor for a new CreateAppCookieStickinessPolicyRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public CreateAppCookieStickinessPolicyRequest() {}
/**
* Constructs a new CreateAppCookieStickinessPolicyRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param loadBalancerName The name of the load balancer.
* @param policyName The name of the policy being created. The name must
* be unique within the set of policies for this load balancer.
* @param cookieName Name of the application cookie used for stickiness.
*/
public CreateAppCookieStickinessPolicyRequest(String loadBalancerName, String policyName, String cookieName) {
setLoadBalancerName(loadBalancerName);
setPolicyName(policyName);
setCookieName(cookieName);
}
/**
* The name of the load balancer.
*
* @return The name of the load balancer.
*/
public String getLoadBalancerName() {
return loadBalancerName;
}
/**
* The name of the load balancer.
*
* @param loadBalancerName The name of the load balancer.
*/
public void setLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
}
/**
* The name of the load balancer.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param loadBalancerName The name of the load balancer.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateAppCookieStickinessPolicyRequest withLoadBalancerName(String loadBalancerName) {
this.loadBalancerName = loadBalancerName;
return this;
}
/**
* The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*
* @return The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*/
public String getPolicyName() {
return policyName;
}
/**
* The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*
* @param policyName The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param policyName The name of the policy being created. The name must be unique within
* the set of policies for this load balancer.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateAppCookieStickinessPolicyRequest withPolicyName(String policyName) {
this.policyName = policyName;
return this;
}
/**
* Name of the application cookie used for stickiness.
*
* @return Name of the application cookie used for stickiness.
*/
public String getCookieName() {
return cookieName;
}
/**
* Name of the application cookie used for stickiness.
*
* @param cookieName Name of the application cookie used for stickiness.
*/
public void setCookieName(String cookieName) {
this.cookieName = cookieName;
}
/**
* Name of the application cookie used for stickiness.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param cookieName Name of the application cookie used for stickiness.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public CreateAppCookieStickinessPolicyRequest withCookieName(String cookieName) {
this.cookieName = cookieName;
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 (getCookieName() != null) sb.append("CookieName: " + getCookieName() );
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 + ((getCookieName() == null) ? 0 : getCookieName().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof CreateAppCookieStickinessPolicyRequest == false) return false;
CreateAppCookieStickinessPolicyRequest other = (CreateAppCookieStickinessPolicyRequest)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.getCookieName() == null ^ this.getCookieName() == null) return false;
if (other.getCookieName() != null && other.getCookieName().equals(this.getCookieName()) == false) return false;
return true;
}
}