com.amazonaws.services.route53resolver.model.ListFirewallRulesRequest Maven / Gradle / Ivy
/*
* Copyright 2018-2023 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.route53resolver.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 ListFirewallRulesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
*
*/
private String firewallRuleGroupId;
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules
* in a rule group by order of priority, starting from the lowest setting.
*
*/
private Integer priority;
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain
* list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
* rule's BlockResponse setting.
*
*
*
*/
private String action;
/**
*
* The maximum number of objects that you want Resolver to return for this request. If more objects are available,
* in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
* the next batch of objects.
*
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*
*/
private Integer maxResults;
/**
*
* For the first call to this list request, omit this value.
*
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
* value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
* request in your next request.
*
*/
private String nextToken;
/**
*
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
*
*
* @param firewallRuleGroupId
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
*/
public void setFirewallRuleGroupId(String firewallRuleGroupId) {
this.firewallRuleGroupId = firewallRuleGroupId;
}
/**
*
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
*
*
* @return The unique identifier of the firewall rule group that you want to retrieve the rules for.
*/
public String getFirewallRuleGroupId() {
return this.firewallRuleGroupId;
}
/**
*
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
*
*
* @param firewallRuleGroupId
* The unique identifier of the firewall rule group that you want to retrieve the rules for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFirewallRulesRequest withFirewallRuleGroupId(String firewallRuleGroupId) {
setFirewallRuleGroupId(firewallRuleGroupId);
return this;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules
* in a rule group by order of priority, starting from the lowest setting.
*
*
* @param priority
* Optional additional filter for the rules to retrieve.
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the
* rules in a rule group by order of priority, starting from the lowest setting.
*/
public void setPriority(Integer priority) {
this.priority = priority;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules
* in a rule group by order of priority, starting from the lowest setting.
*
*
* @return Optional additional filter for the rules to retrieve.
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the
* rules in a rule group by order of priority, starting from the lowest setting.
*/
public Integer getPriority() {
return this.priority;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules
* in a rule group by order of priority, starting from the lowest setting.
*
*
* @param priority
* Optional additional filter for the rules to retrieve.
*
* The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the
* rules in a rule group by order of priority, starting from the lowest setting.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFirewallRulesRequest withPriority(Integer priority) {
setPriority(priority);
return this;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain
* list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
* rule's BlockResponse setting.
*
*
*
*
* @param action
* Optional additional filter for the rules to retrieve.
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's
* domain list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided
* in the rule's BlockResponse setting.
*
*
* @see Action
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain
* list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
* rule's BlockResponse setting.
*
*
*
*
* @return Optional additional filter for the rules to retrieve.
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's
* domain list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided
* in the rule's BlockResponse setting.
*
*
* @see Action
*/
public String getAction() {
return this.action;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain
* list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
* rule's BlockResponse setting.
*
*
*
*
* @param action
* Optional additional filter for the rules to retrieve.
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's
* domain list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided
* in the rule's BlockResponse setting.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Action
*/
public ListFirewallRulesRequest withAction(String action) {
setAction(action);
return this;
}
/**
*
* Optional additional filter for the rules to retrieve.
*
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain
* list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided in the
* rule's BlockResponse setting.
*
*
*
*
* @param action
* Optional additional filter for the rules to retrieve.
*
* The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's
* domain list:
*
*
* -
*
* ALLOW - Permit the request to go through.
*
*
* -
*
* ALERT - Permit the request to go through but send an alert to the logs.
*
*
* -
*
* BLOCK - Disallow the request. If this is specified, additional handling details are provided
* in the rule's BlockResponse setting.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Action
*/
public ListFirewallRulesRequest withAction(Action action) {
this.action = action.toString();
return this;
}
/**
*
* The maximum number of objects that you want Resolver to return for this request. If more objects are available,
* in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
* the next batch of objects.
*
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*
*
* @param maxResults
* The maximum number of objects that you want Resolver to return for this request. If more objects are
* available, in the response, Resolver provides a NextToken value that you can use in a
* subsequent call to get the next batch of objects.
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of objects that you want Resolver to return for this request. If more objects are available,
* in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
* the next batch of objects.
*
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*
*
* @return The maximum number of objects that you want Resolver to return for this request. If more objects are
* available, in the response, Resolver provides a NextToken value that you can use in a
* subsequent call to get the next batch of objects.
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of objects that you want Resolver to return for this request. If more objects are available,
* in the response, Resolver provides a NextToken value that you can use in a subsequent call to get
* the next batch of objects.
*
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
*
*
* @param maxResults
* The maximum number of objects that you want Resolver to return for this request. If more objects are
* available, in the response, Resolver provides a NextToken value that you can use in a
* subsequent call to get the next batch of objects.
*
* If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFirewallRulesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* For the first call to this list request, omit this value.
*
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
* value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
* request in your next request.
*
*
* @param nextToken
* For the first call to this list request, omit this value.
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a
* NextToken value in the response. To retrieve the next batch of objects, use the token that
* was returned for the prior request in your next request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* For the first call to this list request, omit this value.
*
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
* value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
* request in your next request.
*
*
* @return For the first call to this list request, omit this value.
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a
* NextToken value in the response. To retrieve the next batch of objects, use the token that
* was returned for the prior request in your next request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* For the first call to this list request, omit this value.
*
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a NextToken
* value in the response. To retrieve the next batch of objects, use the token that was returned for the prior
* request in your next request.
*
*
* @param nextToken
* For the first call to this list request, omit this value.
*
* When you request a list of objects, Resolver returns at most the number of objects specified in
* MaxResults. If more objects are available for retrieval, Resolver returns a
* NextToken value in the response. To retrieve the next batch of objects, use the token that
* was returned for the prior request in your next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListFirewallRulesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getFirewallRuleGroupId() != null)
sb.append("FirewallRuleGroupId: ").append(getFirewallRuleGroupId()).append(",");
if (getPriority() != null)
sb.append("Priority: ").append(getPriority()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListFirewallRulesRequest == false)
return false;
ListFirewallRulesRequest other = (ListFirewallRulesRequest) obj;
if (other.getFirewallRuleGroupId() == null ^ this.getFirewallRuleGroupId() == null)
return false;
if (other.getFirewallRuleGroupId() != null && other.getFirewallRuleGroupId().equals(this.getFirewallRuleGroupId()) == false)
return false;
if (other.getPriority() == null ^ this.getPriority() == null)
return false;
if (other.getPriority() != null && other.getPriority().equals(this.getPriority()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFirewallRuleGroupId() == null) ? 0 : getFirewallRuleGroupId().hashCode());
hashCode = prime * hashCode + ((getPriority() == null) ? 0 : getPriority().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListFirewallRulesRequest clone() {
return (ListFirewallRulesRequest) super.clone();
}
}