com.amazonaws.services.logs.model

Class DescribeExportTasksRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeExportTasksRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DescribeExportTasksRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeExportTasksRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Integer	getLimit() The maximum number of items returned.
java.lang.String	getNextToken() The token for the next set of items to return.
java.lang.String	getStatusCode() The status code of the export task.
java.lang.String	getTaskId() The ID of the export task.
int	hashCode()
void	setLimit(java.lang.Integer limit) The maximum number of items returned.
void	setNextToken(java.lang.String nextToken) The token for the next set of items to return.
void	setStatusCode(ExportTaskStatusCode statusCode) The status code of the export task.
void	setStatusCode(java.lang.String statusCode) The status code of the export task.
void	setTaskId(java.lang.String taskId) The ID of the export task.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeExportTasksRequest	withLimit(java.lang.Integer limit) The maximum number of items returned.
DescribeExportTasksRequest	withNextToken(java.lang.String nextToken) The token for the next set of items to return.
DescribeExportTasksRequest	withStatusCode(ExportTaskStatusCode statusCode) The status code of the export task.
DescribeExportTasksRequest	withStatusCode(java.lang.String statusCode) The status code of the export task.
DescribeExportTasksRequest	withTaskId(java.lang.String taskId) The ID of the export task.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeExportTasksRequest

public DescribeExportTasksRequest()

Method Detail

getTaskId

public java.lang.String getTaskId()

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

Constraints:
Length: 1 - 512

Returns:

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

setTaskId

public void setTaskId(java.lang.String taskId)

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

Constraints:
Length: 1 - 512

Parameters:

taskId -

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

withTaskId

public DescribeExportTasksRequest withTaskId(java.lang.String taskId)

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

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

Constraints:
Length: 1 - 512

Parameters:

taskId -

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatusCode

public java.lang.String getStatusCode()

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

Returns:

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

See Also:

ExportTaskStatusCode

setStatusCode

public void setStatusCode(java.lang.String statusCode)

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

Parameters:

statusCode -

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

See Also:

ExportTaskStatusCode

withStatusCode

public DescribeExportTasksRequest withStatusCode(java.lang.String statusCode)

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

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

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

Parameters:

statusCode -

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ExportTaskStatusCode

setStatusCode

public void setStatusCode(ExportTaskStatusCode statusCode)

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

Parameters:

statusCode -

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

See Also:

ExportTaskStatusCode

withStatusCode

public DescribeExportTasksRequest withStatusCode(ExportTaskStatusCode statusCode)

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

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

Constraints:
Allowed Values: CANCELLED, COMPLETED, FAILED, PENDING, PENDING_CANCEL, RUNNING

Parameters:

statusCode -

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

ExportTaskStatusCode

getNextToken

public java.lang.String getNextToken()

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Returns:

The token for the next set of items to return. (You received this token from a previous call.)

setNextToken

public void setNextToken(java.lang.String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Constraints:
Length: 1 -

Parameters:

nextToken -

The token for the next set of items to return. (You received this token from a previous call.)

withNextToken

public DescribeExportTasksRequest withNextToken(java.lang.String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

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

Constraints:
Length: 1 -

Parameters:

nextToken -

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public java.lang.Integer getLimit()

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

Returns:

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

setLimit

public void setLimit(java.lang.Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Constraints:
Range: 1 - 50

Parameters:

limit -

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

withLimit

public DescribeExportTasksRequest withLimit(java.lang.Integer limit)

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

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

Constraints:
Range: 1 - 50

Parameters:

limit -

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object