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

Interface StartQueryRequest.Builder

    • Method Detail

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

        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.

        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.

        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.

        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.

        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.

        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, the ARN can't end with an asterisk (*).

        A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

        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, the ARN can't end with an asterisk (*).

        A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

        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, the ARN can't end with an asterisk (*).

        A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

        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, the ARN can't end with an asterisk (*).

        A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

        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.

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