Interface DescribeFieldIndexesRequest.Builder

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

  • Method Details

    • logGroupIdentifiers

      DescribeFieldIndexesRequest.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.

      Parameters:
      logGroupIdentifiers - An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logGroupIdentifiers

      DescribeFieldIndexesRequest.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.

      Parameters:
      logGroupIdentifiers - An array containing the names or ARNs of the log groups that you want to retrieve field indexes for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • indexCategoriesWithStrings

      DescribeFieldIndexesRequest.Builder indexCategoriesWithStrings(Collection<String> indexCategories)

      The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

      Parameters:
      indexCategories - The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

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

    • indexCategoriesWithStrings

      DescribeFieldIndexesRequest.Builder indexCategoriesWithStrings(String... indexCategories)

      The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

      Parameters:
      indexCategories - The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

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

    • indexCategories

      DescribeFieldIndexesRequest.Builder indexCategories(Collection<IndexCategory> indexCategories)

      The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

      Parameters:
      indexCategories - The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

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

    • indexCategories

      DescribeFieldIndexesRequest.Builder indexCategories(IndexCategory... indexCategories)

      The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

      Parameters:
      indexCategories - The index categories to return. The following values are supported:

      • DEFAULT: Fields that CloudWatch Logs indexes by default. Examples include @logStream and @data_format.

      • CUSTOM: Fields that you added manually to the field index policy. CloudWatch Logs always indexes these fields. These fields count toward the quota of 20 fields for each log group.

      • AUTO: Fields that CloudWatch Logs indexes automatically based on your query patterns and usage. These fields do not count toward the field index quota. CloudWatch Logs might update these fields based on changes in your query patterns. To keep a field indexed permanently, add it to an account-level or log-group level field index policy.

      • INACTIVE: Fields that CloudWatch Logs indexed before but does not index now. This happens if you remove a field from the field index policy or if CloudWatch Logs automatically selects a different field based on your queries.

      If you omit this parameter, the response includes the DEFAULT, CUSTOM, and INACTIVE categories.

      For more information about automatically indexed fields and using the AUTO category, see Automatically indexed fields.

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

    • nextToken

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

    • overrideConfiguration

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

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