CloudWatchLogsRequest Class

(QtAws::CloudWatchLogs::CloudWatchLogsRequest)

The CloudWatchLogsRequest class provides an interface for CloudWatchLogs requests. More...

Header: #include <CloudWatchLogsRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::CloudWatchLogs::AssociateKmsKeyRequest, QtAws::CloudWatchLogs::CancelExportTaskRequest, QtAws::CloudWatchLogs::CreateExportTaskRequest, QtAws::CloudWatchLogs::CreateLogGroupRequest, QtAws::CloudWatchLogs::CreateLogStreamRequest, QtAws::CloudWatchLogs::DeleteDestinationRequest, QtAws::CloudWatchLogs::DeleteLogGroupRequest, QtAws::CloudWatchLogs::DeleteLogStreamRequest, QtAws::CloudWatchLogs::DeleteMetricFilterRequest, QtAws::CloudWatchLogs::DeleteResourcePolicyRequest, QtAws::CloudWatchLogs::DeleteRetentionPolicyRequest, QtAws::CloudWatchLogs::DeleteSubscriptionFilterRequest, QtAws::CloudWatchLogs::DescribeDestinationsRequest, QtAws::CloudWatchLogs::DescribeExportTasksRequest, QtAws::CloudWatchLogs::DescribeLogGroupsRequest, QtAws::CloudWatchLogs::DescribeLogStreamsRequest, QtAws::CloudWatchLogs::DescribeMetricFiltersRequest, QtAws::CloudWatchLogs::DescribeResourcePoliciesRequest, QtAws::CloudWatchLogs::DescribeSubscriptionFiltersRequest, QtAws::CloudWatchLogs::DisassociateKmsKeyRequest, QtAws::CloudWatchLogs::FilterLogEventsRequest, QtAws::CloudWatchLogs::GetLogEventsRequest, QtAws::CloudWatchLogs::ListTagsLogGroupRequest, QtAws::CloudWatchLogs::PutDestinationPolicyRequest, QtAws::CloudWatchLogs::PutDestinationRequest, QtAws::CloudWatchLogs::PutLogEventsRequest, QtAws::CloudWatchLogs::PutMetricFilterRequest, QtAws::CloudWatchLogs::PutResourcePolicyRequest, QtAws::CloudWatchLogs::PutRetentionPolicyRequest, QtAws::CloudWatchLogs::PutSubscriptionFilterRequest, QtAws::CloudWatchLogs::TagLogGroupRequest, QtAws::CloudWatchLogs::TestMetricFilterRequest, and QtAws::CloudWatchLogs::UntagLogGroupRequest

Public Types

enum Action { AssociateKmsKeyAction, CancelExportTaskAction, CreateExportTaskAction, CreateLogGroupAction, ..., UntagLogGroupAction }
flags Actions

Public Functions

