software.amazon.awssdk.services.rds.model

Class DownloadDbLogFilePortionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rds.model.RdsRequest

software.amazon.awssdk.services.rds.model.DownloadDbLogFilePortionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DownloadDbLogFilePortionRequest
extends RdsRequest
implements ToCopyableBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DownloadDbLogFilePortionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DownloadDbLogFilePortionRequest.Builder	builder()
String	dbInstanceIdentifier() The customer-assigned name of the DB instance that contains the log files you want to list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	logFileName() The name of the log file to be downloaded.
String	marker() The pagination token provided in the previous request or "0".
Integer	numberOfLines() The number of lines to download.
List<SdkField<?>>	sdkFields()
static Class<? extends DownloadDbLogFilePortionRequest.Builder>	serializableBuilderClass()
DownloadDbLogFilePortionRequest.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

dbInstanceIdentifier

public final String dbInstanceIdentifier()

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

• Must match the identifier of an existing DBInstance.

Returns:

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

• Must match the identifier of an existing DBInstance.

logFileName

public final String logFileName()

The name of the log file to be downloaded.

Returns:

The name of the log file to be downloaded.

marker

public final String marker()

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

Returns:

The pagination token provided in the previous request or "0". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

numberOfLines

public final Integer numberOfLines()

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

• If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

• If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.

• If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

• You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

Returns:

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

• If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

• If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.

• If Marker is specified as "0", then the specified number of lines from the beginning of the log file are returned.

• You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of "0" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

toBuilder

public DownloadDbLogFilePortionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>

Specified by:

toBuilder in class RdsRequest

builder

public static DownloadDbLogFilePortionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DownloadDbLogFilePortionRequest.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