io.gs2.watch

クラス Gs2WatchClient

java.lang.Object

io.gs2.AbstractGs2Client<Gs2WatchClient>

io.gs2.watch.Gs2WatchClient

public class Gs2WatchClient
extends io.gs2.AbstractGs2Client<Gs2WatchClient>

GS2 Timer API クライアント

作成者:

Game Server Services, Inc.

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	ENDPOINT
static String	VARIATION

クラスから継承されたフィールド io.gs2.AbstractGs2Client

credential, region

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
Gs2WatchClient(io.gs2.model.IGs2Credential credential) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
CreateAlermResult	createAlerm(CreateAlermRequest request) アラームを作成。
void	deleteAlerm(DeleteAlermRequest request) アラームを削除。
DescribeAlermResult	describeAlerm(DescribeAlermRequest request) アラーム一覧を取得。
DescribeAlermEventResult	describeAlermEvent(DescribeAlermEventRequest request) アラームイベント一覧を取得。
DescribeOperationResult	describeOperation(DescribeOperationRequest request) オペレーション一覧を取得。
DescribeServiceResult	describeService(DescribeServiceRequest request) サービス一覧を取得。
GetAlermResult	getAlerm(GetAlermRequest request) アラームを取得。
GetMetricResult	getMetric(GetMetricRequest request) メトリクスを取得。
UpdateAlermResult	updateAlerm(UpdateAlermRequest request) アラームを更新。

クラスから継承されたメソッド io.gs2.AbstractGs2Client

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

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

ENDPOINT

public static String ENDPOINT

VARIATION

public static String VARIATION

コンストラクタの詳細

Gs2WatchClient

public Gs2WatchClient(io.gs2.model.IGs2Credential credential)

コンストラクタ。

パラメータ:

credential - 認証情報

メソッドの詳細

createAlerm

public CreateAlermResult createAlerm(CreateAlermRequest request)

アラームを作成。

GS2 内のスタティスティックスに対して監視を行うことができます。
クオータの消費量に対して閾値を設定し、閾値を超えた際に通知を出すことができます。

パラメータ:

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

戻り値:

作成結果

describeAlerm

public DescribeAlermResult describeAlerm(DescribeAlermRequest request)

アラーム一覧を取得。

パラメータ:

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

戻り値:

アラーム一覧

getAlerm

public GetAlermResult getAlerm(GetAlermRequest request)

アラームを取得。

パラメータ:

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

戻り値:

アラーム

updateAlerm

public UpdateAlermResult updateAlerm(UpdateAlermRequest request)

アラームを更新。

パラメータ:

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

戻り値:

更新結果

deleteAlerm

public void deleteAlerm(DeleteAlermRequest request)

アラームを削除。

パラメータ:

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

describeAlermEvent

public DescribeAlermEventResult describeAlermEvent(DescribeAlermEventRequest request)

アラームイベント一覧を取得。

過去にアラームが発生した履歴などを確認できます。

パラメータ:

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

戻り値:

アラームイベント一覧

describeService

public DescribeServiceResult describeService(DescribeServiceRequest request)

サービス一覧を取得。

アラームを設定する際に指定できるサービスの一覧を取得できます。

パラメータ:

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

戻り値:

サービス一覧

describeOperation

public DescribeOperationResult describeOperation(DescribeOperationRequest request)

オペレーション一覧を取得。

アラームを設定する際に指定できるオペレーションの一覧を取得できます。

パラメータ:

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

戻り値:

オペレーション一覧

getMetric

public GetMetricResult getMetric(GetMetricRequest request)

メトリクスを取得。

過去のサービスの利用状況を取得します。
結果は以下のCSV形式で形式で応答されます。

timestamp(yyyy-mm-dd hh:mm),value

パラメータ:

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

戻り値:

メトリクス