All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartArchiveSearchRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  StartArchiveSearchRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StartArchiveSearchRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getArchiveId () The identifier of the archive to search emails in.
  ArchiveFilters	getFilters () Criteria to filter which emails are included in the search results.
  Date	getFromTimestamp () The start timestamp of the range to search emails from.
  Integer	getMaxResults () The maximum number of search results to return.
  Date	getToTimestamp () The end timestamp of the range to search emails from.
  int	hashCode ()
  void	setArchiveId (String archiveId) The identifier of the archive to search emails in.
  void	setFilters (ArchiveFilters filters) Criteria to filter which emails are included in the search results.
  void	setFromTimestamp (Date fromTimestamp) The start timestamp of the range to search emails from.
  void	setMaxResults (Integer maxResults) The maximum number of search results to return.
  void	setToTimestamp (Date toTimestamp) The end timestamp of the range to search emails from.
  String	toString () Returns a string representation of this object.
  StartArchiveSearchRequest	withArchiveId (String archiveId) The identifier of the archive to search emails in.
  StartArchiveSearchRequest	withFilters (ArchiveFilters filters) Criteria to filter which emails are included in the search results.
  StartArchiveSearchRequest	withFromTimestamp (Date fromTimestamp) The start timestamp of the range to search emails from.
  StartArchiveSearchRequest	withMaxResults (Integer maxResults) The maximum number of search results to return.
  StartArchiveSearchRequest	withToTimestamp (Date toTimestamp) The end timestamp of the range to search emails from.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • StartArchiveSearchRequest

    public StartArchiveSearchRequest()

• Method Detail

  • setArchiveId

    public void setArchiveId(String archiveId)

    The identifier of the archive to search emails in.

    Parameters:

    archiveId - The identifier of the archive to search emails in.

  • getArchiveId

    public String getArchiveId()

    The identifier of the archive to search emails in.

    Returns:

    The identifier of the archive to search emails in.

  • withArchiveId

    public StartArchiveSearchRequest withArchiveId(String archiveId)

    The identifier of the archive to search emails in.

    Parameters:

    archiveId - The identifier of the archive to search emails in.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setFilters

    public void setFilters(ArchiveFilters filters)

    Criteria to filter which emails are included in the search results.

    Parameters:

    filters - Criteria to filter which emails are included in the search results.

  • getFilters

    public ArchiveFilters getFilters()

    Criteria to filter which emails are included in the search results.

    Returns:

    Criteria to filter which emails are included in the search results.

  • withFilters

    public StartArchiveSearchRequest withFilters(ArchiveFilters filters)

    Criteria to filter which emails are included in the search results.

    Parameters:

    filters - Criteria to filter which emails are included in the search results.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setFromTimestamp

    public void setFromTimestamp(Date fromTimestamp)

    The start timestamp of the range to search emails from.

    Parameters:

    fromTimestamp - The start timestamp of the range to search emails from.

  • getFromTimestamp

    public Date getFromTimestamp()

    The start timestamp of the range to search emails from.

    Returns:

    The start timestamp of the range to search emails from.

  • withFromTimestamp

    public StartArchiveSearchRequest withFromTimestamp(Date fromTimestamp)

    The start timestamp of the range to search emails from.

    Parameters:

    fromTimestamp - The start timestamp of the range to search emails from.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setMaxResults

    public void setMaxResults(Integer maxResults)

    The maximum number of search results to return.

    Parameters:

    maxResults - The maximum number of search results to return.

  • getMaxResults

    public Integer getMaxResults()

    The maximum number of search results to return.

    Returns:

    The maximum number of search results to return.

  • withMaxResults

    public StartArchiveSearchRequest withMaxResults(Integer maxResults)

    The maximum number of search results to return.

    Parameters:

    maxResults - The maximum number of search results to return.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setToTimestamp

    public void setToTimestamp(Date toTimestamp)

    The end timestamp of the range to search emails from.

    Parameters:

    toTimestamp - The end timestamp of the range to search emails from.

  • getToTimestamp

    public Date getToTimestamp()

    The end timestamp of the range to search emails from.

    Returns:

    The end timestamp of the range to search emails from.

  • withToTimestamp

    public StartArchiveSearchRequest withToTimestamp(Date toTimestamp)

    The end timestamp of the range to search emails from.

    Parameters:

    toTimestamp - The end timestamp of the range to search emails from.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public String toString()

    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.

    Overrides:

    toString in class Object

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public StartArchiveSearchRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()