Google Cloud Advisory Notifications V1 Client - Class Settings (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Advisory Notifications V1 Client class Settings.

Settings for Advisory Notifications.

Generated from protobuf message google.cloud.advisorynotifications.v1.Settings

Namespace

Google \ Cloud \ AdvisoryNotifications \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.

↳ notification_settings array|Google\Protobuf\Internal\MapField

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

↳ etag string

Required. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.

getName

Identifier. The resource name of the settings to retrieve.

Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.

Returns
Type Description
string

setName

Identifier. The resource name of the settings to retrieve.

Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.

Parameter
Name Description
var string
Returns
Type Description
$this

getNotificationSettings

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

Returns
Type Description
Google\Protobuf\Internal\MapField

setNotificationSettings

Required. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

Required. Fingerprint for optimistic concurrency returned in Get requests.

Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.

Returns
Type Description
string

setEtag

Required. Fingerprint for optimistic concurrency returned in Get requests.

Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.

Parameter
Name Description
var string
Returns
Type Description
$this