Package Torello.Browser.BrowserAPI

Class Network.ReportingApiReport

java.lang.Object

Torello.Browser.BaseType<Network.ReportingApiReport>

Torello.Browser.BrowserAPI.Network.ReportingApiReport

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

Network

public static class Network.ReportingApiReport
extends BaseType<Network.ReportingApiReport>
implements java.io.Serializable

This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in the Network domain, which may be found within the BrowserAPI.

📌 All browser domain type classes will have a class name that begins with an upper case letter.

An object representing a report generated by the Reporting API.
EXPERIMENTAL

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 3,370 Bytes Line Count: 81 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Network$$ReportingApiReport$$.java
• Open New Browser-Tab: Network$$ReportingApiReport$$.java

File Size: 12,062 Bytes Line Count: 294 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field	Description
protected static long	serialVersionUID
Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
JsonValue	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).

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
ReportingApiReport(ReadOnlyList<Boolean> isPresent, String id, String initiatorUrl, String destination, String type, Number timestamp, int depth, int completedAttempts, JsonValue body, String status)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Network.ReportingApiReport	fromJSON(JsonObject jo)	Creates an instance of this class from a JsonObject.
Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
static NestedDescriptor<Network.ReportingApiReport>	descriptor()	Returns this class's NestedDescriptor singleton-instance.

Methods inherited from class Torello.Browser.BaseType

allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

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 JsonValue body

[No Description Provided by Google]

status

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String status

[No Description Provided by Google]

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:

📎 Network.ReportStatus

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = Network.ReportStatus.enumStrList("status");

// Print the list of strings to the terminal
for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");

See Also:

BaseType.enumStrList(String)

Constructor Detail

ReportingApiReport

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public ReportingApiReport(ReadOnlyList<java.lang.Boolean> isPresent,
                          java.lang.String id,
                          java.lang.String initiatorUrl,
                          java.lang.String destination,
                          java.lang.String type,
                          java.lang.Number timestamp,
                          int depth,
                          int completedAttempts,
                          JsonValue body,
                          java.lang.String status)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Network.ReportingApiReport fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Network.ReportingApiReport> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();