Class DescribeEventsRequest

    • Method Detail

      • sourceName

        public final String sourceName()

        The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

        Returns:
        The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.
      • sourceType

        public final SourceType sourceType()

        The event source to retrieve events for. If no value is specified, all events are returned.

        If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

        Returns:
        The event source to retrieve events for. If no value is specified, all events are returned.
        See Also:
        SourceType
      • sourceTypeAsString

        public final String sourceTypeAsString()

        The event source to retrieve events for. If no value is specified, all events are returned.

        If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

        Returns:
        The event source to retrieve events for. If no value is specified, all events are returned.
        See Also:
        SourceType
      • startTime

        public final Instant startTime()

        The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

        Returns:
        The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
      • endTime

        public final Instant endTime()

        The end of the time interval for which to retrieve events, specified in ISO 8601 format.

        Returns:
        The end of the time interval for which to retrieve events, specified in ISO 8601 format.
      • duration

        public final Integer duration()

        The number of minutes' worth of events to retrieve.

        Returns:
        The number of minutes' worth of events to retrieve.
      • maxResults

        public final Integer maxResults()

        The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

        The value for MaxResults must be between 20 and 100.

        Returns:
        The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

        The value for MaxResults must be between 20 and 100.

      • nextToken

        public final String nextToken()

        An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

        Returns:
        An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object