Struct aws_sdk_cloudwatchlogs::operation::get_log_group_fields::builders::GetLogGroupFieldsFluentBuilder

pub struct GetLogGroupFieldsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetLogGroupFields.

Returns a list of the fields that are included in log events in the specified log group. Includes the percentage of log events that contain each field. The search is limited to a time period that you specify.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must specify one of these parameters, but you can't specify both.

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.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Implementations

impl GetLogGroupFieldsFluentBuilder

pub fn as_input(&self) -> &GetLogGroupFieldsInputBuilder

Access the GetLogGroupFields as a reference.

pub async fn send( self, ) -> Result<GetLogGroupFieldsOutput, SdkError<GetLogGroupFieldsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<GetLogGroupFieldsOutput, GetLogGroupFieldsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn log_group_name(self, input: impl Into<String>) -> Self

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn set_log_group_name(self, input: Option<String>) -> Self

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn get_log_group_name(&self) -> &Option<String>

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn time(self, input: i64) -> Self

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn set_time(self, input: Option<i64>) -> Self

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn get_time(&self) -> &Option<i64>

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the most recent 15 minutes up to the current time are searched.

The time value is specified as epoch time, which is the number of seconds since January 1, 1970, 00:00:00 UTC.

pub fn log_group_identifier(self, input: impl Into<String>) -> Self

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn set_log_group_identifier(self, input: Option<String>) -> Self

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

pub fn get_log_group_identifier(&self) -> &Option<String>

Specify either the name or ARN of the log group to view. If the log group is in a source account and you are using a monitoring account, you must specify the ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Trait Implementations

impl Clone for GetLogGroupFieldsFluentBuilder

fn clone(&self) -> GetLogGroupFieldsFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetLogGroupFieldsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.