google-cloud-bigquery-analytics_hub-v1 0.2.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31,22 +31,21 @@ module Google
31
31
  # e.g. `projects/myproject/locations/US/dataExchanges/123`.
32
32
  # @!attribute [rw] display_name
33
33
  # @return [::String]
34
- # Required. Human-readable display name of the data exchange. The display name must
35
- # contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
36
- # spaces ( ), ampersands (&) and must not start or end with spaces.
37
- # Default value is an empty string.
38
- # Max length: 63 bytes.
34
+ # Required. Human-readable display name of the data exchange. The display
35
+ # name must contain only Unicode letters, numbers (0-9), underscores (_),
36
+ # dashes (-), spaces ( ), ampersands (&) and must not start or end with
37
+ # spaces. Default value is an empty string. Max length: 63 bytes.
39
38
  # @!attribute [rw] description
40
39
  # @return [::String]
41
- # Optional. Description of the data exchange. The description must not contain Unicode
42
- # non-characters as well as C0 and C1 control codes except tabs (HT),
43
- # new lines (LF), carriage returns (CR), and page breaks (FF).
40
+ # Optional. Description of the data exchange. The description must not
41
+ # contain Unicode non-characters as well as C0 and C1 control codes except
42
+ # tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).
44
43
  # Default value is an empty string.
45
44
  # Max length: 2000 bytes.
46
45
  # @!attribute [rw] primary_contact
47
46
  # @return [::String]
48
- # Optional. Email or URL of the primary point of contact of the data exchange.
49
- # Max Length: 1000 bytes.
47
+ # Optional. Email or URL of the primary point of contact of the data
48
+ # exchange. Max Length: 1000 bytes.
50
49
  # @!attribute [rw] documentation
51
50
  # @return [::String]
52
51
  # Optional. Documentation describing the data exchange.
@@ -55,16 +54,44 @@ module Google
55
54
  # Output only. Number of listings contained in the data exchange.
56
55
  # @!attribute [rw] icon
57
56
  # @return [::String]
58
- # Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB
59
- # Expected image dimensions are 512x512 pixels, however the API only
60
- # performs validation on size of the encoded data.
61
- # Note: For byte fields, the content of the fields are base64-encoded (which
62
- # increases the size of the data by 33-36%) when using JSON on the wire.
57
+ # Optional. Base64 encoded image representing the data exchange. Max
58
+ # Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API
59
+ # only performs validation on size of the encoded data. Note: For byte
60
+ # fields, the content of the fields are base64-encoded (which increases the
61
+ # size of the data by 33-36%) when using JSON on the wire.
62
+ # @!attribute [rw] sharing_environment_config
63
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::SharingEnvironmentConfig]
64
+ # Optional. Configurable data sharing environment option for a data exchange.
63
65
  class DataExchange
64
66
  include ::Google::Protobuf::MessageExts
65
67
  extend ::Google::Protobuf::MessageExts::ClassMethods
66
68
  end
67
69
 
70
+ # Sharing environment is a behavior model for sharing data within a
71
+ # data exchange. This option is configurable for a data exchange.
72
+ # @!attribute [rw] default_exchange_config
73
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::SharingEnvironmentConfig::DefaultExchangeConfig]
74
+ # Default Analytics Hub data exchange, used for secured data sharing.
75
+ # @!attribute [rw] dcr_exchange_config
76
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::SharingEnvironmentConfig::DcrExchangeConfig]
77
+ # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
78
+ class SharingEnvironmentConfig
79
+ include ::Google::Protobuf::MessageExts
80
+ extend ::Google::Protobuf::MessageExts::ClassMethods
81
+
82
+ # Default Analytics Hub data exchange, used for secured data sharing.
83
+ class DefaultExchangeConfig
84
+ include ::Google::Protobuf::MessageExts
85
+ extend ::Google::Protobuf::MessageExts::ClassMethods
86
+ end
87
+
88
+ # Data Clean Room (DCR), used for privacy-safe and secured data sharing.
89
+ class DcrExchangeConfig
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+ end
94
+
68
95
  # Contains details of the data provider.
69
96
  # @!attribute [rw] name
70
97
  # @return [::String]
@@ -154,18 +181,16 @@ module Google
154
181
  # e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`
155
182
  # @!attribute [rw] display_name
