com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest.java Source code

Java tutorial

Introduction

Here is the source code for com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest.java

Source

/*
 * Copyright 2014-2019 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.cloudwatchevents.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargets" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RemoveTargetsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * <p>
     * The name of the rule.
     * </p>
     */
    private String rule;
    /**
     * <p>
     * The name of the event bus associated with the rule.
     * </p>
     */
    private String eventBusName;
    /**
     * <p>
     * The IDs of the targets to remove from the rule.
     * </p>
     */
    private java.util.List<String> ids;
    /**
     * <p>
     * If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     * <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
     * whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
     * <code>ManagedBy</code> field of the response.
     * </p>
     */
    private Boolean force;

    /**
     * <p>
     * The name of the rule.
     * </p>
     * 
     * @param rule
     *        The name of the rule.
     */

    public void setRule(String rule) {
        this.rule = rule;
    }

    /**
     * <p>
     * The name of the rule.
     * </p>
     * 
     * @return The name of the rule.
     */

    public String getRule() {
        return this.rule;
    }

    /**
     * <p>
     * The name of the rule.
     * </p>
     * 
     * @param rule
     *        The name of the rule.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RemoveTargetsRequest withRule(String rule) {
        setRule(rule);
        return this;
    }

    /**
     * <p>
     * The name of the event bus associated with the rule.
     * </p>
     * 
     * @param eventBusName
     *        The name of the event bus associated with the rule.
     */

    public void setEventBusName(String eventBusName) {
        this.eventBusName = eventBusName;
    }

    /**
     * <p>
     * The name of the event bus associated with the rule.
     * </p>
     * 
     * @return The name of the event bus associated with the rule.
     */

    public String getEventBusName() {
        return this.eventBusName;
    }

    /**
     * <p>
     * The name of the event bus associated with the rule.
     * </p>
     * 
     * @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 RemoveTargetsRequest withEventBusName(String eventBusName) {
        setEventBusName(eventBusName);
        return this;
    }

    /**
     * <p>
     * The IDs of the targets to remove from the rule.
     * </p>
     * 
     * @return The IDs of the targets to remove from the rule.
     */

    public java.util.List<String> getIds() {
        return ids;
    }

    /**
     * <p>
     * The IDs of the targets to remove from the rule.
     * </p>
     * 
     * @param ids
     *        The IDs of the targets to remove from the rule.
     */

    public void setIds(java.util.Collection<String> ids) {
        if (ids == null) {
            this.ids = null;
            return;
        }

        this.ids = new java.util.ArrayList<String>(ids);
    }

    /**
     * <p>
     * The IDs of the targets to remove from the rule.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setIds(java.util.Collection)} or {@link #withIds(java.util.Collection)} if you want to override the
     * existing values.
     * </p>
     * 
     * @param ids
     *        The IDs of the targets to remove from the rule.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RemoveTargetsRequest withIds(String... ids) {
        if (this.ids == null) {
            setIds(new java.util.ArrayList<String>(ids.length));
        }
        for (String ele : ids) {
            this.ids.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * The IDs of the targets to remove from the rule.
     * </p>
     * 
     * @param ids
     *        The IDs of the targets to remove from the rule.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RemoveTargetsRequest withIds(java.util.Collection<String> ids) {
        setIds(ids);
        return this;
    }

    /**
     * <p>
     * If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     * <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
     * whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
     * <code>ManagedBy</code> field of the response.
     * </p>
     * 
     * @param force
     *        If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     *        <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You
     *        can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code>
     *        and checking the <code>ManagedBy</code> field of the response.
     */

    public void setForce(Boolean force) {
        this.force = force;
    }

    /**
     * <p>
     * If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     * <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
     * whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
     * <code>ManagedBy</code> field of the response.
     * </p>
     * 
     * @return If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code>
     *         as <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules.
     *         You can check whether a rule is a managed rule by using <code>DescribeRule</code> or
     *         <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.
     */

    public Boolean getForce() {
        return this.force;
    }

    /**
     * <p>
     * If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     * <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
     * whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
     * <code>ManagedBy</code> field of the response.
     * </p>
     * 
     * @param force
     *        If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     *        <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You
     *        can check whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code>
     *        and checking the <code>ManagedBy</code> field of the response.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public RemoveTargetsRequest withForce(Boolean force) {
        setForce(force);
        return this;
    }

    /**
     * <p>
     * If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code> as
     * <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
     * whether a rule is a managed rule by using <code>DescribeRule</code> or <code>ListRules</code> and checking the
     * <code>ManagedBy</code> field of the response.
     * </p>
     * 
     * @return If this is a managed rule created by an AWS service on your behalf, you must specify <code>Force</code>
     *         as <code>True</code> to remove targets. This parameter is ignored for rules that aren't managed rules.
     *         You can check whether a rule is a managed rule by using <code>DescribeRule</code> or
     *         <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.
     */

    public Boolean isForce() {
        return this.force;
    }

    /**
     * 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 (getRule() != null)
            sb.append("Rule: ").append(getRule()).append(",");
        if (getEventBusName() != null)
            sb.append("EventBusName: ").append(getEventBusName()).append(",");
        if (getIds() != null)
            sb.append("Ids: ").append(getIds()).append(",");
        if (getForce() != null)
            sb.append("Force: ").append(getForce());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof RemoveTargetsRequest == false)
            return false;
        RemoveTargetsRequest other = (RemoveTargetsRequest) obj;
        if (other.getRule() == null ^ this.getRule() == null)
            return false;
        if (other.getRule() != null && other.getRule().equals(this.getRule()) == 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.getIds() == null ^ this.getIds() == null)
            return false;
        if (other.getIds() != null && other.getIds().equals(this.getIds()) == false)
            return false;
        if (other.getForce() == null ^ this.getForce() == null)
            return false;
        if (other.getForce() != null && other.getForce().equals(this.getForce()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode + ((getRule() == null) ? 0 : getRule().hashCode());
        hashCode = prime * hashCode + ((getEventBusName() == null) ? 0 : getEventBusName().hashCode());
        hashCode = prime * hashCode + ((getIds() == null) ? 0 : getIds().hashCode());
        hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode());
        return hashCode;
    }

    @Override
    public RemoveTargetsRequest clone() {
        return (RemoveTargetsRequest) super.clone();
    }

}