SecurityReportArgs

data class SecurityReportArgs(val csvDelimiter: Output<String>? = null, val dimensions: Output<List<String>>? = null, val displayName: Output<String>? = null, val envgroupHostname: Output<String>? = null, val environmentId: Output<String>? = null, val filter: Output<String>? = null, val groupByTimeUnit: Output<String>? = null, val limit: Output<Int>? = null, val metrics: Output<List<GoogleCloudApigeeV1SecurityReportQueryMetricArgs>>? = null, val mimeType: Output<String>? = null, val organizationId: Output<String>? = null, val reportDefinitionId: Output<String>? = null, val timeRange: Output<Any>? = null) : ConvertibleToJava<SecurityReportArgs>

Submit a report request to be processed in the background. If the submission succeeds, the API returns a 200 status and an ID that refer to the report request. In addition to the HTTP status 200, the state of "enqueued" means that the request succeeded. Auto-naming is currently not supported for this resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Constructors

Link copied to clipboard
fun SecurityReportArgs(csvDelimiter: Output<String>? = null, dimensions: Output<List<String>>? = null, displayName: Output<String>? = null, envgroupHostname: Output<String>? = null, environmentId: Output<String>? = null, filter: Output<String>? = null, groupByTimeUnit: Output<String>? = null, limit: Output<Int>? = null, metrics: Output<List<GoogleCloudApigeeV1SecurityReportQueryMetricArgs>>? = null, mimeType: Output<String>? = null, organizationId: Output<String>? = null, reportDefinitionId: Output<String>? = null, timeRange: Output<Any>? = null)

Functions

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

Properties

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

Delimiter used in the CSV file, if outputFormat is set to csv. Defaults to the , (comma) character. Supported delimiter characters include comma (,), pipe (|), and tab (\t).

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

A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions

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

Security Report display name which users can specify.

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

Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostSecurityReport where analytics data will be grouped by organization and hostname.

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

Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics-reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax

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

Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.

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

Maximum number of rows that can be returned in the result.

Link copied to clipboard

A list of Metrics.

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

Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.

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

Report Definition ID.

Link copied to clipboard
val timeRange: Output<Any>? = null

Time range for the query. Can use the following predefined strings to specify the time range: last60minutes last24hours last7days Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }