com.amazonaws.services.securityhub.model.AutomationRulesMetadata Maven / Gradle / Ivy
Show all versions of aws-java-sdk-securityhub 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.securityhub.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Metadata for automation rules in the calling account. The response includes rules with a RuleStatus of
* ENABLED and DISABLED.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AutomationRulesMetadata implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) for the rule.
*
*/
private String ruleArn;
/**
*
* Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use
* BatchUpdateAutomationRules .
*
*/
private String ruleStatus;
/**
*
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
*
*/
private Integer ruleOrder;
/**
*
* The name of the rule.
*
*/
private String ruleName;
/**
*
* A description of the rule.
*
*/
private String description;
/**
*
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
*
*/
private Boolean isTerminal;
/**
*
* A timestamp that indicates when the rule was created.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*/
private java.util.Date createdAt;
/**
*
* A timestamp that indicates when the rule was most recently updated.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*/
private java.util.Date updatedAt;
/**
*
* The principal that created a rule.
*
*/
private String createdBy;
/**
*
* The Amazon Resource Name (ARN) for the rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) for the rule.
*/
public void setRuleArn(String ruleArn) {
this.ruleArn = ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) for the rule.
*
*
* @return The Amazon Resource Name (ARN) for the rule.
*/
public String getRuleArn() {
return this.ruleArn;
}
/**
*
* The Amazon Resource Name (ARN) for the rule.
*
*
* @param ruleArn
* The Amazon Resource Name (ARN) for the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withRuleArn(String ruleArn) {
setRuleArn(ruleArn);
return this;
}
/**
*
* Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use
* BatchUpdateAutomationRules .
*
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to ENABLED,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use
* BatchUpdateAutomationRules .
* @see RuleStatus
*/
public void setRuleStatus(String ruleStatus) {
this.ruleStatus = ruleStatus;
}
/**
*
* Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use
* BatchUpdateAutomationRules .
*
*
* @return Whether the rule is active after it is created. If this parameter is equal to ENABLED,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To
* change the value of this parameter after creating a rule, use
* BatchUpdateAutomationRules .
* @see RuleStatus
*/
public String getRuleStatus() {
return this.ruleStatus;
}
/**
*
* Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use
* BatchUpdateAutomationRules .
*
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to ENABLED,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use
* BatchUpdateAutomationRules .
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleStatus
*/
public AutomationRulesMetadata withRuleStatus(String ruleStatus) {
setRuleStatus(ruleStatus);
return this;
}
/**
*
* Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub
* starts applying the rule to findings and finding updates after the rule is created. To change the value of this
* parameter after creating a rule, use
* BatchUpdateAutomationRules .
*
*
* @param ruleStatus
* Whether the rule is active after it is created. If this parameter is equal to ENABLED,
* Security Hub starts applying the rule to findings and finding updates after the rule is created. To change
* the value of this parameter after creating a rule, use
* BatchUpdateAutomationRules .
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleStatus
*/
public AutomationRulesMetadata withRuleStatus(RuleStatus ruleStatus) {
this.ruleStatus = ruleStatus.toString();
return this;
}
/**
*
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
*
*
* @param ruleOrder
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
*/
public void setRuleOrder(Integer ruleOrder) {
this.ruleOrder = ruleOrder;
}
/**
*
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
*
*
* @return An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
*/
public Integer getRuleOrder() {
return this.ruleOrder;
}
/**
*
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings.
* Security Hub applies rules with lower values for this parameter first.
*
*
* @param ruleOrder
* An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to
* findings. Security Hub applies rules with lower values for this parameter first.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withRuleOrder(Integer ruleOrder) {
setRuleOrder(ruleOrder);
return this;
}
/**
*
* The name of the rule.
*
*
* @param ruleName
* The name of the rule.
*/
public void setRuleName(String ruleName) {
this.ruleName = ruleName;
}
/**
*
* The name of the rule.
*
*
* @return The name of the rule.
*/
public String getRuleName() {
return this.ruleName;
}
/**
*
* The name of the rule.
*
*
* @param ruleName
* The name of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withRuleName(String ruleName) {
setRuleName(ruleName);
return this;
}
/**
*
* A description of the rule.
*
*
* @param description
* A description of the rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description of the rule.
*
*
* @return A description of the rule.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description of the rule.
*
*
* @param description
* A description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
*
*
* @param isTerminal
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public void setIsTerminal(Boolean isTerminal) {
this.isTerminal = isTerminal;
}
/**
*
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
*
*
* @return Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public Boolean getIsTerminal() {
return this.isTerminal;
}
/**
*
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
*
*
* @param isTerminal
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withIsTerminal(Boolean isTerminal) {
setIsTerminal(isTerminal);
return this;
}
/**
*
* Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This
* is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule
* is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't
* evaluate other rules for the finding. By default, a rule isn't terminal.
*
*
* @return Specifies whether a rule is the last to be applied with respect to a finding that matches the rule
* criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has
* different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches
* the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
*/
public Boolean isTerminal() {
return this.isTerminal;
}
/**
*
* A timestamp that indicates when the rule was created.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @param createdAt
* A timestamp that indicates when the rule was created.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* A timestamp that indicates when the rule was created.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @return A timestamp that indicates when the rule was created.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* A timestamp that indicates when the rule was created.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @param createdAt
* A timestamp that indicates when the rule was created.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* A timestamp that indicates when the rule was most recently updated.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @param updatedAt
* A timestamp that indicates when the rule was most recently updated.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
*/
public void setUpdatedAt(java.util.Date updatedAt) {
this.updatedAt = updatedAt;
}
/**
*
* A timestamp that indicates when the rule was most recently updated.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @return A timestamp that indicates when the rule was most recently updated.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
*/
public java.util.Date getUpdatedAt() {
return this.updatedAt;
}
/**
*
* A timestamp that indicates when the rule was most recently updated.
*
*
* Uses the date-time format specified in RFC
* 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example,
* 2020-03-22T13:22:13.933Z.
*
*
* @param updatedAt
* A timestamp that indicates when the rule was most recently updated.
*
* Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time
* Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withUpdatedAt(java.util.Date updatedAt) {
setUpdatedAt(updatedAt);
return this;
}
/**
*
* The principal that created a rule.
*
*
* @param createdBy
* The principal that created a rule.
*/
public void setCreatedBy(String createdBy) {
this.createdBy = createdBy;
}
/**
*
* The principal that created a rule.
*
*
* @return The principal that created a rule.
*/
public String getCreatedBy() {
return this.createdBy;
}
/**
*
* The principal that created a rule.
*
*
* @param createdBy
* The principal that created a rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AutomationRulesMetadata withCreatedBy(String createdBy) {
setCreatedBy(createdBy);
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 (getRuleStatus() != null)
sb.append("RuleStatus: ").append(getRuleStatus()).append(",");
if (getRuleOrder() != null)
sb.append("RuleOrder: ").append(getRuleOrder()).append(",");
if (getRuleName() != null)
sb.append("RuleName: ").append(getRuleName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getIsTerminal() != null)
sb.append("IsTerminal: ").append(getIsTerminal()).append(",");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getUpdatedAt() != null)
sb.append("UpdatedAt: ").append(getUpdatedAt()).append(",");
if (getCreatedBy() != null)
sb.append("CreatedBy: ").append(getCreatedBy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AutomationRulesMetadata == false)
return false;
AutomationRulesMetadata other = (AutomationRulesMetadata) obj;
if (other.getRuleArn() == null ^ this.getRuleArn() == null)
return false;
if (other.getRuleArn() != null && other.getRuleArn().equals(this.getRuleArn()) == false)
return false;
if (other.getRuleStatus() == null ^ this.getRuleStatus() == null)
return false;
if (other.getRuleStatus() != null && other.getRuleStatus().equals(this.getRuleStatus()) == false)
return false;
if (other.getRuleOrder() == null ^ this.getRuleOrder() == null)
return false;
if (other.getRuleOrder() != null && other.getRuleOrder().equals(this.getRuleOrder()) == false)
return false;
if (other.getRuleName() == null ^ this.getRuleName() == null)
return false;
if (other.getRuleName() != null && other.getRuleName().equals(this.getRuleName()) == 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.getIsTerminal() == null ^ this.getIsTerminal() == null)
return false;
if (other.getIsTerminal() != null && other.getIsTerminal().equals(this.getIsTerminal()) == false)
return false;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getUpdatedAt() == null ^ this.getUpdatedAt() == null)
return false;
if (other.getUpdatedAt() != null && other.getUpdatedAt().equals(this.getUpdatedAt()) == false)
return false;
if (other.getCreatedBy() == null ^ this.getCreatedBy() == null)
return false;
if (other.getCreatedBy() != null && other.getCreatedBy().equals(this.getCreatedBy()) == 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 + ((getRuleStatus() == null) ? 0 : getRuleStatus().hashCode());
hashCode = prime * hashCode + ((getRuleOrder() == null) ? 0 : getRuleOrder().hashCode());
hashCode = prime * hashCode + ((getRuleName() == null) ? 0 : getRuleName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getIsTerminal() == null) ? 0 : getIsTerminal().hashCode());
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getUpdatedAt() == null) ? 0 : getUpdatedAt().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
return hashCode;
}
@Override
public AutomationRulesMetadata clone() {
try {
return (AutomationRulesMetadata) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.securityhub.model.transform.AutomationRulesMetadataMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}