Google Cloud Advisory Notifications V1 Client - Class GetNotificationRequest (0.8.2)

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

Request for fetching a notification.

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

Namespace

Google \ Cloud \ AdvisoryNotifications \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}.

↳ language_code string

ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

getName

Required. A name of the notification to retrieve.

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

Returns
Type Description
string

setName

Required. A name of the notification to retrieve.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguageCode

ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

Returns
Type Description
string

setLanguageCode

ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}. Please see Google\Cloud\AdvisoryNotifications\V1\AdvisoryNotificationsServiceClient::notificationName() for help formatting this field.

Returns
Type Description
Google\Cloud\AdvisoryNotifications\V1\GetNotificationRequest