pulumi-google-native-kotlin/com.pulumi.googlenative.apigee.v1.kotlin/ReportArgs

ReportArgs

data class ReportArgs(val chartType: Output<String>? = null, val comments: Output<List<String>>? = null, val dimensions: Output<List<String>>? = null, val displayName: Output<String>? = null, val filter: Output<String>? = null, val fromTime: Output<String>? = null, val limit: Output<String>? = null, val metrics: Output<List<GoogleCloudApigeeV1CustomReportMetricArgs>>? = null, val name: Output<String>? = null, val offset: Output<String>? = null, val organizationId: Output<String>? = null, val properties: Output<List<GoogleCloudApigeeV1ReportPropertyArgs>>? = null, val sortByCols: Output<List<String>>? = null, val sortOrder: Output<String>? = null, val tags: Output<List<String>>? = null, val timeUnit: Output<String>? = null, val toTime: Output<String>? = null, val topk: Output<String>? = null) : ConvertibleToJava<ReportArgs>

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

Link copied to clipboard
fun ReportArgs(chartType: Output<String>? = null, comments: Output<List<String>>? = null, dimensions: Output<List<String>>? = null, displayName: Output<String>? = null, filter: Output<String>? = null, fromTime: Output<String>? = null, limit: Output<String>? = null, metrics: Output<List<GoogleCloudApigeeV1CustomReportMetricArgs>>? = null, name: Output<String>? = null, offset: Output<String>? = null, organizationId: Output<String>? = null, properties: Output<List<GoogleCloudApigeeV1ReportPropertyArgs>>? = null, sortByCols: Output<List<String>>? = null, sortOrder: Output<String>? = null, tags: Output<List<String>>? = null, timeUnit: Output<String>? = null, toTime: Output<String>? = null, topk: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ReportArgs

Properties

Link copied to clipboard
val chartType: Output<String>? = null

This field contains the chart type for the report

Link copied to clipboard
val comments: Output<List<String>>? = null

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

Link copied to clipboard
val dimensions: Output<List<String>>? = null

This contains the list of dimensions for the report

Link copied to clipboard
val displayName: Output<String>? = null

This is the display name for the report

Link copied to clipboard
val filter: Output<String>? = null

This field contains the filter expression

Link copied to clipboard
val fromTime: Output<String>? = null

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

Link copied to clipboard
val limit: Output<String>? = null

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

Link copied to clipboard
val metrics: Output<List<GoogleCloudApigeeV1CustomReportMetricArgs>>? = null

This contains the list of metrics

Link copied to clipboard
val name: Output<String>? = null

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

Link copied to clipboard
val offset: Output<String>? = null

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

Link copied to clipboard
val organizationId: Output<String>? = null
Link copied to clipboard
val properties: Output<List<GoogleCloudApigeeV1ReportPropertyArgs>>? = null

This field contains report properties such as ui metadata etc.

Link copied to clipboard
val sortByCols: Output<List<String>>? = null

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

Link copied to clipboard
val sortOrder: Output<String>? = null

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

Link copied to clipboard
val tags: Output<List<String>>? = null

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

Link copied to clipboard
val timeUnit: Output<String>? = null

This field contains the time unit of aggregation for the report

Link copied to clipboard
val topk: Output<String>? = null

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

Link copied to clipboard
val toTime: Output<String>? = null

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