• Home
• com.amazonaws
• aws-java-sdk-mailmanager
• 1.12.780
• source code
• StartArchiveSearchRequest.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.StartArchiveSearchRequest 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.AmazonWebServiceRequest;

/**
 * 

 * The request to initiate a search across emails in an archive.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartArchiveSearchRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {

    /**
     * 

     * The identifier of the archive to search emails in.
     * 
     */
    private String archiveId;
    /**
     * 

     * Criteria to filter which emails are included in the search results.
     * 
     */
    private ArchiveFilters filters;
    /**
     * 

     * The start timestamp of the range to search emails from.
     * 
     */
    private java.util.Date fromTimestamp;
    /**
     * 

     * The maximum number of search results to return.
     * 
     */
    private Integer maxResults;
    /**
     * 

     * The end timestamp of the range to search emails from.
     * 
     */
    private java.util.Date toTimestamp;

    /**
     * 

     * The identifier of the archive to search emails in.
     * 
     * 
     * @param archiveId
     *        The identifier of the archive to search emails in.
     */

    public void setArchiveId(String archiveId) {
        this.archiveId = archiveId;
    }

    /**
     * 

     * The identifier of the archive to search emails in.
     * 
     * 
     * @return The identifier of the archive to search emails in.
     */

    public String getArchiveId() {
        return this.archiveId;
    }

    /**
     * 

     * The identifier of the archive to search emails in.
     * 
     * 
     * @param archiveId
     *        The identifier of the archive to search emails in.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartArchiveSearchRequest withArchiveId(String archiveId) {
        setArchiveId(archiveId);
        return this;
    }

    /**
     * 

     * Criteria to filter which emails are included in the search results.
     * 
     * 
     * @param filters
     *        Criteria to filter which emails are included in the search results.
     */

    public void setFilters(ArchiveFilters filters) {
        this.filters = filters;
    }

    /**
     * 

     * Criteria to filter which emails are included in the search results.
     * 
     * 
     * @return Criteria to filter which emails are included in the search results.
     */

    public ArchiveFilters getFilters() {
        return this.filters;
    }

    /**
     * 

     * Criteria to filter which emails are included in the search results.
     * 
     * 
     * @param filters
     *        Criteria to filter which emails are included in the search results.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartArchiveSearchRequest withFilters(ArchiveFilters filters) {
        setFilters(filters);
        return this;
    }

    /**
     * 

     * The start timestamp of the range to search emails from.
     * 
     * 
     * @param fromTimestamp
     *        The start timestamp of the range to search emails from.
     */

    public void setFromTimestamp(java.util.Date fromTimestamp) {
        this.fromTimestamp = fromTimestamp;
    }

    /**
     * 

     * The start timestamp of the range to search emails from.
     * 
     * 
     * @return The start timestamp of the range to search emails from.
     */

    public java.util.Date getFromTimestamp() {
        return this.fromTimestamp;
    }

    /**
     * 

     * The start timestamp of the range to search emails from.
     * 
     * 
     * @param fromTimestamp
     *        The start timestamp of the range to search emails from.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartArchiveSearchRequest withFromTimestamp(java.util.Date fromTimestamp) {
        setFromTimestamp(fromTimestamp);
        return this;
    }

    /**
     * 

     * The maximum number of search results to return.
     * 
     * 
     * @param maxResults
     *        The maximum number of search results to return.
     */

    public void setMaxResults(Integer maxResults) {
        this.maxResults = maxResults;
    }

    /**
     * 

     * The maximum number of search results to return.
     * 
     * 
     * @return The maximum number of search results to return.
     */

    public Integer getMaxResults() {
        return this.maxResults;
    }

    /**
     * 

     * The maximum number of search results to return.
     * 
     * 
     * @param maxResults
     *        The maximum number of search results to return.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartArchiveSearchRequest withMaxResults(Integer maxResults) {
        setMaxResults(maxResults);
        return this;
    }

    /**
     * 

     * The end timestamp of the range to search emails from.
     * 
     * 
     * @param toTimestamp
     *        The end timestamp of the range to search emails from.
     */

    public void setToTimestamp(java.util.Date toTimestamp) {
        this.toTimestamp = toTimestamp;
    }

    /**
     * 

     * The end timestamp of the range to search emails from.
     * 
     * 
     * @return The end timestamp of the range to search emails from.
     */

    public java.util.Date getToTimestamp() {
        return this.toTimestamp;
    }

    /**
     * 

     * The end timestamp of the range to search emails from.
     * 
     * 
     * @param toTimestamp
     *        The end timestamp of the range to search emails from.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public StartArchiveSearchRequest withToTimestamp(java.util.Date toTimestamp) {
        setToTimestamp(toTimestamp);
        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 (getArchiveId() != null)
            sb.append("ArchiveId: ").append(getArchiveId()).append(",");
        if (getFilters() != null)
            sb.append("Filters: ").append(getFilters()).append(",");
        if (getFromTimestamp() != null)
            sb.append("FromTimestamp: ").append(getFromTimestamp()).append(",");
        if (getMaxResults() != null)
            sb.append("MaxResults: ").append(getMaxResults()).append(",");
        if (getToTimestamp() != null)
            sb.append("ToTimestamp: ").append(getToTimestamp());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof StartArchiveSearchRequest == false)
            return false;
        StartArchiveSearchRequest other = (StartArchiveSearchRequest) obj;
        if (other.getArchiveId() == null ^ this.getArchiveId() == null)
            return false;
        if (other.getArchiveId() != null && other.getArchiveId().equals(this.getArchiveId()) == false)
            return false;
        if (other.getFilters() == null ^ this.getFilters() == null)
            return false;
        if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
            return false;
        if (other.getFromTimestamp() == null ^ this.getFromTimestamp() == null)
            return false;
        if (other.getFromTimestamp() != null && other.getFromTimestamp().equals(this.getFromTimestamp()) == false)
            return false;
        if (other.getMaxResults() == null ^ this.getMaxResults() == null)
            return false;
        if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
            return false;
        if (other.getToTimestamp() == null ^ this.getToTimestamp() == null)
            return false;
        if (other.getToTimestamp() != null && other.getToTimestamp().equals(this.getToTimestamp()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getArchiveId() == null) ? 0 : getArchiveId().hashCode());
        hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
        hashCode = prime * hashCode + ((getFromTimestamp() == null) ? 0 : getFromTimestamp().hashCode());
        hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
        hashCode = prime * hashCode + ((getToTimestamp() == null) ? 0 : getToTimestamp().hashCode());
        return hashCode;
    }

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

}