Package software.amazon.awssdk.services.rds.model

Class DownloadDBLogFilePortionRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.rds.model.DownloadDBLogFilePortionRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DownloadDBLogFilePortionRequest.Builder,DownloadDBLogFilePortionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DownloadDBLogFilePortionRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	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)
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.
static Class<? extends DownloadDBLogFilePortionRequest.Builder>	serializableBuilderClass()
DownloadDBLogFilePortionRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

dbInstanceIdentifier

public String dbInstanceIdentifier()

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Returns:

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

Constraints:

• Must contain from 1 to 63 alphanumeric characters or hyphens

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

logFileName

public String logFileName()

The name of the log file to be downloaded.

Returns:

The name of the log file to be downloaded.

marker

public 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 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 will be 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 is not 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 will be 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 is not 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DownloadDBLogFilePortionRequest.Builder,DownloadDBLogFilePortionRequest>

Returns:

a builder for type T

builder

public static DownloadDBLogFilePortionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object