Google Cloud Chronicle V1 Client - Class Button (0.4.0)

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

Button config for a chart.

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

Namespace

Google \ Cloud \ Chronicle \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ label string
↳ hyperlink string
↳ description string
↳ new_tab bool

Optional. Whether to open the link in a new tab.

↳ properties Button\Properties

getLabel

Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
string

setLabel

Generated from protobuf field string label = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
var string
Returns
Type Description
$this

Generated from protobuf field string hyperlink = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
string

Generated from protobuf field string hyperlink = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
string

setDescription

Generated from protobuf field string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
var string
Returns
Type Description
$this

getNewTab

Optional. Whether to open the link in a new tab.

Returns
Type Description
bool

setNewTab

Optional. Whether to open the link in a new tab.

Parameter
Name Description
var bool
Returns
Type Description
$this

getProperties

Generated from protobuf field .google.cloud.chronicle.v1.Button.Properties properties = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Button\Properties|null

hasProperties

clearProperties

setProperties

Generated from protobuf field .google.cloud.chronicle.v1.Button.Properties properties = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
var Button\Properties
Returns
Type Description
$this