/*
 * Copyright 2018-2023 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.fms.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * <p>
 * A set of resources to include in a policy.
 * </p>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/fms-2018-01-01/ResourceSet" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResourceSet implements Serializable, Cloneable, StructuredPojo {

    /**
     * <p>
     * A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You
     * provide it to operations like update and delete.
     * </p>
     */
    private String id;
    /**
     * <p>
     * The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     * </p>
     */
    private String name;
    /**
     * <p>
     * A description of the resource set.
     * </p>
     */
    private String description;
    /**
     * <p>
     * An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that
     * access the resource set. The token marks the state of the resource set resource at the time of the request.
     * Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the
     * resource set requires the update token.
     * </p>
     * <p>
     * To make an unconditional change to the resource set, omit the token in your update request. Without the token,
     * Firewall Manager performs your updates regardless of whether the resource set has changed since you last
     * retrieved it.
     * </p>
     * <p>
     * To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses
     * the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the
     * operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the resource set again to
     * get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the
     * new token.
     * </p>
     */
    private String updateToken;
    /**
     * <p>
     * Determines the resources that can be associated to the resource set. Depending on your setting for max results
     * and the number of resource sets, a single call might not return the full list.
     * </p>
     */
    private java.util.List<String> resourceTypeList;
    /**
     * <p>
     * The last time that the resource set was changed.
     * </p>
     */
    private java.util.Date lastUpdateTime;
    /**
     * <p>
     * Indicates whether the resource set is in or out of an admin's Region scope.
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the
     * resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
     * be protected.
     * </p>
     * </li>
     * </ul>
     */
    private String resourceSetStatus;

    /**
     * <p>
     * A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You
     * provide it to operations like update and delete.
     * </p>
     * 
     * @param id
     *        A unique identifier for the resource set. This ID is returned in the responses to create and list
     *        commands. You provide it to operations like update and delete.
     */

    public void setId(String id) {
        this.id = id;
    }

    /**
     * <p>
     * A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You
     * provide it to operations like update and delete.
     * </p>
     * 
     * @return A unique identifier for the resource set. This ID is returned in the responses to create and list
     *         commands. You provide it to operations like update and delete.
     */

    public String getId() {
        return this.id;
    }

    /**
     * <p>
     * A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You
     * provide it to operations like update and delete.
     * </p>
     * 
     * @param id
     *        A unique identifier for the resource set. This ID is returned in the responses to create and list
     *        commands. You provide it to operations like update and delete.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withId(String id) {
        setId(id);
        return this;
    }

    /**
     * <p>
     * The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     * </p>
     * 
     * @param name
     *        The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     */

    public void setName(String name) {
        this.name = name;
    }

    /**
     * <p>
     * The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     * </p>
     * 
     * @return The descriptive name of the resource set. You can't change the name of a resource set after you create
     *         it.
     */

    public String getName() {
        return this.name;
    }

    /**
     * <p>
     * The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     * </p>
     * 
     * @param name
     *        The descriptive name of the resource set. You can't change the name of a resource set after you create it.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withName(String name) {
        setName(name);
        return this;
    }

    /**
     * <p>
     * A description of the resource set.
     * </p>
     * 
     * @param description
     *        A description of the resource set.
     */

    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * <p>
     * A description of the resource set.
     * </p>
     * 
     * @return A description of the resource set.
     */

    public String getDescription() {
        return this.description;
    }

    /**
     * <p>
     * A description of the resource set.
     * </p>
     * 
     * @param description
     *        A description of the resource set.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withDescription(String description) {
        setDescription(description);
        return this;
    }

    /**
     * <p>
     * An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that
     * access the resource set. The token marks the state of the resource set resource at the time of the request.
     * Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the
     * resource set requires the update token.
     * </p>
     * <p>
     * To make an unconditional change to the resource set, omit the token in your update request. Without the token,
     * Firewall Manager performs your updates regardless of whether the resource set has changed since you last
     * retrieved it.
     * </p>
     * <p>
     * To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses
     * the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the
     * operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the resource set again to
     * get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the
     * new token.
     * </p>
     * 
     * @param updateToken
     *        An optional token that you can use for optimistic locking. Firewall Manager returns a token to your
     *        requests that access the resource set. The token marks the state of the resource set resource at the time
     *        of the request. Update tokens are not allowed when creating a resource set. After creation, each
     *        subsequent update call to the resource set requires the update token. </p>
     *        <p>
     *        To make an unconditional change to the resource set, omit the token in your update request. Without the
     *        token, Firewall Manager performs your updates regardless of whether the resource set has changed since you
     *        last retrieved it.
     *        </p>
     *        <p>
     *        To make a conditional change to the resource set, provide the token in your update request. Firewall
     *        Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it
     *        has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the
     *        resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try
     *        the operation again using the new token.
     */

    public void setUpdateToken(String updateToken) {
        this.updateToken = updateToken;
    }

    /**
     * <p>
     * An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that
     * access the resource set. The token marks the state of the resource set resource at the time of the request.
     * Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the
     * resource set requires the update token.
     * </p>
     * <p>
     * To make an unconditional change to the resource set, omit the token in your update request. Without the token,
     * Firewall Manager performs your updates regardless of whether the resource set has changed since you last
     * retrieved it.
     * </p>
     * <p>
     * To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses
     * the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the
     * operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the resource set again to
     * get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the
     * new token.
     * </p>
     * 
     * @return An optional token that you can use for optimistic locking. Firewall Manager returns a token to your
     *         requests that access the resource set. The token marks the state of the resource set resource at the time
     *         of the request. Update tokens are not allowed when creating a resource set. After creation, each
     *         subsequent update call to the resource set requires the update token. </p>
     *         <p>
     *         To make an unconditional change to the resource set, omit the token in your update request. Without the
     *         token, Firewall Manager performs your updates regardless of whether the resource set has changed since
     *         you last retrieved it.
     *         </p>
     *         <p>
     *         To make a conditional change to the resource set, provide the token in your update request. Firewall
     *         Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it
     *         has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve
     *         the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then
     *         try the operation again using the new token.
     */

    public String getUpdateToken() {
        return this.updateToken;
    }

    /**
     * <p>
     * An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that
     * access the resource set. The token marks the state of the resource set resource at the time of the request.
     * Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the
     * resource set requires the update token.
     * </p>
     * <p>
     * To make an unconditional change to the resource set, omit the token in your update request. Without the token,
     * Firewall Manager performs your updates regardless of whether the resource set has changed since you last
     * retrieved it.
     * </p>
     * <p>
     * To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses
     * the token to ensure that the resource set hasn't changed since you last retrieved it. If it has changed, the
     * operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the resource set again to
     * get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the
     * new token.
     * </p>
     * 
     * @param updateToken
     *        An optional token that you can use for optimistic locking. Firewall Manager returns a token to your
     *        requests that access the resource set. The token marks the state of the resource set resource at the time
     *        of the request. Update tokens are not allowed when creating a resource set. After creation, each
     *        subsequent update call to the resource set requires the update token. </p>
     *        <p>
     *        To make an unconditional change to the resource set, omit the token in your update request. Without the
     *        token, Firewall Manager performs your updates regardless of whether the resource set has changed since you
     *        last retrieved it.
     *        </p>
     *        <p>
     *        To make a conditional change to the resource set, provide the token in your update request. Firewall
     *        Manager uses the token to ensure that the resource set hasn't changed since you last retrieved it. If it
     *        has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the
     *        resource set again to get a current copy of it with a new 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 ResourceSet withUpdateToken(String updateToken) {
        setUpdateToken(updateToken);
        return this;
    }

    /**
     * <p>
     * Determines the resources that can be associated to the resource set. Depending on your setting for max results
     * and the number of resource sets, a single call might not return the full list.
     * </p>
     * 
     * @return Determines the resources that can be associated to the resource set. Depending on your setting for max
     *         results and the number of resource sets, a single call might not return the full list.
     */

    public java.util.List<String> getResourceTypeList() {
        return resourceTypeList;
    }

    /**
     * <p>
     * Determines the resources that can be associated to the resource set. Depending on your setting for max results
     * and the number of resource sets, a single call might not return the full list.
     * </p>
     * 
     * @param resourceTypeList
     *        Determines the resources that can be associated to the resource set. Depending on your setting for max
     *        results and the number of resource sets, a single call might not return the full list.
     */

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

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

    /**
     * <p>
     * Determines the resources that can be associated to the resource set. Depending on your setting for max results
     * and the number of resource sets, a single call might not return the full list.
     * </p>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setResourceTypeList(java.util.Collection)} or {@link #withResourceTypeList(java.util.Collection)} if you
     * want to override the existing values.
     * </p>
     * 
     * @param resourceTypeList
     *        Determines the resources that can be associated to the resource set. Depending on your setting for max
     *        results and the number of resource sets, a single call might not return the full list.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withResourceTypeList(String... resourceTypeList) {
        if (this.resourceTypeList == null) {
            setResourceTypeList(new java.util.ArrayList<String>(resourceTypeList.length));
        }
        for (String ele : resourceTypeList) {
            this.resourceTypeList.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * Determines the resources that can be associated to the resource set. Depending on your setting for max results
     * and the number of resource sets, a single call might not return the full list.
     * </p>
     * 
     * @param resourceTypeList
     *        Determines the resources that can be associated to the resource set. Depending on your setting for max
     *        results and the number of resource sets, a single call might not return the full list.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withResourceTypeList(java.util.Collection<String> resourceTypeList) {
        setResourceTypeList(resourceTypeList);
        return this;
    }

    /**
     * <p>
     * The last time that the resource set was changed.
     * </p>
     * 
     * @param lastUpdateTime
     *        The last time that the resource set was changed.
     */

    public void setLastUpdateTime(java.util.Date lastUpdateTime) {
        this.lastUpdateTime = lastUpdateTime;
    }

    /**
     * <p>
     * The last time that the resource set was changed.
     * </p>
     * 
     * @return The last time that the resource set was changed.
     */

    public java.util.Date getLastUpdateTime() {
        return this.lastUpdateTime;
    }

    /**
     * <p>
     * The last time that the resource set was changed.
     * </p>
     * 
     * @param lastUpdateTime
     *        The last time that the resource set was changed.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ResourceSet withLastUpdateTime(java.util.Date lastUpdateTime) {
        setLastUpdateTime(lastUpdateTime);
        return this;
    }

    /**
     * <p>
     * Indicates whether the resource set is in or out of an admin's Region scope.
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the
     * resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
     * be protected.
     * </p>
     * </li>
     * </ul>
     * 
     * @param resourceSetStatus
     *        Indicates whether the resource set is in or out of an admin's Region scope.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or
     *        delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
     *        resource set won't be protected.
     *        </p>
     *        </li>
     * @see ResourceSetStatus
     */

    public void setResourceSetStatus(String resourceSetStatus) {
        this.resourceSetStatus = resourceSetStatus;
    }

    /**
     * <p>
     * Indicates whether the resource set is in or out of an admin's Region scope.
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the
     * resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
     * be protected.
     * </p>
     * </li>
     * </ul>
     * 
     * @return Indicates whether the resource set is in or out of an admin's Region scope.</p>
     *         <ul>
     *         <li>
     *         <p>
     *         <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     *         </p>
     *         </li>
     *         <li>
     *         <p>
     *         <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or
     *         delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
     *         resource set won't be protected.
     *         </p>
     *         </li>
     * @see ResourceSetStatus
     */

    public String getResourceSetStatus() {
        return this.resourceSetStatus;
    }

    /**
     * <p>
     * Indicates whether the resource set is in or out of an admin's Region scope.
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the
     * resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
     * be protected.
     * </p>
     * </li>
     * </ul>
     * 
     * @param resourceSetStatus
     *        Indicates whether the resource set is in or out of an admin's Region scope.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or
     *        delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
     *        resource set won't be protected.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ResourceSetStatus
     */

    public ResourceSet withResourceSetStatus(String resourceSetStatus) {
        setResourceSetStatus(resourceSetStatus);
        return this;
    }

    /**
     * <p>
     * Indicates whether the resource set is in or out of an admin's Region scope.
     * </p>
     * <ul>
     * <li>
     * <p>
     * <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     * </p>
     * </li>
     * <li>
     * <p>
     * <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or delete the
     * resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won't
     * be protected.
     * </p>
     * </li>
     * </ul>
     * 
     * @param resourceSetStatus
     *        Indicates whether the resource set is in or out of an admin's Region scope.</p>
     *        <ul>
     *        <li>
     *        <p>
     *        <code>ACTIVE</code> - The administrator can manage and delete the resource set.
     *        </p>
     *        </li>
     *        <li>
     *        <p>
     *        <code>OUT_OF_ADMIN_SCOPE</code> - The administrator can view the resource set, but they can't edit or
     *        delete the resource set. Existing protections stay in place. Any new resource that come into scope of the
     *        resource set won't be protected.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see ResourceSetStatus
     */

    public ResourceSet withResourceSetStatus(ResourceSetStatus resourceSetStatus) {
        this.resourceSetStatus = resourceSetStatus.toString();
        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 (getId() != null)
            sb.append("Id: ").append(getId()).append(",");
        if (getName() != null)
            sb.append("Name: ").append(getName()).append(",");
        if (getDescription() != null)
            sb.append("Description: ").append(getDescription()).append(",");
        if (getUpdateToken() != null)
            sb.append("UpdateToken: ").append(getUpdateToken()).append(",");
        if (getResourceTypeList() != null)
            sb.append("ResourceTypeList: ").append(getResourceTypeList()).append(",");
        if (getLastUpdateTime() != null)
            sb.append("LastUpdateTime: ").append(getLastUpdateTime()).append(",");
        if (getResourceSetStatus() != null)
            sb.append("ResourceSetStatus: ").append(getResourceSetStatus());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof ResourceSet == false)
            return false;
        ResourceSet other = (ResourceSet) obj;
        if (other.getId() == null ^ this.getId() == null)
            return false;
        if (other.getId() != null && other.getId().equals(this.getId()) == false)
            return false;
        if (other.getName() == null ^ this.getName() == null)
            return false;
        if (other.getName() != null && other.getName().equals(this.getName()) == 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.getUpdateToken() == null ^ this.getUpdateToken() == null)
            return false;
        if (other.getUpdateToken() != null && other.getUpdateToken().equals(this.getUpdateToken()) == false)
            return false;
        if (other.getResourceTypeList() == null ^ this.getResourceTypeList() == null)
            return false;
        if (other.getResourceTypeList() != null && other.getResourceTypeList().equals(this.getResourceTypeList()) == false)
            return false;
        if (other.getLastUpdateTime() == null ^ this.getLastUpdateTime() == null)
            return false;
        if (other.getLastUpdateTime() != null && other.getLastUpdateTime().equals(this.getLastUpdateTime()) == false)
            return false;
        if (other.getResourceSetStatus() == null ^ this.getResourceSetStatus() == null)
            return false;
        if (other.getResourceSetStatus() != null && other.getResourceSetStatus().equals(this.getResourceSetStatus()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
        hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
        hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
        hashCode = prime * hashCode + ((getUpdateToken() == null) ? 0 : getUpdateToken().hashCode());
        hashCode = prime * hashCode + ((getResourceTypeList() == null) ? 0 : getResourceTypeList().hashCode());
        hashCode = prime * hashCode + ((getLastUpdateTime() == null) ? 0 : getLastUpdateTime().hashCode());
        hashCode = prime * hashCode + ((getResourceSetStatus() == null) ? 0 : getResourceSetStatus().hashCode());
        return hashCode;
    }

    @Override
    public ResourceSet clone() {
        try {
            return (ResourceSet) 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.fms.model.transform.ResourceSetMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}