io.gs2.notification

Class Gs2NotificationClient

java.lang.Object

io.gs2.AbstractGs2Client<Gs2NotificationClient>

io.gs2.notification.Gs2NotificationClient

public class Gs2NotificationClient
extends AbstractGs2Client<Gs2NotificationClient>

GS2 Notification API クライアント

Author:

Game Server Services, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT

Fields inherited from class io.gs2.AbstractGs2Client

credential, region

Constructor Summary

Constructors

Constructor and Description
Gs2NotificationClient(IGs2Credential credential) コンストラクタ。

Method Summary

Modifier and Type	Method and Description
CreateNotificationResult	createNotification(CreateNotificationRequest request) 通知を作成。 通知はGS2内で発生したイベントを受け取る手段を提供します。 例えば、GS2-Watch の監視データが一定の閾値を超えた時に通知する。といった用途に利用できます。 GS2 のサービスの多くはクオータを買い、その範囲内でサービスを利用する形式が多く取られていますが、 現在の消費クオータが GS2-Watch で取れますので、クオータの消費量が予約量の80%を超えたら通知をだす。というような使い方ができます。
CreateSubscribeResult	createSubscribe(CreateSubscribeRequest request) 通知先を作成。 E-Mail, HTTP/HTTPS 通信を指定して通知先を登録できます。 通知先は1つの通知に対して複数登録することもできます。 そのため、メールとSlackに通知する。といった利用ができます。 type に指定できるパラメータ email http/https endpoint には type に指定したプロトコルによって指定する内容が変わります。 email を選択した場合には メールアドレスを、 http/https を選択した場合には URL を指定してください。 http/https を選択した場合には登録時に疎通確認を行います。 指定したURLでPOSTリクエストを受け付けられる状態で登録してください。 疎通確認の通信は通常の通知とは異なり、body パラメータがからの通信が発生します。ご注意ください。
void	deleteNotification(DeleteNotificationRequest request) 通知を削除。
void	deleteSubscribe(DeleteSubscribeRequest request) 通知先を削除。
DescribeNotificationResult	describeNotification(DescribeNotificationRequest request) 通知一覧を取得。
DescribeSubscribeResult	describeSubscribe(DescribeSubscribeRequest request) 通知先一覧を取得。
GetNotificationResult	getNotification(GetNotificationRequest request) 通知を取得。
GetSubscribeResult	getSubscribe(GetSubscribeRequest request) 通知先を取得。
UpdateNotificationResult	updateNotification(UpdateNotificationRequest request) 通知を更新。

Methods inherited from class io.gs2.AbstractGs2Client

createHttpDelete, createHttpGet, createHttpPost, createHttpPut, doRequest, getRegion, setRegion, withRegion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENDPOINT

public static String ENDPOINT

Constructor Detail

Gs2NotificationClient

public Gs2NotificationClient(IGs2Credential credential)

コンストラクタ。

Parameters:

credential - 認証情報

Method Detail

createNotification

public CreateNotificationResult createNotification(CreateNotificationRequest request)

通知を作成。

通知はGS2内で発生したイベントを受け取る手段を提供します。
例えば、GS2-Watch の監視データが一定の閾値を超えた時に通知する。といった用途に利用できます。

GS2 のサービスの多くはクオータを買い、その範囲内でサービスを利用する形式が多く取られていますが、
現在の消費クオータが GS2-Watch で取れますので、クオータの消費量が予約量の80%を超えたら通知をだす。というような使い方ができます。

Parameters:

request - リクエストパラメータ

Returns:

作成結果

describeNotification

public DescribeNotificationResult describeNotification(DescribeNotificationRequest request)

通知一覧を取得。

Parameters:

request - リクエストパラメータ

Returns:

通知一覧

getNotification

public GetNotificationResult getNotification(GetNotificationRequest request)

通知を取得。

Parameters:

request - リクエストパラメータ

Returns:

通知

updateNotification

public UpdateNotificationResult updateNotification(UpdateNotificationRequest request)

通知を更新。

Parameters:

request - リクエストパラメータ

Returns:

更新結果

deleteNotification

public void deleteNotification(DeleteNotificationRequest request)

通知を削除。

Parameters:

request - リクエストパラメータ

createSubscribe

public CreateSubscribeResult createSubscribe(CreateSubscribeRequest request)

通知先を作成。

E-Mail, HTTP/HTTPS 通信を指定して通知先を登録できます。
通知先は1つの通知に対して複数登録することもできます。

そのため、メールとSlackに通知する。といった利用ができます。

type に指定できるパラメータ

• email
• http/https

endpoint には type に指定したプロトコルによって指定する内容が変わります。
email を選択した場合には メールアドレスを、
http/https を選択した場合には URL を指定してください。

http/https を選択した場合には登録時に疎通確認を行います。
指定したURLでPOSTリクエストを受け付けられる状態で登録してください。
疎通確認の通信は通常の通知とは異なり、body パラメータがからの通信が発生します。ご注意ください。

Parameters:

request - リクエストパラメータ

Returns:

作成結果

describeSubscribe

public DescribeSubscribeResult describeSubscribe(DescribeSubscribeRequest request)

通知先一覧を取得。

Parameters:

request - リクエストパラメータ

Returns:

通知先一覧

getSubscribe

public GetSubscribeResult getSubscribe(GetSubscribeRequest request)

通知先を取得。

Parameters:

request - リクエストパラメータ

Returns:

通知先

deleteSubscribe

public void deleteSubscribe(DeleteSubscribeRequest request)

通知先を削除。

Parameters:

request - リクエストパラメータ