Gs2GatewayRestClient (Game Server Services SDK for Java GS2-Gateway Library 2.0.0 API)

java.lang.Object
- io.gs2.AbstractGs2Client<Gs2GatewayRestClient>
- - io.gs2.gateway.Gs2GatewayRestClient

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

GS2 Gateway 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

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT`

Constructor Summary

Constructors
Constructor and Description
`Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential)` コンストラクタ。
`Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential, io.gs2.model.Region region)` コンストラクタ。
`Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential, String region)` コンストラクタ。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateNamespaceResult`	`createNamespace(CreateNamespaceRequest request)` ネームスペースを新規作成
`DeleteFirebaseTokenResult`	`deleteFirebaseToken(DeleteFirebaseTokenRequest request)` Firebaseデバイストークンを削除
`DeleteFirebaseTokenByUserIdResult`	`deleteFirebaseTokenByUserId(DeleteFirebaseTokenByUserIdRequest request)` ユーザIDを指定してFirebaseデバイストークンを削除
`DeleteNamespaceResult`	`deleteNamespace(DeleteNamespaceRequest request)` ネームスペースを削除
`DescribeNamespacesResult`	`describeNamespaces(DescribeNamespacesRequest request)` ネームスペースの一覧を取得
`DescribeWebSocketSessionsResult`	`describeWebSocketSessions(DescribeWebSocketSessionsRequest request)` Websocketセッションの一覧を取得
`DescribeWebSocketSessionsByUserIdResult`	`describeWebSocketSessionsByUserId(DescribeWebSocketSessionsByUserIdRequest request)` ユーザIDを指定してWebsocketセッションの一覧を取得
`GetFirebaseTokenResult`	`getFirebaseToken(GetFirebaseTokenRequest request)` Firebaseデバイストークンを取得
`GetFirebaseTokenByUserIdResult`	`getFirebaseTokenByUserId(GetFirebaseTokenByUserIdRequest request)` ユーザIDを指定してFirebaseデバイストークンを取得
`GetNamespaceResult`	`getNamespace(GetNamespaceRequest request)` ネームスペースを取得
`GetNamespaceStatusResult`	`getNamespaceStatus(GetNamespaceStatusRequest request)` ネームスペースを取得
`GetWebSocketSessionResult`	`getWebSocketSession(GetWebSocketSessionRequest request)` Websocketセッションを取得
`GetWebSocketSessionByConnectionIdResult`	`getWebSocketSessionByConnectionId(GetWebSocketSessionByConnectionIdRequest request)` ユーザIDを指定してWebsocketセッションを取得
`SendMobileNotificationByUserIdResult`	`sendMobileNotificationByUserId(SendMobileNotificationByUserIdRequest request)` モバイルプッシュ通知を送信
`SendNotificationResult`	`sendNotification(SendNotificationRequest request)` 通知を送信
`SetFirebaseTokenResult`	`setFirebaseToken(SetFirebaseTokenRequest request)` デバイストークンを設定
`SetFirebaseTokenByUserIdResult`	`setFirebaseTokenByUserId(SetFirebaseTokenByUserIdRequest request)` ユーザIDを指定してデバイストークンを設定
`SetUserIdResult`	`setUserId(SetUserIdRequest request)` WebsocketセッションにユーザIDを設定
`SetUserIdByUserIdResult`	`setUserIdByUserId(SetUserIdByUserIdRequest request)` WebsocketセッションにユーザIDを設定
`UpdateNamespaceResult`	`updateNamespace(UpdateNamespaceRequest 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
  - Gs2GatewayRestClient
```
public Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential)
```
    コンストラクタ。
    
    Parameters:
    
    credential - 認証情報
  - Gs2GatewayRestClient
```
public Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential,
                            io.gs2.model.Region region)
```
    コンストラクタ。
    
    Parameters:
    
    credential - 認証情報
    
    region - リージョン
  - Gs2GatewayRestClient
```
public Gs2GatewayRestClient(io.gs2.model.IGs2Credential credential,
                            String region)
