Package Torello.Browser

Class Network.ReportingApiReport

java.lang.Object

Torello.Java.Additional.BaseType

Torello.Browser.Network.ReportingApiReport

Enclosing class:

Network

public static class Network.ReportingApiReport
extends BaseType

An object representing a report generated by the Reporting API.

EXPERIMENTAL

Hi-Lited Source-Code:

• View Here: Torello/Browser/Network.java
• Open New Browser-Tab: Torello/Browser/Network.java

File Size: 4,957 Bytes Line Count: 111 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
protected static long	serialVersionUID	For Object Serialization.
Type Properties
Modifier and Type	Field
JsonObject	body	[No Description Provided by Google]
int	completedAttempts	The number of delivery attempts made so far, not including an active attempt.
int	depth	How many uploads deep the related request was.
String	destination	The name of the endpoint group that should be used to deliver the report.
String	id	[No Description Provided by Google]
String	initiatorUrl	The URL of the document that triggered the report.
String	status	[No Description Provided by Google]
Number	timestamp	When the report was generated.
String	type	The type of the report (specifies the set of data that is contained in the report body).

Constructor Summary

Constructors

Constructor	Description
ReportingApiReport(String id, String initiatorUrl, String destination, String type, Number timestamp, int depth, int completedAttempts, JsonObject body, String status)	Constructor
ReportingApiReport(JsonObject jo)	JSON Object Constructor

Method Summary

Modifier and Type	Method	Description
boolean[]	optionals()	Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.

Methods inherited from class Torello.Java.Additional.BaseType

toJSON, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫

protected static final long serialVersionUID

For Object Serialization. java.io.Serializable

See Also:

Constant Field Values

id

🡅 🡇 ⇈ ⮫

public final java.lang.String id

[No Description Provided by Google]

initiatorUrl

🡅 🡇 ⇈ ⮫

public final java.lang.String initiatorUrl

The URL of the document that triggered the report.

destination

🡅 🡇 ⇈ ⮫

public final java.lang.String destination

The name of the endpoint group that should be used to deliver the report.

type

🡅 🡇 ⇈ ⮫

public final java.lang.String type

The type of the report (specifies the set of data that is contained in the report body).

timestamp

🡅 🡇 ⇈ ⮫

public final java.lang.Number timestamp

When the report was generated.

depth

🡅 🡇 ⇈ ⮫

public final int depth

How many uploads deep the related request was.

completedAttempts

🡅 🡇 ⇈ ⮫

public final int completedAttempts

The number of delivery attempts made so far, not including an active attempt.

body

🡅 🡇 ⇈ ⮫

public final JsonObject body

[No Description Provided by Google]

status

🡅 🡇 ⇈ ⮫

public final java.lang.String status

[No Description Provided by Google]

Constructor Detail

ReportingApiReport

🡅 🡇 ⇈ ⮫

public ReportingApiReport(java.lang.String id,
                          java.lang.String initiatorUrl,
                          java.lang.String destination,
                          java.lang.String type,
                          java.lang.Number timestamp,
                          int depth,
                          int completedAttempts,
                          JsonObject body,
                          java.lang.String status)

Constructor

Parameters:

id - -

initiatorUrl - The URL of the document that triggered the report.

destination - The name of the endpoint group that should be used to deliver the report.

type - The type of the report (specifies the set of data that is contained in the report body).

timestamp - When the report was generated.

depth - How many uploads deep the related request was.

completedAttempts - The number of delivery attempts made so far, not including an active attempt.

body - -

status - -

ReportingApiReport

🡅 🡇 ⇈ ⮫

public ReportingApiReport(JsonObject jo)

JSON Object Constructor

Parameters:

jo - A Json-Object having data about an instance of 'ReportingApiReport'.

Method Detail

optionals

🡅 ⇈ ⮫

public boolean[] optionals()

Description copied from class: BaseType

Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...

Specified by:

optionals in class BaseType

Returns:

A boolean[] array whose length is precisely equal to the number of fields in the Java Object.