software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest Maven / Gradle / Ivy
Show all versions of cloudwatchlogs Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.cloudwatchlogs.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeLogStreamsRequest extends CloudWatchLogsRequest implements
ToCopyableBuilder {
private static final SdkField LOG_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("logGroupName").getter(getter(DescribeLogStreamsRequest::logGroupName))
.setter(setter(Builder::logGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logGroupName").build()).build();
private static final SdkField LOG_STREAM_NAME_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("logStreamNamePrefix").getter(getter(DescribeLogStreamsRequest::logStreamNamePrefix))
.setter(setter(Builder::logStreamNamePrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logStreamNamePrefix").build())
.build();
private static final SdkField ORDER_BY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("orderBy").getter(getter(DescribeLogStreamsRequest::orderByAsString)).setter(setter(Builder::orderBy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("orderBy").build()).build();
private static final SdkField DESCENDING_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("descending").getter(getter(DescribeLogStreamsRequest::descending)).setter(setter(Builder::descending))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("descending").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(DescribeLogStreamsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("limit")
.getter(getter(DescribeLogStreamsRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("limit").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOG_GROUP_NAME_FIELD,
LOG_STREAM_NAME_PREFIX_FIELD, ORDER_BY_FIELD, DESCENDING_FIELD, NEXT_TOKEN_FIELD, LIMIT_FIELD));
private final String logGroupName;
private final String logStreamNamePrefix;
private final String orderBy;
private final Boolean descending;
private final String nextToken;
private final Integer limit;
private DescribeLogStreamsRequest(BuilderImpl builder) {
super(builder);
this.logGroupName = builder.logGroupName;
this.logStreamNamePrefix = builder.logStreamNamePrefix;
this.orderBy = builder.orderBy;
this.descending = builder.descending;
this.nextToken = builder.nextToken;
this.limit = builder.limit;
}
/**
*
* The name of the log group.
*
*
* @return The name of the log group.
*/
public final String logGroupName() {
return logGroupName;
}
/**
*
* 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 final String logStreamNamePrefix() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #orderBy} will
* return {@link OrderBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderByAsString}.
*
*
* @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 final OrderBy orderBy() {
return OrderBy.fromValue(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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #orderBy} will
* return {@link OrderBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #orderByAsString}.
*
*
* @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 final String orderByAsString() {
return 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.
*
*
* @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 final Boolean descending() {
return descending;
}
/**
*
* 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 final String nextToken() {
return nextToken;
}
/**
*
* 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 final Integer limit() {
return limit;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(logGroupName());
hashCode = 31 * hashCode + Objects.hashCode(logStreamNamePrefix());
hashCode = 31 * hashCode + Objects.hashCode(orderByAsString());
hashCode = 31 * hashCode + Objects.hashCode(descending());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(limit());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeLogStreamsRequest)) {
return false;
}
DescribeLogStreamsRequest other = (DescribeLogStreamsRequest) obj;
return Objects.equals(logGroupName(), other.logGroupName())
&& Objects.equals(logStreamNamePrefix(), other.logStreamNamePrefix())
&& Objects.equals(orderByAsString(), other.orderByAsString()) && Objects.equals(descending(), other.descending())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(limit(), other.limit());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeLogStreamsRequest").add("LogGroupName", logGroupName())
.add("LogStreamNamePrefix", logStreamNamePrefix()).add("OrderBy", orderByAsString())
.add("Descending", descending()).add("NextToken", nextToken()).add("Limit", limit()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "logGroupName":
return Optional.ofNullable(clazz.cast(logGroupName()));
case "logStreamNamePrefix":
return Optional.ofNullable(clazz.cast(logStreamNamePrefix()));
case "orderBy":
return Optional.ofNullable(clazz.cast(orderByAsString()));
case "descending":
return Optional.ofNullable(clazz.cast(descending()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "limit":
return Optional.ofNullable(clazz.cast(limit()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeLogStreamsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the log group.
*
*
* @param logGroupName
* The name of the log group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logGroupName(String logGroupName);
/**
*
* 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.
*/
Builder logStreamNamePrefix(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.
*
*
* @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
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
Builder orderBy(String 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.
* @see OrderBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see OrderBy
*/
Builder orderBy(OrderBy 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.
*
*
* @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.
*/
Builder descending(Boolean 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.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* 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.
*/
Builder limit(Integer limit);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudWatchLogsRequest.BuilderImpl implements Builder {
private String logGroupName;
private String logStreamNamePrefix;
private String orderBy;
private Boolean descending;
private String nextToken;
private Integer limit;
private BuilderImpl() {
}
private BuilderImpl(DescribeLogStreamsRequest model) {
super(model);
logGroupName(model.logGroupName);
logStreamNamePrefix(model.logStreamNamePrefix);
orderBy(model.orderBy);
descending(model.descending);
nextToken(model.nextToken);
limit(model.limit);
}
public final String getLogGroupName() {
return logGroupName;
}
@Override
public final Builder logGroupName(String logGroupName) {
this.logGroupName = logGroupName;
return this;
}
public final void setLogGroupName(String logGroupName) {
this.logGroupName = logGroupName;
}
public final String getLogStreamNamePrefix() {
return logStreamNamePrefix;
}
@Override
public final Builder logStreamNamePrefix(String logStreamNamePrefix) {
this.logStreamNamePrefix = logStreamNamePrefix;
return this;
}
public final void setLogStreamNamePrefix(String logStreamNamePrefix) {
this.logStreamNamePrefix = logStreamNamePrefix;
}
public final String getOrderBy() {
return orderBy;
}
@Override
public final Builder orderBy(String orderBy) {
this.orderBy = orderBy;
return this;
}
@Override
public final Builder orderBy(OrderBy orderBy) {
this.orderBy(orderBy == null ? null : orderBy.toString());
return this;
}
public final void setOrderBy(String orderBy) {
this.orderBy = orderBy;
}
public final Boolean getDescending() {
return descending;
}
@Override
public final Builder descending(Boolean descending) {
this.descending = descending;
return this;
}
public final void setDescending(Boolean descending) {
this.descending = descending;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Integer getLimit() {
return limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeLogStreamsRequest build() {
return new DescribeLogStreamsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}