You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/analyticshub_v1.organizations.locations.dataExchanges.html
+6
Original file line number
Diff line number
Diff line change
@@ -115,6 +115,12 @@ <h3>Method Details</h3>
115
115
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
116
116
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
117
117
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
118
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
119
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
120
+
},
121
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
122
+
},
123
+
},
118
124
},
119
125
],
120
126
"nextPageToken": "A String", # A token to request the next page of results.
<pclass="firstline">Returns the permissions that a caller has.</p>
@@ -132,6 +141,12 @@ <h3>Method Details</h3>
132
141
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
133
142
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
134
143
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
144
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
145
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
146
+
},
147
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
148
+
},
149
+
},
135
150
}
136
151
137
152
dataExchangeId: string, Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.
@@ -151,6 +166,12 @@ <h3>Method Details</h3>
151
166
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
152
167
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
153
168
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
169
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
170
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
171
+
},
172
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
173
+
},
174
+
},
154
175
}</pre>
155
176
</div>
156
177
@@ -194,6 +215,12 @@ <h3>Method Details</h3>
194
215
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
195
216
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
196
217
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
218
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
219
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
220
+
},
221
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
222
+
},
223
+
},
197
224
}</pre>
198
225
</div>
199
226
@@ -279,12 +306,72 @@ <h3>Method Details</h3>
279
306
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
280
307
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
281
308
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
309
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
310
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
311
+
},
312
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
313
+
},
314
+
},
282
315
},
283
316
],
284
317
"nextPageToken": "A String", # A token to request the next page of results.
<pre>Lists all subscriptions on a given Data Exchange or Listing.
324
+
325
+
Args:
326
+
resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 (required)
327
+
includeDeletedSubscriptions: boolean, If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
328
+
pageSize: integer, The maximum number of results to return in a single response page.
329
+
pageToken: string, Page token, returned by a previous call.
330
+
x__xgafv: string, V1 error format.
331
+
Allowed values
332
+
1 - v1 error format
333
+
2 - v2 error format
334
+
335
+
Returns:
336
+
An object of the form:
337
+
338
+
{ # Message for response to the listing of shared resource subscriptions.
339
+
"nextPageToken": "A String", # Next page token.
340
+
"sharedResourceSubscriptions": [ # The list of subscriptions.
341
+
{ # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs.
342
+
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
343
+
"dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
344
+
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
345
+
"linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
346
+
"a_key": { # Reference to a linked resource tracked by this Subscription.
347
+
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
348
+
},
349
+
},
350
+
"listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
351
+
"name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
352
+
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
353
+
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
354
+
"state": "A String", # Output only. Current state of the subscription.
355
+
"subscriberContact": "A String", # Output only. Email of the subscriber.
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
317
404
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
318
405
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
406
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
407
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
408
+
},
409
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
410
+
},
411
+
},
319
412
}
320
413
321
414
updateMask: string, Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.
@@ -335,6 +428,12 @@ <h3>Method Details</h3>
335
428
"listingCount": 42, # Output only. Number of listings contained in the data exchange.
336
429
"name": "A String", # Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.
337
430
"primaryContact": "A String", # Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.
431
+
"sharingEnvironmentConfig": { # Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. # Required. Configurable data sharing environment option for a data exchange.
432
+
"dcrExchangeConfig": { # Data Clean Room (DCR), used for privacy-safe and secured data sharing. # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
433
+
},
434
+
"defaultExchangeConfig": { # Default Analytics Hub data exchange, used for secured data sharing. # Default Analytics Hub data exchange, used for secured data sharing.
<pre>Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
528
+
529
+
Args:
530
+
name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` (required)
531
+
body: object, The request body.
532
+
The object takes the form of:
533
+
534
+
{ # Message for subscribing to a Data Exchange.
535
+
"destination": "A String", # Required. The parent resource path of the Subscription. e.g. `projects/subscriberproject/locations/US`
536
+
"subscriberContact": "A String", # Email of the subscriber.
537
+
"subscription": "A String", # Required. Name of the subscription to create. e.g. `subscription1`
538
+
}
539
+
540
+
x__xgafv: string, V1 error format.
541
+
Allowed values
542
+
1 - v1 error format
543
+
2 - v2 error format
544
+
545
+
Returns:
546
+
An object of the form:
547
+
548
+
{ # This resource represents a long-running operation that is the result of a network API call.
549
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
550
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
551
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
552
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
553
+
{
554
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
555
+
},
556
+
],
557
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
558
+
},
559
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
560
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
561
+
},
562
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
563
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
564
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
<pre>Lists all subscriptions on a given Data Exchange or Listing.
375
+
376
+
Args:
377
+
resource: string, Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789 (required)
378
+
includeDeletedSubscriptions: boolean, If selected, includes deleted subscriptions in the response (up to 63 days after deletion).
379
+
pageSize: integer, The maximum number of results to return in a single response page.
380
+
pageToken: string, Page token, returned by a previous call.
381
+
x__xgafv: string, V1 error format.
382
+
Allowed values
383
+
1 - v1 error format
384
+
2 - v2 error format
385
+
386
+
Returns:
387
+
An object of the form:
388
+
389
+
{ # Message for response to the listing of shared resource subscriptions.
390
+
"nextPageToken": "A String", # Next page token.
391
+
"sharedResourceSubscriptions": [ # The list of subscriptions.
392
+
{ # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs.
393
+
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
394
+
"dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
395
+
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
396
+
"linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
397
+
"a_key": { # Reference to a linked resource tracked by this Subscription.
398
+
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
399
+
},
400
+
},
401
+
"listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
402
+
"name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
403
+
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
404
+
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
405
+
"state": "A String", # Output only. Current state of the subscription.
406
+
"subscriberContact": "A String", # Output only. Email of the subscriber.
{ # Message for response when you subscribe to a listing.
637
+
"subscription": { # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs. # Subscription object created from this subscribe action.
638
+
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
639
+
"dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
640
+
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
641
+
"linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
642
+
"a_key": { # Reference to a linked resource tracked by this Subscription.
643
+
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
644
+
},
645
+
},
646
+
"listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
647
+
"name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
648
+
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
649
+
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
650
+
"state": "A String", # Output only. Current state of the subscription.
651
+
"subscriberContact": "A String", # Output only. Email of the subscriber.
<pclass="firstline">Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.</p>
name: string, Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456 (required)
110
+
x__xgafv: string, V1 error format.
111
+
Allowed values
112
+
1 - v1 error format
113
+
2 - v2 error format
114
+
115
+
Returns:
116
+
An object of the form:
117
+
118
+
{ # This resource represents a long-running operation that is the result of a network API call.
119
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
120
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
121
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
122
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
123
+
{
124
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
125
+
},
126
+
],
127
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
128
+
},
129
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
130
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
131
+
},
132
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
133
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
134
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
name: string, Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456 (required)
145
+
x__xgafv: string, V1 error format.
146
+
Allowed values
147
+
1 - v1 error format
148
+
2 - v2 error format
149
+
150
+
Returns:
151
+
An object of the form:
152
+
153
+
{ # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs.
154
+
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
155
+
"dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
156
+
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
157
+
"linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
158
+
"a_key": { # Reference to a linked resource tracked by this Subscription.
159
+
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
160
+
},
161
+
},
162
+
"listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
163
+
"name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
164
+
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
165
+
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
166
+
"state": "A String", # Output only. Current state of the subscription.
167
+
"subscriberContact": "A String", # Output only. Email of the subscriber.
<pre>Lists all subscriptions in a given project and location.
174
+
175
+
Args:
176
+
parent: string, Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US (required)
177
+
filter: string, The filter expression may be used to filter by Data Exchange or Listing.
178
+
pageSize: integer, The maximum number of results to return in a single response page.
179
+
pageToken: string, Page token, returned by a previous call.
180
+
x__xgafv: string, V1 error format.
181
+
Allowed values
182
+
1 - v1 error format
183
+
2 - v2 error format
184
+
185
+
Returns:
186
+
An object of the form:
187
+
188
+
{ # Message for response to the listing of subscriptions.
189
+
"nextPageToken": "A String", # Next page token.
190
+
"subscriptions": [ # The list of subscriptions.
191
+
{ # A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs.
192
+
"creationTime": "A String", # Output only. Timestamp when the subscription was created.
193
+
"dataExchange": "A String", # Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456
194
+
"lastModifyTime": "A String", # Output only. Timestamp when the subscription was last modified.
195
+
"linkedDatasetMap": { # Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.
196
+
"a_key": { # Reference to a linked resource tracked by this Subscription.
197
+
"linkedDataset": "A String", # Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset
198
+
},
199
+
},
200
+
"listing": "A String", # Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789
201
+
"name": "A String", # Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.
202
+
"organizationDisplayName": "A String", # Output only. Display name of the project of this subscription.
203
+
"organizationId": "A String", # Output only. Organization of the project this subscription belongs to.
204
+
"state": "A String", # Output only. Current state of the subscription.
205
+
"subscriberContact": "A String", # Output only. Email of the subscriber.
<pre>Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.
228
+
229
+
Args:
230
+
name: string, Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123` (required)
231
+
body: object, The request body.
232
+
The object takes the form of:
233
+
234
+
{ # Message for refreshing a subscription.
235
+
}
236
+
237
+
x__xgafv: string, V1 error format.
238
+
Allowed values
239
+
1 - v1 error format
240
+
2 - v2 error format
241
+
242
+
Returns:
243
+
An object of the form:
244
+
245
+
{ # This resource represents a long-running operation that is the result of a network API call.
246
+
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
247
+
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
248
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
249
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
250
+
{
251
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
252
+
},
253
+
],
254
+
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
255
+
},
256
+
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
257
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
258
+
},
259
+
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
260
+
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
261
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
"description": "Reference to a linked resource tracked by this Subscription.",
935
+
"id": "LinkedResource",
936
+
"properties": {
937
+
"linkedDataset": {
938
+
"description": "Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset",
939
+
"readOnly": true,
940
+
"type": "string"
941
+
}
942
+
},
943
+
"type": "object"
944
+
},
933
945
"ListDataExchangesResponse": {
934
946
"description": "Message for response to the list of data exchanges.",
935
947
"id": "ListDataExchangesResponse",
@@ -1191,6 +1203,17 @@
1191
1203
},
1192
1204
"type": "object"
1193
1205
},
1206
+
"RefreshSubscriptionResponse": {
1207
+
"description": "Message for response when you refresh a subscription.",
1208
+
"id": "RefreshSubscriptionResponse",
1209
+
"properties": {
1210
+
"subscription": {
1211
+
"$ref": "Subscription",
1212
+
"description": "The refreshed subscription resource."
1213
+
}
1214
+
},
1215
+
"type": "object"
1216
+
},
1194
1217
"RestrictedExportConfig": {
1195
1218
"description": "Restricted export config, used to configure restricted export on linked dataset.",
1196
1219
"id": "RestrictedExportConfig",
@@ -1227,6 +1250,17 @@
1227
1250
},
1228
1251
"type": "object"
1229
1252
},
1253
+
"SubscribeDataExchangeResponse": {
1254
+
"description": "Message for response when you subscribe to a Data Exchange.",
1255
+
"id": "SubscribeDataExchangeResponse",
1256
+
"properties": {
1257
+
"subscription": {
1258
+
"$ref": "Subscription",
1259
+
"description": "Subscription object created from this subscribe action."
1260
+
}
1261
+
},
1262
+
"type": "object"
1263
+
},
1230
1264
"SubscribeListingRequest": {
1231
1265
"description": "Message for subscribing to a listing.",
1232
1266
"id": "SubscribeListingRequest",
@@ -1244,6 +1278,80 @@
1244
1278
"properties": {},
1245
1279
"type": "object"
1246
1280
},
1281
+
"Subscription": {
1282
+
"description": "A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets. TODO(b/267528977) Consider port the new resource to v1beta1 and dataexchange APIs.",
1283
+
"id": "Subscription",
1284
+
"properties": {
1285
+
"creationTime": {
1286
+
"description": "Output only. Timestamp when the subscription was created.",
1287
+
"format": "google-datetime",
1288
+
"readOnly": true,
1289
+
"type": "string"
1290
+
},
1291
+
"dataExchange": {
1292
+
"description": "Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456",
1293
+
"readOnly": true,
1294
+
"type": "string"
1295
+
},
1296
+
"lastModifyTime": {
1297
+
"description": "Output only. Timestamp when the subscription was last modified.",
1298
+
"format": "google-datetime",
1299
+
"readOnly": true,
1300
+
"type": "string"
1301
+
},
1302
+
"linkedDatasetMap": {
1303
+
"additionalProperties": {
1304
+
"$ref": "LinkedResource"
1305
+
},
1306
+
"description": "Output only. Map of listing resource names to associated linked resource, e.g. projects/123/locations/US/dataExchanges/456/listings/789 -> projects/123/datasets/my_dataset For listing-level subscriptions, this is a map of size 1. Only contains values if state == STATE_ACTIVE.",
1307
+
"readOnly": true,
1308
+
"type": "object"
1309
+
},
1310
+
"listing": {
1311
+
"description": "Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789",
1312
+
"readOnly": true,
1313
+
"type": "string"
1314
+
},
1315
+
"name": {
1316
+
"description": "Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`.",
1317
+
"readOnly": true,
1318
+
"type": "string"
1319
+
},
1320
+
"organizationDisplayName": {
1321
+
"description": "Output only. Display name of the project of this subscription.",
1322
+
"readOnly": true,
1323
+
"type": "string"
1324
+
},
1325
+
"organizationId": {
1326
+
"description": "Output only. Organization of the project this subscription belongs to.",
1327
+
"readOnly": true,
1328
+
"type": "string"
1329
+
},
1330
+
"state": {
1331
+
"description": "Output only. Current state of the subscription.",
1332
+
"enum": [
1333
+
"STATE_UNSPECIFIED",
1334
+
"STATE_ACTIVE",
1335
+
"STATE_STALE",
1336
+
"STATE_INACTIVE"
1337
+
],
1338
+
"enumDescriptions": [
1339
+
"Default value. This value is unused.",
1340
+
"This subscription is active and the data is accessible.",
1341
+
"The data referenced by this subscription is out of date and should be refreshed. This can happen when a data provider adds or removes datasets.",
1342
+
"This subscription has been cancelled or revoked and the data is no longer accessible."
1343
+
],
1344
+
"readOnly": true,
1345
+
"type": "string"
1346
+
},
1347
+
"subscriberContact": {
1348
+
"description": "Output only. Email of the subscriber.",
1349
+
"readOnly": true,
1350
+
"type": "string"
1351
+
}
1352
+
},
1353
+
"type": "object"
1354
+
},
1247
1355
"TestIamPermissionsRequest": {
1248
1356
"description": "Request message for `TestIamPermissions` method.",
0 commit comments