CreateExportTaskRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.logs.model.CreateExportTaskRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateExportTaskRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active ( RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateExportTaskRequest()

Constructors
Constructor and Description
`CreateExportTaskRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDestination()` The name of S3 bucket for the exported log data.
`java.lang.String`	`getDestinationPrefix()` The prefix used as the start of the key for every object exported.
`java.lang.Long`	`getFrom()` The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`java.lang.String`	`getLogGroupName()` The name of the log group.
`java.lang.String`	`getLogStreamNamePrefix()` Export only log streams that match the provided prefix.
`java.lang.String`	`getTaskName()` The name of the export task.
`java.lang.Long`	`getTo()` The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`int`	`hashCode()`
`void`	`setDestination(java.lang.String destination)` The name of S3 bucket for the exported log data.
`void`	`setDestinationPrefix(java.lang.String destinationPrefix)` The prefix used as the start of the key for every object exported.
`void`	`setFrom(java.lang.Long from)` The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`void`	`setLogGroupName(java.lang.String logGroupName)` The name of the log group.
`void`	`setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)` Export only log streams that match the provided prefix.
`void`	`setTaskName(java.lang.String taskName)` The name of the export task.
`void`	`setTo(java.lang.Long to)` The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateExportTaskRequest`	`withDestination(java.lang.String destination)` The name of S3 bucket for the exported log data.
`CreateExportTaskRequest`	`withDestinationPrefix(java.lang.String destinationPrefix)` The prefix used as the start of the key for every object exported.
`CreateExportTaskRequest`	`withFrom(java.lang.Long from)` The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`CreateExportTaskRequest`	`withLogGroupName(java.lang.String logGroupName)` The name of the log group.
`CreateExportTaskRequest`	`withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)` Export only log streams that match the provided prefix.
`CreateExportTaskRequest`	`withTaskName(java.lang.String taskName)` The name of the export task.
`CreateExportTaskRequest`	`withTo(java.lang.Long to)` The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

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
  - CreateExportTaskRequest
```
public CreateExportTaskRequest()
```
- Method Detail
  - getTaskName
```
public java.lang.String getTaskName()
```
    The name of the export task.
    
    Constraints:
    Length: 1 - 512
    
    Returns:
    
    The name of the export task.
  - setTaskName
```
public void setTaskName(java.lang.String taskName)
```
    The name of the export task.
    
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    taskName -
    The name of the export task.
  - withTaskName
```
public CreateExportTaskRequest withTaskName(java.lang.String taskName)
```
    The name of the export task.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    taskName -
    The name of the export task.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogGroupName
```
public java.lang.String getLogGroupName()
```
    The name of the log group.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Returns:
    
    The name of the log group.
  - setLogGroupName
```
public void setLogGroupName(java.lang.String logGroupName)
```
    The name of the log group.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Parameters:
    
    logGroupName -
    The name of the log group.
  - withLogGroupName
```
public CreateExportTaskRequest withLogGroupName(java.lang.String logGroupName)
```
    The name of the log group.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Parameters:
    
    logGroupName -
    The name of the log group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogStreamNamePrefix
```
public java.lang.String getLogStreamNamePrefix()
```
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Returns:
    
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
  - setLogStreamNamePrefix
```
public void setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
```
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    logStreamNamePrefix -
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
  - withLogStreamNamePrefix
```
public CreateExportTaskRequest withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)
```
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    logStreamNamePrefix -
    Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFrom
```
public java.lang.Long getFrom()
```
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
  - setFrom
```
public void setFrom(java.lang.Long from)
```
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    from -
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
  - withFrom
```
public CreateExportTaskRequest withFrom(java.lang.Long from)
```
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    from -
    The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp earlier than this time are not exported.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTo
```
public java.lang.Long getTo()
```
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
  - setTo
```
public void setTo(java.lang.Long to)
```
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    to -
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
  - withTo
```
public CreateExportTaskRequest withTo(java.lang.Long to)
```
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    to -
    The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not exported.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDestination
```
public java.lang.String getDestination()
```
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
    
    Constraints:
    Length: 1 - 512
    
    Returns:
    
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
  - setDestination
```
public void setDestination(java.lang.String destination)
```
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
    
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    destination -
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
  - withDestination
```
public CreateExportTaskRequest withDestination(java.lang.String destination)
```
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    
    Parameters:
    
    destination -
    The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDestinationPrefix
```
public java.lang.String getDestinationPrefix()
```
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
    
    Returns:
    
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
  - setDestinationPrefix
```
public void setDestinationPrefix(java.lang.String destinationPrefix)
```
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
    
    Parameters:
    
    destinationPrefix -
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
  - withDestinationPrefix
```
public CreateExportTaskRequest withDestinationPrefix(java.lang.String destinationPrefix)
```
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    destinationPrefix -
    The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.
    
    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

Class CreateExportTaskRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateExportTaskRequest

Method Detail

getTaskName

setTaskName

withTaskName

getLogGroupName

setLogGroupName

withLogGroupName

getLogStreamNamePrefix

setLogStreamNamePrefix

withLogStreamNamePrefix

getFrom

setFrom

withFrom

getTo

setTo

withTo

getDestination

setDestination

withDestination

getDestinationPrefix

setDestinationPrefix

withDestinationPrefix

toString

hashCode

equals