com.amazonaws.services.networkfirewall.model.DescribeRuleGroupMetadataResult 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 DescribeRuleGroupMetadataResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*/
private String ruleGroupArn;
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*/
private String ruleGroupName;
/**
*
* Returns the metadata objects for the specified rule group.
*
*/
private String description;
/**
*
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless
* rules. If it is stateful, it contains stateful rules.
*
*
*
* This setting is required for requests that do not include the RuleGroupARN.
*
*
*/
private String type;
/**
*
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you
* update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy,
* Network Firewall reserves this capacity for the rule group.
*
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
* CreateRuleGroup with DryRun set to TRUE.
*
*/
private Integer capacity;
private StatefulRuleOptions statefulRuleOptions;
/**
*
* The last time that the rule group was changed.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param ruleGroupArn
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public void setRuleGroupArn(String ruleGroupArn) {
this.ruleGroupArn = ruleGroupArn;
}
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @return The descriptive name of the rule group. You can't change the name of a rule group after you create
* it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public String getRuleGroupArn() {
return this.ruleGroupArn;
}
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param ruleGroupArn
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
* You must specify the ARN or the name, and you can specify both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withRuleGroupArn(String ruleGroupArn) {
setRuleGroupArn(ruleGroupArn);
return this;
}
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param ruleGroupName
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public void setRuleGroupName(String ruleGroupName) {
this.ruleGroupName = ruleGroupName;
}
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @return The descriptive name of the rule group. You can't change the name of a rule group after you create
* it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public String getRuleGroupName() {
return this.ruleGroupName;
}
/**
*
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param ruleGroupName
* The descriptive name of the rule group. You can't change the name of a rule group after you create it.
*
* You must specify the ARN or the name, and you can specify both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withRuleGroupName(String ruleGroupName) {
setRuleGroupName(ruleGroupName);
return this;
}
/**
*
* Returns the metadata objects for the specified rule group.
*
*
* @param description
* Returns the metadata objects for the specified rule group.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Returns the metadata objects for the specified rule group.
*
*
* @return Returns the metadata objects for the specified rule group.
*/
public String getDescription() {
return this.description;
}
/**
*
* Returns the metadata objects for the specified rule group.
*
*
* @param description
* Returns the metadata objects for the specified rule group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless
* rules. If it is stateful, it contains stateful rules.
*
*
*
* This setting is required for requests that do not include the RuleGroupARN.
*
*
*
* @param type
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
* stateless rules. If it is stateful, it contains stateful rules.
*
* This setting is required for requests that do not include the RuleGroupARN.
*
* @see RuleGroupType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless
* rules. If it is stateful, it contains stateful rules.
*
*
*
* This setting is required for requests that do not include the RuleGroupARN.
*
*
*
* @return Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
* stateless rules. If it is stateful, it contains stateful rules.
*
* This setting is required for requests that do not include the RuleGroupARN.
*
* @see RuleGroupType
*/
public String getType() {
return this.type;
}
/**
*
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless
* rules. If it is stateful, it contains stateful rules.
*
*
*
* This setting is required for requests that do not include the RuleGroupARN.
*
*
*
* @param type
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
* stateless rules. If it is stateful, it contains stateful rules.
*
* This setting is required for requests that do not include the RuleGroupARN.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleGroupType
*/
public DescribeRuleGroupMetadataResult withType(String type) {
setType(type);
return this;
}
/**
*
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless
* rules. If it is stateful, it contains stateful rules.
*
*
*
* This setting is required for requests that do not include the RuleGroupARN.
*
*
*
* @param type
* Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains
* stateless rules. If it is stateful, it contains stateful rules.
*
* This setting is required for requests that do not include the RuleGroupARN.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleGroupType
*/
public DescribeRuleGroupMetadataResult withType(RuleGroupType type) {
this.type = type.toString();
return this;
}
/**
*
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you
* update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy,
* Network Firewall reserves this capacity for the rule group.
*
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
* CreateRuleGroup with DryRun set to TRUE.
*
*
* @param capacity
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
* When you update a rule group, you are limited to this capacity. When you reference a rule group from a
* firewall policy, Network Firewall reserves this capacity for the rule group.
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by
* calling CreateRuleGroup with DryRun set to TRUE.
*/
public void setCapacity(Integer capacity) {
this.capacity = capacity;
}
/**
*
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you
* update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy,
* Network Firewall reserves this capacity for the rule group.
*
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
* CreateRuleGroup with DryRun set to TRUE.
*
*
* @return The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
* When you update a rule group, you are limited to this capacity. When you reference a rule group from a
* firewall policy, Network Firewall reserves this capacity for the rule group.
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by
* calling CreateRuleGroup with DryRun set to TRUE.
*/
public Integer getCapacity() {
return this.capacity;
}
/**
*
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you
* update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy,
* Network Firewall reserves this capacity for the rule group.
*
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
* CreateRuleGroup with DryRun set to TRUE.
*
*
* @param capacity
* The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
* When you update a rule group, you are limited to this capacity. When you reference a rule group from a
* firewall policy, Network Firewall reserves this capacity for the rule group.
*
* You can retrieve the capacity that would be required for a rule group before you create the rule group by
* calling CreateRuleGroup with DryRun set to TRUE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withCapacity(Integer capacity) {
setCapacity(capacity);
return this;
}
/**
* @param statefulRuleOptions
*/
public void setStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions) {
this.statefulRuleOptions = statefulRuleOptions;
}
/**
* @return
*/
public StatefulRuleOptions getStatefulRuleOptions() {
return this.statefulRuleOptions;
}
/**
* @param statefulRuleOptions
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withStatefulRuleOptions(StatefulRuleOptions statefulRuleOptions) {
setStatefulRuleOptions(statefulRuleOptions);
return this;
}
/**
*
* The last time that the rule group was changed.
*
*
* @param lastModifiedTime
* The last time that the rule group was changed.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* The last time that the rule group was changed.
*
*
* @return The last time that the rule group was changed.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* The last time that the rule group was changed.
*
*
* @param lastModifiedTime
* The last time that the rule group was changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleGroupMetadataResult withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
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 (getRuleGroupArn() != null)
sb.append("RuleGroupArn: ").append(getRuleGroupArn()).append(",");
if (getRuleGroupName() != null)
sb.append("RuleGroupName: ").append(getRuleGroupName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getCapacity() != null)
sb.append("Capacity: ").append(getCapacity()).append(",");
if (getStatefulRuleOptions() != null)
sb.append("StatefulRuleOptions: ").append(getStatefulRuleOptions()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRuleGroupMetadataResult == false)
return false;
DescribeRuleGroupMetadataResult other = (DescribeRuleGroupMetadataResult) obj;
if (other.getRuleGroupArn() == null ^ this.getRuleGroupArn() == null)
return false;
if (other.getRuleGroupArn() != null && other.getRuleGroupArn().equals(this.getRuleGroupArn()) == false)
return false;
if (other.getRuleGroupName() == null ^ this.getRuleGroupName() == null)
return false;
if (other.getRuleGroupName() != null && other.getRuleGroupName().equals(this.getRuleGroupName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getCapacity() == null ^ this.getCapacity() == null)
return false;
if (other.getCapacity() != null && other.getCapacity().equals(this.getCapacity()) == false)
return false;
if (other.getStatefulRuleOptions() == null ^ this.getStatefulRuleOptions() == null)
return false;
if (other.getStatefulRuleOptions() != null && other.getStatefulRuleOptions().equals(this.getStatefulRuleOptions()) == false)
return false;
if (other.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRuleGroupArn() == null) ? 0 : getRuleGroupArn().hashCode());
hashCode = prime * hashCode + ((getRuleGroupName() == null) ? 0 : getRuleGroupName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getCapacity() == null) ? 0 : getCapacity().hashCode());
hashCode = prime * hashCode + ((getStatefulRuleOptions() == null) ? 0 : getStatefulRuleOptions().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
return hashCode;
}
@Override
public DescribeRuleGroupMetadataResult clone() {
try {
return (DescribeRuleGroupMetadataResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}