/* * Copyright 2018-2023 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.logs.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 DescribeLogStreamsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The name of the log group. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* */ private String logGroupName; /** *

* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are * using a monitoring account, you must use the log group ARN. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* */ private String logGroupIdentifier; /** *

* The prefix to match. *

*

* If orderBy is LastEventTime, you cannot specify this parameter. *

*/ private String logStreamNamePrefix; /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

*/ private String orderBy; /** *

* If the value is true, results are returned in descending order. If the value is to false, results are returned in * ascending order. The default value is false. *

*/ private Boolean descending; /** *

* The token for the next set of items to return. (You received this token from a previous call.) *

*/ private String nextToken; /** *

* The maximum number of items returned. If you don't specify a value, the default is up to 50 items. *

*/ private Integer limit; /** * Default constructor for DescribeLogStreamsRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize the object after creating it. */ public DescribeLogStreamsRequest() { } /** * Constructs a new DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize any additional object members. * * @param logGroupName * The name of the log group.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

*/ public DescribeLogStreamsRequest(String logGroupName) { setLogGroupName(logGroupName); } /** *

* The name of the log group. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @param logGroupName * The name of the log group.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

*/ public void setLogGroupName(String logGroupName) { this.logGroupName = logGroupName; } /** *

* The name of the log group. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @return The name of the log group.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

*/ public String getLogGroupName() { return this.logGroupName; } /** *

* The name of the log group. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @param logGroupName * The name of the log group.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withLogGroupName(String logGroupName) { setLogGroupName(logGroupName); return this; } /** *

* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are * using a monitoring account, you must use the log group ARN. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @param logGroupIdentifier * Specify either the name or ARN of the log group to view. If the log group is in a source account and you * are using a monitoring account, you must use the log group ARN.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

*/ public void setLogGroupIdentifier(String logGroupIdentifier) { this.logGroupIdentifier = logGroupIdentifier; } /** *

* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are * using a monitoring account, you must use the log group ARN. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @return Specify either the name or ARN of the log group to view. If the log group is in a source account and you * are using a monitoring account, you must use the log group ARN.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

*/ public String getLogGroupIdentifier() { return this.logGroupIdentifier; } /** *

* Specify either the name or ARN of the log group to view. If the log group is in a source account and you are * using a monitoring account, you must use the log group ARN. *

* *

* You must include either logGroupIdentifier or logGroupName, but not both. *

* * * @param logGroupIdentifier * Specify either the name or ARN of the log group to view. If the log group is in a source account and you * are using a monitoring account, you must use the log group ARN.

*

* You must include either logGroupIdentifier or logGroupName, but not both. *

* @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withLogGroupIdentifier(String logGroupIdentifier) { setLogGroupIdentifier(logGroupIdentifier); return this; } /** *

* The prefix to match. *

*

* If orderBy is LastEventTime, you cannot specify this parameter. *

* * @param logStreamNamePrefix * The prefix to match.

*

* If orderBy is LastEventTime, you cannot specify this parameter. */ public void setLogStreamNamePrefix(String logStreamNamePrefix) { this.logStreamNamePrefix = logStreamNamePrefix; } /** *

* The prefix to match. *

*

* If orderBy is LastEventTime, you cannot specify this parameter. *

* * @return The prefix to match.

*

* If orderBy is LastEventTime, you cannot specify this parameter. */ public String getLogStreamNamePrefix() { return this.logStreamNamePrefix; } /** *

* The prefix to match. *

*

* If orderBy is LastEventTime, you cannot specify this parameter. *

* * @param logStreamNamePrefix * The prefix to match.

*

* If orderBy is LastEventTime, you cannot specify this parameter. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withLogStreamNamePrefix(String logStreamNamePrefix) { setLogStreamNamePrefix(logStreamNamePrefix); return this; } /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

* * @param orderBy * If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName.

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in * CloudWatch Logs. This number is expressed as the number of milliseconds after * Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency * basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. * @see OrderBy */ public void setOrderBy(String orderBy) { this.orderBy = orderBy; } /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

* * @return If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName.

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix * parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in * CloudWatch Logs. This number is expressed as the number of milliseconds after * Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency * basis. It typically updates in less than an hour from ingestion, but in rare situations might take * longer. * @see OrderBy */ public String getOrderBy() { return this.orderBy; } /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

* * @param orderBy * If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName.

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in * CloudWatch Logs. This number is expressed as the number of milliseconds after * Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency * basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. * @return Returns a reference to this object so that method calls can be chained together. * @see OrderBy */ public DescribeLogStreamsRequest withOrderBy(String orderBy) { setOrderBy(orderBy); return this; } /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

