REST Resource: projects.locations.instances.dashboardScheduledReports

Resource: DashboardScheduledReport

DashboardScheduledReport represents a scheduled report configuration.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "createUserId": string,
  "updateUserId": string,
  "status": enum (ReportState),
  "userData": {
    object (UserData)
  },
  "dashboard": {
    object (NativeDashboard)
  },
  "scopeInfo": {
    object (ReportScopeInfo)
  },
  "cronDetails": {
    object (CronDetails)
  },
  "deliveryDetails": {
    object (DeliveryDetails)
  },
  "format": {
    object (Format)
  },
  "lastSuccessfulGeneratedTime": string,
  "lastReportGenerationDetail": {
    object (ReportGenerationDetail)
  },
  "etag": string
}
Fields
name

string

Immutable. Identifier. The resource name of the DashboardScheduledReport. Format: projects/{project}/locations/{location}/instances/{instance}/dashboardScheduledReports/{dashboardScheduledReport} The {dashboardScheduledReport} segment is assigned by the server upon creation.
displayName

string

Required. Display name of the report, as shown in the UI.
description

string

Optional. Description of the report
createTime

string (Timestamp format)

Output only. The timestamp when the report schedule was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp when the report schedule was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
createUserId

string

Output only. The user ID who created the report schedule.
updateUserId

string

Output only. The user ID who last updated the report schedule.
status

enum (ReportState)

Output only. Current status of the report.
userData

object (UserData)

Optional. User data preference
dashboard

object (NativeDashboard)

Required. The dashboard details for which report is scheduled
scopeInfo

object (ReportScopeInfo)

Optional. Data scope for the report, defining which data is included.
cronDetails

object (CronDetails)

Required. Cron details for scheduling a report, contains cron string and timezone
deliveryDetails

object (DeliveryDetails)

Required. Delivery settings for the report.
format

object (Format)

Required. Format settings for the report.
lastSuccessfulGeneratedTime

string (Timestamp format)

Output only. The timestamp when the report was last generated successfully.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
lastReportGenerationDetail

object (ReportGenerationDetail)

Output only. Details of last Schedule run.
etag

string

Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

ReportState

Current status of the report. LINT.IfChange

Enums
REPORT_STATE_UNSPECIFIED Unspecified report state.
ACTIVE The report is active and will be generated on schedule.
SUSPENDED The report is suspended and will not be generated on schedule.

UserData

User data preference

JSON representation 
{
  "pinned": boolean
}
Fields
pinned

boolean

Optional. pinning information of the scheduled report

ReportScopeInfo

ReportScopeInfo defines the scope of data included in the report.

JSON representation 
{
  "dataAccessScopes": [
    string
  ],
  "simulatedDataVisibility": enum (SimulatedDataVisibility)
}
Fields
dataAccessScopes[]

string

Optional. List of data access scopes. The scope names should be full resource names, in the format: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scopeName}.
simulatedDataVisibility

enum (SimulatedDataVisibility)

Optional. Specifies visibility of simulated data to include in report results.

SimulatedDataVisibility

Specifies visibility of simulated data to include. This enum is used in multiple protos to filter out simulated data from the data returned by the API (like events, detections, and alerts, etc.).

Enums
SIMULATED_DATA_VISIBILITY_UNSPECIFIED If unspecified, simulated data will be excluded.
SIMULATED_DATA_INCLUDED If specified, simulated data will be included.
SIMULATED_DATA_EXCLUDED If specified, simulated data will be excluded.

CronDetails

Cron details for scheduling a report, contains cron string and timezone

JSON representation 
{
  "cron": string,
  "timeZone": string
}
Fields
cron

string

Required. cron string which contains the schedule trigger time crontab format. +------------- minute (0 - 59) | +----------- hour (0 - 23) | | +--------- day of month (1 - 31) | | | +------- month (1 - 12, or {Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec}) | | | | +----- day of week (0 - 6, with Sunday=0, or {Sun,Mon,Tue,Wed,Thu,Fri,Sat}) | | | | | v v v v v timespec = '* * * * *'
timeZone

