GS2-Schedule SDK API リファレンス
モデル
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceId | string | | ✓ | | ~ 1024文字 | ネームスペースGRN |
name | string | | ✓ | | ~ 32文字 | ネームスペース名 |
description | string | | | | ~ 1024文字 | 説明文 |
logSetting | LogSetting | | | | | ログの出力設定 |
createdAt | long | | ✓ | | | 作成日時 |
updatedAt | long | | ✓ | | | 最終更新日時 |
revision | long | | | 0 | ~ 9223372036854775805 | リビジョン |
EventMaster
イベントマスター
イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。
イベントには開催期間だけでなく、繰り返しが設定できるようになっており
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
eventId | string | | ✓ | | ~ 1024文字 | イベントマスターGRN |
name | string | | ✓ | | ~ 128文字 | イベントの種類名 |
description | string | | | | ~ 1024文字 | 説明文 |
metadata | string | | | | ~ 2048文字 | メタデータ |
scheduleType | enum [‘absolute’, ‘relative’] | | ✓ | | ~ 128文字 | イベント期間の種類 |
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | “always” | ~ 128文字 | 繰り返しの種類 |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | | | イベントの開始日時 |
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | | | イベントの終了日時 |
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し開始曜日 |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し終了曜日 |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し開始時間 |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し終了時間 |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | | ~ 128文字 | イベントのトリガー名 |
createdAt | long | | ✓ | | | 作成日時 |
updatedAt | long | | ✓ | | | 最終更新日時 |
revision | long | | | 0 | ~ 9223372036854775805 | リビジョン |
Trigger
トリガー
トリガーはゲームプレイヤー毎に異なるイベント開催期間を実現する際に、イベントの開始の起点となるタイミングを定義するエンティティです。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
triggerId | string | | ✓ | | ~ 1024文字 | トリガーGRN |
name | string | | ✓ | | ~ 128文字 | トリガーの名前 |
userId | string | | ✓ | | ~ 128文字 | ユーザーID |
createdAt | long | | ✓ | | | 作成日時 |
expiresAt | long | | ✓ | | | トリガーの有効期限 |
revision | long | | | 0 | ~ 9223372036854775805 | リビジョン |
Event
イベント
イベントの期間は絶対期間と相対期間の2種類存在します。
絶対期間は 2021年1月1日 00:00(UTC) ~ 2021年1月7日 23:59(UTC) のような固定の期間で、
相対期間は トリガーを引いたタイミングから 24時間 のようなゲームプレイヤー毎に異なる期間をイベント期間とするものです。
イベントには開催期間だけでなく、繰り返しが設定できるようになっており
イベント期間のうち、月曜日の 10:00 ~ 11:00 だけをイベント期間とするような設定も可能です。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
eventId | string | | ✓ | | ~ 1024文字 | イベントGRN |
name | string | | ✓ | | ~ 128文字 | イベントの種類名 |
metadata | string | | | | ~ 2048文字 | メタデータ |
scheduleType | enum [‘absolute’, ‘relative’] | | ✓ | | ~ 128文字 | イベント期間の種類 |
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | “always” | ~ 128文字 | 繰り返しの種類 |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | | | イベントの開始日時 |
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | | | イベントの終了日時 |
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し開始曜日 |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し終了曜日 |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し開始時間 |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し終了時間 |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | | ~ 128文字 | イベントの開始トリガー |
CurrentEventMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceId | string | | ✓ | | ~ 1024文字 | ネームスペースGRN |
settings | string | | ✓ | | ~ 5242880文字 | マスターデータ |
GitHubCheckoutSetting
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
apiKeyId | string | | ✓ | | ~ 1024文字 | GitHub のAPIキーGRN |
repositoryName | string | | ✓ | | ~ 1024文字 | リポジトリ名 |
sourcePath | string | | ✓ | | ~ 1024文字 | ソースコードのファイルパス |
referenceType | enum [‘commit_hash’, ‘branch’, ’tag’] | | ✓ | | ~ 128文字 | コードの取得元 |
commitHash | string | {referenceType} == “commit_hash” | ✓ | | ~ 1024文字 | コミットハッシュ |
branchName | string | {referenceType} == “branch” | ✓ | | ~ 1024文字 | ブランチ名 |
tagName | string | {referenceType} == “tag” | ✓ | | ~ 1024文字 | タグ名 |
LogSetting
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
loggingNamespaceId | string | | ✓ | | ~ 1024文字 | ネームスペースGRN |
RepeatSchedule
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
repeatCount | int | | ✓ | | ~ 2147483646 | 繰り返し回数 |
currentRepeatStartAt | long | | | | | リピート中のイベントの開始日時 |
currentRepeatEndAt | long | | | | | リピート中のイベントの終了日時 |
lastRepeatEndAt | long | | | | | 前回のイベントの終了日時 |
nextRepeatStartAt | long | | | | | 次回のイベントの開始日時 |
メソッド
describeNamespaces
ネームスペースの一覧を取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
limit | int | | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DescribeNamespaces(
&schedule.DescribeNamespacesRequest {
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DescribeNamespacesRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeNamespaces(
(new DescribeNamespacesRequest())
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DescribeNamespacesRequest;
import io.gs2.schedule.result.DescribeNamespacesResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DescribeNamespacesResult result = client.describeNamespaces(
new DescribeNamespacesRequest()
.withPageToken(null)
.withLimit(null)
);
List<Namespace> items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DescribeNamespacesRequest;
using Gs2.Gs2Schedule.Result.DescribeNamespacesResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DescribeNamespacesResult> asyncResult = null;
yield return client.DescribeNamespaces(
new Gs2.Gs2Schedule.Request.DescribeNamespacesRequest()
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.describeNamespaces(
new Gs2Schedule.DescribeNamespacesRequest()
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.describe_namespaces(
schedule.DescribeNamespacesRequest()
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.describe_namespaces({
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
createNamespace
ネームスペースを新規作成
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
name | string | | ✓ | | ~ 32文字 | ネームスペース名 |
description | string | | | | ~ 1024文字 | 説明文 |
logSetting | LogSetting | | | | | ログの出力設定 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.CreateNamespace(
&schedule.CreateNamespaceRequest {
Name: pointy.String("namespace1"),
Description: nil,
LogSetting: &schedule.LogSetting{
LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"),
},
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\CreateNamespaceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createNamespace(
(new CreateNamespaceRequest())
->withName(self::namespace1)
->withDescription(null)
->withLogSetting((new \Gs2\Schedule\Model\LogSetting())
->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.CreateNamespaceRequest;
import io.gs2.schedule.result.CreateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
CreateNamespaceResult result = client.createNamespace(
new CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withLogSetting(new io.gs2.schedule.model.LogSetting()
.withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
Namespace item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.CreateNamespaceRequest;
using Gs2.Gs2Schedule.Result.CreateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.CreateNamespaceResult> asyncResult = null;
yield return client.CreateNamespace(
new Gs2.Gs2Schedule.Request.CreateNamespaceRequest()
.WithName("namespace1")
.WithDescription(null)
.WithLogSetting(new Gs2.Gs2Schedule.Model.LogSetting()
.WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.createNamespace(
new Gs2Schedule.CreateNamespaceRequest()
.withName("namespace1")
.withDescription(null)
.withLogSetting(new Gs2Schedule.model.LogSetting()
.withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.create_namespace(
schedule.CreateNamespaceRequest()
.with_name(self.hash1)
.with_description(None)
.with_log_setting(
schedule.LogSetting()
.with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001'))
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.create_namespace({
name='namespace1',
description=nil,
logSetting={
loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getNamespaceStatus
ネームスペースの状態を取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.GetNamespaceStatus(
&schedule.GetNamespaceStatusRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
status := result.Status
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\GetNamespaceStatusRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getNamespaceStatus(
(new GetNamespaceStatusRequest())
->withNamespaceName(self::namespace1)
);
$status = $result->getStatus();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.GetNamespaceStatusRequest;
import io.gs2.schedule.result.GetNamespaceStatusResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
GetNamespaceStatusResult result = client.getNamespaceStatus(
new GetNamespaceStatusRequest()
.withNamespaceName("namespace1")
);
String status = result.getStatus();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.GetNamespaceStatusRequest;
using Gs2.Gs2Schedule.Result.GetNamespaceStatusResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.GetNamespaceStatusResult> asyncResult = null;
yield return client.GetNamespaceStatus(
new Gs2.Gs2Schedule.Request.GetNamespaceStatusRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var status = result.Status;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.getNamespaceStatus(
new Gs2Schedule.GetNamespaceStatusRequest()
.withNamespaceName("namespace1")
);
const status = result.getStatus();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.get_namespace_status(
schedule.GetNamespaceStatusRequest()
.with_namespace_name(self.hash1)
)
status = result.status
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.get_namespace_status({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
status = result.status;
getNamespace
ネームスペースを取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.GetNamespace(
&schedule.GetNamespaceRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\GetNamespaceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getNamespace(
(new GetNamespaceRequest())
->withNamespaceName(self::namespace1)
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.GetNamespaceRequest;
import io.gs2.schedule.result.GetNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
GetNamespaceResult result = client.getNamespace(
new GetNamespaceRequest()
.withNamespaceName("namespace1")
);
Namespace item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.GetNamespaceRequest;
using Gs2.Gs2Schedule.Result.GetNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.GetNamespaceResult> asyncResult = null;
yield return client.GetNamespace(
new Gs2.Gs2Schedule.Request.GetNamespaceRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.getNamespace(
new Gs2Schedule.GetNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.get_namespace(
schedule.GetNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.get_namespace({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateNamespace
ネームスペースを更新
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
description | string | | | | ~ 1024文字 | 説明文 |
logSetting | LogSetting | | | | | ログの出力設定 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.UpdateNamespace(
&schedule.UpdateNamespaceRequest {
NamespaceName: pointy.String("namespace1"),
Description: pointy.String("description1"),
LogSetting: &schedule.LogSetting{
LoggingNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"),
},
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\UpdateNamespaceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateNamespace(
(new UpdateNamespaceRequest())
->withNamespaceName(self::namespace1)
->withDescription("description1")
->withLogSetting((new \Gs2\Schedule\Model\LogSetting())
->withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.UpdateNamespaceRequest;
import io.gs2.schedule.result.UpdateNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
UpdateNamespaceResult result = client.updateNamespace(
new UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withLogSetting(new io.gs2.schedule.model.LogSetting()
.withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
Namespace item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.UpdateNamespaceRequest;
using Gs2.Gs2Schedule.Result.UpdateNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.UpdateNamespaceResult> asyncResult = null;
yield return client.UpdateNamespace(
new Gs2.Gs2Schedule.Request.UpdateNamespaceRequest()
.WithNamespaceName("namespace1")
.WithDescription("description1")
.WithLogSetting(new Gs2.Gs2Schedule.Model.LogSetting()
.WithLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001")),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.updateNamespace(
new Gs2Schedule.UpdateNamespaceRequest()
.withNamespaceName("namespace1")
.withDescription("description1")
.withLogSetting(new Gs2Schedule.model.LogSetting()
.withLoggingNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"))
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.update_namespace(
schedule.UpdateNamespaceRequest()
.with_namespace_name(self.hash1)
.with_description('description1')
.with_log_setting(
schedule.LogSetting()
.with_logging_namespace_id('grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001'))
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.update_namespace({
namespaceName='namespace1',
description='description1',
logSetting={
loggingNamespaceId='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
},
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteNamespace
ネームスペースを削除
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DeleteNamespace(
&schedule.DeleteNamespaceRequest {
NamespaceName: pointy.String("namespace1"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DeleteNamespaceRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteNamespace(
(new DeleteNamespaceRequest())
->withNamespaceName(self::namespace1)
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DeleteNamespaceRequest;
import io.gs2.schedule.result.DeleteNamespaceResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DeleteNamespaceResult result = client.deleteNamespace(
new DeleteNamespaceRequest()
.withNamespaceName("namespace1")
);
Namespace item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DeleteNamespaceRequest;
using Gs2.Gs2Schedule.Result.DeleteNamespaceResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DeleteNamespaceResult> asyncResult = null;
yield return client.DeleteNamespace(
new Gs2.Gs2Schedule.Request.DeleteNamespaceRequest()
.WithNamespaceName("namespace1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.deleteNamespace(
new Gs2Schedule.DeleteNamespaceRequest()
.withNamespaceName("namespace1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.delete_namespace(
schedule.DeleteNamespaceRequest()
.with_namespace_name(self.hash1)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.delete_namespace({
namespaceName='namespace1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeEventMasters
イベントマスターの一覧を取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
limit | int | | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DescribeEventMasters(
&schedule.DescribeEventMastersRequest {
NamespaceName: pointy.String("namespace1"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DescribeEventMastersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeEventMasters(
(new DescribeEventMastersRequest())
->withNamespaceName(self::namespace1)
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DescribeEventMastersRequest;
import io.gs2.schedule.result.DescribeEventMastersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DescribeEventMastersResult result = client.describeEventMasters(
new DescribeEventMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
List<EventMaster> items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DescribeEventMastersRequest;
using Gs2.Gs2Schedule.Result.DescribeEventMastersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DescribeEventMastersResult> asyncResult = null;
yield return client.DescribeEventMasters(
new Gs2.Gs2Schedule.Request.DescribeEventMastersRequest()
.WithNamespaceName("namespace1")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.describeEventMasters(
new Gs2Schedule.DescribeEventMastersRequest()
.withNamespaceName("namespace1")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.describe_event_masters(
schedule.DescribeEventMastersRequest()
.with_namespace_name(self.hash1)
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.describe_event_masters({
namespaceName='namespace1',
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
createEventMaster
イベントマスターを新規作成
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
name | string | | ✓ | | ~ 128文字 | イベントの種類名 |
description | string | | | | ~ 1024文字 | 説明文 |
metadata | string | | | | ~ 2048文字 | メタデータ |
scheduleType | enum [‘absolute’, ‘relative’] | | ✓ | | ~ 128文字 | イベント期間の種類 |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | | | イベントの開始日時 |
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | | | イベントの終了日時 |
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | “always” | ~ 128文字 | 繰り返しの種類 |
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し開始曜日 |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し終了曜日 |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し開始時間 |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し終了時間 |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | | ~ 128文字 | イベントのトリガー名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.CreateEventMaster(
&schedule.CreateEventMasterRequest {
NamespaceName: pointy.String("namespace1"),
Name: pointy.String("event-0001"),
Description: nil,
Metadata: nil,
ScheduleType: pointy.String("absolute"),
AbsoluteBegin: pointy.Int64(10000),
AbsoluteEnd: pointy.Int64(20000),
RepeatType: nil,
RepeatBeginDayOfMonth: pointy.Int32(1),
RepeatEndDayOfMonth: pointy.Int32(2),
RepeatBeginDayOfWeek: pointy.String("monday"),
RepeatEndDayOfWeek: pointy.String("sunday"),
RepeatBeginHour: pointy.Int32(5),
RepeatEndHour: pointy.Int32(6),
RelativeTriggerName: pointy.String("trigger-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\CreateEventMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->createEventMaster(
(new CreateEventMasterRequest())
->withNamespaceName(self::namespace1)
->withName("event-0001")
->withDescription(null)
->withMetadata(null)
->withScheduleType("absolute")
->withAbsoluteBegin(10000)
->withAbsoluteEnd(20000)
->withRepeatType(null)
->withRepeatBeginDayOfMonth(1)
->withRepeatEndDayOfMonth(2)
->withRepeatBeginDayOfWeek("monday")
->withRepeatEndDayOfWeek("sunday")
->withRepeatBeginHour(5)
->withRepeatEndHour(6)
->withRelativeTriggerName("trigger-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.CreateEventMasterRequest;
import io.gs2.schedule.result.CreateEventMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
CreateEventMasterResult result = client.createEventMaster(
new CreateEventMasterRequest()
.withNamespaceName("namespace1")
.withName("event-0001")
.withDescription(null)
.withMetadata(null)
.withScheduleType("absolute")
.withAbsoluteBegin(10000L)
.withAbsoluteEnd(20000L)
.withRepeatType(null)
.withRepeatBeginDayOfMonth(1)
.withRepeatEndDayOfMonth(2)
.withRepeatBeginDayOfWeek("monday")
.withRepeatEndDayOfWeek("sunday")
.withRepeatBeginHour(5)
.withRepeatEndHour(6)
.withRelativeTriggerName("trigger-0001")
);
EventMaster item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.CreateEventMasterRequest;
using Gs2.Gs2Schedule.Result.CreateEventMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.CreateEventMasterResult> asyncResult = null;
yield return client.CreateEventMaster(
new Gs2.Gs2Schedule.Request.CreateEventMasterRequest()
.WithNamespaceName("namespace1")
.WithName("event-0001")
.WithDescription(null)
.WithMetadata(null)
.WithScheduleType("absolute")
.WithAbsoluteBegin(10000L)
.WithAbsoluteEnd(20000L)
.WithRepeatType(null)
.WithRepeatBeginDayOfMonth(1)
.WithRepeatEndDayOfMonth(2)
.WithRepeatBeginDayOfWeek("monday")
.WithRepeatEndDayOfWeek("sunday")
.WithRepeatBeginHour(5)
.WithRepeatEndHour(6)
.WithRelativeTriggerName("trigger-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.createEventMaster(
new Gs2Schedule.CreateEventMasterRequest()
.withNamespaceName("namespace1")
.withName("event-0001")
.withDescription(null)
.withMetadata(null)
.withScheduleType("absolute")
.withAbsoluteBegin(10000)
.withAbsoluteEnd(20000)
.withRepeatType(null)
.withRepeatBeginDayOfMonth(1)
.withRepeatEndDayOfMonth(2)
.withRepeatBeginDayOfWeek("monday")
.withRepeatEndDayOfWeek("sunday")
.withRepeatBeginHour(5)
.withRepeatEndHour(6)
.withRelativeTriggerName("trigger-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.create_event_master(
schedule.CreateEventMasterRequest()
.with_namespace_name(self.hash1)
.with_name('event-0001')
.with_description(None)
.with_metadata(None)
.with_schedule_type('absolute')
.with_absolute_begin(10000)
.with_absolute_end(20000)
.with_repeat_type(None)
.with_repeat_begin_day_of_month(1)
.with_repeat_end_day_of_month(2)
.with_repeat_begin_day_of_week('monday')
.with_repeat_end_day_of_week('sunday')
.with_repeat_begin_hour(5)
.with_repeat_end_hour(6)
.with_relative_trigger_name('trigger-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.create_event_master({
namespaceName='namespace1',
name='event-0001',
description=nil,
metadata=nil,
scheduleType='absolute',
absoluteBegin=10000,
absoluteEnd=20000,
repeatType=nil,
repeatBeginDayOfMonth=1,
repeatEndDayOfMonth=2,
repeatBeginDayOfWeek='monday',
repeatEndDayOfWeek='sunday',
repeatBeginHour=5,
repeatEndHour=6,
relativeTriggerName='trigger-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getEventMaster
イベントマスターを取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
eventName | string | | ✓ | | ~ 128文字 | イベントの種類名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.GetEventMaster(
&schedule.GetEventMasterRequest {
NamespaceName: pointy.String("namespace1"),
EventName: pointy.String("event-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\GetEventMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getEventMaster(
(new GetEventMasterRequest())
->withNamespaceName(self::namespace1)
->withEventName("event-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.GetEventMasterRequest;
import io.gs2.schedule.result.GetEventMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
GetEventMasterResult result = client.getEventMaster(
new GetEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
);
EventMaster item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.GetEventMasterRequest;
using Gs2.Gs2Schedule.Result.GetEventMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.GetEventMasterResult> asyncResult = null;
yield return client.GetEventMaster(
new Gs2.Gs2Schedule.Request.GetEventMasterRequest()
.WithNamespaceName("namespace1")
.WithEventName("event-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.getEventMaster(
new Gs2Schedule.GetEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.get_event_master(
schedule.GetEventMasterRequest()
.with_namespace_name(self.hash1)
.with_event_name('event-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.get_event_master({
namespaceName='namespace1',
eventName='event-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
updateEventMaster
イベントマスターを更新
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
eventName | string | | ✓ | | ~ 128文字 | イベントの種類名 |
description | string | | | | ~ 1024文字 | 説明文 |
metadata | string | | | | ~ 2048文字 | メタデータ |
scheduleType | enum [‘absolute’, ‘relative’] | | ✓ | | ~ 128文字 | イベント期間の種類 |
absoluteBegin | long | {scheduleType} == “absolute” | ✓ | | | イベントの開始日時 |
absoluteEnd | long | {scheduleType} == “absolute” | ✓ | | | イベントの終了日時 |
repeatType | enum [‘always’, ‘daily’, ‘weekly’, ‘monthly’] | | ✓ | “always” | ~ 128文字 | 繰り返しの種類 |
repeatBeginDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し開始日(月の日数を超える場合は、最終日として扱われます) |
repeatEndDayOfMonth | int | {repeatType} == “monthly” | ✓ | | 1 ~ 31 | イベントの繰り返し終了日(月の日数を超える場合は、最終日として扱われます) |
repeatBeginDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し開始曜日 |
repeatEndDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {repeatType} == “weekly” | ✓ | | ~ 128文字 | イベントの繰り返し終了曜日 |
repeatBeginHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し開始時間 |
repeatEndHour | int | {repeatType} in [“daily”, “weekly”, “monthly”] | ✓ | | ~ 23 | イベントの繰り返し終了時間 |
relativeTriggerName | string | {scheduleType} == “relative” | ✓ | | ~ 128文字 | イベントのトリガー名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.UpdateEventMaster(
&schedule.UpdateEventMasterRequest {
NamespaceName: pointy.String("namespace1"),
EventName: pointy.String("event-0001"),
Description: pointy.String("description1"),
Metadata: pointy.String("{\"hoge\": \"fuga\"}"),
ScheduleType: pointy.String("absolute"),
AbsoluteBegin: pointy.Int64(20000),
AbsoluteEnd: pointy.Int64(30000),
RepeatType: nil,
RepeatBeginDayOfMonth: pointy.Int32(1),
RepeatEndDayOfMonth: pointy.Int32(2),
RepeatBeginDayOfWeek: pointy.String("monday"),
RepeatEndDayOfWeek: pointy.String("sunday"),
RepeatBeginHour: pointy.Int32(5),
RepeatEndHour: pointy.Int32(6),
RelativeTriggerName: pointy.String("trigger-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\UpdateEventMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->updateEventMaster(
(new UpdateEventMasterRequest())
->withNamespaceName(self::namespace1)
->withEventName("event-0001")
->withDescription("description1")
->withMetadata("{\"hoge\": \"fuga\"}")
->withScheduleType("absolute")
->withAbsoluteBegin(20000)
->withAbsoluteEnd(30000)
->withRepeatType(null)
->withRepeatBeginDayOfMonth(1)
->withRepeatEndDayOfMonth(2)
->withRepeatBeginDayOfWeek("monday")
->withRepeatEndDayOfWeek("sunday")
->withRepeatBeginHour(5)
->withRepeatEndHour(6)
->withRelativeTriggerName("trigger-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.UpdateEventMasterRequest;
import io.gs2.schedule.result.UpdateEventMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
UpdateEventMasterResult result = client.updateEventMaster(
new UpdateEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
.withDescription("description1")
.withMetadata("{\"hoge\": \"fuga\"}")
.withScheduleType("absolute")
.withAbsoluteBegin(20000L)
.withAbsoluteEnd(30000L)
.withRepeatType(null)
.withRepeatBeginDayOfMonth(1)
.withRepeatEndDayOfMonth(2)
.withRepeatBeginDayOfWeek("monday")
.withRepeatEndDayOfWeek("sunday")
.withRepeatBeginHour(5)
.withRepeatEndHour(6)
.withRelativeTriggerName("trigger-0001")
);
EventMaster item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.UpdateEventMasterRequest;
using Gs2.Gs2Schedule.Result.UpdateEventMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.UpdateEventMasterResult> asyncResult = null;
yield return client.UpdateEventMaster(
new Gs2.Gs2Schedule.Request.UpdateEventMasterRequest()
.WithNamespaceName("namespace1")
.WithEventName("event-0001")
.WithDescription("description1")
.WithMetadata("{\"hoge\": \"fuga\"}")
.WithScheduleType("absolute")
.WithAbsoluteBegin(20000L)
.WithAbsoluteEnd(30000L)
.WithRepeatType(null)
.WithRepeatBeginDayOfMonth(1)
.WithRepeatEndDayOfMonth(2)
.WithRepeatBeginDayOfWeek("monday")
.WithRepeatEndDayOfWeek("sunday")
.WithRepeatBeginHour(5)
.WithRepeatEndHour(6)
.WithRelativeTriggerName("trigger-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.updateEventMaster(
new Gs2Schedule.UpdateEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
.withDescription("description1")
.withMetadata("{\"hoge\": \"fuga\"}")
.withScheduleType("absolute")
.withAbsoluteBegin(20000)
.withAbsoluteEnd(30000)
.withRepeatType(null)
.withRepeatBeginDayOfMonth(1)
.withRepeatEndDayOfMonth(2)
.withRepeatBeginDayOfWeek("monday")
.withRepeatEndDayOfWeek("sunday")
.withRepeatBeginHour(5)
.withRepeatEndHour(6)
.withRelativeTriggerName("trigger-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.update_event_master(
schedule.UpdateEventMasterRequest()
.with_namespace_name(self.hash1)
.with_event_name('event-0001')
.with_description('description1')
.with_metadata('{"hoge": "fuga"}')
.with_schedule_type('absolute')
.with_absolute_begin(20000)
.with_absolute_end(30000)
.with_repeat_type(None)
.with_repeat_begin_day_of_month(1)
.with_repeat_end_day_of_month(2)
.with_repeat_begin_day_of_week('monday')
.with_repeat_end_day_of_week('sunday')
.with_repeat_begin_hour(5)
.with_repeat_end_hour(6)
.with_relative_trigger_name('trigger-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.update_event_master({
namespaceName='namespace1',
eventName='event-0001',
description='description1',
metadata='{"hoge": "fuga"}',
scheduleType='absolute',
absoluteBegin=20000,
absoluteEnd=30000,
repeatType=nil,
repeatBeginDayOfMonth=1,
repeatEndDayOfMonth=2,
repeatBeginDayOfWeek='monday',
repeatEndDayOfWeek='sunday',
repeatBeginHour=5,
repeatEndHour=6,
relativeTriggerName='trigger-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteEventMaster
イベントマスターを削除
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
eventName | string | | ✓ | | ~ 128文字 | イベントの種類名 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DeleteEventMaster(
&schedule.DeleteEventMasterRequest {
NamespaceName: pointy.String("namespace1"),
EventName: pointy.String("event-0001"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DeleteEventMasterRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->deleteEventMaster(
(new DeleteEventMasterRequest())
->withNamespaceName(self::namespace1)
->withEventName("event-0001")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DeleteEventMasterRequest;
import io.gs2.schedule.result.DeleteEventMasterResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DeleteEventMasterResult result = client.deleteEventMaster(
new DeleteEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
);
EventMaster item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DeleteEventMasterRequest;
using Gs2.Gs2Schedule.Result.DeleteEventMasterResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DeleteEventMasterResult> asyncResult = null;
yield return client.DeleteEventMaster(
new Gs2.Gs2Schedule.Request.DeleteEventMasterRequest()
.WithNamespaceName("namespace1")
.WithEventName("event-0001"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.deleteEventMaster(
new Gs2Schedule.DeleteEventMasterRequest()
.withNamespaceName("namespace1")
.withEventName("event-0001")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.delete_event_master(
schedule.DeleteEventMasterRequest()
.with_namespace_name(self.hash1)
.with_event_name('event-0001')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.delete_event_master({
namespaceName='namespace1',
eventName='event-0001',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
describeTriggers
トリガーの一覧を取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
accessToken | string | | ✓ | | ~ 128文字 | ユーザーID |
pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
limit | int | | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
| 型 | 説明 |
---|
items | List<Trigger> | トリガーのリスト |
nextPageToken | string | リストの続きを取得するためのページトークン |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DescribeTriggers(
&schedule.DescribeTriggersRequest {
NamespaceName: pointy.String("namespace1"),
AccessToken: pointy.String("$access_token_0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DescribeTriggersRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeTriggers(
(new DescribeTriggersRequest())
->withNamespaceName(self::namespace1)
->withAccessToken(self::$accessToken0001)
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DescribeTriggersRequest;
import io.gs2.schedule.result.DescribeTriggersResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DescribeTriggersResult result = client.describeTriggers(
new DescribeTriggersRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withPageToken(null)
.withLimit(null)
);
List<Trigger> items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DescribeTriggersRequest;
using Gs2.Gs2Schedule.Result.DescribeTriggersResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DescribeTriggersResult> asyncResult = null;
yield return client.DescribeTriggers(
new Gs2.Gs2Schedule.Request.DescribeTriggersRequest()
.WithNamespaceName("namespace1")
.WithAccessToken("$access_token_0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.describeTriggers(
new Gs2Schedule.DescribeTriggersRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.describe_triggers(
schedule.DescribeTriggersRequest()
.with_namespace_name(self.hash1)
.with_access_token(self.access_token_0001)
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.describe_triggers({
namespaceName='namespace1',
accessToken='$access_token_0001',
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
describeTriggersByUserId
ユーザIDを指定してトリガーの一覧を取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
userId | string | | ✓ | | ~ 128文字 | ユーザーID |
pageToken | string | | | | ~ 1024文字 | データの取得を開始する位置を指定するトークン |
limit | int | | ✓ | 30 | 1 ~ 1000 | データの取得件数 |
Result
| 型 | 説明 |
---|
items | List<Trigger> | トリガーのリスト |
nextPageToken | string | リストの続きを取得するためのページトークン |
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.DescribeTriggersByUserId(
&schedule.DescribeTriggersByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
PageToken: nil,
Limit: nil,
}
)
if err != nil {
panic("error occurred")
}
items := result.Items
nextPageToken := result.NextPageToken
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\DescribeTriggersByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->describeTriggersByUserId(
(new DescribeTriggersByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withPageToken(null)
->withLimit(null)
);
$items = $result->getItems();
$nextPageToken = $result->getNextPageToken();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.DescribeTriggersByUserIdRequest;
import io.gs2.schedule.result.DescribeTriggersByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
DescribeTriggersByUserIdResult result = client.describeTriggersByUserId(
new DescribeTriggersByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withPageToken(null)
.withLimit(null)
);
List<Trigger> items = result.getItems();
String nextPageToken = result.getNextPageToken();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.DescribeTriggersByUserIdRequest;
using Gs2.Gs2Schedule.Result.DescribeTriggersByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.DescribeTriggersByUserIdResult> asyncResult = null;
yield return client.DescribeTriggersByUserId(
new Gs2.Gs2Schedule.Request.DescribeTriggersByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithPageToken(null)
.WithLimit(null),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var items = result.Items;
var nextPageToken = result.NextPageToken;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.describeTriggersByUserId(
new Gs2Schedule.DescribeTriggersByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withPageToken(null)
.withLimit(null)
);
const items = result.getItems();
const nextPageToken = result.getNextPageToken();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.describe_triggers_by_user_id(
schedule.DescribeTriggersByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_page_token(None)
.with_limit(None)
)
items = result.items
next_page_token = result.next_page_token
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.describe_triggers_by_user_id({
namespaceName='namespace1',
userId='user-0001',
pageToken=nil,
limit=nil,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
items = result.items;
nextPageToken = result.nextPageToken;
getTrigger
トリガーを取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
accessToken | string | | ✓ | | ~ 128文字 | ユーザーID |
triggerName | string | | ✓ | | ~ 128文字 | トリガーの名前 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.GetTrigger(
&schedule.GetTriggerRequest {
NamespaceName: pointy.String("namespace1"),
AccessToken: pointy.String("$access_token_0001"),
TriggerName: pointy.String("trigger1"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\GetTriggerRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getTrigger(
(new GetTriggerRequest())
->withNamespaceName(self::namespace1)
->withAccessToken(self::$accessToken0001)
->withTriggerName("trigger1")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.GetTriggerRequest;
import io.gs2.schedule.result.GetTriggerResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
GetTriggerResult result = client.getTrigger(
new GetTriggerRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withTriggerName("trigger1")
);
Trigger item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.GetTriggerRequest;
using Gs2.Gs2Schedule.Result.GetTriggerResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.GetTriggerResult> asyncResult = null;
yield return client.GetTrigger(
new Gs2.Gs2Schedule.Request.GetTriggerRequest()
.WithNamespaceName("namespace1")
.WithAccessToken("$access_token_0001")
.WithTriggerName("trigger1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.getTrigger(
new Gs2Schedule.GetTriggerRequest()
.withNamespaceName("namespace1")
.withAccessToken("$access_token_0001")
.withTriggerName("trigger1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.get_trigger(
schedule.GetTriggerRequest()
.with_namespace_name(self.hash1)
.with_access_token(self.access_token_0001)
.with_trigger_name('trigger1')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.get_trigger({
namespaceName='namespace1',
accessToken='$access_token_0001',
triggerName='trigger1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
getTriggerByUserId
ユーザIDを指定してトリガーを取得
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
userId | string | | ✓ | | ~ 128文字 | ユーザーID |
triggerName | string | | ✓ | | ~ 128文字 | トリガーの名前 |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.GetTriggerByUserId(
&schedule.GetTriggerByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
UserId: pointy.String("user-0001"),
TriggerName: pointy.String("trigger1"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\GetTriggerByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->getTriggerByUserId(
(new GetTriggerByUserIdRequest())
->withNamespaceName(self::namespace1)
->withUserId("user-0001")
->withTriggerName("trigger1")
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.GetTriggerByUserIdRequest;
import io.gs2.schedule.result.GetTriggerByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
GetTriggerByUserIdResult result = client.getTriggerByUserId(
new GetTriggerByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withTriggerName("trigger1")
);
Trigger item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.GetTriggerByUserIdRequest;
using Gs2.Gs2Schedule.Result.GetTriggerByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.GetTriggerByUserIdResult> asyncResult = null;
yield return client.GetTriggerByUserId(
new Gs2.Gs2Schedule.Request.GetTriggerByUserIdRequest()
.WithNamespaceName("namespace1")
.WithUserId("user-0001")
.WithTriggerName("trigger1"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.getTriggerByUserId(
new Gs2Schedule.GetTriggerByUserIdRequest()
.withNamespaceName("namespace1")
.withUserId("user-0001")
.withTriggerName("trigger1")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.get_trigger_by_user_id(
schedule.GetTriggerByUserIdRequest()
.with_namespace_name(self.hash1)
.with_user_id('user-0001')
.with_trigger_name('trigger1')
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.get_trigger_by_user_id({
namespaceName='namespace1',
userId='user-0001',
triggerName='trigger1',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
triggerByUserId
ユーザIDを指定してトリガーを実行
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
triggerName | string | | ✓ | | ~ 128文字 | トリガーの名前 |
userId | string | | ✓ | | ~ 128文字 | ユーザーID |
triggerStrategy | enum [‘renew’, ‘drop’] | | ✓ | | ~ 128文字 | トリガーの引き方の方針 |
ttl | int | | ✓ | | ~ 2147483646 | トリガーの有効期限(秒) |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.TriggerByUserId(
&schedule.TriggerByUserIdRequest {
NamespaceName: pointy.String("namespace1"),
TriggerName: pointy.String("trigger1"),
UserId: pointy.String("user-0001"),
TriggerStrategy: pointy.String("renew"),
Ttl: pointy.Int32(300),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\TriggerByUserIdRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->triggerByUserId(
(new TriggerByUserIdRequest())
->withNamespaceName(self::namespace1)
->withTriggerName("trigger1")
->withUserId("user-0001")
->withTriggerStrategy("renew")
->withTtl(300)
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.TriggerByUserIdRequest;
import io.gs2.schedule.result.TriggerByUserIdResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
TriggerByUserIdResult result = client.triggerByUserId(
new TriggerByUserIdRequest()
.withNamespaceName("namespace1")
.withTriggerName("trigger1")
.withUserId("user-0001")
.withTriggerStrategy("renew")
.withTtl(300)
);
Trigger item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.TriggerByUserIdRequest;
using Gs2.Gs2Schedule.Result.TriggerByUserIdResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.TriggerByUserIdResult> asyncResult = null;
yield return client.TriggerByUserId(
new Gs2.Gs2Schedule.Request.TriggerByUserIdRequest()
.WithNamespaceName("namespace1")
.WithTriggerName("trigger1")
.WithUserId("user-0001")
.WithTriggerStrategy("renew")
.WithTtl(300),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.triggerByUserId(
new Gs2Schedule.TriggerByUserIdRequest()
.withNamespaceName("namespace1")
.withTriggerName("trigger1")
.withUserId("user-0001")
.withTriggerStrategy("renew")
.withTtl(300)
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.trigger_by_user_id(
schedule.TriggerByUserIdRequest()
.with_namespace_name(self.hash1)
.with_trigger_name('trigger1')
.with_user_id('user-0001')
.with_trigger_strategy('renew')
.with_ttl(300)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.trigger_by_user_id({
namespaceName='namespace1',
triggerName='trigger1',
userId='user-0001',
triggerStrategy='renew',
ttl=300,
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
triggerByStampSheet
スタンプシートを使用してトリガーを実行
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
stampSheet | string | | ✓ | | ~ 5242880文字 | スタンプシート |
keyId | string | | ✓ | | ~ 1024文字 | 暗号鍵GRN |
Result
実装例
import "github.com/gs2io/gs2-golang-sdk/core"
import "github.com/gs2io/gs2-golang-sdk/schedule"
import "github.com/openlyinc/pointy"
session := core.Gs2RestSession{
Credential: &core.BasicGs2Credential{
ClientId: "your client id",
ClientSecret: "your client secret",
},
Region: core.ApNortheast1,
}
if err := session.Connect(); err != nil {
panic("error occurred")
}
client := schedule.Gs2ScheduleRestClient{
Session: &session,
}
result, err := client.TriggerByStampSheet(
&schedule.TriggerByStampSheetRequest {
StampSheet: pointy.String("$stampSheet"),
KeyId: pointy.String("$key1.keyId"),
}
)
if err != nil {
panic("error occurred")
}
item := result.Item
use Gs2\Core\Model\BasicGs2Credential;
use Gs2\Core\Model\Region;
use Gs2\Core\Net\Gs2RestSession;
use Gs2\Core\Exception\Gs2Exception;
use Gs2\Schedule\Gs2ScheduleRestClient;
use Gs2\Schedule\Request\TriggerByStampSheetRequest;
$session = new Gs2RestSession(
new BasicGs2Credential(
"your client id",
"your client secret"
),
Region::AP_NORTHEAST_1
);
$session->open();
$client = new Gs2AccountRestClient(
$session
);
try {
$result = $client->triggerByStampSheet(
(new TriggerByStampSheetRequest())
->withStampSheet(self::$stampSheet)
->withKeyId(self::$key1.keyId)
);
$item = $result->getItem();
} catch (Gs2Exception $e) {
exit("error occurred")
}
import io.gs2.core.model.Region;
import io.gs2.core.model.BasicGs2Credential;
import io.gs2.core.rest.Gs2RestSession;
import io.gs2.core.exception.Gs2Exception;
import io.gs2.schedule.rest.Gs2ScheduleRestClient;
import io.gs2.schedule.request.TriggerByStampSheetRequest;
import io.gs2.schedule.result.TriggerByStampSheetResult;
Gs2RestSession session = new Gs2RestSession(
Region.AP_NORTHEAST_1,
new BasicGs2Credential(
'your client id',
'your client secret'
)
);
session.connect();
Gs2ScheduleRestClient client = new Gs2ScheduleRestClient(session);
try {
TriggerByStampSheetResult result = client.triggerByStampSheet(
new TriggerByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
Trigger item = result.getItem();
} catch (Gs2Exception e) {
System.exit(1);
}
using Gs2.Core.Model.Region;
using Gs2.Core.Model.BasicGs2Credential;
using Gs2.Core.Net.Gs2RestSession;
using Gs2.Core.Exception.Gs2Exception;
using Gs2.Core.AsyncResult;
using Gs2.Gs2Schedule.Gs2ScheduleRestClient;
using Gs2.Gs2Schedule.Request.TriggerByStampSheetRequest;
using Gs2.Gs2Schedule.Result.TriggerByStampSheetResult;
var session = new Gs2RestSession(
new BasicGs2Credential(
'your client id',
'your client secret'
),
Region.ApNortheast1
);
yield return session.Open();
var client = new Gs2ScheduleRestClient(session);
AsyncResult<Gs2.Gs2Schedule.Result.TriggerByStampSheetResult> asyncResult = null;
yield return client.TriggerByStampSheet(
new Gs2.Gs2Schedule.Request.TriggerByStampSheetRequest()
.WithStampSheet("$stampSheet")
.WithKeyId("$key1.keyId"),
r => asyncResult = r
);
if (asyncResult.Error != null) {
throw asyncResult.Error;
}
var result = asyncResult.Result;
var item = result.Item;
import Gs2Core from '@/gs2/core';
import * as Gs2Schedule from '@/gs2/schedule';
const session = new Gs2Core.Gs2RestSession(
"ap-northeast-1",
new Gs2Core.BasicGs2Credential(
'your client id',
'your client secret'
)
);
await session.connect();
const client = new Gs2Schedule.Gs2ScheduleRestClient(session);
try {
const result = await client.triggerByStampSheet(
new Gs2Schedule.TriggerByStampSheetRequest()
.withStampSheet("$stampSheet")
.withKeyId("$key1.keyId")
);
const item = result.getItem();
} catch (e) {
process.exit(1);
}
from gs2 import core
from gs2 import schedule
session = core.Gs2RestSession(
core.BasicGs2Credential(
'your client id',
'your client secret'
),
"ap-northeast-1",
)
session.connect()
client = schedule.Gs2ScheduleRestClient(session)
try:
result = client.trigger_by_stamp_sheet(
schedule.TriggerByStampSheetRequest()
.with_stamp_sheet(self.stamp_sheet)
.with_key_id(self.key1.key_id)
)
item = result.item
except core.Gs2Exception as e:
exit(1)
client = gs2('schedule')
api_result = client.trigger_by_stamp_sheet({
stampSheet='$stampSheet',
keyId='$key1.keyId',
})
if(api_result.isError) then
-- When error occurs
fail(api_result['statusCode'], api_result['message'])
end
result = api_result.result
item = result.item;
deleteTrigger
トリガーを削除
Request
| 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
---|
namespaceName | string | | ✓ | | ~ 32文字 | ネームスペース名 |
accessToken | string | | ✓ | | ~ 128文字 | ユーザーID |
triggerName | string | | ✓ | | ~ 128文字 | トリガーの名前 |
Result
実装例