com.amazonaws.services.rds.model.DownloadDBLogFilePortionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-rds Show documentation
/*
* Copyright 2016-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.rds.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DownloadDBLogFilePortionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*
*/
private String dBInstanceIdentifier;
/**
*
* The name of the log file to be downloaded.
*
*/
private String logFileName;
/**
*
* 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.
*
*/
private String marker;
/**
*
* 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.
*
*
*
*/
private Integer numberOfLines;
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setDBInstanceIdentifier(String dBInstanceIdentifier) {
this.dBInstanceIdentifier = 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.
*
*
*
*
* @return 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.
*
*
*/
public String getDBInstanceIdentifier() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DownloadDBLogFilePortionRequest withDBInstanceIdentifier(String dBInstanceIdentifier) {
setDBInstanceIdentifier(dBInstanceIdentifier);
return this;
}
/**
*
* The name of the log file to be downloaded.
*
*
* @param logFileName
* The name of the log file to be downloaded.
*/
public void setLogFileName(String logFileName) {
this.logFileName = logFileName;
}
/**
*
* The name of the log file to be downloaded.
*
*
* @return The name of the log file to be downloaded.
*/
public String getLogFileName() {
return this.logFileName;
}
/**
*
* The name of the log file to be downloaded.
*
*
* @param logFileName
* The name of the log file to be downloaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DownloadDBLogFilePortionRequest withLogFileName(String logFileName) {
setLogFileName(logFileName);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setMarker(String marker) {
this.marker = 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.
*
*
* @return 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.
*/
public String getMarker() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DownloadDBLogFilePortionRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setNumberOfLines(Integer numberOfLines) {
this.numberOfLines = 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.
*
*
*
*
* @return 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.
*
*
*/
public Integer getNumberOfLines() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DownloadDBLogFilePortionRequest withNumberOfLines(Integer numberOfLines) {
setNumberOfLines(numberOfLines);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDBInstanceIdentifier() != null)
sb.append("DBInstanceIdentifier: ").append(getDBInstanceIdentifier()).append(",");
if (getLogFileName() != null)
sb.append("LogFileName: ").append(getLogFileName()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getNumberOfLines() != null)
sb.append("NumberOfLines: ").append(getNumberOfLines());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DownloadDBLogFilePortionRequest == false)
return false;
DownloadDBLogFilePortionRequest other = (DownloadDBLogFilePortionRequest) obj;
if (other.getDBInstanceIdentifier() == null ^ this.getDBInstanceIdentifier() == null)
return false;
if (other.getDBInstanceIdentifier() != null && other.getDBInstanceIdentifier().equals(this.getDBInstanceIdentifier()) == false)
return false;
if (other.getLogFileName() == null ^ this.getLogFileName() == null)
return false;
if (other.getLogFileName() != null && other.getLogFileName().equals(this.getLogFileName()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getNumberOfLines() == null ^ this.getNumberOfLines() == null)
return false;
if (other.getNumberOfLines() != null && other.getNumberOfLines().equals(this.getNumberOfLines()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBInstanceIdentifier() == null) ? 0 : getDBInstanceIdentifier().hashCode());
hashCode = prime * hashCode + ((getLogFileName() == null) ? 0 : getLogFileName().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getNumberOfLines() == null) ? 0 : getNumberOfLines().hashCode());
return hashCode;
}
@Override
public DownloadDBLogFilePortionRequest clone() {
return (DownloadDBLogFilePortionRequest) super.clone();
}
}