Method: dashboardScheduledReports.patch

Full name: projects.locations.instances.dashboardScheduledReports.patch

Update a Dashboard Scheduled Report.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{dashboardScheduledReport.name}

Path parameters

Parameters
dashboardScheduledReport.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.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. LINT.IfChange(update_mask_values) The list of fields to update. Supported paths are - displayName description cronDetails format deliveryDetails scopeInfo dashboard.name userData.pinned LINT.ThenChange( //depot/google3/googlex/security/malachite/dataplane/common/nativedashboardsconv.go:field_path_mapping_edit_scheduled_report )

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of DashboardScheduledReport.

Response body

If successful, the response body contains an instance of DashboardScheduledReport.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/chronicle
  • https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.dashboardScheduledReports.update

For more information, see the IAM documentation.