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

Interface ListLogGroupsRequest.Builder

    • Method Detail

      • logGroupNamePattern

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

      • logGroupClass

        ListLogGroupsRequest.Builder logGroupClass​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LogGroupClass, LogGroupClass

      • logGroupClass

        ListLogGroupsRequest.Builder logGroupClass​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LogGroupClass, LogGroupClass

      • includeLinkedAccounts

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

      • accountIdentifiers

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

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

      • nextToken

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

        ListLogGroupsRequest.Builder limit​(Integer limit)

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

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

      • dataSources

        ListLogGroupsRequest.Builder dataSources​(Collection<DataSourceFilter> dataSources)

        An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.

        Parameters:
        dataSources - An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSources

        ListLogGroupsRequest.Builder dataSources​(DataSourceFilter... dataSources)

        An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.

        Parameters:
        dataSources - An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataSources

        ListLogGroupsRequest.Builder dataSources​(Consumer<DataSourceFilter.Builder>... dataSources)

        An array of data source filters to filter log groups by their associated data sources. You can filter by data source name, type, or both. Multiple filters within the same dimension are combined with OR logic, while filters across different dimensions are combined with AND logic.

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

        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:
        #dataSources(java.util.Collection)

      • fieldIndexNames

        ListLogGroupsRequest.Builder fieldIndexNames​(Collection<String> fieldIndexNames)

        An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.

        Parameters:
        fieldIndexNames - An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fieldIndexNames

        ListLogGroupsRequest.Builder fieldIndexNames​(String... fieldIndexNames)

        An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.

        Parameters:
        fieldIndexNames - An array of field index names to filter log groups that have specific field indexes. Only log groups containing all specified field indexes are returned. You can specify 1 to 20 field index names, each with 1 to 512 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.