Report class

Creates a Custom Report for an Organization. A Custom Report provides Apigee Customers to create custom dashboards in addition to the standard dashboards which are provided. The Custom Report in its simplest form contains specifications about metrics, dimensions and filters. It is important to note that the custom report by itself does not provide an executable entity. The Edge UI converts the custom report definition into an analytics query and displays the result in a chart.

Constructors

Report(String name, {ReportArgs? args, CustomResourceOptions? options})

Creates a new Report. name The Pulumi resource name. args Arguments used to configure this Report. The set of arguments for Report. options Resource options controlling this resource's behavior.

Properties

chartType ↔ Output<String>

This field contains the chart type for the report

late, final

childResources → Set<Resource>

final, inherited

comments ↔ Output<List<String>>

Legacy field: not used. This field contains a list of comments associated with custom report

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createdAt ↔ Output<String>

Unix time when the app was created json key: createdAt

late, final

dimensions ↔ Output<List<String>>

This contains the list of dimensions for the report

late, final

displayName ↔ Output<String>

This is the display name for the report

late, final

environment ↔ Output<String>

Environment name

late, final

filter ↔ Output<String>

This field contains the filter expression

late, final

fromTime ↔ Output<String>

Legacy field: not used. Contains the from time for the report

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

lastModifiedAt ↔ Output<String>

Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt

late, final

lastViewedAt ↔ Output<String>

Last viewed time of this entity as milliseconds since epoch

late, final

limit ↔ Output<String>

Legacy field: not used This field contains the limit for the result retrieved

late, final

metrics ↔ Output<List<Map<String, dynamic>>>

This contains the list of metrics

late, final

name ↔ Output<String>

Unique identifier for the report T his is a legacy field used to encode custom report unique id

late, final

offset ↔ Output<String>

Legacy field: not used. This field contains the offset for the data

late, final

organization ↔ Output<String>

Organization name

late, final

organizationId ↔ Output<String>

late, final

properties ↔ Output<List<Map<String, dynamic>>>

This field contains report properties such as ui metadata etc.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sortByCols ↔ Output<List<String>>

Legacy field: not used much. Contains the list of sort by columns

late, final

sortOrder ↔ Output<String>

Legacy field: not used much. Contains the sort order for the sort columns

late, final

tags ↔ Output<List<String>>

Legacy field: not used. This field contains a list of tags associated with custom report

late, final

timeUnit ↔ Output<String>

This field contains the time unit of aggregation for the report

late, final

topk ↔ Output<String>

Legacy field: not used. This field contains the top k parameter value for restricting the result

late, final

toTime ↔ Output<String>

Legacy field: not used. Contains the end time for the report

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited