com.amazonaws.services.networkfirewall.model.DescribeRuleGroupResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-networkfirewall 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.networkfirewall.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRuleGroupResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule
* group. The token marks the state of the rule group resource at the time of the request.
*
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
* ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
* with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy
* of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
*
*/
private String updateToken;
/**
*
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule
* group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to
* inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic
* flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy
* in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall
* policy in more than one firewall.
*
*/
private RuleGroup ruleGroup;
/**
*
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can
* retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*/
private RuleGroupResponse ruleGroupResponse;
/**
*
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule
* group. The token marks the state of the rule group resource at the time of the request.
*
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
* ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
* with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy
* of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @param updateToken
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the
* rule group. The token marks the state of the rule group resource at the time of the request.
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
* to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a
* current copy of it with a current token. Reapply your changes as needed, then try the operation again
* using the new token.
*/
public void setUpdateToken(String updateToken) {
this.updateToken = updateToken;
}
/**
*
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule
* group. The token marks the state of the rule group resource at the time of the request.
*
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
* ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
* with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy
* of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @return A token used for optimistic locking. Network Firewall returns a token to your requests that access the
* rule group. The token marks the state of the rule group resource at the time of the request.
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
* to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the
* operation fails with an InvalidTokenException. If this happens, retrieve the rule group
* again to get a current copy of it with a current token. Reapply your changes as needed, then try the
* operation again using the new token.
*/
public String getUpdateToken() {
return this.updateToken;
}
/**
*
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule
* group. The token marks the state of the rule group resource at the time of the request.
*
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
* ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
* with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy
* of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @param updateToken
* A token used for optimistic locking. Network Firewall returns a token to your requests that access the
* rule group. The token marks the state of the rule group resource at the time of the request.
*
* To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
* to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a
* current copy of it with a current token. Reapply your changes as needed, then try the operation again
* using the new token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupResult withUpdateToken(String updateToken) {
setUpdateToken(updateToken);
return this;
}
/**
*
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule
* group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to
* inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic
* flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy
* in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall
* policy in more than one firewall.
*
*
* @param ruleGroup
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the
* rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule
* groups to inspect individual packets and you define stateful rule groups to inspect packets in the context
* of their traffic flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the
* policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a
* firewall policy in more than one firewall.
*/
public void setRuleGroup(RuleGroup ruleGroup) {
this.ruleGroup = ruleGroup;
}
/**
*
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule
* group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to
* inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic
* flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy
* in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall
* policy in more than one firewall.
*
*
* @return The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the
* rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule
* groups to inspect individual packets and you define stateful rule groups to inspect packets in the
* context of their traffic flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the
* policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use
* a firewall policy in more than one firewall.
*/
public RuleGroup getRuleGroup() {
return this.ruleGroup;
}
/**
*
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule
* group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to
* inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic
* flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy
* in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall
* policy in more than one firewall.
*
*
* @param ruleGroup
* The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the
* rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*
* Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule
* groups to inspect individual packets and you define stateful rule groups to inspect packets in the context
* of their traffic flow.
*
*
* To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the
* policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a
* firewall policy in more than one firewall.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupResult withRuleGroup(RuleGroup ruleGroup) {
setRuleGroup(ruleGroup);
return this;
}
/**
*
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can
* retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* @param ruleGroupResponse
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group.
* You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*/
public void setRuleGroupResponse(RuleGroupResponse ruleGroupResponse) {
this.ruleGroupResponse = ruleGroupResponse;
}
/**
*
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can
* retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* @return The high-level properties of a rule group. This, along with the RuleGroup, define the rule group.
* You can retrieve all objects for a rule group by calling DescribeRuleGroup.
*/
public RuleGroupResponse getRuleGroupResponse() {
return this.ruleGroupResponse;
}
/**
*
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can
* retrieve all objects for a rule group by calling DescribeRuleGroup.
*
*
* @param ruleGroupResponse
* The high-level properties of a rule group. This, along with the RuleGroup, define the rule group.
* You can retrieve all objects for a rule group by calling DescribeRuleGroup.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupResult withRuleGroupResponse(RuleGroupResponse ruleGroupResponse) {
setRuleGroupResponse(ruleGroupResponse);
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 (getUpdateToken() != null)
sb.append("UpdateToken: ").append(getUpdateToken()).append(",");
if (getRuleGroup() != null)
sb.append("RuleGroup: ").append(getRuleGroup()).append(",");
if (getRuleGroupResponse() != null)
sb.append("RuleGroupResponse: ").append(getRuleGroupResponse());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRuleGroupResult == false)
return false;
DescribeRuleGroupResult other = (DescribeRuleGroupResult) obj;
if (other.getUpdateToken() == null ^ this.getUpdateToken() == null)
return false;
if (other.getUpdateToken() != null && other.getUpdateToken().equals(this.getUpdateToken()) == false)
return false;
if (other.getRuleGroup() == null ^ this.getRuleGroup() == null)
return false;
if (other.getRuleGroup() != null && other.getRuleGroup().equals(this.getRuleGroup()) == false)
return false;
if (other.getRuleGroupResponse() == null ^ this.getRuleGroupResponse() == null)
return false;
if (other.getRuleGroupResponse() != null && other.getRuleGroupResponse().equals(this.getRuleGroupResponse()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUpdateToken() == null) ? 0 : getUpdateToken().hashCode());
hashCode = prime * hashCode + ((getRuleGroup() == null) ? 0 : getRuleGroup().hashCode());
hashCode = prime * hashCode + ((getRuleGroupResponse() == null) ? 0 : getRuleGroupResponse().hashCode());
return hashCode;
}
@Override
public DescribeRuleGroupResult clone() {
try {
return (DescribeRuleGroupResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}