com.amazonaws.services.eventbridge.model.DescribeRuleResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-eventbridge 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.eventbridge.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRuleResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The name of the rule.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*/
private String arn;
/**
*
* The event pattern. For more information, see Events and
* Event Patterns in the Amazon EventBridge User Guide .
*
*/
private String eventPattern;
/**
*
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*
*/
private String scheduleExpression;
/**
*
* Specifies whether the rule is enabled or disabled.
*
*/
private String state;
/**
*
* The description of the rule.
*
*/
private String description;
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*/
private String roleArn;
/**
*
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the
* principal name of the Amazon Web Services service that created the rule.
*
*/
private String managedBy;
/**
*
* The name of the event bus associated with the rule.
*
*/
private String eventBusName;
/**
*
* The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus
* in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that
* account. However, the value for CreatedBy is the account ID as the account that created the rule in
* the other account.
*
*/
private String createdBy;
/**
*
* The name of the rule.
*
*
* @param name
* The name of the rule.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the rule.
*
*
* @return The name of the rule.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the rule.
*
*
* @param name
* The name of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the rule.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @return The Amazon Resource Name (ARN) of the rule.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the rule.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The event pattern. For more information, see Events and
* Event Patterns in the Amazon EventBridge User Guide .
*
*
* @param eventPattern
* The event pattern. For more information, see Events
* and Event Patterns in the Amazon EventBridge User Guide .
*/
public void setEventPattern(String eventPattern) {
this.eventPattern = eventPattern;
}
/**
*
* The event pattern. For more information, see Events and
* Event Patterns in the Amazon EventBridge User Guide .
*
*
* @return The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
*/
public String getEventPattern() {
return this.eventPattern;
}
/**
*
* The event pattern. For more information, see Events and
* Event Patterns in the Amazon EventBridge User Guide .
*
*
* @param eventPattern
* The event pattern. For more information, see Events
* and Event Patterns in the Amazon EventBridge User Guide .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withEventPattern(String eventPattern) {
setEventPattern(eventPattern);
return this;
}
/**
*
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*
*
* @param scheduleExpression
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*/
public void setScheduleExpression(String scheduleExpression) {
this.scheduleExpression = scheduleExpression;
}
/**
*
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*
*
* @return The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*/
public String getScheduleExpression() {
return this.scheduleExpression;
}
/**
*
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
*
*
* @param scheduleExpression
* The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withScheduleExpression(String scheduleExpression) {
setScheduleExpression(scheduleExpression);
return this;
}
/**
*
* Specifies whether the rule is enabled or disabled.
*
*
* @param state
* Specifies whether the rule is enabled or disabled.
* @see RuleState
*/
public void setState(String state) {
this.state = state;
}
/**
*
* Specifies whether the rule is enabled or disabled.
*
*
* @return Specifies whether the rule is enabled or disabled.
* @see RuleState
*/
public String getState() {
return this.state;
}
/**
*
* Specifies whether the rule is enabled or disabled.
*
*
* @param state
* Specifies whether the rule is enabled or disabled.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleState
*/
public DescribeRuleResult withState(String state) {
setState(state);
return this;
}
/**
*
* Specifies whether the rule is enabled or disabled.
*
*
* @param state
* Specifies whether the rule is enabled or disabled.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RuleState
*/
public DescribeRuleResult withState(RuleState state) {
this.state = state.toString();
return this;
}
/**
*
* The description of the rule.
*
*
* @param description
* The description of the rule.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the rule.
*
*
* @return The description of the rule.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the rule.
*
*
* @param description
* The description of the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*
* @return The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of the IAM role associated with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the
* principal name of the Amazon Web Services service that created the rule.
*
*
* @param managedBy
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
* the principal name of the Amazon Web Services service that created the rule.
*/
public void setManagedBy(String managedBy) {
this.managedBy = managedBy;
}
/**
*
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the
* principal name of the Amazon Web Services service that created the rule.
*
*
* @return If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
* the principal name of the Amazon Web Services service that created the rule.
*/
public String getManagedBy() {
return this.managedBy;
}
/**
*
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the
* principal name of the Amazon Web Services service that created the rule.
*
*
* @param managedBy
* If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays
* the principal name of the Amazon Web Services service that created the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withManagedBy(String managedBy) {
setManagedBy(managedBy);
return this;
}
/**
*
* The name of the event bus associated with the rule.
*
*
* @param eventBusName
* The name of the event bus associated with the rule.
*/
public void setEventBusName(String eventBusName) {
this.eventBusName = eventBusName;
}
/**
*
* The name of the event bus associated with the rule.
*
*
* @return The name of the event bus associated with the rule.
*/
public String getEventBusName() {
return this.eventBusName;
}
/**
*
* The name of the event bus associated with the rule.
*
*
* @param eventBusName
* The name of the event bus associated with the rule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult withEventBusName(String eventBusName) {
setEventBusName(eventBusName);
return this;
}
/**
*
* The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus
* in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that
* account. However, the value for CreatedBy is the account ID as the account that created the rule in
* the other account.
*
*
* @param createdBy
* The account ID of the user that created the rule. If you use PutRule to put a rule on an
* event bus in another account, the other account is the owner of the rule, and the rule ARN includes the
* account ID for that account. However, the value for CreatedBy is the account ID as the
* account that created the rule in the other account.
*/
public void setCreatedBy(String createdBy) {
this.createdBy = createdBy;
}
/**
*
* The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus
* in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that
* account. However, the value for CreatedBy is the account ID as the account that created the rule in
* the other account.
*
*
* @return The account ID of the user that created the rule. If you use PutRule to put a rule on an
* event bus in another account, the other account is the owner of the rule, and the rule ARN includes the
* account ID for that account. However, the value for CreatedBy is the account ID as the
* account that created the rule in the other account.
*/
public String getCreatedBy() {
return this.createdBy;
}
/**
*
* The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus
* in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that
* account. However, the value for CreatedBy is the account ID as the account that created the rule in
* the other account.
*
*
* @param createdBy
* The account ID of the user that created the rule. If you use PutRule to put a rule on an
* event bus in another account, the other account is the owner of the rule, and the rule ARN includes the
* account ID for that account. However, the value for CreatedBy is the account ID as the
* account that created the rule in the other account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRuleResult 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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getEventPattern() != null)
sb.append("EventPattern: ").append(getEventPattern()).append(",");
if (getScheduleExpression() != null)
sb.append("ScheduleExpression: ").append(getScheduleExpression()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getManagedBy() != null)
sb.append("ManagedBy: ").append(getManagedBy()).append(",");
if (getEventBusName() != null)
sb.append("EventBusName: ").append(getEventBusName()).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 DescribeRuleResult == false)
return false;
DescribeRuleResult other = (DescribeRuleResult) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getEventPattern() == null ^ this.getEventPattern() == null)
return false;
if (other.getEventPattern() != null && other.getEventPattern().equals(this.getEventPattern()) == false)
return false;
if (other.getScheduleExpression() == null ^ this.getScheduleExpression() == null)
return false;
if (other.getScheduleExpression() != null && other.getScheduleExpression().equals(this.getScheduleExpression()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == 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.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getManagedBy() == null ^ this.getManagedBy() == null)
return false;
if (other.getManagedBy() != null && other.getManagedBy().equals(this.getManagedBy()) == false)
return false;
if (other.getEventBusName() == null ^ this.getEventBusName() == null)
return false;
if (other.getEventBusName() != null && other.getEventBusName().equals(this.getEventBusName()) == 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 + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getEventPattern() == null) ? 0 : getEventPattern().hashCode());
hashCode = prime * hashCode + ((getScheduleExpression() == null) ? 0 : getScheduleExpression().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getManagedBy() == null) ? 0 : getManagedBy().hashCode());
hashCode = prime * hashCode + ((getEventBusName() == null) ? 0 : getEventBusName().hashCode());
hashCode = prime * hashCode + ((getCreatedBy() == null) ? 0 : getCreatedBy().hashCode());
return hashCode;
}
@Override
public DescribeRuleResult clone() {
try {
return (DescribeRuleResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}