Google Cloud Chronicle V1 Client - Class NativeDashboard (0.4.0)

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

NativeDashboard resource.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Name of the dashboard.

↳ display_name
string

Required. Dashboard display name/title visible to users.

↳ description
string

Optional. Description of the dashboard.

↳ definition
DashboardDefinition

Optional. Definition of the dashboard like metadata, visualization and datasource configuration etc.

↳ type
int

Output only. Whether it's an out of the box or custom created dashboard.

↳ create_time
Google\Protobuf\Timestamp

Output only. Creation time of dashboard.

↳ update_time
Google\Protobuf\Timestamp

Output only. Time the dashboard was last edited.

↳ create_user_id
string

Output only. User who created the dashboard.

↳ update_user_id
string

Output only. User who last edited the dashboard.

↳ dashboard_user_data
DashboardUserData

Output only. User Preferences for a dashboard

↳ 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.

↳ access
int

Output only. Access of the dashboard

getName

Output only. Name of the dashboard.

Returns
Type
Description
string

setName

Output only. Name of the dashboard.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Required. Dashboard display name/title visible to users.

Returns
Type
Description
string

setDisplayName

Required. Dashboard display name/title visible to users.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

Optional. Description of the dashboard.

Returns
Type
Description
string

setDescription

Optional. Description of the dashboard.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDefinition

Optional. Definition of the dashboard like metadata, visualization and datasource configuration etc.

Returns
Type
Description

hasDefinition

clearDefinition

setDefinition

Optional. Definition of the dashboard like metadata, visualization and datasource configuration etc.

Parameter
Name
Description
Returns
Type
Description
$this

getType

Output only. Whether it's an out of the box or custom created dashboard.

Returns
Type
Description
int
Enum of type DashboardType .

setType

Output only. Whether it's an out of the box or custom created dashboard.

Parameter
Name
Description
var
int

Enum of type DashboardType .

Returns
Type
Description
$this

getCreateTime

Output only. Creation time of dashboard.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of dashboard.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Time the dashboard was last edited.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time the dashboard was last edited.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateUserId

Output only. User who created the dashboard.

Returns
Type
Description
string

setCreateUserId

Output only. User who created the dashboard.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUpdateUserId

Output only. User who last edited the dashboard.

Returns
Type
Description
string

setUpdateUserId

Output only. User who last edited the dashboard.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDashboardUserData

Output only. User Preferences for a dashboard

Returns
Type
Description

hasDashboardUserData

clearDashboardUserData

setDashboardUserData

Output only. User Preferences for a dashboard

Parameter
Name
Description
Returns
Type
Description
$this

getEtag

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.

Returns
Type
Description
string

setEtag

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getAccess

Output only. Access of the dashboard

Returns
Type
Description
int
Enum of type DashboardAccess .

setAccess

Output only. Access of the dashboard

Parameter
Name
Description
var
int

Enum of type DashboardAccess .

Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: