AWS SDK for C++  1.9.14
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest Class Reference

#include <DescribeLogStreamsRequest.h>

+ Inheritance diagram for Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest:

Public Member Functions

 DescribeLogStreamsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetLogGroupName () const
 
bool LogGroupNameHasBeenSet () const
 
void SetLogGroupName (const Aws::String &value)
 
void SetLogGroupName (Aws::String &&value)
 
void SetLogGroupName (const char *value)
 
DescribeLogStreamsRequestWithLogGroupName (const Aws::String &value)
 
DescribeLogStreamsRequestWithLogGroupName (Aws::String &&value)
 
DescribeLogStreamsRequestWithLogGroupName (const char *value)
 
const Aws::StringGetLogStreamNamePrefix () const
 
bool LogStreamNamePrefixHasBeenSet () const
 
void SetLogStreamNamePrefix (const Aws::String &value)
 
void SetLogStreamNamePrefix (Aws::String &&value)
 
void SetLogStreamNamePrefix (const char *value)
 
DescribeLogStreamsRequestWithLogStreamNamePrefix (const Aws::String &value)
 
DescribeLogStreamsRequestWithLogStreamNamePrefix (Aws::String &&value)
 
DescribeLogStreamsRequestWithLogStreamNamePrefix (const char *value)
 
const OrderByGetOrderBy () const
 
bool OrderByHasBeenSet () const
 
void SetOrderBy (const OrderBy &value)
 
void SetOrderBy (OrderBy &&value)
 
DescribeLogStreamsRequestWithOrderBy (const OrderBy &value)
 
DescribeLogStreamsRequestWithOrderBy (OrderBy &&value)
 
bool GetDescending () const
 
bool DescendingHasBeenSet () const
 
void SetDescending (bool value)
 