string

Optional. Timezone of the schedule delivery (UTC if not specified).

DeliveryDetails

contains the email delivery details.

JSON representation 
{
  "emailDelivery": {
    object (EmailDelivery)
  },
  "deliveryType": enum (DeliveryType)
}
Fields
emailDelivery

object (EmailDelivery)

Required. EmailDelivery specifies the email delivery settings.
deliveryType

enum (DeliveryType)

Optional. Delivery type of the report.

EmailDelivery

EmailDelivery specifies the email delivery settings.

JSON representation 
{
  "subject": string,
  "emailBody": string,
  "recipients": [
    string
  ]
}
Fields
subject

string

Optional. Subject of the email.
emailBody

string

Optional. Body of the email.
recipients[]

string

Required. Recipients of the email.

DeliveryType

Delivery type of the report. LINT.IfChange

Enums
DELIVERY_TYPE_UNSPECIFIED Unspecified delivery type. If this value is provided, the API will return an INVALID_ARGUMENT error.
DELIVERY_TYPE_EMAIL_ATTACHMENT Delivery as an email attachment.
DELIVERY_TYPE_GCS_BUCKET Delivery to a Google Cloud Storage bucket.

Format

Format specifies the desired file formats for the report.

JSON representation 
{
  "fileFormat": enum (FileFormat)
}
Fields
fileFormat

enum (FileFormat)

Required. File formats for the report.

FileFormat

File formats for the report. LINT.IfChange

Enums
FILE_FORMAT_UNSPECIFIED Unspecified file format.
FILE_FORMAT_PDF PDF file format.
FILE_FORMAT_CSV CSV file format.
FILE_FORMAT_PNG PNG file format.

ReportGenerationDetail

ReportGenerationDetail contains details about a single report generation attempt.

JSON representation 
{
  "reportTime": string,
  "deliveryStatus": enum (DeliveryState),

  // Union field status_details can be only one of the following:
  "successDetails": {
    object (SuccessDetails)
  },
  "errorDetails": {
    object (ErrorDetails)
  }
  // End of list of possible types for union field status_details.
}
Fields
reportTime

string (Timestamp format)

Output only. Timestamp is the time when the report generation was triggered.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
deliveryStatus

enum (DeliveryState)

Output only. Status of the generation/delivery attempt.
Union field status_details. Details of the status. status_details can be only one of the following:
successDetails

object (SuccessDetails)

Details of a successful delivery.
errorDetails

object (ErrorDetails)

Details of a failed delivery.

SuccessDetails

SuccessDetails contains details about a successful delivery.

JSON representation 
{
  "successMessage": string
}
Fields
successMessage

string

Optional. A success message.

ErrorDetails

ErrorDetails contains details about a failed delivery.

JSON representation 
{
  "errorMessage": string,
  "detailedError": string
}
Fields
errorMessage

string

Required. An error message.
detailedError

string

Optional. A detailed error message.

DeliveryState

Delivery state of the report. LINT.IfChange

Enums
DELIVERY_STATE_UNSPECIFIED Unspecified delivery state.
DELIVERY_STATE_SUCCEEDED The report was delivered successfully.
DELIVERY_STATE_FAILED The report delivery failed.
DELIVERY_STATE_IN_PROGRESS The report delivery is in progress.

Methods

create

 Create a Dashboard Scheduled Report.

delete

 Delete a Dashboard Scheduled Report.

duplicate

 Duplicate a scheduled report.

fetchHistory

 Retrieves details of past report runs for a specific scheduled report from the last year, including run count, status, and other success/failure information.

get

 Get a Dashboard Scheduled Report.

list

 List Dashboard Scheduled Reports.

patch

 Update a Dashboard Scheduled Report.

trigger

 Sends the given report immediately.