REST Resource: projects.locations.subscriptions

リソースのサブスクリプション

サブスクリプションは、公開された特定のデータセットに対するサブスクライバーのアクセス権を表しています。これには、関連するリスティング、データ エクスチェンジ、リンクされたデータセットへの参照が含まれます。

JSON 表現 
{
  "name": string,
  "creationTime": string,
  "lastModifyTime": string,
  "organizationId": string,
  "organizationDisplayName": string,
  "state": enum (State),
  "linkedDatasetMap": {
    string: {
      object (LinkedResource)
    },
    ...
  },
  "subscriberContact": string,

  // Union field resource_name can be only one of the following:
  "listing": string,
  "dataExchange": string
  // End of list of possible types for union field resource_name.
}
フィールド
name

string

出力専用。サブスクリプションのリソース名。例: projects/myproject/locations/US/subscriptions/123
creationTime

string (Timestamp format)

出力専用。サブスクリプションが作成されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
lastModifyTime

string (Timestamp format)

出力専用。サブスクリプションが最後に変更されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
organizationId

string

出力専用。このサブスクリプションが属するプロジェクトの組織。
organizationDisplayName

string

出力専用。このサブスクリプションのプロジェクトの表示名。
state

enum (State)

出力専用。サブスクリプションの現在の状態。
linkedDatasetMap

map (key: string, value: object (LinkedResource))

出力専用。リスティング リソース名と関連付けられたリンクリソースのマッピング（例: projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset）

リスティングレベルのサブスクリプションの場合、これはサイズ 1 のマッピングになります。state == STATE_ACTIVE の場合にのみ値が含まれます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
subscriberContact

string

出力専用。サブスクライバーのメールアドレス。

共用体フィールド resource_name。

resource_name は次のいずれかになります。
listing

string

出力専用。ソース リスティングのリソース名。例: projects/123/locations/US/dataExchanges/456/listings/789
dataExchange

string

出力専用。ソース データ エクスチェンジのリソース名。例: projects/123/locations/US/dataExchanges/456

メソッド

delete

 サブスクリプションを削除します。

get

 サブスクリプションの詳細を取得します。

list

 指定されたプロジェクトとロケーションのすべてのサブスクリプションを一覧表示します。

refresh

 データ エクスチェンジへのサブスクリプションを更新します。

revoke

 指定されたサブスクリプションを取り消します。