Master Data Reference of GS2-Distributor
{
"version": "2019-03-01",
"distributorModels": [
{
"name": "[string]Delivery setting name",
"metadata": "[string?]metadata",
"inboxNamespaceId": "[string?]GS2-Inbox namespace GRN to transfer overflow resources",
"whiteListTargetIds": [
"[string]Target resources GRNs that can be processed through the distributor"
]
}
]
}
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 2019-03-01 | Format version of master data | |||
| distributorModels | List<DistributorModel> | ~ 100 items | Delivery Setting Model |
DistributorModel
Delivery Setting Model
A delivery setting is an entity that sets the policy when an entity’s acquisition exceeds its possession quota. By processing acquisitions through GS2-Distributor, overflow resources can be forwarded as GS2-Inbox messages.
| Type | Condition | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|---|
| distributorModelId | string | ✓ | ~ 1024 chars | Delivery Setting GRN | ||
| name | string | ✓ | ~ 128 chars | Delivery setting name | ||
| metadata | string | ~ 2048 chars | metadata | |||
| inboxNamespaceId | string | ~ 1024 chars | GS2-Inbox namespace GRN to transfer overflow resources | |||
| whiteListTargetIds | List<string> | [] | ~ 1000 items | Whitelist of target resource GRNs that can be processed through the distributor |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action
DistributeResource
Distribute Resource