software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsAsyncClient 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;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.AssociateKmsKeyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CancelExportTaskRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CancelExportTaskResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateExportTaskResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogStreamRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.CreateLogStreamResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogStreamRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteLogStreamResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteQueryDefinitionRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteQueryDefinitionResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteResourcePolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteResourcePolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteRetentionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteRetentionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteSubscriptionFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DeleteSubscriptionFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeExportTasksRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeExportTasksResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueriesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueryDefinitionsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeQueryDefinitionsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeResourcePoliciesRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeResourcePoliciesResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.DisassociateKmsKeyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.DisassociateKmsKeyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogGroupFieldsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogGroupFieldsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogRecordRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogRecordResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.GetQueryResultsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.ListTagsLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutDestinationResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutQueryDefinitionResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutResourcePolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutRetentionPolicyRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutRetentionPolicyResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.PutSubscriptionFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartQueryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.StartQueryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.StopQueryRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.StopQueryResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.TagLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.TestMetricFilterRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.TestMetricFilterResponse;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagLogGroupRequest;
import software.amazon.awssdk.services.cloudwatchlogs.model.UntagLogGroupResponse;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher;
import software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher;
/**
* Service client for accessing Amazon CloudWatch Logs asynchronously. This can be created using the static
* {@link #builder()} method.
*
*
* You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, AWS CloudTrail,
* or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console,
* CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.
*
*
* You can use CloudWatch Logs to:
*
*
* -
*
* Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems
* using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and
* send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your
* log data for monitoring so no code changes are required. For example, you can monitor application logs for specific
* literal terms (such as "NullReferenceException") or count the number of occurrences of a literal term at a particular
* position in log data (such as "404" status codes in an Apache access log). When the term you are searching for is
* found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.
*
*
* -
*
* Monitor AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of
* particular API activity as captured by CloudTrail. You can use the notification to perform troubleshooting.
*
*
* -
*
* Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change
* the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch
* Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log
* service. You can then access the raw log data when you need it.
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface CloudWatchLogsAsyncClient extends SdkClient {
String SERVICE_NAME = "logs";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "logs";
/**
* Create a {@link CloudWatchLogsAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static CloudWatchLogsAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link CloudWatchLogsAsyncClient}.
*/
static CloudWatchLogsAsyncClientBuilder builder() {
return new DefaultCloudWatchLogsAsyncClientBuilder();
}
/**
*
* Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
* group.
*
*
* Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK.
* After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK.
* This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs.
* This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
*
*
*
* CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For
* more information, see Using Symmetric and
* Asymmetric Keys.
*
*
*
* It can take up to 5 minutes for this operation to take effect.
*
*
* If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you receive
* an InvalidParameterException error.
*
*
* @param associateKmsKeyRequest
* @return A Java Future containing the result of the AssociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.AssociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture associateKmsKey(AssociateKmsKeyRequest associateKmsKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log
* group.
*
*
* Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK.
* After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK.
* This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs.
* This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
*
*
*
* CloudWatch Logs supports only symmetric CMKs. Do not use an associate an asymmetric CMK with your log group. For
* more information, see Using Symmetric and
* Asymmetric Keys.
*
*
*
* It can take up to 5 minutes for this operation to take effect.
*
*
* If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you receive
* an InvalidParameterException error.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateKmsKeyRequest.Builder} avoiding the need
* to create one manually via {@link AssociateKmsKeyRequest#builder()}
*
*
* @param associateKmsKeyRequest
* A {@link Consumer} that will call methods on {@link AssociateKmsKeyRequest.Builder} to create a request.
* @return A Java Future containing the result of the AssociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.AssociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture associateKmsKey(
Consumer associateKmsKeyRequest) {
return associateKmsKey(AssociateKmsKeyRequest.builder().applyMutation(associateKmsKeyRequest).build());
}
/**
*
* Cancels the specified export task.
*
*
* The task must be in the PENDING or RUNNING state.
*
*
* @param cancelExportTaskRequest
* @return A Java Future containing the result of the CancelExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidOperationException The operation is not valid on the specified resource.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CancelExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture cancelExportTask(CancelExportTaskRequest cancelExportTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels the specified export task.
*
*
* The task must be in the PENDING or RUNNING state.
*
*
*
* This is a convenience which creates an instance of the {@link CancelExportTaskRequest.Builder} avoiding the need
* to create one manually via {@link CancelExportTaskRequest#builder()}
*
*
* @param cancelExportTaskRequest
* A {@link Consumer} that will call methods on {@link CancelExportTaskRequest.Builder} to create a request.
* @return A Java Future containing the result of the CancelExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidOperationException The operation is not valid on the specified resource.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CancelExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture cancelExportTask(
Consumer cancelExportTaskRequest) {
return cancelExportTask(CancelExportTaskRequest.builder().applyMutation(cancelExportTaskRequest).build());
}
/**
*
* Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket. When
* you perform a CreateExportTask operation, you must use credentials that have permission to write to
* the S3 bucket that you specify as the destination.
*
*
* This is an asynchronous call. If all the required information is provided, this operation initiates an export
* task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (
* RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
*
*
* You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log
* data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported
* objects.
*
*
* Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with
* SSE-KMS is not supported.
*
*
* @param createExportTaskRequest
* @return A Java Future containing the result of the CreateExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - ResourceNotFoundException The specified resource does not exist.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture createExportTask(CreateExportTaskRequest createExportTaskRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket. When
* you perform a CreateExportTask operation, you must use credentials that have permission to write to
* the S3 bucket that you specify as the destination.
*
*
* This is an asynchronous call. If all the required information is provided, this operation initiates an export
* task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (
* RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.
*
*
* You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log
* data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported
* objects.
*
*
* Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with
* SSE-KMS is not supported.
*
*
*
* This is a convenience which creates an instance of the {@link CreateExportTaskRequest.Builder} avoiding the need
* to create one manually via {@link CreateExportTaskRequest#builder()}
*
*
* @param createExportTaskRequest
* A {@link Consumer} that will call methods on {@link CreateExportTaskRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateExportTask operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - ResourceNotFoundException The specified resource does not exist.
* - ResourceAlreadyExistsException The specified resource already exists.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateExportTask
* @see AWS API
* Documentation
*/
default CompletableFuture createExportTask(
Consumer createExportTaskRequest) {
return createExportTask(CreateExportTaskRequest.builder().applyMutation(createExportTaskRequest).build());
}
/**
*
* Creates a log group with the specified name. You can create up to 20,000 log groups per account.
*
*
* You must use the following guidelines when naming a log group:
*
*
* -
*
* Log group names must be unique within a region for an AWS account.
*
*
* -
*
* Log group names can be between 1 and 512 characters long.
*
*
* -
*
* Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward
* slash), '.' (period), and '#' (number sign)
*
*
*
*
* When you create a log group, by default the log events in the log group never expire. To set a retention policy
* so that events expire and are deleted after a specified time, use PutRetentionPolicy.
*
*
* If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested
* data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still
* within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
*
*
* If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you
* receive an InvalidParameterException error.
*
*
*
* CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more
* information, see Using
* Symmetric and Asymmetric Keys.
*
*
*
* @param createLogGroupRequest
* @return A Java Future containing the result of the CreateLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createLogGroup(CreateLogGroupRequest createLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a log group with the specified name. You can create up to 20,000 log groups per account.
*
*
* You must use the following guidelines when naming a log group:
*
*
* -
*
* Log group names must be unique within a region for an AWS account.
*
*
* -
*
* Log group names can be between 1 and 512 characters long.
*
*
* -
*
* Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward
* slash), '.' (period), and '#' (number sign)
*
*
*
*
* When you create a log group, by default the log events in the log group never expire. To set a retention policy
* so that events expire and are deleted after a specified time, use PutRetentionPolicy.
*
*
* If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested
* data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still
* within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.
*
*
* If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you
* receive an InvalidParameterException error.
*
*
*
* CloudWatch Logs supports only symmetric CMKs. Do not associate an asymmetric CMK with your log group. For more
* information, see Using
* Symmetric and Asymmetric Keys.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link CreateLogGroupRequest#builder()}
*
*
* @param createLogGroupRequest
* A {@link Consumer} that will call methods on {@link CreateLogGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createLogGroup(Consumer createLogGroupRequest) {
return createLogGroup(CreateLogGroupRequest.builder().applyMutation(createLogGroupRequest).build());
}
/**
*
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a
* single source, such as an application instance or a resource that is being monitored.
*
*
* There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
* CreateLogStream operations, after which transactions are throttled.
*
*
* You must use the following guidelines when naming a log stream:
*
*
* -
*
* Log stream names must be unique within the log group.
*
*
* -
*
* Log stream names can be between 1 and 512 characters long.
*
*
* -
*
* The ':' (colon) and '*' (asterisk) characters are not allowed.
*
*
*
*
* @param createLogStreamRequest
* @return A Java Future containing the result of the CreateLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture createLogStream(CreateLogStreamRequest createLogStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a log stream for the specified log group. A log stream is a sequence of log events that originate from a
* single source, such as an application instance or a resource that is being monitored.
*
*
* There is no limit on the number of log streams that you can create for a log group. There is a limit of 50 TPS on
* CreateLogStream operations, after which transactions are throttled.
*
*
* You must use the following guidelines when naming a log stream:
*
*
* -
*
* Log stream names must be unique within the log group.
*
*
* -
*
* Log stream names can be between 1 and 512 characters long.
*
*
* -
*
* The ':' (colon) and '*' (asterisk) characters are not allowed.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link CreateLogStreamRequest.Builder} avoiding the need
* to create one manually via {@link CreateLogStreamRequest#builder()}
*
*
* @param createLogStreamRequest
* A {@link Consumer} that will call methods on {@link CreateLogStreamRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceAlreadyExistsException The specified resource already exists.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.CreateLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture createLogStream(
Consumer createLogStreamRequest) {
return createLogStream(CreateLogStreamRequest.builder().applyMutation(createLogStreamRequest).build());
}
/**
*
* Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This
* operation does not delete the physical resource encapsulated by the destination.
*
*
* @param deleteDestinationRequest
* @return A Java Future containing the result of the DeleteDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDestination
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDestination(DeleteDestinationRequest deleteDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This
* operation does not delete the physical resource encapsulated by the destination.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDestinationRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDestinationRequest#builder()}
*
*
* @param deleteDestinationRequest
* A {@link Consumer} that will call methods on {@link DeleteDestinationRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteDestination
* @see AWS API
* Documentation
*/
default CompletableFuture deleteDestination(
Consumer deleteDestinationRequest) {
return deleteDestination(DeleteDestinationRequest.builder().applyMutation(deleteDestinationRequest).build());
}
/**
*
* Deletes the specified log group and permanently deletes all the archived log events associated with the log
* group.
*
*
* @param deleteLogGroupRequest
* @return A Java Future containing the result of the DeleteLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogGroup(DeleteLogGroupRequest deleteLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified log group and permanently deletes all the archived log events associated with the log
* group.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link DeleteLogGroupRequest#builder()}
*
*
* @param deleteLogGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteLogGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogGroup(Consumer deleteLogGroupRequest) {
return deleteLogGroup(DeleteLogGroupRequest.builder().applyMutation(deleteLogGroupRequest).build());
}
/**
*
* Deletes the specified log stream and permanently deletes all the archived log events associated with the log
* stream.
*
*
* @param deleteLogStreamRequest
* @return A Java Future containing the result of the DeleteLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogStream(DeleteLogStreamRequest deleteLogStreamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified log stream and permanently deletes all the archived log events associated with the log
* stream.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteLogStreamRequest.Builder} avoiding the need
* to create one manually via {@link DeleteLogStreamRequest#builder()}
*
*
* @param deleteLogStreamRequest
* A {@link Consumer} that will call methods on {@link DeleteLogStreamRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteLogStream operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteLogStream
* @see AWS API
* Documentation
*/
default CompletableFuture deleteLogStream(
Consumer deleteLogStreamRequest) {
return deleteLogStream(DeleteLogStreamRequest.builder().applyMutation(deleteLogStreamRequest).build());
}
/**
*
* Deletes the specified metric filter.
*
*
* @param deleteMetricFilterRequest
* @return A Java Future containing the result of the DeleteMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteMetricFilter(DeleteMetricFilterRequest deleteMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified metric filter.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMetricFilterRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMetricFilterRequest#builder()}
*
*
* @param deleteMetricFilterRequest
* A {@link Consumer} that will call methods on {@link DeleteMetricFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture deleteMetricFilter(
Consumer deleteMetricFilterRequest) {
return deleteMetricFilter(DeleteMetricFilterRequest.builder().applyMutation(deleteMetricFilterRequest).build());
}
/**
*
* Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved
* CloudWatch Logs Insights query.
*
*
* Each DeleteQueryDefinition operation can delete one query definition.
*
*
* You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
*
*
* @param deleteQueryDefinitionRequest
* @return A Java Future containing the result of the DeleteQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteQueryDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deleteQueryDefinition(
DeleteQueryDefinitionRequest deleteQueryDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a saved CloudWatch Logs Insights query definition. A query definition contains details about a saved
* CloudWatch Logs Insights query.
*
*
* Each DeleteQueryDefinition operation can delete one query definition.
*
*
* You must have the logs:DeleteQueryDefinition permission to be able to perform this operation.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteQueryDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteQueryDefinitionRequest#builder()}
*
*
* @param deleteQueryDefinitionRequest
* A {@link Consumer} that will call methods on {@link DeleteQueryDefinitionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteQueryDefinition
* @see AWS
* API Documentation
*/
default CompletableFuture deleteQueryDefinition(
Consumer deleteQueryDefinitionRequest) {
return deleteQueryDefinition(DeleteQueryDefinitionRequest.builder().applyMutation(deleteQueryDefinitionRequest).build());
}
/**
*
* Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log
* events to this account.
*
*
* @param deleteResourcePolicyRequest
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResourcePolicy(
DeleteResourcePolicyRequest deleteResourcePolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log
* events to this account.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteResourcePolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteResourcePolicyRequest#builder()}
*
*
* @param deleteResourcePolicyRequest
* A {@link Consumer} that will call methods on {@link DeleteResourcePolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture deleteResourcePolicy(
Consumer deleteResourcePolicyRequest) {
return deleteResourcePolicy(DeleteResourcePolicyRequest.builder().applyMutation(deleteResourcePolicyRequest).build());
}
/**
*
* Deletes the specified retention policy.
*
*
* Log events do not expire if they belong to log groups without a retention policy.
*
*
* @param deleteRetentionPolicyRequest
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
DeleteRetentionPolicyRequest deleteRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified retention policy.
*
*
* Log events do not expire if they belong to log groups without a retention policy.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRetentionPolicyRequest#builder()}
*
*
* @param deleteRetentionPolicyRequest
* A {@link Consumer} that will call methods on {@link DeleteRetentionPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteRetentionPolicy
* @see AWS
* API Documentation
*/
default CompletableFuture deleteRetentionPolicy(
Consumer deleteRetentionPolicyRequest) {
return deleteRetentionPolicy(DeleteRetentionPolicyRequest.builder().applyMutation(deleteRetentionPolicyRequest).build());
}
/**
*
* Deletes the specified subscription filter.
*
*
* @param deleteSubscriptionFilterRequest
* @return A Java Future containing the result of the DeleteSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSubscriptionFilter(
DeleteSubscriptionFilterRequest deleteSubscriptionFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified subscription filter.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSubscriptionFilterRequest.Builder} avoiding
* the need to create one manually via {@link DeleteSubscriptionFilterRequest#builder()}
*
*
* @param deleteSubscriptionFilterRequest
* A {@link Consumer} that will call methods on {@link DeleteSubscriptionFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DeleteSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture deleteSubscriptionFilter(
Consumer deleteSubscriptionFilterRequest) {
return deleteSubscriptionFilter(DeleteSubscriptionFilterRequest.builder().applyMutation(deleteSubscriptionFilterRequest)
.build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
* @param describeDestinationsRequest
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations(
DescribeDestinationsRequest describeDestinationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDestinationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDestinationsRequest#builder()}
*
*
* @param describeDestinationsRequest
* A {@link Consumer} that will call methods on {@link DescribeDestinationsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations(
Consumer describeDestinationsRequest) {
return describeDestinations(DescribeDestinationsRequest.builder().applyMutation(describeDestinationsRequest).build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
* @return A Java Future containing the result of the DescribeDestinations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default CompletableFuture describeDestinations() {
return describeDestinations(DescribeDestinationsRequest.builder().build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator() {
return describeDestinationsPaginator(DescribeDestinationsRequest.builder().build());
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* @param describeDestinationsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator(DescribeDestinationsRequest describeDestinationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists all your destinations. The results are ASCII-sorted by destination name.
*
*
*
* This is a variant of
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeDestinationsPublisher publisher = client.describeDestinationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeDestinations(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeDestinationsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDestinationsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDestinationsRequest#builder()}
*
*
* @param describeDestinationsRequest
* A {@link Consumer} that will call methods on {@link DescribeDestinationsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeDestinations
* @see AWS API
* Documentation
*/
default DescribeDestinationsPublisher describeDestinationsPaginator(
Consumer describeDestinationsRequest) {
return describeDestinationsPaginator(DescribeDestinationsRequest.builder().applyMutation(describeDestinationsRequest)
.build());
}
/**
*
* Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or
* task status.
*
*
* @param describeExportTasksRequest
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks(
DescribeExportTasksRequest describeExportTasksRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or
* task status.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeExportTasksRequest.Builder} avoiding the
* need to create one manually via {@link DescribeExportTasksRequest#builder()}
*
*
* @param describeExportTasksRequest
* A {@link Consumer} that will call methods on {@link DescribeExportTasksRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks(
Consumer describeExportTasksRequest) {
return describeExportTasks(DescribeExportTasksRequest.builder().applyMutation(describeExportTasksRequest).build());
}
/**
*
* Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or
* task status.
*
*
* @return A Java Future containing the result of the DescribeExportTasks operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeExportTasks
* @see AWS API
* Documentation
*/
default CompletableFuture describeExportTasks() {
return describeExportTasks(DescribeExportTasksRequest.builder().build());
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
* @param describeLogGroupsRequest
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups(DescribeLogGroupsRequest describeLogGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeLogGroupsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeLogGroupsRequest#builder()}
*
*
* @param describeLogGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeLogGroupsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups(
Consumer describeLogGroupsRequest) {
return describeLogGroups(DescribeLogGroupsRequest.builder().applyMutation(describeLogGroupsRequest).build());
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
* @return A Java Future containing the result of the DescribeLogGroups operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogGroups() {
return describeLogGroups(DescribeLogGroupsRequest.builder().build());
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
*
* This is a variant of
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator() {
return describeLogGroupsPaginator(DescribeLogGroupsRequest.builder().build());
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
*
* This is a variant of
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* @param describeLogGroupsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator(DescribeLogGroupsRequest describeLogGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are
* ASCII-sorted by log group name.
*
*
*
* This is a variant of
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogGroupsPublisher publisher = client.describeLogGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeLogGroups(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeLogGroupsRequest.Builder} avoiding the need
* to create one manually via {@link DescribeLogGroupsRequest#builder()}
*
*
* @param describeLogGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeLogGroupsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogGroups
* @see AWS API
* Documentation
*/
default DescribeLogGroupsPublisher describeLogGroupsPaginator(
Consumer describeLogGroupsRequest) {
return describeLogGroupsPaginator(DescribeLogGroupsRequest.builder().applyMutation(describeLogGroupsRequest).build());
}
/**
*
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by
* prefix. You can also control how the results are ordered.
*
*
* This operation has a limit of five transactions per second, after which transactions are throttled.
*
*
* @param describeLogStreamsRequest
* @return A Java Future containing the result of the DescribeLogStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogStreams(DescribeLogStreamsRequest describeLogStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by
* prefix. You can also control how the results are ordered.
*
*
* This operation has a limit of five transactions per second, after which transactions are throttled.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeLogStreamsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeLogStreamsRequest#builder()}
*
*
* @param describeLogStreamsRequest
* A {@link Consumer} that will call methods on {@link DescribeLogStreamsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeLogStreams operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default CompletableFuture describeLogStreams(
Consumer describeLogStreamsRequest) {
return describeLogStreams(DescribeLogStreamsRequest.builder().applyMutation(describeLogStreamsRequest).build());
}
/**
*
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by
* prefix. You can also control how the results are ordered.
*
*
* This operation has a limit of five transactions per second, after which transactions are throttled.
*
*
*
* This is a variant of
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation.
*
*
* @param describeLogStreamsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default DescribeLogStreamsPublisher describeLogStreamsPaginator(DescribeLogStreamsRequest describeLogStreamsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the log streams for the specified log group. You can list all the log streams or filter the results by
* prefix. You can also control how the results are ordered.
*
*
* This operation has a limit of five transactions per second, after which transactions are throttled.
*
*
*
* This is a variant of
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeLogStreamsPublisher publisher = client.describeLogStreamsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeLogStreams(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeLogStreamsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeLogStreamsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeLogStreamsRequest#builder()}
*
*
* @param describeLogStreamsRequest
* A {@link Consumer} that will call methods on {@link DescribeLogStreamsRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeLogStreams
* @see AWS API
* Documentation
*/
default DescribeLogStreamsPublisher describeLogStreamsPaginator(
Consumer describeLogStreamsRequest) {
return describeLogStreamsPaginator(DescribeLogStreamsRequest.builder().applyMutation(describeLogStreamsRequest).build());
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
* @param describeMetricFiltersRequest
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters(
DescribeMetricFiltersRequest describeMetricFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeMetricFiltersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeMetricFiltersRequest#builder()}
*
*
* @param describeMetricFiltersRequest
* A {@link Consumer} that will call methods on {@link DescribeMetricFiltersRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters(
Consumer describeMetricFiltersRequest) {
return describeMetricFilters(DescribeMetricFiltersRequest.builder().applyMutation(describeMetricFiltersRequest).build());
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
* @return A Java Future containing the result of the DescribeMetricFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default CompletableFuture describeMetricFilters() {
return describeMetricFilters(DescribeMetricFiltersRequest.builder().build());
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
*
* This is a variant of
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator() {
return describeMetricFiltersPaginator(DescribeMetricFiltersRequest.builder().build());
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
*
* This is a variant of
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* @param describeMetricFiltersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(
DescribeMetricFiltersRequest describeMetricFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the specified metric filters. You can list all of the metric filters or filter the results by log name,
* prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.
*
*
*
* This is a variant of
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeMetricFiltersPublisher publisher = client.describeMetricFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeMetricFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeMetricFiltersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeMetricFiltersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeMetricFiltersRequest#builder()}
*
*
* @param describeMetricFiltersRequest
* A {@link Consumer} that will call methods on {@link DescribeMetricFiltersRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeMetricFilters
* @see AWS
* API Documentation
*/
default DescribeMetricFiltersPublisher describeMetricFiltersPaginator(
Consumer describeMetricFiltersRequest) {
return describeMetricFiltersPaginator(DescribeMetricFiltersRequest.builder().applyMutation(describeMetricFiltersRequest)
.build());
}
/**
*
* Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
* in this account. You can request all queries or limit it to queries of a specific log group or queries with a
* certain status.
*
*
* @param describeQueriesRequest
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries(DescribeQueriesRequest describeQueriesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
* in this account. You can request all queries or limit it to queries of a specific log group or queries with a
* certain status.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeQueriesRequest.Builder} avoiding the need
* to create one manually via {@link DescribeQueriesRequest#builder()}
*
*
* @param describeQueriesRequest
* A {@link Consumer} that will call methods on {@link DescribeQueriesRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries(
Consumer describeQueriesRequest) {
return describeQueries(DescribeQueriesRequest.builder().applyMutation(describeQueriesRequest).build());
}
/**
*
* Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently
* in this account. You can request all queries or limit it to queries of a specific log group or queries with a
* certain status.
*
*
* @return A Java Future containing the result of the DescribeQueries operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueries
* @see AWS API
* Documentation
*/
default CompletableFuture describeQueries() {
return describeQueries(DescribeQueriesRequest.builder().build());
}
/**
*
* This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
*
*
* You can use the queryDefinitionNamePrefix parameter to limit the results to only the query
* definitions that have names that start with a certain string.
*
*
* @param describeQueryDefinitionsRequest
* @return A Java Future containing the result of the DescribeQueryDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueryDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeQueryDefinitions(
DescribeQueryDefinitionsRequest describeQueryDefinitionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.
*
*
* You can use the queryDefinitionNamePrefix parameter to limit the results to only the query
* definitions that have names that start with a certain string.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeQueryDefinitionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeQueryDefinitionsRequest#builder()}
*
*
* @param describeQueryDefinitionsRequest
* A {@link Consumer} that will call methods on {@link DescribeQueryDefinitionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeQueryDefinitions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeQueryDefinitions
* @see AWS
* API Documentation
*/
default CompletableFuture describeQueryDefinitions(
Consumer describeQueryDefinitionsRequest) {
return describeQueryDefinitions(DescribeQueryDefinitionsRequest.builder().applyMutation(describeQueryDefinitionsRequest)
.build());
}
/**
*
* Lists the resource policies in this account.
*
*
* @param describeResourcePoliciesRequest
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies(
DescribeResourcePoliciesRequest describeResourcePoliciesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the resource policies in this account.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeResourcePoliciesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeResourcePoliciesRequest#builder()}
*
*
* @param describeResourcePoliciesRequest
* A {@link Consumer} that will call methods on {@link DescribeResourcePoliciesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies(
Consumer describeResourcePoliciesRequest) {
return describeResourcePolicies(DescribeResourcePoliciesRequest.builder().applyMutation(describeResourcePoliciesRequest)
.build());
}
/**
*
* Lists the resource policies in this account.
*
*
* @return A Java Future containing the result of the DescribeResourcePolicies operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeResourcePolicies
* @see AWS
* API Documentation
*/
default CompletableFuture describeResourcePolicies() {
return describeResourcePolicies(DescribeResourcePoliciesRequest.builder().build());
}
/**
*
* Lists the subscription filters for the specified log group. You can list all the subscription filters or filter
* the results by prefix. The results are ASCII-sorted by filter name.
*
*
* @param describeSubscriptionFiltersRequest
* @return A Java Future containing the result of the DescribeSubscriptionFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default CompletableFuture describeSubscriptionFilters(
DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the subscription filters for the specified log group. You can list all the subscription filters or filter
* the results by prefix. The results are ASCII-sorted by filter name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeSubscriptionFiltersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeSubscriptionFiltersRequest#builder()}
*
*
* @param describeSubscriptionFiltersRequest
* A {@link Consumer} that will call methods on {@link DescribeSubscriptionFiltersRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the DescribeSubscriptionFilters operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default CompletableFuture describeSubscriptionFilters(
Consumer describeSubscriptionFiltersRequest) {
return describeSubscriptionFilters(DescribeSubscriptionFiltersRequest.builder()
.applyMutation(describeSubscriptionFiltersRequest).build());
}
/**
*
* Lists the subscription filters for the specified log group. You can list all the subscription filters or filter
* the results by prefix. The results are ASCII-sorted by filter name.
*
*
*
* This is a variant of
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation.
*
*
* @param describeSubscriptionFiltersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(
DescribeSubscriptionFiltersRequest describeSubscriptionFiltersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the subscription filters for the specified log group. You can list all the subscription filters or filter
* the results by prefix. The results are ASCII-sorted by filter name.
*
*
*
* This is a variant of
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.DescribeSubscriptionFiltersPublisher publisher = client.describeSubscriptionFiltersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #describeSubscriptionFilters(software.amazon.awssdk.services.cloudwatchlogs.model.DescribeSubscriptionFiltersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeSubscriptionFiltersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeSubscriptionFiltersRequest#builder()}
*
*
* @param describeSubscriptionFiltersRequest
* A {@link Consumer} that will call methods on {@link DescribeSubscriptionFiltersRequest.Builder} to create
* a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DescribeSubscriptionFilters
* @see AWS API Documentation
*/
default DescribeSubscriptionFiltersPublisher describeSubscriptionFiltersPaginator(
Consumer describeSubscriptionFiltersRequest) {
return describeSubscriptionFiltersPaginator(DescribeSubscriptionFiltersRequest.builder()
.applyMutation(describeSubscriptionFiltersRequest).build());
}
/**
*
* Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
* log group.
*
*
* After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested
* data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires
* permissions for the CMK whenever the encrypted data is requested.
*
*
* Note that it can take up to 5 minutes for this operation to take effect.
*
*
* @param disassociateKmsKeyRequest
* @return A Java Future containing the result of the DisassociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DisassociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateKmsKey(DisassociateKmsKeyRequest disassociateKmsKeyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified
* log group.
*
*
* After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested
* data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires
* permissions for the CMK whenever the encrypted data is requested.
*
*
* Note that it can take up to 5 minutes for this operation to take effect.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateKmsKeyRequest.Builder} avoiding the
* need to create one manually via {@link DisassociateKmsKeyRequest#builder()}
*
*
* @param disassociateKmsKeyRequest
* A {@link Consumer} that will call methods on {@link DisassociateKmsKeyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DisassociateKmsKey operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.DisassociateKmsKey
* @see AWS API
* Documentation
*/
default CompletableFuture disassociateKmsKey(
Consumer disassociateKmsKeyRequest) {
return disassociateKmsKey(DisassociateKmsKeyRequest.builder().applyMutation(disassociateKmsKeyRequest).build());
}
/**
*
* Lists log events from the specified log group. You can list all the log events or filter the results using a
* filter pattern, a time range, and the name of the log stream.
*
*
* By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the
* events found within the time range that you specify. If the results include a token, then there are more log
* events available, and you can get additional results by specifying the token in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
* The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
* Logs, and the ID of the PutLogEvents request.
*
*
* @param filterLogEventsRequest
* @return A Java Future containing the result of the FilterLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture filterLogEvents(FilterLogEventsRequest filterLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists log events from the specified log group. You can list all the log events or filter the results using a
* filter pattern, a time range, and the name of the log stream.
*
*
* By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the
* events found within the time range that you specify. If the results include a token, then there are more log
* events available, and you can get additional results by specifying the token in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
* The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
* Logs, and the ID of the PutLogEvents request.
*
*
*
* This is a convenience which creates an instance of the {@link FilterLogEventsRequest.Builder} avoiding the need
* to create one manually via {@link FilterLogEventsRequest#builder()}
*
*
* @param filterLogEventsRequest
* A {@link Consumer} that will call methods on {@link FilterLogEventsRequest.Builder} to create a request.
* @return A Java Future containing the result of the FilterLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture filterLogEvents(
Consumer filterLogEventsRequest) {
return filterLogEvents(FilterLogEventsRequest.builder().applyMutation(filterLogEventsRequest).build());
}
/**
*
* Lists log events from the specified log group. You can list all the log events or filter the results using a
* filter pattern, a time range, and the name of the log stream.
*
*
* By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the
* events found within the time range that you specify. If the results include a token, then there are more log
* events available, and you can get additional results by specifying the token in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
* The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
* Logs, and the ID of the PutLogEvents request.
*
*
*
* This is a variant of
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)}
* operation.
*
*
* @param filterLogEventsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default FilterLogEventsPublisher filterLogEventsPaginator(FilterLogEventsRequest filterLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists log events from the specified log group. You can list all the log events or filter the results using a
* filter pattern, a time range, and the name of the log stream.
*
*
* By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events) or all the
* events found within the time range that you specify. If the results include a token, then there are more log
* events available, and you can get additional results by specifying the token in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
* The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch
* Logs, and the ID of the PutLogEvents request.
*
*
*
* This is a variant of
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.FilterLogEventsPublisher publisher = client.filterLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #filterLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link FilterLogEventsRequest.Builder} avoiding the need
* to create one manually via {@link FilterLogEventsRequest#builder()}
*
*
* @param filterLogEventsRequest
* A {@link Consumer} that will call methods on {@link FilterLogEventsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.FilterLogEvents
* @see AWS API
* Documentation
*/
default FilterLogEventsPublisher filterLogEventsPaginator(Consumer filterLogEventsRequest) {
return filterLogEventsPaginator(FilterLogEventsRequest.builder().applyMutation(filterLogEventsRequest).build());
}
/**
*
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
*
*
* By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log
* events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
* @param getLogEventsRequest
* @return A Java Future containing the result of the GetLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture getLogEvents(GetLogEventsRequest getLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
*
*
* By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log
* events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
*
* This is a convenience which creates an instance of the {@link GetLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link GetLogEventsRequest#builder()}
*
*
* @param getLogEventsRequest
* A {@link Consumer} that will call methods on {@link GetLogEventsRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture getLogEvents(Consumer getLogEventsRequest) {
return getLogEvents(GetLogEventsRequest.builder().applyMutation(getLogEventsRequest).build());
}
/**
*
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
*
*
* By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log
* events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
*
* This is a variant of
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation.
*
*
* @param getLogEventsRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default GetLogEventsPublisher getLogEventsPaginator(GetLogEventsRequest getLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists log events from the specified log stream. You can list all of the log events or filter using a time range.
*
*
* By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log
* events). You can get additional log events by specifying one of the tokens in a subsequent call. This operation
* can return empty results while there are more log events available through the token.
*
*
*
* This is a variant of
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.cloudwatchlogs.paginators.GetLogEventsPublisher publisher = client.getLogEventsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of limit won't limit the number of results you get with the paginator. It
* only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #getLogEvents(software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link GetLogEventsRequest#builder()}
*
*
* @param getLogEventsRequest
* A {@link Consumer} that will call methods on {@link GetLogEventsRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogEvents
* @see AWS API
* Documentation
*/
default GetLogEventsPublisher getLogEventsPaginator(Consumer getLogEventsRequest) {
return getLogEventsPaginator(GetLogEventsRequest.builder().applyMutation(getLogEventsRequest).build());
}
/**
*
* Returns a list of the fields that are included in log events in the specified log group, along with the
* percentage of log events that contain each field. The search is limited to a time period that you specify.
*
*
* In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
* @timestamp is the timestamp of each log event. For more information about the fields that are
* generated by CloudWatch logs, see Supported Logs and Discovered Fields.
*
*
* The response results are sorted by the frequency percentage, starting with the highest percentage.
*
*
* @param getLogGroupFieldsRequest
* @return A Java Future containing the result of the GetLogGroupFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogGroupFields
* @see AWS API
* Documentation
*/
default CompletableFuture getLogGroupFields(GetLogGroupFieldsRequest getLogGroupFieldsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the fields that are included in log events in the specified log group, along with the
* percentage of log events that contain each field. The search is limited to a time period that you specify.
*
*
* In the results, fields that start with @ are fields generated by CloudWatch Logs. For example,
* @timestamp is the timestamp of each log event. For more information about the fields that are
* generated by CloudWatch logs, see Supported Logs and Discovered Fields.
*
*
* The response results are sorted by the frequency percentage, starting with the highest percentage.
*
*
*
* This is a convenience which creates an instance of the {@link GetLogGroupFieldsRequest.Builder} avoiding the need
* to create one manually via {@link GetLogGroupFieldsRequest#builder()}
*
*
* @param getLogGroupFieldsRequest
* A {@link Consumer} that will call methods on {@link GetLogGroupFieldsRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetLogGroupFields operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogGroupFields
* @see AWS API
* Documentation
*/
default CompletableFuture getLogGroupFields(
Consumer getLogGroupFieldsRequest) {
return getLogGroupFields(GetLogGroupFieldsRequest.builder().applyMutation(getLogGroupFieldsRequest).build());
}
/**
*
* Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original
* query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as
* field name/field value pairs.
*
*
* The full unparsed log event is returned within @message.
*
*
* @param getLogRecordRequest
* @return A Java Future containing the result of the GetLogRecord operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogRecord
* @see AWS API
* Documentation
*/
default CompletableFuture getLogRecord(GetLogRecordRequest getLogRecordRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all of the fields and values of a single log event. All fields are retrieved, even if the original
* query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as
* field name/field value pairs.
*
*
* The full unparsed log event is returned within @message.
*
*
*
* This is a convenience which creates an instance of the {@link GetLogRecordRequest.Builder} avoiding the need to
* create one manually via {@link GetLogRecordRequest#builder()}
*
*
* @param getLogRecordRequest
* A {@link Consumer} that will call methods on {@link GetLogRecordRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetLogRecord operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetLogRecord
* @see AWS API
* Documentation
*/
default CompletableFuture getLogRecord(Consumer getLogRecordRequest) {
return getLogRecord(GetLogRecordRequest.builder().applyMutation(getLogRecordRequest).build());
}
/**
*
* Returns the results from the specified query.
*
*
* Only the fields requested in the query are returned, along with a @ptr field, which is the
* identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
*
*
* GetQueryResults does not start a query execution. To run a query, use StartQuery.
*
*
* If the value of the Status field in the output is Running, this operation returns only
* partial results. If you see a value of Scheduled or Running for the status, you can
* retry the operation later to see the final results.
*
*
* @param getQueryResultsRequest
* @return A Java Future containing the result of the GetQueryResults operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetQueryResults
* @see AWS API
* Documentation
*/
default CompletableFuture getQueryResults(GetQueryResultsRequest getQueryResultsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the results from the specified query.
*
*
* Only the fields requested in the query are returned, along with a @ptr field, which is the
* identifier for the log record. You can use the value of @ptr in a GetLogRecord operation to get the full log record.
*
*
* GetQueryResults does not start a query execution. To run a query, use StartQuery.
*
*
* If the value of the Status field in the output is Running, this operation returns only
* partial results. If you see a value of Scheduled or Running for the status, you can
* retry the operation later to see the final results.
*
*
*
* This is a convenience which creates an instance of the {@link GetQueryResultsRequest.Builder} avoiding the need
* to create one manually via {@link GetQueryResultsRequest#builder()}
*
*
* @param getQueryResultsRequest
* A {@link Consumer} that will call methods on {@link GetQueryResultsRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetQueryResults operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.GetQueryResults
* @see AWS API
* Documentation
*/
default CompletableFuture getQueryResults(
Consumer getQueryResultsRequest) {
return getQueryResults(GetQueryResultsRequest.builder().applyMutation(getQueryResultsRequest).build());
}
/**
*
* Lists the tags for the specified log group.
*
*
* @param listTagsLogGroupRequest
* @return A Java Future containing the result of the ListTagsLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsLogGroup(ListTagsLogGroupRequest listTagsLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the tags for the specified log group.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsLogGroupRequest.Builder} avoiding the need
* to create one manually via {@link ListTagsLogGroupRequest#builder()}
*
*
* @param listTagsLogGroupRequest
* A {@link Consumer} that will call methods on {@link ListTagsLogGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListTagsLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.ListTagsLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture listTagsLogGroup(
Consumer listTagsLogGroupRequest) {
return listTagsLogGroup(ListTagsLogGroupRequest.builder().applyMutation(listTagsLogGroupRequest).build());
}
/**
*
* Creates or updates a destination. This operation is used only to create destinations for cross-account
* subscriptions.
*
*
* A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to
* a real-time stream of log events for a different account, ingested using PutLogEvents.
*
*
* Through an access policy, a destination controls what is written to it. By default, PutDestination
* does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
*
*
* To perform a PutDestination operation, you must also have the iam:PassRole permission.
*
*
* @param putDestinationRequest
* @return A Java Future containing the result of the PutDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestination
* @see AWS API
* Documentation
*/
default CompletableFuture putDestination(PutDestinationRequest putDestinationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a destination. This operation is used only to create destinations for cross-account
* subscriptions.
*
*
* A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to
* a real-time stream of log events for a different account, ingested using PutLogEvents.
*
*
* Through an access policy, a destination controls what is written to it. By default, PutDestination
* does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.
*
*
* To perform a PutDestination operation, you must also have the iam:PassRole permission.
*
*
*
* This is a convenience which creates an instance of the {@link PutDestinationRequest.Builder} avoiding the need to
* create one manually via {@link PutDestinationRequest#builder()}
*
*
* @param putDestinationRequest
* A {@link Consumer} that will call methods on {@link PutDestinationRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutDestination operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestination
* @see AWS API
* Documentation
*/
default CompletableFuture putDestination(Consumer putDestinationRequest) {
return putDestination(PutDestinationRequest.builder().applyMutation(putDestinationRequest).build());
}
/**
*
* Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is
* used to authorize claims to register a subscription filter against a given destination.
*
*
* @param putDestinationPolicyRequest
* @return A Java Future containing the result of the PutDestinationPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestinationPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putDestinationPolicy(
PutDestinationPolicyRequest putDestinationPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is
* used to authorize claims to register a subscription filter against a given destination.
*
*
*
* This is a convenience which creates an instance of the {@link PutDestinationPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutDestinationPolicyRequest#builder()}
*
*
* @param putDestinationPolicyRequest
* A {@link Consumer} that will call methods on {@link PutDestinationPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutDestinationPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutDestinationPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putDestinationPolicy(
Consumer putDestinationPolicyRequest) {
return putDestinationPolicy(PutDestinationPolicyRequest.builder().applyMutation(putDestinationPolicyRequest).build());
}
/**
*
* Uploads a batch of log events to the specified log stream.
*
*
* You must include the sequence token obtained from the response of the previous call. An upload in a newly created
* log stream does not require a sequence token. You can also get the sequence token in the
* expectedSequenceToken field from InvalidSequenceTokenException. If you call
* PutLogEvents twice within a narrow time period using the same value for sequenceToken,
* both calls might be successful or one might be rejected.
*
*
* The batch of events must satisfy the following constraints:
*
*
* -
*
* The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8,
* plus 26 bytes for each log event.
*
*
* -
*
* None of the log events in the batch can be more than 2 hours in the future.
*
*
* -
*
* None of the log events in the batch can be older than 14 days or older than the retention period of the log
* group.
*
*
* -
*
* The log events in the batch must be in chronological order by their timestamp. The timestamp is the time the
* event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for
* PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,
* 2017-09-15T13:45:30.)
*
*
* -
*
* A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
*
*
* -
*
* The maximum number of log events in a batch is 10,000.
*
*
* -
*
* There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be
* changed.
*
*
*
*
* If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid
* AWS access key ID or secret key.
*
*
* @param putLogEventsRequest
* @return A Java Future containing the result of the PutLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - InvalidSequenceTokenException The sequence token is not valid. You can get the correct sequence token
* in the
expectedSequenceToken field in the InvalidSequenceTokenException
* message.
* - DataAlreadyAcceptedException The event was already logged.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - UnrecognizedClientException The most likely cause is an invalid AWS access key ID or secret key.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture putLogEvents(PutLogEventsRequest putLogEventsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Uploads a batch of log events to the specified log stream.
*
*
* You must include the sequence token obtained from the response of the previous call. An upload in a newly created
* log stream does not require a sequence token. You can also get the sequence token in the
* expectedSequenceToken field from InvalidSequenceTokenException. If you call
* PutLogEvents twice within a narrow time period using the same value for sequenceToken,
* both calls might be successful or one might be rejected.
*
*
* The batch of events must satisfy the following constraints:
*
*
* -
*
* The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of all event messages in UTF-8,
* plus 26 bytes for each log event.
*
*
* -
*
* None of the log events in the batch can be more than 2 hours in the future.
*
*
* -
*
* None of the log events in the batch can be older than 14 days or older than the retention period of the log
* group.
*
*
* -
*
* The log events in the batch must be in chronological order by their timestamp. The timestamp is the time the
* event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for
* PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example,
* 2017-09-15T13:45:30.)
*
*
* -
*
* A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
*
*
* -
*
* The maximum number of log events in a batch is 10,000.
*
*
* -
*
* There is a quota of 5 requests per second per log stream. Additional requests are throttled. This quota can't be
* changed.
*
*
*
*
* If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid
* AWS access key ID or secret key.
*
*
*
* This is a convenience which creates an instance of the {@link PutLogEventsRequest.Builder} avoiding the need to
* create one manually via {@link PutLogEventsRequest#builder()}
*
*
* @param putLogEventsRequest
* A {@link Consumer} that will call methods on {@link PutLogEventsRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutLogEvents operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - InvalidSequenceTokenException The sequence token is not valid. You can get the correct sequence token
* in the
expectedSequenceToken field in the InvalidSequenceTokenException
* message.
* - DataAlreadyAcceptedException The event was already logged.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - UnrecognizedClientException The most likely cause is an invalid AWS access key ID or secret key.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutLogEvents
* @see AWS API
* Documentation
*/
default CompletableFuture putLogEvents(Consumer putLogEventsRequest) {
return putLogEvents(PutLogEventsRequest.builder().applyMutation(putLogEventsRequest).build());
}
/**
*
* Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to
* configure rules to extract metric data from log events ingested through PutLogEvents.
*
*
* The maximum number of metric filters that can be associated with a log group is 100.
*
*
* @param putMetricFilterRequest
* @return A Java Future containing the result of the PutMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricFilter(PutMetricFilterRequest putMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to
* configure rules to extract metric data from log events ingested through PutLogEvents.
*
*
* The maximum number of metric filters that can be associated with a log group is 100.
*
*
*
* This is a convenience which creates an instance of the {@link PutMetricFilterRequest.Builder} avoiding the need
* to create one manually via {@link PutMetricFilterRequest#builder()}
*
*
* @param putMetricFilterRequest
* A {@link Consumer} that will call methods on {@link PutMetricFilterRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture putMetricFilter(
Consumer putMetricFilterRequest) {
return putMetricFilter(PutMetricFilterRequest.builder().applyMutation(putMetricFilterRequest).build());
}
/**
*
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with
* CloudWatch Logs Insights.
*
*
* To update a query definition, specify its queryDefinitionId in your request. The values of
* name, queryString, and logGroupNames are changed to the values that you
* specify in your update operation. No current values are retained from the current query definition. For example,
* if you update a current query definition that includes log groups, and you don't specify the
* logGroupNames parameter in your update operation, the query definition changes to contain no log
* groups.
*
*
* You must have the logs:PutQueryDefinition permission to be able to perform this operation.
*
*
* @param putQueryDefinitionRequest
* @return A Java Future containing the result of the PutQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutQueryDefinition
* @see AWS API
* Documentation
*/
default CompletableFuture putQueryDefinition(PutQueryDefinitionRequest putQueryDefinitionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with
* CloudWatch Logs Insights.
*
*
* To update a query definition, specify its queryDefinitionId in your request. The values of
* name, queryString, and logGroupNames are changed to the values that you
* specify in your update operation. No current values are retained from the current query definition. For example,
* if you update a current query definition that includes log groups, and you don't specify the
* logGroupNames parameter in your update operation, the query definition changes to contain no log
* groups.
*
*
* You must have the logs:PutQueryDefinition permission to be able to perform this operation.
*
*
*
* This is a convenience which creates an instance of the {@link PutQueryDefinitionRequest.Builder} avoiding the
* need to create one manually via {@link PutQueryDefinitionRequest#builder()}
*
*
* @param putQueryDefinitionRequest
* A {@link Consumer} that will call methods on {@link PutQueryDefinitionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutQueryDefinition operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutQueryDefinition
* @see AWS API
* Documentation
*/
default CompletableFuture putQueryDefinition(
Consumer putQueryDefinitionRequest) {
return putQueryDefinition(PutQueryDefinitionRequest.builder().applyMutation(putQueryDefinitionRequest).build());
}
/**
*
* Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
* Amazon Route 53. An account can have up to 10 resource policies per AWS Region.
*
*
* @param putResourcePolicyRequest
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a resource policy allowing other AWS services to put log events to this account, such as
* Amazon Route 53. An account can have up to 10 resource policies per AWS Region.
*
*
*
* This is a convenience which creates an instance of the {@link PutResourcePolicyRequest.Builder} avoiding the need
* to create one manually via {@link PutResourcePolicyRequest#builder()}
*
*
* @param putResourcePolicyRequest
* A {@link Consumer} that will call methods on {@link PutResourcePolicyRequest.Builder} to create a request.
* @return A Java Future containing the result of the PutResourcePolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutResourcePolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putResourcePolicy(
Consumer putResourcePolicyRequest) {
return putResourcePolicy(PutResourcePolicyRequest.builder().applyMutation(putResourcePolicyRequest).build());
}
/**
*
* Sets the retention of the specified log group. A retention policy allows you to configure the number of days for
* which to retain log events in the specified log group.
*
*
* @param putRetentionPolicyRequest
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutRetentionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putRetentionPolicy(PutRetentionPolicyRequest putRetentionPolicyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Sets the retention of the specified log group. A retention policy allows you to configure the number of days for
* which to retain log events in the specified log group.
*
*
*
* This is a convenience which creates an instance of the {@link PutRetentionPolicyRequest.Builder} avoiding the
* need to create one manually via {@link PutRetentionPolicyRequest#builder()}
*
*
* @param putRetentionPolicyRequest
* A {@link Consumer} that will call methods on {@link PutRetentionPolicyRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutRetentionPolicy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutRetentionPolicy
* @see AWS API
* Documentation
*/
default CompletableFuture putRetentionPolicy(
Consumer putRetentionPolicyRequest) {
return putRetentionPolicy(PutRetentionPolicyRequest.builder().applyMutation(putRetentionPolicyRequest).build());
}
/**
*
* Creates or updates a subscription filter and associates it with the specified log group. Subscription filters
* allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving
* service, they are Base64 encoded and compressed with the gzip format.
*
*
* The following destinations are supported for subscription filters:
*
*
* -
*
* An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
*
*
* -
*
* A logical destination that belongs to a different account, for cross-account delivery.
*
*
* -
*
* An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for
* same-account delivery.
*
*
* -
*
* An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
*
*
*
*
* There can only be one subscription filter associated with a log group. If you are updating an existing filter,
* you must specify the correct name in filterName. Otherwise, the call fails because you cannot
* associate a second filter with a log group.
*
*
* To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole
* permission.
*
*
* @param putSubscriptionFilterRequest
* @return A Java Future containing the result of the PutSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture putSubscriptionFilter(
PutSubscriptionFilterRequest putSubscriptionFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates or updates a subscription filter and associates it with the specified log group. Subscription filters
* allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. When log events are sent to the receiving
* service, they are Base64 encoded and compressed with the gzip format.
*
*
* The following destinations are supported for subscription filters:
*
*
* -
*
* An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
*
*
* -
*
* A logical destination that belongs to a different account, for cross-account delivery.
*
*
* -
*
* An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for
* same-account delivery.
*
*
* -
*
* An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.
*
*
*
*
* There can only be one subscription filter associated with a log group. If you are updating an existing filter,
* you must specify the correct name in filterName. Otherwise, the call fails because you cannot
* associate a second filter with a log group.
*
*
* To perform a PutSubscriptionFilter operation, you must also have the iam:PassRole
* permission.
*
*
*
* This is a convenience which creates an instance of the {@link PutSubscriptionFilterRequest.Builder} avoiding the
* need to create one manually via {@link PutSubscriptionFilterRequest#builder()}
*
*
* @param putSubscriptionFilterRequest
* A {@link Consumer} that will call methods on {@link PutSubscriptionFilterRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutSubscriptionFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - OperationAbortedException Multiple requests to update the same resource were in conflict.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.PutSubscriptionFilter
* @see AWS
* API Documentation
*/
default CompletableFuture putSubscriptionFilter(
Consumer putSubscriptionFilterRequest) {
return putSubscriptionFilter(PutSubscriptionFilterRequest.builder().applyMutation(putSubscriptionFilterRequest).build());
}
/**
*
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to
* query and the query string to use.
*
*
* For more information, see CloudWatch Logs Insights
* Query Syntax.
*
*
* Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being
* searched or partition your query into a number of queries.
*
*
* @param startQueryRequest
* @return A Java Future containing the result of the StartQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - MalformedQueryException The query string is not valid. Details about this error are displayed in a
*
QueryCompileError object. For more information, see QueryCompileError.
*
* For more information about valid query syntax, see CloudWatch Logs
* Insights Query Syntax.
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartQuery
* @see AWS API
* Documentation
*/
default CompletableFuture startQuery(StartQueryRequest startQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to
* query and the query string to use.
*
*
* For more information, see CloudWatch Logs Insights
* Query Syntax.
*
*
* Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being
* searched or partition your query into a number of queries.
*
*
*
* This is a convenience which creates an instance of the {@link StartQueryRequest.Builder} avoiding the need to
* create one manually via {@link StartQueryRequest#builder()}
*
*
* @param startQueryRequest
* A {@link Consumer} that will call methods on {@link StartQueryRequest.Builder} to create a request.
* @return A Java Future containing the result of the StartQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - MalformedQueryException The query string is not valid. Details about this error are displayed in a
*
QueryCompileError object. For more information, see QueryCompileError.
*
* For more information about valid query syntax, see CloudWatch Logs
* Insights Query Syntax.
* - InvalidParameterException A parameter is specified incorrectly.
* - LimitExceededException You have reached the maximum number of resources that can be created.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StartQuery
* @see AWS API
* Documentation
*/
default CompletableFuture startQuery(Consumer startQueryRequest) {
return startQuery(StartQueryRequest.builder().applyMutation(startQueryRequest).build());
}
/**
*
* Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns
* an error indicating that the specified query is not running.
*
*
* @param stopQueryRequest
* @return A Java Future containing the result of the StopQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StopQuery
* @see AWS API
* Documentation
*/
default CompletableFuture stopQuery(StopQueryRequest stopQueryRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns
* an error indicating that the specified query is not running.
*
*
*
* This is a convenience which creates an instance of the {@link StopQueryRequest.Builder} avoiding the need to
* create one manually via {@link StopQueryRequest#builder()}
*
*
* @param stopQueryRequest
* A {@link Consumer} that will call methods on {@link StopQueryRequest.Builder} to create a request.
* @return A Java Future containing the result of the StopQuery operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ResourceNotFoundException The specified resource does not exist.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.StopQuery
* @see AWS API
* Documentation
*/
default CompletableFuture stopQuery(Consumer stopQueryRequest) {
return stopQuery(StopQueryRequest.builder().applyMutation(stopQueryRequest).build());
}
/**
*
* Adds or updates the specified tags for the specified log group.
*
*
* To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
*
*
* For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
*
*
* @param tagLogGroupRequest
* @return A Java Future containing the result of the TagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidParameterException A parameter is specified incorrectly.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture tagLogGroup(TagLogGroupRequest tagLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds or updates the specified tags for the specified log group.
*
*
* To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.
*
*
* For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link TagLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link TagLogGroupRequest#builder()}
*
*
* @param tagLogGroupRequest
* A {@link Consumer} that will call methods on {@link TagLogGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the TagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - InvalidParameterException A parameter is specified incorrectly.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TagLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture tagLogGroup(Consumer tagLogGroupRequest) {
return tagLogGroup(TagLogGroupRequest.builder().applyMutation(tagLogGroupRequest).build());
}
/**
*
* Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to
* validate the correctness of a metric filter pattern.
*
*
* @param testMetricFilterRequest
* @return A Java Future containing the result of the TestMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TestMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture testMetricFilter(TestMetricFilterRequest testMetricFilterRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to
* validate the correctness of a metric filter pattern.
*
*
*
* This is a convenience which creates an instance of the {@link TestMetricFilterRequest.Builder} avoiding the need
* to create one manually via {@link TestMetricFilterRequest#builder()}
*
*
* @param testMetricFilterRequest
* A {@link Consumer} that will call methods on {@link TestMetricFilterRequest.Builder} to create a request.
* @return A Java Future containing the result of the TestMetricFilter operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidParameterException A parameter is specified incorrectly.
* - ServiceUnavailableException The service cannot complete the request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.TestMetricFilter
* @see AWS API
* Documentation
*/
default CompletableFuture testMetricFilter(
Consumer testMetricFilterRequest) {
return testMetricFilter(TestMetricFilterRequest.builder().applyMutation(testMetricFilterRequest).build());
}
/**
*
* Removes the specified tags from the specified log group.
*
*
* To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup.
*
*
* @param untagLogGroupRequest
* @return A Java Future containing the result of the UntagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture untagLogGroup(UntagLogGroupRequest untagLogGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes the specified tags from the specified log group.
*
*
* To list the tags for a log group, use ListTagsLogGroup. To add tags, use TagLogGroup.
*
*
*
* This is a convenience which creates an instance of the {@link UntagLogGroupRequest.Builder} avoiding the need to
* create one manually via {@link UntagLogGroupRequest#builder()}
*
*
* @param untagLogGroupRequest
* A {@link Consumer} that will call methods on {@link UntagLogGroupRequest.Builder} to create a request.
* @return A Java Future containing the result of the UntagLogGroup operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified resource does not exist.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - CloudWatchLogsException Base class for all service exceptions. Unknown exceptions will be thrown as
* an instance of this type.
*
* @sample CloudWatchLogsAsyncClient.UntagLogGroup
* @see AWS API
* Documentation
*/
default CompletableFuture untagLogGroup(Consumer untagLogGroupRequest) {
return untagLogGroup(UntagLogGroupRequest.builder().applyMutation(untagLogGroupRequest).build());
}
}