DescribeLogStreamsRequestWithDescending (bool value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeLogStreamsRequestWithNextToken (const Aws::String &value)
 
DescribeLogStreamsRequestWithNextToken (Aws::String &&value)
 
DescribeLogStreamsRequestWithNextToken (const char *value)
 
int GetLimit () const
 
bool LimitHasBeenSet () const
 
void SetLimit (int value)
 
DescribeLogStreamsRequestWithLimit (int value)
 
- Public Member Functions inherited from Aws::CloudWatchLogs::CloudWatchLogsRequest
virtual ~CloudWatchLogsRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file DescribeLogStreamsRequest.h.

Constructor & Destructor Documentation

◆ DescribeLogStreamsRequest()

Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::DescribeLogStreamsRequest ( )

Member Function Documentation

◆ DescendingHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::DescendingHasBeenSet ( ) const
inline

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.

Definition at line 225 of file DescribeLogStreamsRequest.h.

◆ GetDescending()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetDescending ( ) const
inline

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.

Definition at line 218 of file DescribeLogStreamsRequest.h.

◆ GetLimit()

int Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetLimit ( ) const
inline

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

Definition at line 295 of file DescribeLogStreamsRequest.h.

◆ GetLogGroupName()

const Aws::String& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetLogGroupName ( ) const
inline

The name of the log group.

Definition at line 41 of file DescribeLogStreamsRequest.h.

◆ GetLogStreamNamePrefix()

const Aws::String& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetLogStreamNamePrefix ( ) const
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 83 of file DescribeLogStreamsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetNextToken ( ) const
inline

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

Definition at line 246 of file DescribeLogStreamsRequest.h.

◆ GetOrderBy()

const OrderBy& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetOrderBy ( ) const
inline

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.

Definition at line 140 of file DescribeLogStreamsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file DescribeLogStreamsRequest.h.

◆ LimitHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::LimitHasBeenSet ( ) const
inline

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

Definition at line 301 of file DescribeLogStreamsRequest.h.

◆ LogGroupNameHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::LogGroupNameHasBeenSet ( ) const
inline

The name of the log group.

Definition at line 46 of file DescribeLogStreamsRequest.h.

◆ LogStreamNamePrefixHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::LogStreamNamePrefixHasBeenSet ( ) const
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 89 of file DescribeLogStreamsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::NextTokenHasBeenSet ( ) const
inline

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

Definition at line 252 of file DescribeLogStreamsRequest.h.

◆ OrderByHasBeenSet()

bool Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::OrderByHasBeenSet ( ) const
inline

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.

Definition at line 154 of file DescribeLogStreamsRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescending()

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetDescending ( bool  value)
inline

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.

Definition at line 232 of file DescribeLogStreamsRequest.h.

◆ SetLimit()

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLimit ( int  value)
inline

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

Definition at line 307 of file DescribeLogStreamsRequest.h.

◆ SetLogGroupName() [1/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogGroupName ( Aws::String &&  value)
inline

The name of the log group.

Definition at line 56 of file DescribeLogStreamsRequest.h.

◆ SetLogGroupName() [2/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogGroupName ( const Aws::String value)
inline

The name of the log group.

Definition at line 51 of file DescribeLogStreamsRequest.h.

◆ SetLogGroupName() [3/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogGroupName ( const char *  value)
inline

The name of the log group.

Definition at line 61 of file DescribeLogStreamsRequest.h.

◆ SetLogStreamNamePrefix() [1/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogStreamNamePrefix ( Aws::String &&  value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 101 of file DescribeLogStreamsRequest.h.

◆ SetLogStreamNamePrefix() [2/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogStreamNamePrefix ( const Aws::String value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 95 of file DescribeLogStreamsRequest.h.

◆ SetLogStreamNamePrefix() [3/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetLogStreamNamePrefix ( const char *  value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 107 of file DescribeLogStreamsRequest.h.

◆ SetNextToken() [1/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetNextToken ( Aws::String &&  value)
inline

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

Definition at line 264 of file DescribeLogStreamsRequest.h.

◆ SetNextToken() [2/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetNextToken ( const Aws::String value)
inline

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

Definition at line 258 of file DescribeLogStreamsRequest.h.

◆ SetNextToken() [3/3]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetNextToken ( const char *  value)
inline

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

Definition at line 270 of file DescribeLogStreamsRequest.h.

◆ SetOrderBy() [1/2]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetOrderBy ( const OrderBy value)
inline

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.

Definition at line 168 of file DescribeLogStreamsRequest.h.

◆ SetOrderBy() [2/2]

void Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::SetOrderBy ( OrderBy &&  value)
inline

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.

Definition at line 182 of file DescribeLogStreamsRequest.h.

◆ WithDescending()

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithDescending ( bool  value)
inline

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.

Definition at line 239 of file DescribeLogStreamsRequest.h.

◆ WithLimit()

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLimit ( int  value)
inline

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

Definition at line 313 of file DescribeLogStreamsRequest.h.

◆ WithLogGroupName() [1/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogGroupName ( Aws::String &&  value)
inline

The name of the log group.

Definition at line 71 of file DescribeLogStreamsRequest.h.

◆ WithLogGroupName() [2/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogGroupName ( const Aws::String value)
inline

The name of the log group.

Definition at line 66 of file DescribeLogStreamsRequest.h.

◆ WithLogGroupName() [3/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogGroupName ( const char *  value)
inline

The name of the log group.

Definition at line 76 of file DescribeLogStreamsRequest.h.

◆ WithLogStreamNamePrefix() [1/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogStreamNamePrefix ( Aws::String &&  value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 119 of file DescribeLogStreamsRequest.h.

◆ WithLogStreamNamePrefix() [2/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogStreamNamePrefix ( const Aws::String value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 113 of file DescribeLogStreamsRequest.h.

◆ WithLogStreamNamePrefix() [3/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithLogStreamNamePrefix ( const char *  value)
inline

The prefix to match.

If orderBy is LastEventTime, you cannot specify this parameter.

Definition at line 125 of file DescribeLogStreamsRequest.h.

◆ WithNextToken() [1/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithNextToken ( Aws::String &&  value)
inline

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

Definition at line 282 of file DescribeLogStreamsRequest.h.

◆ WithNextToken() [2/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithNextToken ( const Aws::String value)
inline

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

Definition at line 276 of file DescribeLogStreamsRequest.h.

◆ WithNextToken() [3/3]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithNextToken ( const char *  value)
inline

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

Definition at line 288 of file DescribeLogStreamsRequest.h.

◆ WithOrderBy() [1/2]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithOrderBy ( const OrderBy value)
inline

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.

Definition at line 196 of file DescribeLogStreamsRequest.h.

◆ WithOrderBy() [2/2]

DescribeLogStreamsRequest& Aws::CloudWatchLogs::Model::DescribeLogStreamsRequest::WithOrderBy ( OrderBy &&  value)
inline

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.

Definition at line 210 of file DescribeLogStreamsRequest.h.


The documentation for this class was generated from the following file: