Engine (FlowPDF Groovy Library 1.1.2.0 API)

com.cloudbees.flowpdf.components.reporting.Engine

This class contains reporting-specific interactions with the CloudBees CD server reporting APIs

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>>`	`definitionsCache` Cache for the retrieved definitions of the report types
`boolean`	`previewMode` If this is set to true, no reports will be sent to the CloudBees CD server
`java.util.ArrayList<java.lang.String>`	`reportObjectTypes` This list is used to be sure that given type is supported by the CloudBees CD server

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>>`	`getPayloadDefinition(java.lang.String reportingObjectType)` Cached accessor for the report object types definitions defined on the CloudBees CD server
	`java.util.ArrayList<java.lang.String>`	`getReportObjectTypeRequiredKeys(java.lang.String reportingObjectType)` Filters keys that are required to be in the payload (according to the report object definition)
	`java.util.ArrayList<java.lang.String>`	`getReportObjectTypes()` Cached accessor for the report object types defined on the CloudBees CD server
	`boolean`	`isValidReportingObjectType(java.lang.String reportingObjectType)` This method checks if given type is supported by the CloudBees CD Server
	`java.util.Map<java.lang.String, java.lang.Integer>`	`report(Payloadset payloadset)` This method sends all the Payloads for a given Payloadset
	`java.util.Map<java.lang.String, java.lang.Integer>`	`reportRecursive(java.util.List<Payload> payloads, java.util.Map<java.lang.String, java.lang.Integer> reportStats)` This method is responsible for sending the report of the payload and then send all it's dependent payloads

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.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> definitionsCache
    
    Cache for the retrieved definitions of the report types
  - boolean previewMode
    
    If this is set to true, no reports will be sent to the CloudBees CD server
  - java.util.ArrayList<java.lang.String> reportObjectTypes
    
    This list is used to be sure that given type is supported by the CloudBees CD server
- Method Detail
  - java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>> getPayloadDefinition(java.lang.String reportingObjectType)
    
    Cached accessor for the report object types definitions defined on the CloudBees CD server
    Parameters:
    reportingObjectType - name of report object type to get the definition for
    Returns:
    map with the report object definition attributes
  - java.util.ArrayList<java.lang.String> getReportObjectTypeRequiredKeys(java.lang.String reportingObjectType)
    
    Filters keys that are required to be in the payload (according to the report object definition)
    Parameters:
    reportingObjectType - name of the reporting object type to get definition for
    Returns:
    list of keys that are required to be in the payload
  - java.util.ArrayList<java.lang.String> getReportObjectTypes()
    
    Cached accessor for the report object types defined on the CloudBees CD server
    Returns:
    list of names for report object types
  - boolean isValidReportingObjectType(java.lang.String reportingObjectType)
    
    This method checks if given type is supported by the CloudBees CD Server
    Parameters:
    reportingObjectType - name of report object type to check
    Returns:
    true if this name is known for the CloudBees CD server
  - java.util.Map<java.lang.String, java.lang.Integer> report(Payloadset payloadset)
    
    This method sends all the Payloads for a given Payloadset
    Parameters:
    payloadset - Payloadset to be reported
    Returns:
    map with reporting stats (sent payloads count for each object type)
  - java.util.Map<java.lang.String, java.lang.Integer> reportRecursive(java.util.List<Payload> payloads, java.util.Map<java.lang.String, java.lang.Integer> reportStats)
    
    This method is responsible for sending the report of the payload and then send all it's dependent payloads
    Parameters:
    payloads - list of the Payloads to be sent
    Returns:
    map with reporting stats (sent payloads count for each object type)

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class Engine

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>> definitionsCache

boolean previewMode

java.util.ArrayList<java.lang.String> reportObjectTypes

Method Detail

java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.Object>> getPayloadDefinition(java.lang.String reportingObjectType)

java.util.ArrayList<java.lang.String> getReportObjectTypeRequiredKeys(java.lang.String reportingObjectType)

java.util.ArrayList<java.lang.String> getReportObjectTypes()

boolean isValidReportingObjectType(java.lang.String reportingObjectType)

java.util.Map<java.lang.String, java.lang.Integer> report(Payloadset payloadset)

java.util.Map<java.lang.String, java.lang.Integer> reportRecursive(java.util.List<Payload> payloads, java.util.Map<java.lang.String, java.lang.Integer> reportStats)