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

Interface FilterLogEventsRequest.Builder

    • Method Detail

      • logGroupName

        FilterLogEventsRequest.Builder logGroupName​(String logGroupName)

        The name of the log group to search.

        You must include either logGroupIdentifier or logGroupName, but not both.

        Parameters:
        logGroupName - The name of the log group to search.

        You must include either logGroupIdentifier or logGroupName, but not both.

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

      • logGroupIdentifier

        FilterLogEventsRequest.Builder logGroupIdentifier​(String logGroupIdentifier)

        Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

        You must include either logGroupIdentifier or logGroupName, but not both.

        Parameters:
        logGroupIdentifier - Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

        You must include either logGroupIdentifier or logGroupName, but not both.

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

      • logStreamNames

        FilterLogEventsRequest.Builder logStreamNames​(Collection<String> logStreamNames)

        Filters the results to only logs from the log streams in this list.

        If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

        Parameters:
        logStreamNames - Filters the results to only logs from the log streams in this list.

        If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

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

      • logStreamNames

        FilterLogEventsRequest.Builder logStreamNames​(String... logStreamNames)

        Filters the results to only logs from the log streams in this list.

        If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

        Parameters:
        logStreamNames - Filters the results to only logs from the log streams in this list.

        If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

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

      • logStreamNamePrefix

        FilterLogEventsRequest.Builder logStreamNamePrefix​(String logStreamNamePrefix)

        Filters the results to include only events from log streams that have names starting with this prefix.

        If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

        Parameters:
        logStreamNamePrefix - Filters the results to include only events from log streams that have names starting with this prefix.

        If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

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

      • startTime

        FilterLogEventsRequest.Builder startTime​(Long startTime)

        The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

        Parameters:
        startTime - The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        FilterLogEventsRequest.Builder endTime​(Long endTime)

        The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

        Parameters:
        endTime - The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterPattern

        FilterLogEventsRequest.Builder filterPattern​(String filterPattern)

        The filter pattern to use. For more information, see Filter and Pattern Syntax.

        If not provided, all the events are matched.

        Parameters:
        filterPattern - The filter pattern to use. For more information, see Filter and Pattern Syntax.

        If not provided, all the events are matched.

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

      • nextToken

        FilterLogEventsRequest.Builder nextToken​(String nextToken)

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

        Parameters:
        nextToken - The token for the next set of events 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

        FilterLogEventsRequest.Builder limit​(Integer limit)

        The maximum number of events to return. The default is 10,000 events.

        Parameters:
        limit - The maximum number of events to return. The default is 10,000 events.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • interleaved

        @Deprecated
FilterLogEventsRequest.Builder interleaved​(Boolean interleaved)
        Deprecated.
        Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.

        If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

        Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

        Parameters:
        interleaved - If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

        Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

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

      • unmask

        FilterLogEventsRequest.Builder unmask​(Boolean unmask)

        Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

        To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

        Parameters:
        unmask - Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

        To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

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