156
183
  # @return [::String]
157
- # Required. Human-readable display name of the listing. The display name must contain
158
- # only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces
159
- # ( ), ampersands (&) and can't start or end with spaces.
160
- # Default value is an empty string.
161
- # Max length: 63 bytes.
184
+ # Required. Human-readable display name of the listing. The display name must
185
+ # contain only Unicode letters, numbers (0-9), underscores (_), dashes (-),
186
+ # spaces ( ), ampersands (&) and can't start or end with spaces. Default
187
+ # value is an empty string. Max length: 63 bytes.
162
188
  # @!attribute [rw] description
163
189
  # @return [::String]
164
- # Optional. Short description of the listing. The description must not contain
165
- # Unicode non-characters and C0 and C1 control codes except tabs (HT),
166
- # new lines (LF), carriage returns (CR), and page breaks (FF).
167
- # Default value is an empty string.
168
- # Max length: 2000 bytes.
190
+ # Optional. Short description of the listing. The description must not
191
+ # contain Unicode non-characters and C0 and C1 control codes except tabs
192
+ # (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default
193
+ # value is an empty string. Max length: 2000 bytes.
169
194
  # @!attribute [rw] primary_contact
170
195
  # @return [::String]
171
196
  # Optional. Email or URL of the primary point of contact of the listing.
@@ -198,6 +223,10 @@ module Google
198
223
  # Optional. Email or URL of the request access of the listing.
199
224
  # Subscribers can use this reference to request access.
200
225
  # Max Length: 1000 bytes.
226
+ # @!attribute [rw] restricted_export_config
227
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing::RestrictedExportConfig]
228
+ # Optional. If set, restricted export configuration will be propagated and
229
+ # enforced on the linked dataset.
201
230
  class Listing
202
231
  include ::Google::Protobuf::MessageExts
203
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -218,6 +247,24 @@ module Google
218
247
  extend ::Google::Protobuf::MessageExts::ClassMethods
219
248
  end
220
249
 
250
+ # Restricted export config, used to configure restricted export on linked
251
+ # dataset.
252
+ # @!attribute [rw] enabled
253
+ # @return [::Boolean]
254
+ # Optional. If true, enable restricted export.
255
+ # @!attribute [r] restrict_direct_table_access
256
+ # @return [::Boolean]
257
+ # Output only. If true, restrict direct table access(read
258
+ # api/tabledata.list) on linked table.
259
+ # @!attribute [rw] restrict_query_result
260
+ # @return [::Boolean]
261
+ # Optional. If true, restrict export of query result derived from
262
+ # restricted linked dataset table.
263
+ class RestrictedExportConfig
264
+ include ::Google::Protobuf::MessageExts
265
+ extend ::Google::Protobuf::MessageExts::ClassMethods
266
+ end
267
+
221
268
  # State of the listing.
222
269
  module State
223
270
  # Default value. This value is unused.
@@ -272,6 +319,89 @@ module Google
272
319
  end
273
320
  end
274
321
 
322
+ # A subscription represents a subscribers' access to a particular set of
323
+ # published data. It contains references to associated listings,
324
+ # data exchanges, and linked datasets.
325
+ # @!attribute [r] listing
326
+ # @return [::String]
327
+ # Output only. Resource name of the source Listing.
328
+ # e.g. projects/123/locations/US/dataExchanges/456/listings/789
329
+ # @!attribute [r] data_exchange
330
+ # @return [::String]
331
+ # Output only. Resource name of the source Data Exchange.
332
+ # e.g. projects/123/locations/US/dataExchanges/456
333
+ # @!attribute [r] name
334
+ # @return [::String]
335
+ # Output only. The resource name of the subscription.
336
+ # e.g. `projects/myproject/locations/US/subscriptions/123`.
337
+ # @!attribute [r] creation_time
338
+ # @return [::Google::Protobuf::Timestamp]
339
+ # Output only. Timestamp when the subscription was created.
340
+ # @!attribute [r] last_modify_time
341
+ # @return [::Google::Protobuf::Timestamp]
342
+ # Output only. Timestamp when the subscription was last modified.
343
+ # @!attribute [r] organization_id
344
+ # @return [::String]
345
+ # Output only. Organization of the project this subscription belongs to.
346
+ # @!attribute [r] organization_display_name
347
+ # @return [::String]
348
+ # Output only. Display name of the project of this subscription.
349
+ # @!attribute [r] state
350
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::State]
351
+ # Output only. Current state of the subscription.
352
+ # @!attribute [r] linked_dataset_map
353
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource}]
354
+ # Output only. Map of listing resource names to associated linked resource,
355
+ # e.g. projects/123/locations/US/dataExchanges/456/listings/789
356
+ # ->
357
+ # projects/123/datasets/my_dataset
358
+ #
359
+ # For listing-level subscriptions, this is a map of size 1.
360
+ # Only contains values if state == STATE_ACTIVE.
361
+ # @!attribute [r] subscriber_contact
362
+ # @return [::String]
363
+ # Output only. Email of the subscriber.
364
+ class Subscription
365
+ include ::Google::Protobuf::MessageExts
366
+ extend ::Google::Protobuf::MessageExts::ClassMethods
367
+
368
+ # Reference to a linked resource tracked by this Subscription.
369
+ # @!attribute [r] linked_dataset
370
+ # @return [::String]
371
+ # Output only. Name of the linked dataset, e.g.
372
+ # projects/subscriberproject/datasets/linked_dataset
373
+ class LinkedResource
374
+ include ::Google::Protobuf::MessageExts
375
+ extend ::Google::Protobuf::MessageExts::ClassMethods
376
+ end
377
+
378
+ # @!attribute [rw] key
379
+ # @return [::String]
380
+ # @!attribute [rw] value
381
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription::LinkedResource]
382
+ class LinkedDatasetMapEntry
383
+ include ::Google::Protobuf::MessageExts
384
+ extend ::Google::Protobuf::MessageExts::ClassMethods
385
+ end
386
+
387
+ # State of the subscription.
388
+ module State
389
+ # Default value. This value is unused.
390
+ STATE_UNSPECIFIED = 0
391
+
392
+ # This subscription is active and the data is accessible.
393
+ STATE_ACTIVE = 1
394
+
395
+ # The data referenced by this subscription is out of date and should be
396
+ # refreshed. This can happen when a data provider adds or removes datasets.
397
+ STATE_STALE = 2
398
+
399
+ # This subscription has been cancelled or revoked and the data is no longer
400
+ # accessible.
401
+ STATE_INACTIVE = 3
402
+ end
403
+ end
404
+
275
405
  # Message for requesting the list of data exchanges.
276
406
  # @!attribute [rw] parent
277
407
  # @return [::String]
@@ -306,8 +436,8 @@ module Google
306
436
  # organization and location.
307
437
  # @!attribute [rw] organization
308
438
  # @return [::String]
309
- # Required. The organization resource path of the projects containing DataExchanges.
310
- # e.g. `organizations/myorg/locations/US`.
439
+ # Required. The organization resource path of the projects containing
440
+ # DataExchanges. e.g. `organizations/myorg/locations/US`.
311
441
  # @!attribute [rw] page_size
312
442
  # @return [::Integer]
313
443
  # The maximum number of results to return in a single response page. Leverage
@@ -381,8 +511,8 @@ module Google
381
511
  # Message for deleting a data exchange.
382
512
  # @!attribute [rw] name
383
513
  # @return [::String]
384
- # Required. The full name of the data exchange resource that you want to delete.
385
- # For example, `projects/myproject/locations/US/dataExchanges/123`.
514
+ # Required. The full name of the data exchange resource that you want to
515
+ # delete. For example, `projects/myproject/locations/US/dataExchanges/123`.
386
516
  class DeleteDataExchangeRequest
387
517
  include ::Google::Protobuf::MessageExts
388
518
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -451,9 +581,9 @@ module Google
451
581
  # Message for updating a Listing.
452
582
  # @!attribute [rw] update_mask
453
583
  # @return [::Google::Protobuf::FieldMask]
454
- # Required. Field mask specifies the fields to update in the listing resource. The
455
- # fields specified in the `updateMask` are relative to the resource and are
456
- # not a full request.
584
+ # Required. Field mask specifies the fields to update in the listing
585
+ # resource. The fields specified in the `updateMask` are relative to the
586
+ # resource and are not a full request.
457
587
  # @!attribute [rw] listing
458
588
  # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Listing]
459
589
  # Required. The listing to update.
@@ -486,10 +616,194 @@ module Google
486
616
  end
487
617
 
488
618
  # Message for response when you subscribe to a listing.
619
+ # @!attribute [rw] subscription
620
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription]
621
+ # Subscription object created from this subscribe action.
489
622
  class SubscribeListingResponse
490
623
  include ::Google::Protobuf::MessageExts
491
624
  extend ::Google::Protobuf::MessageExts::ClassMethods
492
625
  end
626
+
627
+ # Message for subscribing to a Data Exchange.
628
+ # @!attribute [rw] name
629
+ # @return [::String]
630
+ # Required. Resource name of the Data Exchange.
631
+ # e.g. `projects/publisherproject/locations/US/dataExchanges/123`
632
+ # @!attribute [rw] destination
633
+ # @return [::String]
634
+ # Required. The parent resource path of the Subscription.
635
+ # e.g. `projects/subscriberproject/locations/US`
636
+ # @!attribute [rw] subscription
637
+ # @return [::String]
638
+ # Required. Name of the subscription to create.
639
+ # e.g. `subscription1`
640
+ # @!attribute [rw] subscriber_contact
641
+ # @return [::String]
642
+ # Email of the subscriber.
643
+ class SubscribeDataExchangeRequest
644
+ include ::Google::Protobuf::MessageExts
645
+ extend ::Google::Protobuf::MessageExts::ClassMethods
646
+ end
647
+
648
+ # Message for response when you subscribe to a Data Exchange.
649
+ # @!attribute [rw] subscription
650
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription]
651
+ # Subscription object created from this subscribe action.
652
+ class SubscribeDataExchangeResponse
653
+ include ::Google::Protobuf::MessageExts
654
+ extend ::Google::Protobuf::MessageExts::ClassMethods
655
+ end
656
+
657
+ # Message for refreshing a subscription.
658
+ # @!attribute [rw] name
659
+ # @return [::String]
660
+ # Required. Resource name of the Subscription to refresh.
661
+ # e.g. `projects/subscriberproject/locations/US/subscriptions/123`
662
+ class RefreshSubscriptionRequest
663
+ include ::Google::Protobuf::MessageExts
664
+ extend ::Google::Protobuf::MessageExts::ClassMethods
665
+ end
666
+
667
+ # Message for response when you refresh a subscription.
668
+ # @!attribute [rw] subscription
669
+ # @return [::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription]
670
+ # The refreshed subscription resource.
671
+ class RefreshSubscriptionResponse
672
+ include ::Google::Protobuf::MessageExts
673
+ extend ::Google::Protobuf::MessageExts::ClassMethods
674
+ end
675
+
676
+ # Message for getting a subscription.
677
+ # @!attribute [rw] name
678
+ # @return [::String]
679
+ # Required. Resource name of the subscription.
680
+ # e.g. projects/123/locations/US/subscriptions/456
681
+ class GetSubscriptionRequest
682
+ include ::Google::Protobuf::MessageExts
683
+ extend ::Google::Protobuf::MessageExts::ClassMethods
684
+ end
685
+
686
+ # Message for listing subscriptions.
687
+ # @!attribute [rw] parent
688
+ # @return [::String]
689
+ # Required. The parent resource path of the subscription.
690
+ # e.g. projects/myproject/locations/US
691
+ # @!attribute [rw] filter
692
+ # @return [::String]
693
+ # The filter expression may be used to filter by Data Exchange or Listing.
694
+ # @!attribute [rw] page_size
695
+ # @return [::Integer]
696
+ # The maximum number of results to return in a single response page.
697
+ # @!attribute [rw] page_token
698
+ # @return [::String]
699
+ # Page token, returned by a previous call.
700
+ class ListSubscriptionsRequest
701
+ include ::Google::Protobuf::MessageExts
702
+ extend ::Google::Protobuf::MessageExts::ClassMethods
703
+ end
704
+
705
+ # Message for response to the listing of subscriptions.
706
+ # @!attribute [rw] subscriptions
707
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>]
708
+ # The list of subscriptions.
709
+ # @!attribute [rw] next_page_token
710
+ # @return [::String]
711
+ # Next page token.
712
+ class ListSubscriptionsResponse
713
+ include ::Google::Protobuf::MessageExts
714
+ extend ::Google::Protobuf::MessageExts::ClassMethods
715
+ end
716
+
717
+ # Message for listing subscriptions of a shared resource.
718
+ # @!attribute [rw] resource
719
+ # @return [::String]
720
+ # Required. Resource name of the requested target. This resource may be
721
+ # either a Listing or a DataExchange. e.g.
722
+ # projects/123/locations/US/dataExchanges/456 OR e.g.
723
+ # projects/123/locations/US/dataExchanges/456/listings/789
724
+ # @!attribute [rw] include_deleted_subscriptions
725
+ # @return [::Boolean]
726
+ # If selected, includes deleted subscriptions in the response
727
+ # (up to 63 days after deletion).
728
+ # @!attribute [rw] page_size
729
+ # @return [::Integer]
730
+ # The maximum number of results to return in a single response page.
731
+ # @!attribute [rw] page_token
732
+ # @return [::String]
733
+ # Page token, returned by a previous call.
734
+ class ListSharedResourceSubscriptionsRequest
735
+ include ::Google::Protobuf::MessageExts
736
+ extend ::Google::Protobuf::MessageExts::ClassMethods
737
+ end
738
+
739
+ # Message for response to the listing of shared resource subscriptions.
740
+ # @!attribute [rw] shared_resource_subscriptions
741
+ # @return [::Array<::Google::Cloud::Bigquery::AnalyticsHub::V1::Subscription>]
742
+ # The list of subscriptions.
743
+ # @!attribute [rw] next_page_token
744
+ # @return [::String]
745
+ # Next page token.
746
+ class ListSharedResourceSubscriptionsResponse
747
+ include ::Google::Protobuf::MessageExts
748
+ extend ::Google::Protobuf::MessageExts::ClassMethods
749
+ end
750
+
751
+ # Message for revoking a subscription.
752
+ # @!attribute [rw] name
753
+ # @return [::String]
754
+ # Required. Resource name of the subscription to revoke.
755
+ # e.g. projects/123/locations/US/subscriptions/456
756
+ class RevokeSubscriptionRequest
757
+ include ::Google::Protobuf::MessageExts
758
+ extend ::Google::Protobuf::MessageExts::ClassMethods
759
+ end
760
+
761
+ # Message for response when you revoke a subscription.
762
+ class RevokeSubscriptionResponse
763
+ include ::Google::Protobuf::MessageExts
764
+ extend ::Google::Protobuf::MessageExts::ClassMethods
765
+ end
766
+
767
+ # Message for deleting a subscription.
768
+ # @!attribute [rw] name
769
+ # @return [::String]
770
+ # Required. Resource name of the subscription to delete.
771
+ # e.g. projects/123/locations/US/subscriptions/456
772
+ class DeleteSubscriptionRequest
773
+ include ::Google::Protobuf::MessageExts
774
+ extend ::Google::Protobuf::MessageExts::ClassMethods
775
+ end
776
+
777
+ # Represents the metadata of a long-running operation in Analytics Hub.
778
+ # @!attribute [r] create_time
779
+ # @return [::Google::Protobuf::Timestamp]
780
+ # Output only. The time the operation was created.
781
+ # @!attribute [r] end_time
782
+ # @return [::Google::Protobuf::Timestamp]
783
+ # Output only. The time the operation finished running.
784
+ # @!attribute [r] target
785
+ # @return [::String]
786
+ # Output only. Server-defined resource path for the target of the operation.
787
+ # @!attribute [r] verb
788
+ # @return [::String]
789
+ # Output only. Name of the verb executed by the operation.
790
+ # @!attribute [r] status_message
791
+ # @return [::String]
792
+ # Output only. Human-readable status of the operation, if any.
793
+ # @!attribute [r] requested_cancellation
794
+ # @return [::Boolean]
795
+ # Output only. Identifies whether the user has requested cancellation
796
+ # of the operation. Operations that have successfully been cancelled
797
+ # have [Operation.error][] value with a
798
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
799
+ # `Code.CANCELLED`.
800
+ # @!attribute [r] api_version
801
+ # @return [::String]
802
+ # Output only. API version used to start the operation.
803
+ class OperationMetadata
804
+ include ::Google::Protobuf::MessageExts
805
+ extend ::Google::Protobuf::MessageExts::ClassMethods
806
+ end
493
807
  end
494
808
  end
495
809
  end
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2023 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Longrunning
22
+ # This resource represents a long-running operation that is the result of a
23
+ # network API call.
24
+ # @!attribute [rw] name
25
+ # @return [::String]
26
+ # The server-assigned name, which is only unique within the same service that
27
+ # originally returns it. If you use the default HTTP mapping, the
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
+ # @!attribute [rw] metadata
30
+ # @return [::Google::Protobuf::Any]
31
+ # Service-specific metadata associated with the operation. It typically
32
+ # contains progress information and common metadata such as create time.
33
+ # Some services might not provide such metadata. Any method that returns a
34
+ # long-running operation should document the metadata type, if any.
35
+ # @!attribute [rw] done
36
+ # @return [::Boolean]
37
+ # If the value is `false`, it means the operation is still in progress.
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
+ # available.
40
+ # @!attribute [rw] error
41
+ # @return [::Google::Rpc::Status]
42
+ # The error result of the operation in case of failure or cancellation.
43
+ # @!attribute [rw] response
44
+ # @return [::Google::Protobuf::Any]
45
+ # The normal response of the operation in case of success. If the original
46
+ # method returns no data on success, such as `Delete`, the response is
47
+ # `google.protobuf.Empty`. If the original method is standard
48
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
49
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
50
+ # is the original method name. For example, if the original method name
51
+ # is `TakeSnapshot()`, the inferred response type is
52
+ # `TakeSnapshotResponse`.
53
+ class Operation
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # The request message for Operations.GetOperation.
59
+ # @!attribute [rw] name
60
+ # @return [::String]
61
+ # The name of the operation resource.
62
+ class GetOperationRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # The request message for Operations.ListOperations.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # The name of the operation's parent resource.
71
+ # @!attribute [rw] filter
72
+ # @return [::String]
73
+ # The standard list filter.
74
+ # @!attribute [rw] page_size
75
+ # @return [::Integer]
76
+ # The standard list page size.
77
+ # @!attribute [rw] page_token
78
+ # @return [::String]
79
+ # The standard list page token.
80
+ class ListOperationsRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # The response message for Operations.ListOperations.
86
+ # @!attribute [rw] operations
87
+ # @return [::Array<::Google::Longrunning::Operation>]
88
+ # A list of operations that matches the specified filter in the request.
89
+ # @!attribute [rw] next_page_token
90
+ # @return [::String]
91
+ # The standard List next-page token.
92
+ class ListOperationsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # The request message for Operations.CancelOperation.
98
+ # @!attribute [rw] name
99
+ # @return [::String]
100
+ # The name of the operation resource to be cancelled.
101
+ class CancelOperationRequest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # The request message for Operations.DeleteOperation.
107
+ # @!attribute [rw] name
108
+ # @return [::String]
109
+ # The name of the operation resource to be deleted.
110
+ class DeleteOperationRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
129
+ # A message representing the message types used by a long-running operation.
130
+ #
131
+ # Example:
132
+ #
133
+ # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
+ # returns (google.longrunning.Operation) {
135
+ # option (google.longrunning.operation_info) = {
136
+ # response_type: "LongRunningRecognizeResponse"
137
+ # metadata_type: "LongRunningRecognizeMetadata"
138
+ # };
139
+ # }
140
+ # @!attribute [rw] response_type
141
+ # @return [::String]
142
+ # Required. The message name of the primary return type for this
143
+ # long-running operation.
144
+ # This type will be used to deserialize the LRO's response.
145
+ #
146
+ # If the response is in a different package from the rpc, a fully-qualified
147
+ # message name must be used (e.g. `google.protobuf.Struct`).
148
+ #
149
+ # Note: Altering this value constitutes a breaking change.
150
+ # @!attribute [rw] metadata_type
151
+ # @return [::String]
152
+ # Required. The message name of the metadata type for this long-running
153
+ # operation.
154
+ #
155
+ # If the response is in a different package from the rpc, a fully-qualified
156
+ # message name must be used (e.g. `google.protobuf.Struct`).
157
+ #
158
+ # Note: Altering this value constitutes a breaking change.
159
+ class OperationInfo
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+ end
163
+ end
164
+ end