Payload (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.components.reporting.Payload

Represents a reporting system data in a format compatible with a DevOpsInsight Server.

Properties Summary

Properties
Type	Name and description
`java.util.ArrayList<Payload>`	`dependentPayloads` Payload can have dependent values
`java.lang.String`	`reportObjectType` Name of the reporting object type
`java.util.Map<java.lang.String, java.lang.Object>`	`values` Report values

Constructor Summary

Constructors
Constructor and description
`Payload (java.util.Map<java.lang.String, java.lang.Object> values)` Constructor

Methods Summary

Methods
Type Params	Return Type	Name and description
	`Payload`	`addDependentPayload(Payload dependentPayload)` Saves given Payload as a dependent for current instance
	`Payload`	`convertDependentDataToPayloadRecursive(Payload payload, Data data)` Recursively goes through the Data in a Payload and converts the dependent values
	`Payload`	`createNewDependentPayload(java.lang.String reportObjectType, java.util.Map<java.lang.String, java.lang.Object> values = [:])` Creates new Payload and saves it as a dependent for current instance
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.util.ArrayList<Payload> dependentPayloads
    
    Payload can have dependent values
  - java.lang.String reportObjectType
    
    Name of the reporting object type
  - java.util.Map<java.lang.String, java.lang.Object> values
    
    Report values
- Constructor Detail
  - Payload(java.util.Map<java.lang.String, java.lang.Object> values)
    
    Constructor
    Parameters:
    values - map with the following keys:
    
    reportObjectType - name of the reporting object type
    
    values - values that should be reported
- Method Detail
  - Payload addDependentPayload(Payload dependentPayload)
    
    Saves given Payload as a dependent for current instance
    Parameters:
    dependentPayload - Payload to be saved as a dependent for this instance
    Returns:
    currentPayload instance
  - Payload convertDependentDataToPayloadRecursive(Payload payload, Data data)
    
    Recursively goes through the Data in a Payload and converts the dependent values
    Parameters:
    payload - Payload to convert Data in
    data - Data that will be converted
    Returns:
    currentPayload instance
  - Payload createNewDependentPayload(java.lang.String reportObjectType, java.util.Map<java.lang.String, java.lang.Object> values = [:])
    
    Creates new Payload and saves it as a dependent for current instance
    Parameters:
    reportObjectType - name of the reporting object type
    values - report values
    Returns:
    createdPayload instance
  - @java.lang.Override java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Payload

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.ArrayList<Payload> dependentPayloads

java.lang.String reportObjectType

java.util.Map<java.lang.String, java.lang.Object> values

Constructor Detail

Payload(java.util.Map<java.lang.String, java.lang.Object> values)

Method Detail

Payload addDependentPayload(Payload dependentPayload)

Payload convertDependentDataToPayloadRecursive(Payload payload, Data data)

Payload createNewDependentPayload(java.lang.String reportObjectType, java.util.Map<java.lang.String, java.lang.Object> values = [:])

@java.lang.Override java.lang.String toString()