Class DescribeLogStreamsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.logs.model.DescribeLogStreamsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
See Also:
  • Constructor Details

    • DescribeLogStreamsRequest

      public DescribeLogStreamsRequest()
      Default constructor for DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
    • DescribeLogStreamsRequest

      public DescribeLogStreamsRequest(String logGroupName)
      Constructs a new DescribeLogStreamsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      logGroupName - The log group name for which log streams are to be listed.
  • Method Details

    • setLogGroupName

      public void setLogGroupName(String logGroupName)

      The log group name for which log streams are to be listed.

      Parameters:
      logGroupName - The log group name for which log streams are to be listed.
    • getLogGroupName

      public String getLogGroupName()

      The log group name for which log streams are to be listed.

      Returns:
      The log group name for which log streams are to be listed.
    • withLogGroupName

      public DescribeLogStreamsRequest withLogGroupName(String logGroupName)

      The log group name for which log streams are to be listed.

      Parameters:
      logGroupName - The log group name for which log streams are to be listed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLogStreamNamePrefix

      public void setLogStreamNamePrefix(String logStreamNamePrefix)

      Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

      Parameters:
      logStreamNamePrefix - Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
    • getLogStreamNamePrefix

      public String getLogStreamNamePrefix()

      Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

      Returns:
      Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
    • withLogStreamNamePrefix

      public DescribeLogStreamsRequest withLogStreamNamePrefix(String logStreamNamePrefix)

      Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.

      Parameters:
      logStreamNamePrefix - Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setOrderBy

      public void setOrderBy(String orderBy)

      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

      Parameters:
      orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
      See Also:
    • getOrderBy

      public String getOrderBy()

      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

      Returns:
      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
      See Also:
    • withOrderBy

      public DescribeLogStreamsRequest withOrderBy(String orderBy)

      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

      Parameters:
      orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setOrderBy

      public void setOrderBy(OrderBy orderBy)

      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

      Parameters:
      orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
      See Also:
    • withOrderBy

      public DescribeLogStreamsRequest withOrderBy(OrderBy orderBy)

      Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.

      Parameters:
      orderBy - Specifies what to order the returned log streams by. Valid arguments are 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results are ordered by LogStreamName. If 'LastEventTime' is chosen, the request cannot also contain a logStreamNamePrefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • setDescending

      public void setDescending(Boolean descending)

      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

      Parameters:
      descending - If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
    • getDescending

      public Boolean getDescending()

      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

      Returns:
      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
    • withDescending

      public DescribeLogStreamsRequest withDescending(Boolean descending)

      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

      Parameters:
      descending - If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isDescending

      public Boolean isDescending()

      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.

      Returns:
      If set to true, results are returned in descending order. If you don't specify a value or set it to false, results are returned in ascending order.
    • setNextToken

      public void setNextToken(String nextToken)

      A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.

      Parameters:
      nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
    • getNextToken

      public String getNextToken()

      A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.

      Returns:
      A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
    • withNextToken

      public DescribeLogStreamsRequest withNextToken(String nextToken)

      A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.

      Parameters:
      nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeLogStreams request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLimit

      public void setLimit(Integer limit)

      The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

      Parameters:
      limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
    • getLimit

      public Integer getLimit()

      The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

      Returns:
      The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
    • withLimit

      public DescribeLogStreamsRequest withLimit(Integer limit)

      The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

      Parameters:
      limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public DescribeLogStreamsRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: