Package software.amazon.awssdk.services.cloudwatchlogs.model

Class CreateExportTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateExportTaskRequest.Builder,CreateExportTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateExportTaskRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<CreateExportTaskRequest.Builder,CreateExportTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateExportTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateExportTaskRequest.Builder	builder()
String	destination()	The name of S3 bucket for the exported log data.
String	destinationPrefix()	The prefix used as the start of the key for every object exported.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logGroupName()	The name of the log group.
String	logStreamNamePrefix()	Export only log streams that match the provided prefix.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateExportTaskRequest.Builder>	serializableBuilderClass()
String	taskName()	The name of the export task.
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.
CreateExportTaskRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

taskName

public final String taskName()

The name of the export task.

Returns:

The name of the export task.

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

logStreamNamePrefix

public final String logStreamNamePrefix()

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

Returns:

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

from

public final 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 timestamp earlier than this time are not exported.

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 timestamp earlier than this time are not exported.

to

public final 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 timestamp later than this time are not exported.

You must specify a time that is not earlier than when this log group was created.

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 timestamp later than this time are not exported.

You must specify a time that is not earlier than when this log group was created.

destination

public final String destination()

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

Returns:

The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.

destinationPrefix

public final 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.

The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes.

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.

The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes.

toBuilder

public CreateExportTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateExportTaskRequest.Builder,CreateExportTaskRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static CreateExportTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateExportTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo