Reference documentation and code samples for the Google Cloud Advisory Notifications V1 Client class ListNotificationsRequest.
Request for fetching all notifications for a given parent.
Generated from protobuf message google.cloud.advisorynotifications.v1.ListNotificationsRequest
Namespace
Google \ Cloud \ AdvisoryNotifications \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}". |
↳ page_size |
int
The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50. |
↳ page_token |
string
A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token. |
↳ view |
int
Specifies which parts of the notification resource should be returned in the response. |
↳ 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. |
getParent
Required. The parent, which owns this collection of notifications.
Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}".
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which owns this collection of notifications.
Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
A page token returned from a previous request.
When paginating, all other parameters provided in the request must match the call that returned the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token returned from a previous request.
When paginating, all other parameters provided in the request must match the call that returned the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getView
Specifies which parts of the notification resource should be returned in the response.
| Returns | |
|---|---|
| Type | Description |
int |
|
setView
Specifies which parts of the notification resource should be returned in the response.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 |
parent |
string
Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}". Please see Google\Cloud\AdvisoryNotifications\V1\AdvisoryNotificationsServiceClient::locationName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AdvisoryNotifications\V1\ListNotificationsRequest |
|