```
    コンストラクタ。
    
    Parameters:
    
    credential - 認証情報
    
    region - リージョン
- Method Detail
  - describeNamespaces
```
public DescribeNamespacesResult describeNamespaces(DescribeNamespacesRequest request)
```
    ネームスペースの一覧を取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - createNamespace
```
public CreateNamespaceResult createNamespace(CreateNamespaceRequest request)
```
    ネームスペースを新規作成
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getNamespaceStatus
```
public GetNamespaceStatusResult getNamespaceStatus(GetNamespaceStatusRequest request)
```
    ネームスペースを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getNamespace
```
public GetNamespaceResult getNamespace(GetNamespaceRequest request)
```
    ネームスペースを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - updateNamespace
```
public UpdateNamespaceResult updateNamespace(UpdateNamespaceRequest request)
```
    ネームスペースを更新
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - deleteNamespace
```
public DeleteNamespaceResult deleteNamespace(DeleteNamespaceRequest request)
```
    ネームスペースを削除
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeWebSocketSessions
```
public DescribeWebSocketSessionsResult describeWebSocketSessions(DescribeWebSocketSessionsRequest request)
```
    Websocketセッションの一覧を取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - describeWebSocketSessionsByUserId
```
public DescribeWebSocketSessionsByUserIdResult describeWebSocketSessionsByUserId(DescribeWebSocketSessionsByUserIdRequest request)
```
    ユーザIDを指定してWebsocketセッションの一覧を取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - setUserId
```
public SetUserIdResult setUserId(SetUserIdRequest request)
```
    WebsocketセッションにユーザIDを設定
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - setUserIdByUserId
```
public SetUserIdByUserIdResult setUserIdByUserId(SetUserIdByUserIdRequest request)
```
    WebsocketセッションにユーザIDを設定
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getWebSocketSession
```
public GetWebSocketSessionResult getWebSocketSession(GetWebSocketSessionRequest request)
```
    Websocketセッションを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getWebSocketSessionByConnectionId
```
public GetWebSocketSessionByConnectionIdResult getWebSocketSessionByConnectionId(GetWebSocketSessionByConnectionIdRequest request)
```
    ユーザIDを指定してWebsocketセッションを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - sendNotification
```
public SendNotificationResult sendNotification(SendNotificationRequest request)
```
    通知を送信
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - setFirebaseToken
```
public SetFirebaseTokenResult setFirebaseToken(SetFirebaseTokenRequest request)
```
    デバイストークンを設定
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - setFirebaseTokenByUserId
```
public SetFirebaseTokenByUserIdResult setFirebaseTokenByUserId(SetFirebaseTokenByUserIdRequest request)
```
    ユーザIDを指定してデバイストークンを設定
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getFirebaseToken
```
public GetFirebaseTokenResult getFirebaseToken(GetFirebaseTokenRequest request)
```
    Firebaseデバイストークンを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - getFirebaseTokenByUserId
```
public GetFirebaseTokenByUserIdResult getFirebaseTokenByUserId(GetFirebaseTokenByUserIdRequest request)
```
    ユーザIDを指定してFirebaseデバイストークンを取得
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - deleteFirebaseToken
```
public DeleteFirebaseTokenResult deleteFirebaseToken(DeleteFirebaseTokenRequest request)
```
    Firebaseデバイストークンを削除
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - deleteFirebaseTokenByUserId
```
public DeleteFirebaseTokenByUserIdResult deleteFirebaseTokenByUserId(DeleteFirebaseTokenByUserIdRequest request)
```
    ユーザIDを指定してFirebaseデバイストークンを削除
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果
  - sendMobileNotificationByUserId
```
public SendMobileNotificationByUserIdResult sendMobileNotificationByUserId(SendMobileNotificationByUserIdRequest request)
```
    モバイルプッシュ通知を送信
    
    Parameters:
    
    request - リクエストパラメータ
    
    Returns:
    
    結果

Class Gs2GatewayRestClient

Field Summary

Fields inherited from class io.gs2.AbstractGs2Client

Constructor Summary

Method Summary

Methods inherited from class io.gs2.AbstractGs2Client

Methods inherited from class java.lang.Object

Field Detail

ENDPOINT

Constructor Detail

Gs2GatewayRestClient

Gs2GatewayRestClient

Gs2GatewayRestClient

Method Detail

describeNamespaces

createNamespace

getNamespaceStatus

getNamespace

updateNamespace

deleteNamespace

describeWebSocketSessions

describeWebSocketSessionsByUserId

setUserId

setUserIdByUserId

getWebSocketSession

getWebSocketSessionByConnectionId

sendNotification

setFirebaseToken

setFirebaseTokenByUserId

getFirebaseToken

getFirebaseTokenByUserId

deleteFirebaseToken

deleteFirebaseTokenByUserId

sendMobileNotificationByUserId