Interface StartQueryRequest.Builder

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

  • Method Details

    • queryLanguage

      StartQueryRequest.Builder queryLanguage(String queryLanguage)

      Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

      Parameters:
      queryLanguage - Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryLanguage

      StartQueryRequest.Builder queryLanguage(QueryLanguage queryLanguage)

      Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

      Parameters:
      queryLanguage - Specify the query language to use for this query. The options are Logs Insights QL, OpenSearch PPL, and OpenSearch SQL. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • logGroupName

      StartQueryRequest.Builder logGroupName(String logGroupName)

      The log group on which to perform the query.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

      Parameters:
      logGroupName - The log group on which to perform the query.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

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

    • logGroupNames

      StartQueryRequest.Builder logGroupNames(Collection<String> logGroupNames)

      The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

      Parameters:
      logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

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

    • logGroupNames

      StartQueryRequest.Builder logGroupNames(String... logGroupNames)

      The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

      Parameters:
      logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

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

    • logGroupIdentifiers

      StartQueryRequest.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

      The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

      Parameters:
      logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

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

    • logGroupIdentifiers

      StartQueryRequest.Builder logGroupIdentifiers(String... logGroupIdentifiers)

      The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

      Parameters:
      logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

      You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

      If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

      A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers. The exception is queries using the OpenSearch Service SQL query language, where you specify the log group names inside the querystring instead of here.

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

    • startTime

      StartQueryRequest.Builder startTime(Long startTime)

      The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

      Parameters:
      startTime - The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      StartQueryRequest.Builder endTime(Long endTime)

      The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

      Parameters:
      endTime - The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      StartQueryRequest.Builder queryString(String queryString)

      The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

      Parameters:
      queryString - The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • limit

      StartQueryRequest.Builder limit(Integer limit)

      The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 10,000.

      Parameters:
      limit - The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 10,000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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