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

Interface StartLiveTailRequest.Builder

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

  • Method Details

    • logGroupIdentifiers

      StartLiveTailRequest.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      An array where each item in the array is a log group to include in the Live Tail session.

      Specify each log group by its ARN.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      You can include up to 10 log groups.

      Parameters:
      logGroupIdentifiers - An array where each item in the array is a log group to include in the Live Tail session.

      Specify each log group by its ARN.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      You can include up to 10 log groups.

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

    • logGroupIdentifiers

      StartLiveTailRequest.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      An array where each item in the array is a log group to include in the Live Tail session.

      Specify each log group by its ARN.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      You can include up to 10 log groups.

      Parameters:
      logGroupIdentifiers - An array where each item in the array is a log group to include in the Live Tail session.

      Specify each log group by its ARN.

      If you specify an ARN, the ARN can't end with an asterisk (*).

      You can include up to 10 log groups.

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

    • logStreamNames

      StartLiveTailRequest.Builder logStreamNames(Collection<String> logStreamNames)

      If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNamePrefixes field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

      Parameters:
      logStreamNames - If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNamePrefixes field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

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

    • logStreamNames

      StartLiveTailRequest.Builder logStreamNames(String... logStreamNames)

      If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNamePrefixes field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

      Parameters:
      logStreamNames - If you specify this parameter, then only log events in the log streams that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNamePrefixes field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

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

    • logStreamNamePrefixes

      StartLiveTailRequest.Builder logStreamNamePrefixes(Collection<String> logStreamNamePrefixes)

      If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNames field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

      Parameters:
      logStreamNamePrefixes - If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNames field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

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

    • logStreamNamePrefixes

      StartLiveTailRequest.Builder logStreamNamePrefixes(String... logStreamNamePrefixes)

      If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNames field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

      Parameters:
      logStreamNamePrefixes - If you specify this parameter, then only log events in the log streams that have names that start with the prefixes that you specify here are included in the Live Tail session.

      If you specify this field, you can't also specify the logStreamNames field.

      You can specify this parameter only if you specify only one log group in logGroupIdentifiers.

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

    • logEventFilterPattern

      StartLiveTailRequest.Builder logEventFilterPattern(String logEventFilterPattern)

      An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 causes only log events that include both error and 404 to be included in the Live Tail stream.

      Regular expression filter patterns are supported.

      For more information about filter pattern syntax, see Filter and Pattern Syntax.

      Parameters:
      logEventFilterPattern - An optional pattern to use to filter the results to include only log events that match the pattern. For example, a filter pattern of error 404 causes only log events that include both error and 404 to be included in the Live Tail stream.

      Regular expression filter patterns are supported.

      For more information about filter pattern syntax, see Filter and Pattern Syntax.

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

    • overrideConfiguration

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

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