* * @param orderBy * If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName.

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in * CloudWatch Logs. This number is expressed as the number of milliseconds after * Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency * basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. * @see OrderBy */ public void setOrderBy(OrderBy orderBy) { withOrderBy(orderBy); } /** *

* If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName. *

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch * Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. * lastEventTimestamp updates on an eventual consistency basis. It typically updates in less than an * hour from ingestion, but in rare situations might take longer. *

* * @param orderBy * If the value is LogStreamName, the results are ordered by log stream name. If the value is * LastEventTime, the results are ordered by the event time. The default value is * LogStreamName.

*

* If you order the results by event time, you cannot specify the logStreamNamePrefix parameter. *

*

* lastEventTimestamp represents the time of the most recent log event in the log stream in * CloudWatch Logs. This number is expressed as the number of milliseconds after * Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency * basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer. * @return Returns a reference to this object so that method calls can be chained together. * @see OrderBy */ public DescribeLogStreamsRequest withOrderBy(OrderBy orderBy) { this.orderBy = orderBy.toString(); return this; } /** *

* If the value is true, results are returned in descending order. If the value is to false, results are returned in * ascending order. The default value is false. *

* * @param descending * If the value is true, results are returned in descending order. If the value is to false, results are * returned in ascending order. The default value is false. */ public void setDescending(Boolean descending) { this.descending = descending; } /** *

* If the value is true, results are returned in descending order. If the value is to false, results are returned in * ascending order. The default value is false. *

* * @return If the value is true, results are returned in descending order. If the value is to false, results are * returned in ascending order. The default value is false. */ public Boolean getDescending() { return this.descending; } /** *

* If the value is true, results are returned in descending order. If the value is to false, results are returned in * ascending order. The default value is false. *

* * @param descending * If the value is true, results are returned in descending order. If the value is to false, results are * returned in ascending order. The default value is false. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withDescending(Boolean descending) { setDescending(descending); return this; } /** *

* If the value is true, results are returned in descending order. If the value is to false, results are returned in * ascending order. The default value is false. *

* * @return If the value is true, results are returned in descending order. If the value is to false, results are * returned in ascending order. The default value is false. */ public Boolean isDescending() { return this.descending; } /** *

* The token for the next set of items to return. (You received this token from a previous call.) *

* * @param nextToken * The token for the next set of items to return. (You received this token from a previous call.) */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token for the next set of items to return. (You received this token from a previous call.) *

* * @return The token for the next set of items to return. (You received this token from a previous call.) */ public String getNextToken() { return this.nextToken; } /** *

* The token for the next set of items to return. (You received this token from a previous call.) *

* * @param nextToken * The token for the next set of items to return. (You received this token from a previous call.) * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

* The maximum number of items returned. If you don't specify a value, the default is up to 50 items. *

* * @param limit * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. */ public void setLimit(Integer limit) { this.limit = limit; } /** *

* The maximum number of items returned. If you don't specify a value, the default is up to 50 items. *

* * @return The maximum number of items returned. If you don't specify a value, the default is up to 50 items. */ public Integer getLimit() { return this.limit; } /** *

* The maximum number of items returned. If you don't specify a value, the default is up to 50 items. *

* * @param limit * The maximum number of items returned. If you don't specify a value, the default is up to 50 items. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeLogStreamsRequest withLimit(Integer limit) { setLimit(limit); 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 (getLogGroupName() != null) sb.append("LogGroupName: ").append(getLogGroupName()).append(","); if (getLogGroupIdentifier() != null) sb.append("LogGroupIdentifier: ").append(getLogGroupIdentifier()).append(","); if (getLogStreamNamePrefix() != null) sb.append("LogStreamNamePrefix: ").append(getLogStreamNamePrefix()).append(","); if (getOrderBy() != null) sb.append("OrderBy: ").append(getOrderBy()).append(","); if (getDescending() != null) sb.append("Descending: ").append(getDescending()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getLimit() != null) sb.append("Limit: ").append(getLimit()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeLogStreamsRequest == false) return false; DescribeLogStreamsRequest other = (DescribeLogStreamsRequest) obj; if (other.getLogGroupName() == null ^ this.getLogGroupName() == null) return false; if (other.getLogGroupName() != null && other.getLogGroupName().equals(this.getLogGroupName()) == false) return false; if (other.getLogGroupIdentifier() == null ^ this.getLogGroupIdentifier() == null) return false; if (other.getLogGroupIdentifier() != null && other.getLogGroupIdentifier().equals(this.getLogGroupIdentifier()) == false) return false; if (other.getLogStreamNamePrefix() == null ^ this.getLogStreamNamePrefix() == null) return false; if (other.getLogStreamNamePrefix() != null && other.getLogStreamNamePrefix().equals(this.getLogStreamNamePrefix()) == false) return false; if (other.getOrderBy() == null ^ this.getOrderBy() == null) return false; if (other.getOrderBy() != null && other.getOrderBy().equals(this.getOrderBy()) == false) return false; if (other.getDescending() == null ^ this.getDescending() == null) return false; if (other.getDescending() != null && other.getDescending().equals(this.getDescending()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getLimit() == null ^ this.getLimit() == null) return false; if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getLogGroupName() == null) ? 0 : getLogGroupName().hashCode()); hashCode = prime * hashCode + ((getLogGroupIdentifier() == null) ? 0 : getLogGroupIdentifier().hashCode()); hashCode = prime * hashCode + ((getLogStreamNamePrefix() == null) ? 0 : getLogStreamNamePrefix().hashCode()); hashCode = prime * hashCode + ((getOrderBy() == null) ? 0 : getOrderBy().hashCode()); hashCode = prime * hashCode + ((getDescending() == null) ? 0 : getDescending().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode()); return hashCode; } @Override public DescribeLogStreamsRequest clone() { return (DescribeLogStreamsRequest) super.clone(); } }