Google Cloud Chronicle V1 Client - Class UpdateNativeDashboardRequest (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class UpdateNativeDashboardRequest.

Request message to update a dashboard.

Generated from protobuf message google.cloud.chronicle.v1.UpdateNativeDashboardRequest

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ native_dashboard NativeDashboard

Required. The dashboard to update. The dashboard's name field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
↳ update_mask Google\Protobuf\FieldMask

Required. LINT.IfChange(update_mask_values) The list of fields to update. Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned

getNativeDashboard

Required. The dashboard to update.

The dashboard's name field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Returns
Type Description
NativeDashboard|null

hasNativeDashboard

clearNativeDashboard

setNativeDashboard

Required. The dashboard to update.

The dashboard's name field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Parameter
Name Description
var NativeDashboard
Returns
Type Description
$this

getUpdateMask

Required. LINT.IfChange(update_mask_values) The list of fields to update.

Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. LINT.IfChange(update_mask_values) The list of fields to update.

Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
nativeDashboard NativeDashboard

Required. The dashboard to update.

The dashboard's name field is used to identify the dashboard to update. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}
updateMask Google\Protobuf\FieldMask

Required. LINT.IfChange(update_mask_values) The list of fields to update. Supported paths are - display_name description definition.filters definition.charts type access dashboard_user_data.is_pinned
Returns
Type Description
UpdateNativeDashboardRequest