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

Interface DownloadDbLogFilePortionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>, RdsRequest.Builder, SdkBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DownloadDbLogFilePortionRequest
public static interface DownloadDbLogFilePortionRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DownloadDbLogFilePortionRequest.Builder,DownloadDbLogFilePortionRequest>

  • Method Details

    • dbInstanceIdentifier

      DownloadDbLogFilePortionRequest.Builder dbInstanceIdentifier(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • logFileName

      DownloadDbLogFilePortionRequest.Builder logFileName(String logFileName)

      The name of the log file to be downloaded.

      Parameters:
      logFileName - The name of the log file to be downloaded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      DownloadDbLogFilePortionRequest.Builder marker(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfLines

      DownloadDbLogFilePortionRequest.Builder numberOfLines(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DownloadDbLogFilePortionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DownloadDbLogFilePortionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.