com.amazonaws.services.elasticloadbalancingv2.model.ModifyRuleRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticloadbalancingv2 Show documentation
/*
* Copyright 2014-2019 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.elasticloadbalancingv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModifyRuleRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*/
private String ruleArn;
/**
*
* The conditions. Each rule can include zero or one of the following conditions: http-request-method,
* host-header, path-pattern, and source-ip, and zero or more of the
* following conditions: http-header and query-string.
*
*/
private java.util.List conditions;
/**
*
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
*
* If the action type is forward, you specify a target group. The protocol of the target group must be
* HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or
* TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
* user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client requests
* from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
* and return a custom HTTP response.
*
*/
private java.util.List actions;
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) of the rule.
*/
public void setRuleArn(String ruleArn) {
this.ruleArn = ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @return The Amazon Resource Name (ARN) of the rule.
*/
public String getRuleArn() {
return this.ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyRuleRequest withRuleArn(String ruleArn) {
setRuleArn(ruleArn);
return this;
}
/**
*
* The conditions. Each rule can include zero or one of the following conditions: http-request-method,
* host-header, path-pattern, and source-ip, and zero or more of the
* following conditions: http-header and query-string.
*
*
* @return The conditions. Each rule can include zero or one of the following conditions:
* http-request-method, host-header, path-pattern, and
* source-ip, and zero or more of the following conditions: http-header and
* query-string.
*/
public java.util.List getConditions() {
return conditions;
}
/**
*
* The conditions. Each rule can include zero or one of the following conditions: http-request-method,
* host-header, path-pattern, and source-ip, and zero or more of the
* following conditions: http-header and query-string.
*
*
* @param conditions
* The conditions. Each rule can include zero or one of the following conditions:
* http-request-method, host-header, path-pattern, and
* source-ip, and zero or more of the following conditions: http-header and
* query-string.
*/
public void setConditions(java.util.Collection conditions) {
if (conditions == null) {
this.conditions = null;
return;
}
this.conditions = new java.util.ArrayList(conditions);
}
/**
*
* The conditions. Each rule can include zero or one of the following conditions: http-request-method,
* host-header, path-pattern, and source-ip, and zero or more of the
* following conditions: http-header and query-string.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setConditions(java.util.Collection)} or {@link #withConditions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param conditions
* The conditions. Each rule can include zero or one of the following conditions:
* http-request-method, host-header, path-pattern, and
* source-ip, and zero or more of the following conditions: http-header and
* query-string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyRuleRequest withConditions(RuleCondition... conditions) {
if (this.conditions == null) {
setConditions(new java.util.ArrayList(conditions.length));
}
for (RuleCondition ele : conditions) {
this.conditions.add(ele);
}
return this;
}
/**
*
* The conditions. Each rule can include zero or one of the following conditions: http-request-method,
* host-header, path-pattern, and source-ip, and zero or more of the
* following conditions: http-header and query-string.
*
*
* @param conditions
* The conditions. Each rule can include zero or one of the following conditions:
* http-request-method, host-header, path-pattern, and
* source-ip, and zero or more of the following conditions: http-header and
* query-string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyRuleRequest withConditions(java.util.Collection conditions) {
setConditions(conditions);
return this;
}
/**
*
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
*
* If the action type is forward, you specify a target group. The protocol of the target group must be
* HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or
* TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
* user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client requests
* from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
* and return a custom HTTP response.
*
*
* @return The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
* If the action type is forward, you specify a target group. The protocol of the target group
* must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP,
* TLS, UDP, or TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through
* the user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client
* requests from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client
* requests and return a custom HTTP response.
*/
public java.util.List getActions() {
return actions;
}
/**
*
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
*
* If the action type is forward, you specify a target group. The protocol of the target group must be
* HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or
* TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
* user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client requests
* from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
* and return a custom HTTP response.
*
*
* @param actions
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
* If the action type is forward, you specify a target group. The protocol of the target group
* must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
* UDP, or TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through
* the user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client
* requests from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client
* requests and return a custom HTTP response.
*/
public void setActions(java.util.Collection actions) {
if (actions == null) {
this.actions = null;
return;
}
this.actions = new java.util.ArrayList(actions);
}
/**
*
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
*
* If the action type is forward, you specify a target group. The protocol of the target group must be
* HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or
* TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
* user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client requests
* from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
* and return a custom HTTP response.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setActions(java.util.Collection)} or {@link #withActions(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param actions
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
* If the action type is forward, you specify a target group. The protocol of the target group
* must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
* UDP, or TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through
* the user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client
* requests from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client
* requests and return a custom HTTP response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyRuleRequest withActions(Action... actions) {
if (this.actions == null) {
setActions(new java.util.ArrayList(actions.length));
}
for (Action ele : actions) {
this.actions.add(ele);
}
return this;
}
/**
*
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
*
* If the action type is forward, you specify a target group. The protocol of the target group must be
* HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or
* TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
* user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client requests
* from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
* and return a custom HTTP response.
*
*
* @param actions
* The actions. Each rule must include exactly one of the following types of actions: forward,
* fixed-response, or redirect.
*
* If the action type is forward, you specify a target group. The protocol of the target group
* must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
* UDP, or TCP_UDP for a Network Load Balancer.
*
*
* [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
* identity provider that is OpenID Connect (OIDC) compliant.
*
*
* [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through
* the user pools supported by Amazon Cognito.
*
*
* [Application Load Balancer] If the action type is redirect, you redirect specified client
* requests from one URL to another.
*
*
* [Application Load Balancer] If the action type is fixed-response, you drop specified client
* requests and return a custom HTTP response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifyRuleRequest withActions(java.util.Collection actions) {
setActions(actions);
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 (getRuleArn() != null)
sb.append("RuleArn: ").append(getRuleArn()).append(",");
if (getConditions() != null)
sb.append("Conditions: ").append(getConditions()).append(",");
if (getActions() != null)
sb.append("Actions: ").append(getActions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModifyRuleRequest == false)
return false;
ModifyRuleRequest other = (ModifyRuleRequest) obj;
if (other.getRuleArn() == null ^ this.getRuleArn() == null)
return false;
if (other.getRuleArn() != null && other.getRuleArn().equals(this.getRuleArn()) == false)
return false;
if (other.getConditions() == null ^ this.getConditions() == null)
return false;
if (other.getConditions() != null && other.getConditions().equals(this.getConditions()) == false)
return false;
if (other.getActions() == null ^ this.getActions() == null)
return false;
if (other.getActions() != null && other.getActions().equals(this.getActions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRuleArn() == null) ? 0 : getRuleArn().hashCode());
hashCode = prime * hashCode + ((getConditions() == null) ? 0 : getConditions().hashCode());
hashCode = prime * hashCode + ((getActions() == null) ? 0 : getActions().hashCode());
return hashCode;
}
@Override
public ModifyRuleRequest clone() {
return (ModifyRuleRequest) super.clone();
}
}