RequestTimeline (Azure Cosmos DB Async SDK Direct Internal Implementation 2.6.12 API)

java.lang.Object
- com.microsoft.azure.cosmosdb.internal.RequestTimeline

All Implemented Interfaces:: Iterable<RequestTimeline.Event>

public final class RequestTimeline
extends Object
implements Iterable<RequestTimeline.Event>

Represents the time and duration of important events in the lifetime of a request.

A RequestTimeline represents a timeline as a sequence of RequestTimeline.Event instances with name, time, and duration properties. Hence, one might use this class to represent any timeline.

A RequestTimeline serializes to JSON as an array of RequestTimeline.Event instances. This is the default serialization for any class that implements Iterable.

Example:

 OffsetDateTime startTime = OffsetDateTime.parse("2020-01-07T11:24:12.842749-08:00", DateTimeFormatter.ISO_OFFSET_DATE_TIME);
 sys.out.println(RequestTimeline.of(
     new RequestTimeline.Event("foo", startTime, startTime.plusSeconds(1)),
     new RequestTimeline.Event("bar", startTime.plusSeconds(1), startTime.plusSeconds(2))));

JSON serialization:

 [{"name":"foo","time":"2020-01-07T11:24:12.842749-08:00","duration":"PT1S"},{"name":"bar","time":"2020-01-07T11:24:13.842749-08:00","duration":"PT1S"}])

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RequestTimeline.Event

Nested Classes
Modifier and Type	Class and Description
`static class`	`RequestTimeline.Event`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestTimeline`	`empty()` Returns an empty `RequestTimeline`.
`Iterator<RequestTimeline.Event>`	`iterator()` Returns an iterator for enumerating the `RequestTimeline.Event` instances in this `RequestTimeline`.
`static RequestTimeline`	`of()` Returns an empty `RequestTimeline`.
`static RequestTimeline`	`of(RequestTimeline.Event... events)` Returns a new `RequestTimeline` with an arbitrary number of events.
`static RequestTimeline`	`of(RequestTimeline.Event event)` Returns a new `RequestTimeline` with a single event.
`static RequestTimeline`	`of(RequestTimeline.Event e1, RequestTimeline.Event e2)` Returns a new `RequestTimeline` with a pair of events.
`static RequestTimeline`	`of(RequestTimeline.Event e1, RequestTimeline.Event e2, RequestTimeline.Event e3)` Returns a new `RequestTimeline` with three events.
`static RequestTimeline`	`of(RequestTimeline.Event e1, RequestTimeline.Event e2, RequestTimeline.Event e3, RequestTimeline.Event e4)` Returns a new `RequestTimeline` with four events.
`static RequestTimeline`	`of(RequestTimeline.Event e1, RequestTimeline.Event e2, RequestTimeline.Event e3, RequestTimeline.Event e4, RequestTimeline.Event e5)` Returns a new `RequestTimeline` with five events.
`String`	`toString()` Returns a textual representation of this `RequestTimeline`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Method Detail

empty
```
public static RequestTimeline empty()
```
Returns an empty RequestTimeline. The empty time line returned is static.

Returns:

an empty RequestTimeline.

iterator
```
public Iterator<RequestTimeline.Event> iterator()
```
Returns an iterator for enumerating the RequestTimeline.Event instances in this RequestTimeline.

Specified by:

iterator in interface Iterable<RequestTimeline.Event>

Returns:

an iterator for enumerating the RequestTimeline.Event instances in this RequestTimeline.

of
```
public static RequestTimeline of()
```
Returns an empty RequestTimeline. The empty time line returned is static and equivalent to calling empty().

Returns:

an empty request timeline.

of
```
public static RequestTimeline of(RequestTimeline.Event event)
```
Returns a new RequestTimeline with a single event.

Returns:

a new RequestTimeline with a single event.

of

public static RequestTimeline of(RequestTimeline.Event e1,
                                 RequestTimeline.Event e2)

Returns a new RequestTimeline with a pair of events.

Returns:: a new RequestTimeline with a pair of events.

of

public static RequestTimeline of(RequestTimeline.Event e1,
                                 RequestTimeline.Event e2,
                                 RequestTimeline.Event e3)

Returns a new RequestTimeline with three events.

Returns:: a new RequestTimeline with three events.

of

public static RequestTimeline of(RequestTimeline.Event e1,
                                 RequestTimeline.Event e2,
                                 RequestTimeline.Event e3,
                                 RequestTimeline.Event e4)

Returns a new RequestTimeline with four events.

Returns:: a new RequestTimeline with four events.

of

public static RequestTimeline of(RequestTimeline.Event e1,
                                 RequestTimeline.Event e2,
                                 RequestTimeline.Event e3,
                                 RequestTimeline.Event e4,
                                 RequestTimeline.Event e5)

Returns a new RequestTimeline with five events.

Returns:: a new RequestTimeline with five events.

of
```
public static RequestTimeline of(RequestTimeline.Event... events)
```
Returns a new RequestTimeline with an arbitrary number of events.

Returns:

a new RequestTimeline with an arbitrary number of events.

toString
```
public String toString()
```
Returns a textual representation of this RequestTimeline.
The textual representation returned is a string of the form RequestTimeline( <event-array> ).

Overrides:

toString in class Object

Class RequestTimeline

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

empty

iterator

of

of

of

of

of

of

of

toString