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

Interface DescribeLogGroupsRequest.Builder

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

  • Method Details

    • accountIdentifiers

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

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

    • logGroupNamePrefix

      DescribeLogGroupsRequest.Builder logGroupNamePrefix(String logGroupNamePrefix)

      The prefix to match.

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

      Parameters:
      logGroupNamePrefix - The prefix to match.

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

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

    • logGroupNamePattern

      DescribeLogGroupsRequest.Builder logGroupNamePattern(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 Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo 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.

      Parameters:
      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 Foo, log groups named FooBar, aws/Foo, and GroupFoo would match, but foo, F/o/o and Froo 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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeLogGroupsRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - The token for the next set of items to return. (You received this token from a previous call.)
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      DescribeLogGroupsRequest.Builder limit(Integer limit)

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

      Parameters:
      limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeLinkedAccounts

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

      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.

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

    • logGroupClass

      DescribeLogGroupsRequest.Builder logGroupClass(String logGroupClass)

      Specifies the log group class for this log group. There are two 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.

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

      Parameters:
      logGroupClass - Specifies the log group class for this log group. There are two 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.

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

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

    • logGroupClass

      DescribeLogGroupsRequest.Builder logGroupClass(LogGroupClass logGroupClass)

      Specifies the log group class for this log group. There are two 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.

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

      Parameters:
      logGroupClass - Specifies the log group class for this log group. There are two 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.

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

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

    • overrideConfiguration

      DescribeLogGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeLogGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.