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

Class DescribeLogGroupsRequest

    • 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.

      • logGroupNamePrefix

        public final String logGroupNamePrefix()

        The prefix to match.

        logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

        Returns:
        The prefix to match.

        logGroupNamePrefix and logGroupNamePattern are mutually exclusive. Only one of these parameters can be passed.

      • logGroupNamePattern

        public final String logGroupNamePattern()

        If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify DataLogs, log groups named DataLogs, aws/DataLogs, and GroupDataLogs would match, but datalogs, Data/log/s and Groupdata would not match.

        If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

        logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

        Returns:
        If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify DataLogs, log groups named DataLogs, aws/DataLogs, and GroupDataLogs would match, but datalogs, Data/log/s and Groupdata would not match.

        If you specify logGroupNamePattern in your request, then only arn, creationTime, and logGroupName are included in the response.

        logGroupNamePattern and logGroupNamePrefix are mutually exclusive. Only one of these parameters can be passed.

      • nextToken

        public final String nextToken()

        The token for the next set of items to return. (You received this token from a previous call.)

        Returns:
        The token for the next set of items to return. (You received this token from a previous call.)

      • limit

        public final Integer limit()

        The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

        Returns:
        The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

      • 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()

        Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

        Specifies the log group class for this log group. There are three classes:

        • The Standard log class supports all CloudWatch Logs features.

        • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

        • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

        For details about the features supported by each class, see Log classes

        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:
        Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

        Specifies the log group class for this log group. There are three classes:

        • The Standard log class supports all CloudWatch Logs features.

        • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

        • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

        For details about the features supported by each class, see Log classes

        See Also:
        LogGroupClass

      • logGroupClassAsString

        public final String logGroupClassAsString()

        Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

        Specifies the log group class for this log group. There are three classes:

        • The Standard log class supports all CloudWatch Logs features.

        • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

        • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

        For details about the features supported by each class, see Log classes

        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:
        Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

        Specifies the log group class for this log group. There are three classes:

        • The Standard log class supports all CloudWatch Logs features.

        • The Infrequent Access log class supports a subset of CloudWatch Logs features and incurs lower costs.

        • Use the Delivery log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn't offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

        For details about the features supported by each class, see Log classes

        See Also:
        LogGroupClass

      • hasLogGroupIdentifiers

        public final boolean hasLogGroupIdentifiers()
        For responses, this returns true if the service returned a value for the LogGroupIdentifiers 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.

      • logGroupIdentifiers

        public final List<String> logGroupIdentifiers()

        Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

        If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

        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 hasLogGroupIdentifiers() method.

        Returns:
        Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is includeLinkedAccounts.

        If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

      • 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