CloudWatchLogsRequest(const Action action)
CloudWatchLogsRequest(const CloudWatchLogsRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
CloudWatchLogsRequest &operator=(const CloudWatchLogsRequest &other)
virtual bool operator==(const CloudWatchLogsRequest &other) const

Protected Functions

CloudWatchLogsRequest(CloudWatchLogsRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The CloudWatchLogsRequest class provides an interface for CloudWatchLogs requests.

Member Type Documentation

enum CloudWatchLogsRequest::Action
flags CloudWatchLogsRequest::Actions

This enum describes the actions that can be performed as CloudWatchLogs requests.

ConstantValueDescription
QtAws::CloudWatchLogs::CloudWatchLogsRequest::AssociateKmsKeyAction0CloudWatchLogs AssociateKmsKey action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::CancelExportTaskAction1CloudWatchLogs CancelExportTask action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::CreateExportTaskAction2CloudWatchLogs CreateExportTask action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::CreateLogGroupAction3CloudWatchLogs CreateLogGroup action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::CreateLogStreamAction4CloudWatchLogs CreateLogStream action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteDestinationAction5CloudWatchLogs DeleteDestination action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteLogGroupAction6CloudWatchLogs DeleteLogGroup action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteLogStreamAction7CloudWatchLogs DeleteLogStream action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteMetricFilterAction8CloudWatchLogs DeleteMetricFilter action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteResourcePolicyAction9CloudWatchLogs DeleteResourcePolicy action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteRetentionPolicyAction10CloudWatchLogs DeleteRetentionPolicy action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DeleteSubscriptionFilterAction11CloudWatchLogs DeleteSubscriptionFilter action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeDestinationsAction12CloudWatchLogs DescribeDestinations action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeExportTasksAction13CloudWatchLogs DescribeExportTasks action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeLogGroupsAction14CloudWatchLogs DescribeLogGroups action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeLogStreamsAction15CloudWatchLogs DescribeLogStreams action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeMetricFiltersAction16CloudWatchLogs DescribeMetricFilters action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeResourcePoliciesAction17CloudWatchLogs DescribeResourcePolicies action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DescribeSubscriptionFiltersAction18CloudWatchLogs DescribeSubscriptionFilters action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::DisassociateKmsKeyAction19CloudWatchLogs DisassociateKmsKey action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::FilterLogEventsAction20CloudWatchLogs FilterLogEvents action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::GetLogEventsAction21CloudWatchLogs GetLogEvents action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::ListTagsLogGroupAction22CloudWatchLogs ListTagsLogGroup action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutDestinationAction23CloudWatchLogs PutDestination action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutDestinationPolicyAction24CloudWatchLogs PutDestinationPolicy action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutLogEventsAction25CloudWatchLogs PutLogEvents action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutMetricFilterAction26CloudWatchLogs PutMetricFilter action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutResourcePolicyAction27CloudWatchLogs PutResourcePolicy action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutRetentionPolicyAction28CloudWatchLogs PutRetentionPolicy action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::PutSubscriptionFilterAction29CloudWatchLogs PutSubscriptionFilter action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::TagLogGroupAction30CloudWatchLogs TagLogGroup action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::TestMetricFilterAction31CloudWatchLogs TestMetricFilter action.
QtAws::CloudWatchLogs::CloudWatchLogsRequest::UntagLogGroupAction32CloudWatchLogs UntagLogGroup action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

CloudWatchLogsRequest::CloudWatchLogsRequest(const Action action)

Constructs a CloudWatchLogsRequest object for CloudWatchLogs action.

CloudWatchLogsRequest::CloudWatchLogsRequest(const CloudWatchLogsRequest &other)

Constructs a copy of other.

[protected] CloudWatchLogsRequest::CloudWatchLogsRequest(CloudWatchLogsRequestPrivate * const d)

Constructs aa CloudWatchLogsRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from CloudWatchLogsRequestPrivate.

Action CloudWatchLogsRequest::action() const

Returns the CloudWatchLogs action to be performed by this request.

See also setAction().

QString CloudWatchLogsRequest::actionString() const

Returns the name of the CloudWatchLogs action to be performed by this request.

QString CloudWatchLogsRequest::apiVersion() const

Returns the CloudWatchLogs API version implemented by this request.

See also setApiVersion().

[protected] int CloudWatchLogsRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

[protected] void CloudWatchLogsRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant CloudWatchLogsRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

[protected] const QVariantMap &CloudWatchLogsRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void CloudWatchLogsRequest::setAction(const Action action)

Sets the CloudWatchLogs action to be performed by this request to action.

See also action().

void CloudWatchLogsRequest::setApiVersion(const QString &version)

Sets the CloudWatchLogs API version to include in this request to version.

See also apiVersion().

[protected] void CloudWatchLogsRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void CloudWatchLogsRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

[override virtual protected] QNetworkRequest CloudWatchLogsRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the CloudWatchLogs request using the given endpoint.

This CloudWatchLogs implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

CloudWatchLogsRequest &CloudWatchLogsRequest::operator=(const CloudWatchLogsRequest &other)

Sets the CloudWatchLogsRequest object to be equal to other.

[virtual] bool CloudWatchLogsRequest::operator==(const CloudWatchLogsRequest &other) const

Returns true if this request is equal to other; false otherwise.

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.