com.amazonaws.services.macie.model.S3Resource Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-macie Show documentation
The AWS Java SDK for Amazon Macie module holds the client classes that are used for communicating with Amazon Macie Service
There is a newer version: 1.12.591
Show newest version
/*
 * 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.macie.model;

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

/**
 * 
 * Contains information about the S3 resource. This data type is used as a request parameter in the
 * DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and
 * UpdateS3Resources actions.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class S3Resource implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The name of the S3 bucket.
     * 
     */
    private String bucketName;
    /**
     * 
     * The prefix of the S3 bucket.
     * 
     */
    private String prefix;

    /**
     * 
     * The name of the S3 bucket.
     * 
     * 
     * @param bucketName
     *        The name of the S3 bucket.
     */

    public void setBucketName(String bucketName) {
        this.bucketName = bucketName;
    }

    /**
     * 
     * The name of the S3 bucket.
     * 
     * 
     * @return The name of the S3 bucket.
     */

    public String getBucketName() {
        return this.bucketName;
    }

    /**
     * 
     * The name of the S3 bucket.
     * 
     * 
     * @param bucketName
     *        The name of the S3 bucket.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public S3Resource withBucketName(String bucketName) {
        setBucketName(bucketName);
        return this;
    }

    /**
     * 
     * The prefix of the S3 bucket.
     * 
     * 
     * @param prefix
     *        The prefix of the S3 bucket.
     */

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    /**
     * 
     * The prefix of the S3 bucket.
     * 
     * 
     * @return The prefix of the S3 bucket.
     */

    public String getPrefix() {
        return this.prefix;
    }

    /**
     * 
     * The prefix of the S3 bucket.
     * 
     * 
     * @param prefix
     *        The prefix of the S3 bucket.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public S3Resource withPrefix(String prefix) {
        setPrefix(prefix);
        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 (getBucketName() != null)
            sb.append("BucketName: ").append(getBucketName()).append(",");
        if (getPrefix() != null)
            sb.append("Prefix: ").append(getPrefix());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof S3Resource == false)
            return false;
        S3Resource other = (S3Resource) obj;
        if (other.getBucketName() == null ^ this.getBucketName() == null)
            return false;
        if (other.getBucketName() != null && other.getBucketName().equals(this.getBucketName()) == false)
            return false;
        if (other.getPrefix() == null ^ this.getPrefix() == null)
            return false;
        if (other.getPrefix() != null && other.getPrefix().equals(this.getPrefix()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getBucketName() == null) ? 0 : getBucketName().hashCode());
        hashCode = prime * hashCode + ((getPrefix() == null) ? 0 : getPrefix().hashCode());
        return hashCode;
    }

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