Class Gs2NotificationClient
-
GS2\Core\AbstractGs2Client
-
GS2\Notification\Gs2NotificationClient
Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeNotification( string $pageToken = NULL, integer $limit = NULL )
通知リストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- notificationId => 通知ID
- ownerId => オーナーID
- name => 通知名
- description => 説明文
- createAt => 作成日時
- updateAt => 更新日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createNotification( array $request )
通知を作成
通知はGS2内で発生したイベントを受け取る手段を提供します。
例えば、GS2-Watch の監視データが一定の閾値を超えた時に通知する。といった用途に利用できます。
GS2 のサービスの多くはクオータを買い、その範囲内でサービスを利用する形式が多く取られていますが、
現在の消費クオータが GS2-Watch で取れますので、クオータの消費量が予約量の80%を超えたら通知をだす。というような使い方ができます。
通知を作成
通知はGS2内で発生したイベントを受け取る手段を提供します。
例えば、GS2-Watch の監視データが一定の閾値を超えた時に通知する。といった用途に利用できます。
GS2 のサービスの多くはクオータを買い、その範囲内でサービスを利用する形式が多く取られていますが、
現在の消費クオータが GS2-Watch で取れますので、クオータの消費量が予約量の80%を超えたら通知をだす。というような使い方ができます。
Parameters
- $request
- name => 通知名
- description => 説明文
Returns
array
- item
- notificationId => 通知ID
- ownerId => オーナーID
- name => 通知名
- description => 説明文
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
getNotification( array $request )
通知を取得
Parameters
Returns
array
- item
- notificationId => 通知ID
- ownerId => オーナーID
- name => 通知名
- description => 説明文
- createAt => 作成日時
- updateAt => 更新日時
|
public
array
|
#
updateNotification( array $request )
通知を更新
Parameters
- $request
- notificationName => 通知名
- description => 説明文
Returns
array
- item
- notificationId => 通知ID
- ownerId => オーナーID
- name => 通知名
- description => 説明文
- createAt => 作成日時
- updateAt => 更新日時
|
public
|
|
public
array
|
#
describeSubscribe( array $request, string $pageToken = NULL, integer $limit = NULL )
通知先リストを取得
Parameters
- $request
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- subscribeId => 通知先ID
- notificationId => 通知ID
- type => 通知プロトコル
- endpoint => 通知先
- createAt => 作成日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createSubscribe( array $request )
通知先を作成
E-Mail, HTTP/HTTPS 通信を指定して通知先を登録できます。
通知先は1つの通知に対して複数登録することもできます。
そのため、メールとSlackに通知する。といった利用ができます。
type に指定できるパラメータ
endpoint には type に指定したプロトコルによって指定する内容が変わります。
email を選択した場合には メールアドレスを、
http/https を選択した場合には URL を指定してください。
http/https を選択した場合には登録時に疎通確認を行います。
指定したURLでPOSTリクエストを受け付けられる状態で登録してください。
疎通確認の通信は通常の通知とは異なり、body パラメータがからの通信が発生します。ご注意ください。
通知先を作成
E-Mail, HTTP/HTTPS 通信を指定して通知先を登録できます。
通知先は1つの通知に対して複数登録することもできます。
そのため、メールとSlackに通知する。といった利用ができます。
type に指定できるパラメータ
endpoint には type に指定したプロトコルによって指定する内容が変わります。
email を選択した場合には メールアドレスを、
http/https を選択した場合には URL を指定してください。
http/https を選択した場合には登録時に疎通確認を行います。
指定したURLでPOSTリクエストを受け付けられる状態で登録してください。
疎通確認の通信は通常の通知とは異なり、body パラメータがからの通信が発生します。ご注意ください。
Parameters
- $request
- notificationName => 通知名
- name => 通知先名
- type => 通知プロトコル
- endpoint => 通知先
Returns
array
- item
- subscribeId => 通知先ID
- notificationId => 通知ID
- type => 通知プロトコル
- endpoint => 通知先
- createAt => 作成日時
|
public
array
|
#
getSubscribe( array $request )
通知先を取得
Parameters
- $request
- notificationName => 通知名
- subscribeId => 通知先ID
Returns
array
- item
- subscribeId => 通知先ID
- notificationId => 通知ID
- type => 通知プロトコル
- endpoint => 通知先
- createAt => 作成日時
|
public
|
#
deleteSubscribe( array $request )
通知先を削除
Parameters
- $request
- notificationName => 通知名
- subscribeId => 通知先ID
|