Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface ListAggregateLogGroupSummariesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>, SdkBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListAggregateLogGroupSummariesRequest
@Mutable @NotThreadSafe public static interface ListAggregateLogGroupSummariesRequest.Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>

  • Method Details

    • accountIdentifiers

      ListAggregateLogGroupSummariesRequest.Builder accountIdentifiers(Collection<String> accountIdentifiers)

      When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

      Parameters:
      accountIdentifiers - When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountIdentifiers

      ListAggregateLogGroupSummariesRequest.Builder accountIdentifiers(String... accountIdentifiers)

      When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

      Parameters:
      accountIdentifiers - When includeLinkedAccounts is set to true, use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeLinkedAccounts

      ListAggregateLogGroupSummariesRequest.Builder includeLinkedAccounts(Boolean includeLinkedAccounts)

      If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.

      If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

      The default for this parameter is false.

      Parameters:
      includeLinkedAccounts - If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers.

      If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

      The default for this parameter is false.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupClass

      ListAggregateLogGroupSummariesRequest.Builder logGroupClass(String logGroupClass)

      Filters the results by log group class to include only log groups of the specified class.

      Parameters:
      logGroupClass - Filters the results by log group class to include only log groups of the specified class.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logGroupClass

      ListAggregateLogGroupSummariesRequest.Builder logGroupClass(LogGroupClass logGroupClass)

      Filters the results by log group class to include only log groups of the specified class.

      Parameters:
      logGroupClass - Filters the results by log group class to include only log groups of the specified class.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logGroupNamePattern

      ListAggregateLogGroupSummariesRequest.Builder logGroupNamePattern(String logGroupNamePattern)

      Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.

      • Use ^ to match log group names by prefix.

      • For a substring match, specify the string to match. All matches are case sensitive

      • To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery

      You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.

      Parameters:
      logGroupNamePattern - Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.

      • Use ^ to match log group names by prefix.

      • For a substring match, specify the string to match. All matches are case sensitive

      • To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery

      You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSources

      ListAggregateLogGroupSummariesRequest.Builder dataSources(Collection<DataSourceFilter> dataSources)

      Filters the results by data source characteristics to include only log groups associated with the specified data sources.

      Parameters:
      dataSources - Filters the results by data source characteristics to include only log groups associated with the specified data sources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSources

      ListAggregateLogGroupSummariesRequest.Builder dataSources(DataSourceFilter... dataSources)

      Filters the results by data source characteristics to include only log groups associated with the specified data sources.

      Parameters:
      dataSources - Filters the results by data source characteristics to include only log groups associated with the specified data sources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSources

      ListAggregateLogGroupSummariesRequest.Builder dataSources(Consumer<DataSourceFilter.Builder>... dataSources)

      Filters the results by data source characteristics to include only log groups associated with the specified data sources.

      This is a convenience method that creates an instance of the DataSourceFilter.Builder avoiding the need to create one manually via DataSourceFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSources(List<DataSourceFilter>).

      Parameters:
      dataSources - a consumer that will call methods on DataSourceFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      ListAggregateLogGroupSummariesRequest.Builder groupBy(String groupBy)

      Specifies how to group the log groups in the summary.

      Parameters:
      groupBy - Specifies how to group the log groups in the summary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupBy

      ListAggregateLogGroupSummariesRequest.Builder groupBy(ListAggregateLogGroupSummariesGroupBy groupBy)

      Specifies how to group the log groups in the summary.

      Parameters:
      groupBy - Specifies how to group the log groups in the summary.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      ListAggregateLogGroupSummariesRequest.Builder nextToken(String nextToken)
      Sets the value of the NextToken property for this object.
      Parameters:
      nextToken - The new value for the NextToken property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      ListAggregateLogGroupSummariesRequest.Builder limit(Integer limit)

      The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.

      Parameters:
      limit - The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListAggregateLogGroupSummariesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      ListAggregateLogGroupSummariesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder