Google Cloud Chronicle V1 Client - Class GetNativeDashboardRequest (0.4.0)

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

Request message to get a dashboard.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The dashboard name to fetch. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

↳ view int

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

getName

Required. The dashboard name to fetch.

Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Returns
Type Description
string

setName

Required. The dashboard name to fetch.

Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard}

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

Returns
Type Description
int Enum of type NativeDashboardView.

setView

Optional. View indicates the scope of fields to populate when returning the dashboard resource. If unspecified, defaults to the basic view.

Parameter
Name Description
var int

Enum of type NativeDashboardView.

Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The dashboard name to fetch. Format: projects/{project}/locations/{location}/instances/{instance}/nativeDashboards/{dashboard} Please see NativeDashboardServiceClient::nativeDashboardName() for help formatting this field.

Returns
Type Description
GetNativeDashboardRequest