java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest
    - - software.amazon.awssdk.services.cloudwatchlogs.model.ListAggregateLogGroupSummariesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListAggregateLogGroupSummariesRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListAggregateLogGroupSummariesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`accountIdentifiers()`	When `includeLinkedAccounts` is set to `true`, use this parameter to specify the list of accounts to search.
`static ListAggregateLogGroupSummariesRequest.Builder`	`builder()`
`List<DataSourceFilter>`	`dataSources()`	Filters the results by data source characteristics to include only log groups associated with the specified data sources.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`ListAggregateLogGroupSummariesGroupBy`	`groupBy()`	Specifies how to group the log groups in the summary.
`String`	`groupByAsString()`	Specifies how to group the log groups in the summary.
`boolean`	`hasAccountIdentifiers()`	For responses, this returns true if the service returned a value for the AccountIdentifiers property.
`boolean`	`hasDataSources()`	For responses, this returns true if the service returned a value for the DataSources property.
`int`	`hashCode()`
`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`.
`Integer`	`limit()`	The maximum number of aggregated summaries to return.
`LogGroupClass`	`logGroupClass()`	Filters the results by log group class to include only log groups of the specified class.
`String`	`logGroupClassAsString()`	Filters the results by log group class to include only log groups of the specified class.
`String`	`logGroupNamePattern()`	Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify.
`String`	`nextToken()`	Returns the value of the NextToken property for this object.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListAggregateLogGroupSummariesRequest.Builder>`	`serializableBuilderClass()`
`ListAggregateLogGroupSummariesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasAccountIdentifiers
```
public final boolean hasAccountIdentifiers()
```
    For responses, this returns true if the service returned a value for the AccountIdentifiers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - accountIdentifiers
```
public final List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccountIdentifiers() method.
    
    Returns:
    
    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.
  - includeLinkedAccounts
```
public final 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.
    
    Returns:
    
    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.
  - logGroupClass
```
public final LogGroupClass logGroupClass()
```
    Filters the results by log group class to include only log groups of the specified class.
    
    If the service returns an enum value that is not available in the current SDK version, logGroupClass will return LogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logGroupClassAsString().
    
    Returns:
    
    Filters the results by log group class to include only log groups of the specified class.
    
    See Also:
    
    LogGroupClass
  - logGroupClassAsString
```
public final String logGroupClassAsString()
```
    Filters the results by log group class to include only log groups of the specified class.
    
    If the service returns an enum value that is not available in the current SDK version, logGroupClass will return LogGroupClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logGroupClassAsString().
    
    Returns:
    
    Filters the results by log group class to include only log groups of the specified class.
    
    See Also:
    
    LogGroupClass
  - logGroupNamePattern
```
public final 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.
    Returns:
    
    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.
  - hasDataSources
```
public final boolean hasDataSources()
```
    For responses, this returns true if the service returned a value for the DataSources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dataSources
```
public final List<DataSourceFilter> dataSources()
```
    Filters the results by data source characteristics to include only log groups associated with the specified data sources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataSources() method.
    
    Returns:
    
    Filters the results by data source characteristics to include only log groups associated with the specified data sources.
  - groupBy
```
public final ListAggregateLogGroupSummariesGroupBy groupBy()
```
    Specifies how to group the log groups in the summary.
    
    If the service returns an enum value that is not available in the current SDK version, groupBy will return ListAggregateLogGroupSummariesGroupBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().
    
    Returns:
    
    Specifies how to group the log groups in the summary.
    
    See Also:
    
    ListAggregateLogGroupSummariesGroupBy
  - groupByAsString
```
public final String groupByAsString()
```
    Specifies how to group the log groups in the summary.
    
    If the service returns an enum value that is not available in the current SDK version, groupBy will return ListAggregateLogGroupSummariesGroupBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from groupByAsString().
    
    Returns:
    
    Specifies how to group the log groups in the summary.
    
    See Also:
    
    ListAggregateLogGroupSummariesGroupBy
  - nextToken
```
public final String nextToken()
```
    Returns the value of the NextToken property for this object.
    
    Returns:
    
    The value of the NextToken property for this object.
  - limit
```
public final Integer limit()
```
    The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.
    
    Returns:
    
    The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.
  - toBuilder
```
public ListAggregateLogGroupSummariesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListAggregateLogGroupSummariesRequest.Builder,ListAggregateLogGroupSummariesRequest>
    
    Specified by:
    
    toBuilder in class CloudWatchLogsRequest
  - builder
```
public static ListAggregateLogGroupSummariesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListAggregateLogGroupSummariesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListAggregateLogGroupSummariesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAccountIdentifiers

accountIdentifiers

includeLinkedAccounts

logGroupClass

logGroupClassAsString

logGroupNamePattern

hasDataSources

dataSources

groupBy

groupByAsString

nextToken

limit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField