Gs2IdentifierClient (gs2-java-sdk-identifier 0.0.1-SNAPSHOT API)

java.lang.Object
- io.gs2.AbstractGs2Client<Gs2IdentifierClient>
- - io.gs2.identifier.Gs2IdentifierClient

public class Gs2IdentifierClient
extends AbstractGs2Client<Gs2IdentifierClient>

GS2 Identifier API クライアント

作成者:: Game Server Services, Inc.

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static String ENDPOINT

static String VARIATION
- クラスから継承されたフィールド io.gs2.AbstractGs2Client
  credential, region

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

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

コンストラクタ
コンストラクタと説明

Gs2IdentifierClient(IGs2Credential credential)
コンストラクタ。

コンストラクタ
コンストラクタと説明
`Gs2IdentifierClient(IGs2Credential credential)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`attachSecurityPolicy(AttachSecurityPolicyRequest request)` ユーザにセキュリティポリシーを割り当てる。
`CreateIdentifierResult`	`createIdentifier(CreateIdentifierRequest request)` GSIを作成。
`CreateSecurityPolicyResult`	`createSecurityPolicy(CreateSecurityPolicyRequest request)` セキュリティポリシーを作成。
`CreateUserResult`	`createUser(CreateUserRequest request)` ユーザを作成。
`void`	`deleteIdentifier(DeleteIdentifierRequest request)` GSIを削除。
`void`	`deleteSecurityPolicy(DeleteSecurityPolicyRequest request)` セキュリティポリシーを削除。
`void`	`deleteUser(DeleteUserRequest request)` ユーザを削除。
`DescribeCommonSecurityPolicyResult`	`describeCommonSecurityPolicy(DescribeCommonSecurityPolicyRequest request)` 共用セキュリティポリシー一覧を取得。
`DescribeIdentifierResult`	`describeIdentifier(DescribeIdentifierRequest request)` GSI一覧を取得。
`DescribeSecurityPolicyResult`	`describeSecurityPolicy(DescribeSecurityPolicyRequest request)` セキュリティポリシー一覧を取得。
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` ユーザ一覧を取得。
`void`	`detachSecurityPolicy(DetachSecurityPolicyRequest request)` ユーザに割り当てられたセキュリティポリシーを解除。
`GetHasSecurityPolicyResult`	`getHasSecurityPolicy(GetHasSecurityPolicyRequest request)` ユーザが保持しているセキュリティポリシー一覧を取得。
`GetSecurityPolicyResult`	`getSecurityPolicy(GetSecurityPolicyRequest request)` セキュリティポリシーを取得。
`GetUserResult`	`getUser(GetUserRequest request)` ユーザを取得。
`UpdateSecurityPolicyResult`	`updateSecurityPolicy(UpdateSecurityPolicyRequest 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
```
- コンストラクタの詳細
  - Gs2IdentifierClient
```
public Gs2IdentifierClient(IGs2Credential credential)
```
    コンストラクタ。
    
    パラメータ:
    
    credential - 認証情報
- メソッドの詳細
  - createUser
```
public CreateUserResult createUser(CreateUserRequest request)
```
    ユーザを作成。 GS2のサービスを利用するにはユーザを作成する必要があります。
    ユーザを作成後、ユーザに対して権限設定を行い、ユーザに対応したGSI(クライアントID/シークレット)を発行することでAPIが利用できるようになります。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    作成結果
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    ユーザ一覧を取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    ユーザ一覧
  - getUser
```
public GetUserResult getUser(GetUserRequest request)
```
    ユーザを取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    ユーザ
  - deleteUser
```
public void deleteUser(DeleteUserRequest request)
```
    ユーザを削除。
    
    パラメータ:
    
    request - リクエストパラメータ
  - createIdentifier
```
public CreateIdentifierResult createIdentifier(CreateIdentifierRequest request)
```
    GSIを作成。 GSIはSDKなどでAPIを利用する際に必要となるクライアントID/シークレットです。
    AWSでいうIAMのクレデンシャルに相当します。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    作成結果
  - describeIdentifier
```
public DescribeIdentifierResult describeIdentifier(DescribeIdentifierRequest request)
```
    GSI一覧を取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    GSI一覧
  - deleteIdentifier
```
public void deleteIdentifier(DeleteIdentifierRequest request)
```
    GSIを削除。
    
    パラメータ:
    
    request - リクエストパラメータ
  - getHasSecurityPolicy
```
public GetHasSecurityPolicyResult getHasSecurityPolicy(GetHasSecurityPolicyRequest request)
```
    ユーザが保持しているセキュリティポリシー一覧を取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    GSI一覧
  - attachSecurityPolicy
```
public void attachSecurityPolicy(AttachSecurityPolicyRequest request)
```
    ユーザにセキュリティポリシーを割り当てる。
    
    パラメータ:
    
    request - リクエストパラメータ
  - detachSecurityPolicy
```
public void detachSecurityPolicy(DetachSecurityPolicyRequest request)
```
    ユーザに割り当てられたセキュリティポリシーを解除。
    
    パラメータ:
    
    request - リクエストパラメータ
  - createSecurityPolicy
```
public CreateSecurityPolicyResult createSecurityPolicy(CreateSecurityPolicyRequest request)
```
    セキュリティポリシーを作成。セキュリティポリシーはユーザの権限を定義したものです。
    AWSのIAMポリシーに似せて設計されていますが、いくつかAWSのIAMポリシーと比較して劣る点があります。
    2016/9 時点では以下の様な点が IAMポリシーとは異なります。
    - リソースに対するアクセス制御はできません。
    - アクションのワイルドカードは最後に1箇所のみ利用できます。
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    作成結果
  - describeSecurityPolicy
```
public DescribeSecurityPolicyResult describeSecurityPolicy(DescribeSecurityPolicyRequest request)
```
    セキュリティポリシー一覧を取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    セキュリティポリシー一覧
  - describeCommonSecurityPolicy
```
public DescribeCommonSecurityPolicyResult describeCommonSecurityPolicy(DescribeCommonSecurityPolicyRequest request)
```
    共用セキュリティポリシー一覧を取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    共用セキュリティポリシー一覧
  - getSecurityPolicy
```
public GetSecurityPolicyResult getSecurityPolicy(GetSecurityPolicyRequest request)
```
    セキュリティポリシーを取得。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    セキュリティポリシー
  - updateSecurityPolicy
```
public UpdateSecurityPolicyResult updateSecurityPolicy(UpdateSecurityPolicyRequest request)
```
    セキュリティポリシーを更新。
    
    パラメータ:
    
    request - リクエストパラメータ
    
    戻り値:
    
    更新結果
  - deleteSecurityPolicy
```
public void deleteSecurityPolicy(DeleteSecurityPolicyRequest request)
```
    セキュリティポリシーを削除。
    
    パラメータ:
    
    request - リクエストパラメータ

クラス Gs2IdentifierClient

フィールドのサマリー

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

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

メソッドのサマリー

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

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

フィールドの詳細

ENDPOINT

VARIATION

コンストラクタの詳細

Gs2IdentifierClient

メソッドの詳細

createUser

describeUser

getUser

deleteUser

createIdentifier

describeIdentifier

deleteIdentifier

getHasSecurityPolicy

attachSecurityPolicy

detachSecurityPolicy

createSecurityPolicy

describeSecurityPolicy

describeCommonSecurityPolicy

getSecurityPolicy

updateSecurityPolicy

deleteSecurityPolicy