• Home
• com.amazonaws
• aws-java-sdk-mailmanager
• 1.12.780
• source code
• SearchStatus.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.services.mailmanager.model.SearchStatus Maven / Gradle / Ivy

/*
 * 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.mailmanager.model;

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

/**
 * 

 * The current status of an archive search job.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SearchStatus implements Serializable, Cloneable, StructuredPojo {

    /**
     * 

     * The timestamp of when the search completed (if finished).
     * 
     */
    private java.util.Date completionTimestamp;
    /**
     * 

     * An error message if the search failed.
     * 
     */
    private String errorMessage;
    /**
     * 

     * The current state of the search job.
     * 
     */
    private String state;
    /**
     * 

     * The timestamp of when the search was submitted.
     * 
     */
    private java.util.Date submissionTimestamp;

    /**
     * 

     * The timestamp of when the search completed (if finished).
     * 
     * 
     * @param completionTimestamp
     *        The timestamp of when the search completed (if finished).
     */

    public void setCompletionTimestamp(java.util.Date completionTimestamp) {
        this.completionTimestamp = completionTimestamp;
    }

    /**
     * 

     * The timestamp of when the search completed (if finished).
     * 
     * 
     * @return The timestamp of when the search completed (if finished).
     */

    public java.util.Date getCompletionTimestamp() {
        return this.completionTimestamp;
    }

    /**
     * 

     * The timestamp of when the search completed (if finished).
     * 
     * 
     * @param completionTimestamp
     *        The timestamp of when the search completed (if finished).
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SearchStatus withCompletionTimestamp(java.util.Date completionTimestamp) {
        setCompletionTimestamp(completionTimestamp);
        return this;
    }

    /**
     * 

     * An error message if the search failed.
     * 
     * 
     * @param errorMessage
     *        An error message if the search failed.
     */

    public void setErrorMessage(String errorMessage) {
        this.errorMessage = errorMessage;
    }

    /**
     * 

     * An error message if the search failed.
     * 
     * 
     * @return An error message if the search failed.
     */

    public String getErrorMessage() {
        return this.errorMessage;
    }

    /**
     * 

     * An error message if the search failed.
     * 
     * 
     * @param errorMessage
     *        An error message if the search failed.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SearchStatus withErrorMessage(String errorMessage) {
        setErrorMessage(errorMessage);
        return this;
    }

    /**
     * 

     * The current state of the search job.
     * 
     * 
     * @param state
     *        The current state of the search job.
     * @see SearchState
     */

    public void setState(String state) {
        this.state = state;
    }

    /**
     * 

     * The current state of the search job.
     * 
     * 
     * @return The current state of the search job.
     * @see SearchState
     */

    public String getState() {
        return this.state;
    }

    /**
     * 

     * The current state of the search job.
     * 
     * 
     * @param state
     *        The current state of the search job.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SearchState
     */

    public SearchStatus withState(String state) {
        setState(state);
        return this;
    }

    /**
     * 

     * The current state of the search job.
     * 
     * 
     * @param state
     *        The current state of the search job.
     * @return Returns a reference to this object so that method calls can be chained together.
     * @see SearchState
     */

    public SearchStatus withState(SearchState state) {
        this.state = state.toString();
        return this;
    }

    /**
     * 

     * The timestamp of when the search was submitted.
     * 
     * 
     * @param submissionTimestamp
     *        The timestamp of when the search was submitted.
     */

    public void setSubmissionTimestamp(java.util.Date submissionTimestamp) {
        this.submissionTimestamp = submissionTimestamp;
    }

    /**
     * 

     * The timestamp of when the search was submitted.
     * 
     * 
     * @return The timestamp of when the search was submitted.
     */

    public java.util.Date getSubmissionTimestamp() {
        return this.submissionTimestamp;
    }

    /**
     * 

     * The timestamp of when the search was submitted.
     * 
     * 
     * @param submissionTimestamp
     *        The timestamp of when the search was submitted.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public SearchStatus withSubmissionTimestamp(java.util.Date submissionTimestamp) {
        setSubmissionTimestamp(submissionTimestamp);
        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 (getCompletionTimestamp() != null)
            sb.append("CompletionTimestamp: ").append(getCompletionTimestamp()).append(",");
        if (getErrorMessage() != null)
            sb.append("ErrorMessage: ").append(getErrorMessage()).append(",");
        if (getState() != null)
            sb.append("State: ").append(getState()).append(",");
        if (getSubmissionTimestamp() != null)
            sb.append("SubmissionTimestamp: ").append(getSubmissionTimestamp());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof SearchStatus == false)
            return false;
        SearchStatus other = (SearchStatus) obj;
        if (other.getCompletionTimestamp() == null ^ this.getCompletionTimestamp() == null)
            return false;
        if (other.getCompletionTimestamp() != null && other.getCompletionTimestamp().equals(this.getCompletionTimestamp()) == false)
            return false;
        if (other.getErrorMessage() == null ^ this.getErrorMessage() == null)
            return false;
        if (other.getErrorMessage() != null && other.getErrorMessage().equals(this.getErrorMessage()) == 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.getSubmissionTimestamp() == null ^ this.getSubmissionTimestamp() == null)
            return false;
        if (other.getSubmissionTimestamp() != null && other.getSubmissionTimestamp().equals(this.getSubmissionTimestamp()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getCompletionTimestamp() == null) ? 0 : getCompletionTimestamp().hashCode());
        hashCode = prime * hashCode + ((getErrorMessage() == null) ? 0 : getErrorMessage().hashCode());
        hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
        hashCode = prime * hashCode + ((getSubmissionTimestamp() == null) ? 0 : getSubmissionTimestamp().hashCode());
        return hashCode;
    }

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