google-api-client 0.46.1 → 0.46.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (151) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/autoapprove.yml +49 -0
  3. data/.gitignore +2 -0
  4. data/CHANGELOG.md +58 -0
  5. data/api_list_config.yaml +8 -0
  6. data/bin/generate-api +77 -15
  7. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  8. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +30 -30
  9. data/generated/google/apis/admin_directory_v1.rb +1 -1
  10. data/generated/google/apis/admin_directory_v1/classes.rb +135 -0
  11. data/generated/google/apis/admin_directory_v1/representations.rb +62 -0
  12. data/generated/google/apis/admin_directory_v1/service.rb +72 -0
  13. data/generated/google/apis/admin_reports_v1.rb +1 -1
  14. data/generated/google/apis/admob_v1.rb +1 -1
  15. data/generated/google/apis/admob_v1/classes.rb +29 -29
  16. data/generated/google/apis/analyticsadmin_v1alpha.rb +1 -1
  17. data/generated/google/apis/analyticsadmin_v1alpha/classes.rb +6 -6
  18. data/generated/google/apis/analyticsadmin_v1alpha/service.rb +8 -9
  19. data/generated/google/apis/analyticsdata_v1alpha.rb +1 -1
  20. data/generated/google/apis/analyticsdata_v1alpha/classes.rb +1 -1
  21. data/generated/google/apis/analyticsdata_v1alpha/service.rb +7 -7
  22. data/generated/google/apis/androidpublisher_v3.rb +1 -1
  23. data/generated/google/apis/androidpublisher_v3/service.rb +5 -2
  24. data/generated/google/apis/artifactregistry_v1beta1.rb +1 -1
  25. data/generated/google/apis/artifactregistry_v1beta1/classes.rb +7 -0
  26. data/generated/google/apis/artifactregistry_v1beta1/representations.rb +1 -0
  27. data/generated/google/apis/bigquery_v2.rb +1 -1
  28. data/generated/google/apis/bigquery_v2/classes.rb +80 -5
  29. data/generated/google/apis/bigquery_v2/representations.rb +33 -0
  30. data/generated/google/apis/bigquery_v2/service.rb +46 -0
  31. data/generated/google/apis/billingbudgets_v1.rb +1 -1
  32. data/generated/google/apis/billingbudgets_v1/classes.rb +1 -1
  33. data/generated/google/apis/billingbudgets_v1beta1.rb +1 -1
  34. data/generated/google/apis/billingbudgets_v1beta1/classes.rb +1 -1
  35. data/generated/google/apis/civicinfo_v2.rb +1 -1
  36. data/generated/google/apis/civicinfo_v2/classes.rb +0 -24
  37. data/generated/google/apis/civicinfo_v2/representations.rb +0 -3
  38. data/generated/google/apis/classroom_v1.rb +1 -1
  39. data/generated/google/apis/classroom_v1/classes.rb +21 -21
  40. data/generated/google/apis/container_v1.rb +1 -1
  41. data/generated/google/apis/container_v1/classes.rb +22 -10
  42. data/generated/google/apis/container_v1beta1.rb +1 -1
  43. data/generated/google/apis/container_v1beta1/classes.rb +22 -10
  44. data/generated/google/apis/content_v2.rb +1 -1
  45. data/generated/google/apis/content_v2_1.rb +1 -1
  46. data/generated/google/apis/content_v2_1/classes.rb +6 -3
  47. data/generated/google/apis/displayvideo_v1.rb +1 -1
  48. data/generated/google/apis/displayvideo_v1/classes.rb +30 -30
  49. data/generated/google/apis/displayvideo_v1/service.rb +8 -8
  50. data/generated/google/apis/dlp_v2.rb +1 -1
  51. data/generated/google/apis/dlp_v2/classes.rb +4 -3
  52. data/generated/google/apis/dns_v1.rb +1 -1
  53. data/generated/google/apis/dns_v1/classes.rb +181 -0
  54. data/generated/google/apis/dns_v1/representations.rb +83 -0
  55. data/generated/google/apis/dns_v1beta2.rb +1 -1
  56. data/generated/google/apis/dns_v1beta2/classes.rb +181 -0
  57. data/generated/google/apis/dns_v1beta2/representations.rb +83 -0
  58. data/generated/google/apis/domains_v1alpha2.rb +34 -0
  59. data/generated/google/apis/domains_v1alpha2/classes.rb +1534 -0
  60. data/generated/google/apis/domains_v1alpha2/representations.rb +605 -0
  61. data/generated/google/apis/domains_v1alpha2/service.rb +805 -0
  62. data/generated/google/apis/domains_v1beta1.rb +34 -0
  63. data/generated/google/apis/domains_v1beta1/classes.rb +1534 -0
  64. data/generated/google/apis/domains_v1beta1/representations.rb +605 -0
  65. data/generated/google/apis/domains_v1beta1/service.rb +805 -0
  66. data/generated/google/apis/doubleclickbidmanager_v1.rb +1 -1
  67. data/generated/google/apis/doubleclickbidmanager_v1/classes.rb +1 -1
  68. data/generated/google/apis/doubleclickbidmanager_v1_1.rb +1 -1
  69. data/generated/google/apis/doubleclickbidmanager_v1_1/classes.rb +1 -1
  70. data/generated/google/apis/drive_v2.rb +1 -1
  71. data/generated/google/apis/drive_v2/classes.rb +2 -0
  72. data/generated/google/apis/drive_v3.rb +1 -1
  73. data/generated/google/apis/drive_v3/classes.rb +4 -2
  74. data/generated/google/apis/fitness_v1.rb +1 -1
  75. data/generated/google/apis/fitness_v1/service.rb +3 -1
  76. data/generated/google/apis/gameservices_v1.rb +1 -1
  77. data/generated/google/apis/gameservices_v1/classes.rb +15 -14
  78. data/generated/google/apis/gameservices_v1/service.rb +54 -51
  79. data/generated/google/apis/gameservices_v1beta.rb +1 -1
  80. data/generated/google/apis/gameservices_v1beta/classes.rb +15 -14
  81. data/generated/google/apis/gameservices_v1beta/service.rb +54 -51
  82. data/generated/google/apis/gmailpostmastertools_v1beta1.rb +1 -1
  83. data/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +10 -10
  84. data/generated/google/apis/healthcare_v1.rb +1 -1
  85. data/generated/google/apis/healthcare_v1/classes.rb +4 -4
  86. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  87. data/generated/google/apis/healthcare_v1beta1/classes.rb +7 -6
  88. data/generated/google/apis/licensing_v1.rb +1 -1
  89. data/generated/google/apis/licensing_v1/service.rb +2 -2
  90. data/generated/google/apis/localservices_v1.rb +1 -1
  91. data/generated/google/apis/localservices_v1/service.rb +20 -20
  92. data/generated/google/apis/managedidentities_v1.rb +1 -1
  93. data/generated/google/apis/managedidentities_v1/classes.rb +1 -1
  94. data/generated/google/apis/managedidentities_v1/service.rb +1 -4
  95. data/generated/google/apis/managedidentities_v1alpha1.rb +1 -1
  96. data/generated/google/apis/managedidentities_v1alpha1/classes.rb +80 -9
  97. data/generated/google/apis/managedidentities_v1alpha1/representations.rb +33 -1
  98. data/generated/google/apis/managedidentities_v1alpha1/service.rb +83 -5
  99. data/generated/google/apis/managedidentities_v1beta1.rb +1 -1
  100. data/generated/google/apis/managedidentities_v1beta1/classes.rb +81 -9
  101. data/generated/google/apis/managedidentities_v1beta1/representations.rb +33 -1
  102. data/generated/google/apis/managedidentities_v1beta1/service.rb +83 -5
  103. data/generated/google/apis/monitoring_v3.rb +1 -1
  104. data/generated/google/apis/monitoring_v3/classes.rb +8 -8
  105. data/generated/google/apis/people_v1.rb +1 -1
  106. data/generated/google/apis/people_v1/classes.rb +45 -45
  107. data/generated/google/apis/playablelocations_v3.rb +1 -1
  108. data/generated/google/apis/playablelocations_v3/classes.rb +6 -6
  109. data/generated/google/apis/poly_v1.rb +3 -4
  110. data/generated/google/apis/poly_v1/classes.rb +65 -79
  111. data/generated/google/apis/poly_v1/service.rb +50 -63
  112. data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
  113. data/generated/google/apis/prod_tt_sasportal_v1alpha1/service.rb +109 -0
  114. data/generated/google/apis/realtimebidding_v1.rb +1 -1
  115. data/generated/google/apis/realtimebidding_v1/classes.rb +33 -33
  116. data/generated/google/apis/realtimebidding_v1/service.rb +4 -4
  117. data/generated/google/apis/run_v1.rb +1 -1
  118. data/generated/google/apis/run_v1/classes.rb +7 -6
  119. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  120. data/generated/google/apis/servicenetworking_v1/classes.rb +107 -4
  121. data/generated/google/apis/servicenetworking_v1/representations.rb +34 -0
  122. data/generated/google/apis/servicenetworking_v1/service.rb +2 -2
  123. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  124. data/generated/google/apis/servicenetworking_v1beta/classes.rb +107 -4
  125. data/generated/google/apis/servicenetworking_v1beta/representations.rb +34 -0
  126. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  127. data/generated/google/apis/storagetransfer_v1/classes.rb +8 -0
  128. data/generated/google/apis/storagetransfer_v1/representations.rb +1 -0
  129. data/generated/google/apis/storagetransfer_v1/service.rb +17 -18
  130. data/generated/google/apis/streetviewpublish_v1.rb +1 -1
  131. data/generated/google/apis/streetviewpublish_v1/classes.rb +4 -4
  132. data/generated/google/apis/sts_v1beta.rb +1 -1
  133. data/generated/google/apis/sts_v1beta/classes.rb +12 -11
  134. data/generated/google/apis/tpu_v1.rb +1 -1
  135. data/generated/google/apis/tpu_v1/classes.rb +3 -3
  136. data/generated/google/apis/tpu_v1/service.rb +8 -8
  137. data/generated/google/apis/tpu_v1alpha1.rb +1 -1
  138. data/generated/google/apis/tpu_v1alpha1/classes.rb +3 -3
  139. data/generated/google/apis/tpu_v1alpha1/service.rb +8 -8
  140. data/generated/google/apis/vault_v1.rb +1 -1
  141. data/generated/google/apis/vault_v1/classes.rb +333 -0
  142. data/generated/google/apis/vault_v1/representations.rb +162 -0
  143. data/generated/google/apis/vault_v1/service.rb +151 -0
  144. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  145. data/generated/google/apis/youtube_v3.rb +1 -1
  146. data/generated/google/apis/youtube_v3/service.rb +2 -2
  147. data/google-api-client.gemspec +1 -1
  148. data/lib/google/apis/core/api_command.rb +1 -0
  149. data/lib/google/apis/version.rb +1 -1
  150. data/synth.py +40 -0
  151. metadata +13 -3
@@ -0,0 +1,805 @@
1
+ # Copyright 2015 Google Inc.
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module DomainsV1alpha2
23
+ # Cloud Domains API
24
+ #
25
+ # Enables management and configuration of domain names.
26
+ #
27
+ # @example
28
+ # require 'google/apis/domains_v1alpha2'
29
+ #
30
+ # Domains = Google::Apis::DomainsV1alpha2 # Alias the module
31
+ # service = Domains::CloudDomainsService.new
32
+ #
33
+ # @see https://cloud.google.com/domains/
34
+ class CloudDomainsService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://domains.googleapis.com/', '')
47
+ @batch_path = 'batch'
48
+ end
49
+
50
+ # Gets information about a location.
51
+ # @param [String] name
52
+ # Resource name for the location.
53
+ # @param [String] fields
54
+ # Selector specifying which fields to include in a partial response.
55
+ # @param [String] quota_user
56
+ # Available to use for quota purposes for server-side applications. Can be any
57
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
58
+ # @param [Google::Apis::RequestOptions] options
59
+ # Request-specific options
60
+ #
61
+ # @yield [result, err] Result & error if block supplied
62
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Location] parsed result object
63
+ # @yieldparam err [StandardError] error object if request failed
64
+ #
65
+ # @return [Google::Apis::DomainsV1alpha2::Location]
66
+ #
67
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
68
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
69
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
70
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
71
+ command = make_simple_command(:get, 'v1alpha2/{+name}', options)
72
+ command.response_representation = Google::Apis::DomainsV1alpha2::Location::Representation
73
+ command.response_class = Google::Apis::DomainsV1alpha2::Location
74
+ command.params['name'] = name unless name.nil?
75
+ command.query['fields'] = fields unless fields.nil?
76
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
77
+ execute_or_queue_command(command, &block)
78
+ end
79
+
80
+ # Lists information about the supported locations for this service.
81
+ # @param [String] name
82
+ # The resource that owns the locations collection, if applicable.
83
+ # @param [String] filter
84
+ # The standard list filter.
85
+ # @param [Fixnum] page_size
86
+ # The standard list page size.
87
+ # @param [String] page_token
88
+ # The standard list page token.
89
+ # @param [String] fields
90
+ # Selector specifying which fields to include in a partial response.
91
+ # @param [String] quota_user
92
+ # Available to use for quota purposes for server-side applications. Can be any
93
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
94
+ # @param [Google::Apis::RequestOptions] options
95
+ # Request-specific options
96
+ #
97
+ # @yield [result, err] Result & error if block supplied
98
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::ListLocationsResponse] parsed result object
99
+ # @yieldparam err [StandardError] error object if request failed
100
+ #
101
+ # @return [Google::Apis::DomainsV1alpha2::ListLocationsResponse]
102
+ #
103
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
104
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
105
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
106
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
107
+ command = make_simple_command(:get, 'v1alpha2/{+name}/locations', options)
108
+ command.response_representation = Google::Apis::DomainsV1alpha2::ListLocationsResponse::Representation
109
+ command.response_class = Google::Apis::DomainsV1alpha2::ListLocationsResponse
110
+ command.params['name'] = name unless name.nil?
111
+ command.query['filter'] = filter unless filter.nil?
112
+ command.query['pageSize'] = page_size unless page_size.nil?
113
+ command.query['pageToken'] = page_token unless page_token.nil?
114
+ command.query['fields'] = fields unless fields.nil?
115
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
116
+ execute_or_queue_command(command, &block)
117
+ end
118
+
119
+ # Gets the latest state of a long-running operation. Clients can use this method
120
+ # to poll the operation result at intervals as recommended by the API service.
121
+ # @param [String] name
122
+ # The name of the operation resource.
123
+ # @param [String] fields
124
+ # Selector specifying which fields to include in a partial response.
125
+ # @param [String] quota_user
126
+ # Available to use for quota purposes for server-side applications. Can be any
127
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
128
+ # @param [Google::Apis::RequestOptions] options
129
+ # Request-specific options
130
+ #
131
+ # @yield [result, err] Result & error if block supplied
132
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
133
+ # @yieldparam err [StandardError] error object if request failed
134
+ #
135
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
136
+ #
137
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
138
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
139
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
140
+ def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
141
+ command = make_simple_command(:get, 'v1alpha2/{+name}', options)
142
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
143
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
144
+ command.params['name'] = name unless name.nil?
145
+ command.query['fields'] = fields unless fields.nil?
146
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
147
+ execute_or_queue_command(command, &block)
148
+ end
149
+
150
+ # Lists operations that match the specified filter in the request. If the server
151
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
152
+ # binding allows API services to override the binding to use different resource
153
+ # name schemes, such as `users/*/operations`. To override the binding, API
154
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
155
+ # service configuration. For backwards compatibility, the default name includes
156
+ # the operations collection id, however overriding users must ensure the name
157
+ # binding is the parent resource, without the operations collection id.
158
+ # @param [String] name
159
+ # The name of the operation's parent resource.
160
+ # @param [String] filter
161
+ # The standard list filter.
162
+ # @param [Fixnum] page_size
163
+ # The standard list page size.
164
+ # @param [String] page_token
165
+ # The standard list page token.
166
+ # @param [String] fields
167
+ # Selector specifying which fields to include in a partial response.
168
+ # @param [String] quota_user
169
+ # Available to use for quota purposes for server-side applications. Can be any
170
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
171
+ # @param [Google::Apis::RequestOptions] options
172
+ # Request-specific options
173
+ #
174
+ # @yield [result, err] Result & error if block supplied
175
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::ListOperationsResponse] parsed result object
176
+ # @yieldparam err [StandardError] error object if request failed
177
+ #
178
+ # @return [Google::Apis::DomainsV1alpha2::ListOperationsResponse]
179
+ #
180
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
181
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
182
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
183
+ def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
184
+ command = make_simple_command(:get, 'v1alpha2/{+name}/operations', options)
185
+ command.response_representation = Google::Apis::DomainsV1alpha2::ListOperationsResponse::Representation
186
+ command.response_class = Google::Apis::DomainsV1alpha2::ListOperationsResponse
187
+ command.params['name'] = name unless name.nil?
188
+ command.query['filter'] = filter unless filter.nil?
189
+ command.query['pageSize'] = page_size unless page_size.nil?
190
+ command.query['pageToken'] = page_token unless page_token.nil?
191
+ command.query['fields'] = fields unless fields.nil?
192
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
193
+ execute_or_queue_command(command, &block)
194
+ end
195
+
196
+ # Updates a `Registration`'s contact settings. Some changes require confirmation
197
+ # by the domain's registrant contact .
198
+ # @param [String] registration
199
+ # Required. The name of the `Registration` whose contact settings are being
200
+ # updated, in the format `projects/*/locations/*/registrations/*`.
201
+ # @param [Google::Apis::DomainsV1alpha2::ConfigureContactSettingsRequest] configure_contact_settings_request_object
202
+ # @param [String] fields
203
+ # Selector specifying which fields to include in a partial response.
204
+ # @param [String] quota_user
205
+ # Available to use for quota purposes for server-side applications. Can be any
206
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
207
+ # @param [Google::Apis::RequestOptions] options
208
+ # Request-specific options
209
+ #
210
+ # @yield [result, err] Result & error if block supplied
211
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
212
+ # @yieldparam err [StandardError] error object if request failed
213
+ #
214
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
215
+ #
216
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
217
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
218
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
219
+ def configure_registration_contact_settings(registration, configure_contact_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
220
+ command = make_simple_command(:post, 'v1alpha2/{+registration}:configureContactSettings', options)
221
+ command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureContactSettingsRequest::Representation
222
+ command.request_object = configure_contact_settings_request_object
223
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
224
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
225
+ command.params['registration'] = registration unless registration.nil?
226
+ command.query['fields'] = fields unless fields.nil?
227
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
228
+ execute_or_queue_command(command, &block)
229
+ end
230
+
231
+ # Updates a `Registration`'s DNS settings.
232
+ # @param [String] registration
233
+ # Required. The name of the `Registration` whose DNS settings are being updated,
234
+ # in the format `projects/*/locations/*/registrations/*`.
235
+ # @param [Google::Apis::DomainsV1alpha2::ConfigureDnsSettingsRequest] configure_dns_settings_request_object
236
+ # @param [String] fields
237
+ # Selector specifying which fields to include in a partial response.
238
+ # @param [String] quota_user
239
+ # Available to use for quota purposes for server-side applications. Can be any
240
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
241
+ # @param [Google::Apis::RequestOptions] options
242
+ # Request-specific options
243
+ #
244
+ # @yield [result, err] Result & error if block supplied
245
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
246
+ # @yieldparam err [StandardError] error object if request failed
247
+ #
248
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
249
+ #
250
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
251
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
252
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
253
+ def configure_registration_dns_settings(registration, configure_dns_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
254
+ command = make_simple_command(:post, 'v1alpha2/{+registration}:configureDnsSettings', options)
255
+ command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureDnsSettingsRequest::Representation
256
+ command.request_object = configure_dns_settings_request_object
257
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
258
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
259
+ command.params['registration'] = registration unless registration.nil?
260
+ command.query['fields'] = fields unless fields.nil?
261
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
262
+ execute_or_queue_command(command, &block)
263
+ end
264
+
265
+ # Updates a `Registration`'s management settings.
266
+ # @param [String] registration
267
+ # Required. The name of the `Registration` whose management settings are being
268
+ # updated, in the format `projects/*/locations/*/registrations/*`.
269
+ # @param [Google::Apis::DomainsV1alpha2::ConfigureManagementSettingsRequest] configure_management_settings_request_object
270
+ # @param [String] fields
271
+ # Selector specifying which fields to include in a partial response.
272
+ # @param [String] quota_user
273
+ # Available to use for quota purposes for server-side applications. Can be any
274
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
275
+ # @param [Google::Apis::RequestOptions] options
276
+ # Request-specific options
277
+ #
278
+ # @yield [result, err] Result & error if block supplied
279
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
280
+ # @yieldparam err [StandardError] error object if request failed
281
+ #
282
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
283
+ #
284
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
285
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
286
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
287
+ def configure_registration_management_settings(registration, configure_management_settings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
288
+ command = make_simple_command(:post, 'v1alpha2/{+registration}:configureManagementSettings', options)
289
+ command.request_representation = Google::Apis::DomainsV1alpha2::ConfigureManagementSettingsRequest::Representation
290
+ command.request_object = configure_management_settings_request_object
291
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
292
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
293
+ command.params['registration'] = registration unless registration.nil?
294
+ command.query['fields'] = fields unless fields.nil?
295
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
296
+ execute_or_queue_command(command, &block)
297
+ end
298
+
299
+ # Deletes a `Registration` resource. This method only works on resources in one
300
+ # of the following states: * `state` is `EXPORTED` with `expire_time` in the
301
+ # past * `state` is `REGISTRATION_FAILED`
302
+ # @param [String] name
303
+ # Required. The name of the `Registration` to delete, in the format `projects/*/
304
+ # locations/*/registrations/*`.
305
+ # @param [String] fields
306
+ # Selector specifying which fields to include in a partial response.
307
+ # @param [String] quota_user
308
+ # Available to use for quota purposes for server-side applications. Can be any
309
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
310
+ # @param [Google::Apis::RequestOptions] options
311
+ # Request-specific options
312
+ #
313
+ # @yield [result, err] Result & error if block supplied
314
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
315
+ # @yieldparam err [StandardError] error object if request failed
316
+ #
317
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
318
+ #
319
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
320
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
321
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
322
+ def delete_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
323
+ command = make_simple_command(:delete, 'v1alpha2/{+name}', options)
324
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
325
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
326
+ command.params['name'] = name unless name.nil?
327
+ command.query['fields'] = fields unless fields.nil?
328
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
329
+ execute_or_queue_command(command, &block)
330
+ end
331
+
332
+ # Exports a `Registration` that you no longer want to use with Cloud Domains.
333
+ # You can continue to use the domain in [Google Domains](https://domains.google/)
334
+ # until it expires. If the export is successful: * The resource's `state`
335
+ # becomes `EXPORTED`, meaning that it is no longer managed by Cloud Domains *
336
+ # Because individual users can own domains in Google Domains, the calling user
337
+ # becomes the domain's sole owner. Permissions for the domain are subsequently
338
+ # managed in Google Domains. * Without further action, the domain does not renew
339
+ # automatically. The new owner can set up billing in Google Domains to renew the
340
+ # domain if needed.
341
+ # @param [String] name
342
+ # Required. The name of the `Registration` to export, in the format `projects/*/
343
+ # locations/*/registrations/*`.
344
+ # @param [Google::Apis::DomainsV1alpha2::ExportRegistrationRequest] export_registration_request_object
345
+ # @param [String] fields
346
+ # Selector specifying which fields to include in a partial response.
347
+ # @param [String] quota_user
348
+ # Available to use for quota purposes for server-side applications. Can be any
349
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
350
+ # @param [Google::Apis::RequestOptions] options
351
+ # Request-specific options
352
+ #
353
+ # @yield [result, err] Result & error if block supplied
354
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
355
+ # @yieldparam err [StandardError] error object if request failed
356
+ #
357
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
358
+ #
359
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
360
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
361
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
362
+ def export_registration(name, export_registration_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
363
+ command = make_simple_command(:post, 'v1alpha2/{+name}:export', options)
364
+ command.request_representation = Google::Apis::DomainsV1alpha2::ExportRegistrationRequest::Representation
365
+ command.request_object = export_registration_request_object
366
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
367
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
368
+ command.params['name'] = name unless name.nil?
369
+ command.query['fields'] = fields unless fields.nil?
370
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
371
+ execute_or_queue_command(command, &block)
372
+ end
373
+
374
+ # Gets the details of a `Registration` resource.
375
+ # @param [String] name
376
+ # Required. The name of the `Registration` to get, in the format `projects/*/
377
+ # locations/*/registrations/*`.
378
+ # @param [String] fields
379
+ # Selector specifying which fields to include in a partial response.
380
+ # @param [String] quota_user
381
+ # Available to use for quota purposes for server-side applications. Can be any
382
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
383
+ # @param [Google::Apis::RequestOptions] options
384
+ # Request-specific options
385
+ #
386
+ # @yield [result, err] Result & error if block supplied
387
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Registration] parsed result object
388
+ # @yieldparam err [StandardError] error object if request failed
389
+ #
390
+ # @return [Google::Apis::DomainsV1alpha2::Registration]
391
+ #
392
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
393
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
394
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
395
+ def get_project_location_registration(name, fields: nil, quota_user: nil, options: nil, &block)
396
+ command = make_simple_command(:get, 'v1alpha2/{+name}', options)
397
+ command.response_representation = Google::Apis::DomainsV1alpha2::Registration::Representation
398
+ command.response_class = Google::Apis::DomainsV1alpha2::Registration
399
+ command.params['name'] = name unless name.nil?
400
+ command.query['fields'] = fields unless fields.nil?
401
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
402
+ execute_or_queue_command(command, &block)
403
+ end
404
+
405
+ # Gets the access control policy for a resource. Returns an empty policy if the
406
+ # resource exists and does not have a policy set.
407
+ # @param [String] resource
408
+ # REQUIRED: The resource for which the policy is being requested. See the
409
+ # operation documentation for the appropriate value for this field.
410
+ # @param [Fixnum] options_requested_policy_version
411
+ # Optional. The policy format version to be returned. Valid values are 0, 1, and
412
+ # 3. Requests specifying an invalid value will be rejected. Requests for
413
+ # policies with any conditional bindings must specify version 3. Policies
414
+ # without any conditional bindings may specify any valid value or leave the
415
+ # field unset. To learn which resources support conditions in their IAM policies,
416
+ # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
417
+ # resource-policies).
418
+ # @param [String] fields
419
+ # Selector specifying which fields to include in a partial response.
420
+ # @param [String] quota_user
421
+ # Available to use for quota purposes for server-side applications. Can be any
422
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
423
+ # @param [Google::Apis::RequestOptions] options
424
+ # Request-specific options
425
+ #
426
+ # @yield [result, err] Result & error if block supplied
427
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Policy] parsed result object
428
+ # @yieldparam err [StandardError] error object if request failed
429
+ #
430
+ # @return [Google::Apis::DomainsV1alpha2::Policy]
431
+ #
432
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
433
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
434
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
435
+ def get_project_location_registration_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
436
+ command = make_simple_command(:get, 'v1alpha2/{+resource}:getIamPolicy', options)
437
+ command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation
438
+ command.response_class = Google::Apis::DomainsV1alpha2::Policy
439
+ command.params['resource'] = resource unless resource.nil?
440
+ command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
441
+ command.query['fields'] = fields unless fields.nil?
442
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
443
+ execute_or_queue_command(command, &block)
444
+ end
445
+
446
+ # Lists the `Registration` resources in a project.
447
+ # @param [String] parent
448
+ # Required. The project and location from which to list `Registration`s,
449
+ # specified in the format `projects/*/locations/*`.
450
+ # @param [String] filter
451
+ # Filter expression to restrict the `Registration`s returned. The expression
452
+ # must specify the field name, a comparison operator, and the value that you
453
+ # want to use for filtering. The value must be a string, a number, a boolean, or
454
+ # an enum value. The comparison operator should be one of =, !=, >, <, >=, <=,
455
+ # or : for prefix or wildcard matches. For example, to filter to a specific
456
+ # domain name, use an expression like `domainName="example.com"`. You can also
457
+ # check for the existence of a field; for example, to find domains using custom
458
+ # DNS settings, use an expression like `dnsSettings.customDns:*`. You can also
459
+ # create compound filters by combining expressions with the `AND` and `OR`
460
+ # operators. For example, to find domains that are suspended or have specific
461
+ # issues flagged, use an expression like `(state=SUSPENDED) OR (issue:*)`.
462
+ # @param [Fixnum] page_size
463
+ # Maximum number of results to return.
464
+ # @param [String] page_token
465
+ # When set to the `next_page_token` from a prior response, provides the next
466
+ # page of results.
467
+ # @param [String] fields
468
+ # Selector specifying which fields to include in a partial response.
469
+ # @param [String] quota_user
470
+ # Available to use for quota purposes for server-side applications. Can be any
471
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
472
+ # @param [Google::Apis::RequestOptions] options
473
+ # Request-specific options
474
+ #
475
+ # @yield [result, err] Result & error if block supplied
476
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::ListRegistrationsResponse] parsed result object
477
+ # @yieldparam err [StandardError] error object if request failed
478
+ #
479
+ # @return [Google::Apis::DomainsV1alpha2::ListRegistrationsResponse]
480
+ #
481
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
482
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
483
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
484
+ def list_project_location_registrations(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
485
+ command = make_simple_command(:get, 'v1alpha2/{+parent}/registrations', options)
486
+ command.response_representation = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse::Representation
487
+ command.response_class = Google::Apis::DomainsV1alpha2::ListRegistrationsResponse
488
+ command.params['parent'] = parent unless parent.nil?
489
+ command.query['filter'] = filter unless filter.nil?
490
+ command.query['pageSize'] = page_size unless page_size.nil?
491
+ command.query['pageToken'] = page_token unless page_token.nil?
492
+ command.query['fields'] = fields unless fields.nil?
493
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
494
+ execute_or_queue_command(command, &block)
495
+ end
496
+
497
+ # Updates select fields of a `Registration` resource, notably `labels`. To
498
+ # update other fields, use the appropriate custom update method: * To update
499
+ # management settings, see `ConfigureManagementSettings` * To update DNS
500
+ # configuration, see `ConfigureDnsSettings` * To update contact information, see
501
+ # `ConfigureContactSettings`
502
+ # @param [String] name
503
+ # Output only. Name of the `Registration` resource, in the format `projects/*/
504
+ # locations/*/registrations/`.
505
+ # @param [Google::Apis::DomainsV1alpha2::Registration] registration_object
506
+ # @param [String] update_mask
507
+ # Required. The field mask describing which fields to update as a comma-
508
+ # separated list. For example, if only the labels are being updated, the `
509
+ # update_mask` would be `"labels"`.
510
+ # @param [String] fields
511
+ # Selector specifying which fields to include in a partial response.
512
+ # @param [String] quota_user
513
+ # Available to use for quota purposes for server-side applications. Can be any
514
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
515
+ # @param [Google::Apis::RequestOptions] options
516
+ # Request-specific options
517
+ #
518
+ # @yield [result, err] Result & error if block supplied
519
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
520
+ # @yieldparam err [StandardError] error object if request failed
521
+ #
522
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
523
+ #
524
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
525
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
526
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
527
+ def patch_project_location_registration(name, registration_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
528
+ command = make_simple_command(:patch, 'v1alpha2/{+name}', options)
529
+ command.request_representation = Google::Apis::DomainsV1alpha2::Registration::Representation
530
+ command.request_object = registration_object
531
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
532
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
533
+ command.params['name'] = name unless name.nil?
534
+ command.query['updateMask'] = update_mask unless update_mask.nil?
535
+ command.query['fields'] = fields unless fields.nil?
536
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
537
+ execute_or_queue_command(command, &block)
538
+ end
539
+
540
+ # Registers a new domain name and creates a corresponding `Registration`
541
+ # resource. Call `RetrieveRegisterParameters` first to check availability of the
542
+ # domain name and determine parameters like price that are needed to build a
543
+ # call to this method. A successful call creates a `Registration` resource in
544
+ # state `REGISTRATION_PENDING`, which resolves to `ACTIVE` within 1-2 minutes,
545
+ # indicating that the domain was successfully registered. If the resource ends
546
+ # up in state `REGISTRATION_FAILED`, it indicates that the domain was not
547
+ # registered successfully, and you can safely delete the resource and retry
548
+ # registration.
549
+ # @param [String] parent
550
+ # Required. The parent resource of the `Registration`. Must be in the format `
551
+ # projects/*/locations/*`.
552
+ # @param [Google::Apis::DomainsV1alpha2::RegisterDomainRequest] register_domain_request_object
553
+ # @param [String] fields
554
+ # Selector specifying which fields to include in a partial response.
555
+ # @param [String] quota_user
556
+ # Available to use for quota purposes for server-side applications. Can be any
557
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
558
+ # @param [Google::Apis::RequestOptions] options
559
+ # Request-specific options
560
+ #
561
+ # @yield [result, err] Result & error if block supplied
562
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Operation] parsed result object
563
+ # @yieldparam err [StandardError] error object if request failed
564
+ #
565
+ # @return [Google::Apis::DomainsV1alpha2::Operation]
566
+ #
567
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
568
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
569
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
570
+ def register_registration_domain(parent, register_domain_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
571
+ command = make_simple_command(:post, 'v1alpha2/{+parent}/registrations:register', options)
572
+ command.request_representation = Google::Apis::DomainsV1alpha2::RegisterDomainRequest::Representation
573
+ command.request_object = register_domain_request_object
574
+ command.response_representation = Google::Apis::DomainsV1alpha2::Operation::Representation
575
+ command.response_class = Google::Apis::DomainsV1alpha2::Operation
576
+ command.params['parent'] = parent unless parent.nil?
577
+ command.query['fields'] = fields unless fields.nil?
578
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
579
+ execute_or_queue_command(command, &block)
580
+ end
581
+
582
+ # Resets the authorization code of the `Registration` to a new random string.
583
+ # You can call this method only after 60 days have elapsed since the initial
584
+ # domain registration.
585
+ # @param [String] registration
586
+ # Required. The name of the `Registration` whose authorization code is being
587
+ # reset, in the format `projects/*/locations/*/registrations/*`.
588
+ # @param [Google::Apis::DomainsV1alpha2::ResetAuthorizationCodeRequest] reset_authorization_code_request_object
589
+ # @param [String] fields
590
+ # Selector specifying which fields to include in a partial response.
591
+ # @param [String] quota_user
592
+ # Available to use for quota purposes for server-side applications. Can be any
593
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
594
+ # @param [Google::Apis::RequestOptions] options
595
+ # Request-specific options
596
+ #
597
+ # @yield [result, err] Result & error if block supplied
598
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::AuthorizationCode] parsed result object
599
+ # @yieldparam err [StandardError] error object if request failed
600
+ #
601
+ # @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
602
+ #
603
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
604
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
605
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
606
+ def reset_registration_authorization_code(registration, reset_authorization_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
607
+ command = make_simple_command(:post, 'v1alpha2/{+registration}:resetAuthorizationCode', options)
608
+ command.request_representation = Google::Apis::DomainsV1alpha2::ResetAuthorizationCodeRequest::Representation
609
+ command.request_object = reset_authorization_code_request_object
610
+ command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
611
+ command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode
612
+ command.params['registration'] = registration unless registration.nil?
613
+ command.query['fields'] = fields unless fields.nil?
614
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
615
+ execute_or_queue_command(command, &block)
616
+ end
617
+
618
+ # Gets the authorization code of the `Registration` for the purpose of
619
+ # transferring the domain to another registrar. You can call this method only
620
+ # after 60 days have elapsed since the initial domain registration.
621
+ # @param [String] registration
622
+ # Required. The name of the `Registration` whose authorization code is being
623
+ # retrieved, in the format `projects/*/locations/*/registrations/*`.
624
+ # @param [String] fields
625
+ # Selector specifying which fields to include in a partial response.
626
+ # @param [String] quota_user
627
+ # Available to use for quota purposes for server-side applications. Can be any
628
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
629
+ # @param [Google::Apis::RequestOptions] options
630
+ # Request-specific options
631
+ #
632
+ # @yield [result, err] Result & error if block supplied
633
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::AuthorizationCode] parsed result object
634
+ # @yieldparam err [StandardError] error object if request failed
635
+ #
636
+ # @return [Google::Apis::DomainsV1alpha2::AuthorizationCode]
637
+ #
638
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
639
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
640
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
641
+ def retrieve_project_location_registration_authorization_code(registration, fields: nil, quota_user: nil, options: nil, &block)
642
+ command = make_simple_command(:get, 'v1alpha2/{+registration}:retrieveAuthorizationCode', options)
643
+ command.response_representation = Google::Apis::DomainsV1alpha2::AuthorizationCode::Representation
644
+ command.response_class = Google::Apis::DomainsV1alpha2::AuthorizationCode
645
+ command.params['registration'] = registration unless registration.nil?
646
+ command.query['fields'] = fields unless fields.nil?
647
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
648
+ execute_or_queue_command(command, &block)
649
+ end
650
+
651
+ # Gets parameters needed to register a new domain name, including price and up-
652
+ # to-date availability. Use the returned values to call `RegisterDomain`.
653
+ # @param [String] location
654
+ # Required. The location. Must be in the format `projects/*/locations/*`.
655
+ # @param [String] domain_name
656
+ # Required. The domain name. Unicode domain names must be expressed in Punycode
657
+ # format.
658
+ # @param [String] fields
659
+ # Selector specifying which fields to include in a partial response.
660
+ # @param [String] quota_user
661
+ # Available to use for quota purposes for server-side applications. Can be any
662
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
663
+ # @param [Google::Apis::RequestOptions] options
664
+ # Request-specific options
665
+ #
666
+ # @yield [result, err] Result & error if block supplied
667
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse] parsed result object
668
+ # @yieldparam err [StandardError] error object if request failed
669
+ #
670
+ # @return [Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse]
671
+ #
672
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
673
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
674
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
675
+ def retrieve_project_location_registration_register_parameters(location, domain_name: nil, fields: nil, quota_user: nil, options: nil, &block)
676
+ command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:retrieveRegisterParameters', options)
677
+ command.response_representation = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse::Representation
678
+ command.response_class = Google::Apis::DomainsV1alpha2::RetrieveRegisterParametersResponse
679
+ command.params['location'] = location unless location.nil?
680
+ command.query['domainName'] = domain_name unless domain_name.nil?
681
+ command.query['fields'] = fields unless fields.nil?
682
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
683
+ execute_or_queue_command(command, &block)
684
+ end
685
+
686
+ # Searches for available domain names similar to the provided query.
687
+ # Availability results from this method are approximate; call `
688
+ # RetrieveRegisterParameters` on a domain before registering to confirm
689
+ # availability.
690
+ # @param [String] location
691
+ # Required. The location. Must be in the format `projects/*/locations/*`.
692
+ # @param [String] query
693
+ # Required. String used to search for available domain names.
694
+ # @param [String] fields
695
+ # Selector specifying which fields to include in a partial response.
696
+ # @param [String] quota_user
697
+ # Available to use for quota purposes for server-side applications. Can be any
698
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
699
+ # @param [Google::Apis::RequestOptions] options
700
+ # Request-specific options
701
+ #
702
+ # @yield [result, err] Result & error if block supplied
703
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::SearchDomainsResponse] parsed result object
704
+ # @yieldparam err [StandardError] error object if request failed
705
+ #
706
+ # @return [Google::Apis::DomainsV1alpha2::SearchDomainsResponse]
707
+ #
708
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
709
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
710
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
711
+ def search_project_location_registration_domains(location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
712
+ command = make_simple_command(:get, 'v1alpha2/{+location}/registrations:searchDomains', options)
713
+ command.response_representation = Google::Apis::DomainsV1alpha2::SearchDomainsResponse::Representation
714
+ command.response_class = Google::Apis::DomainsV1alpha2::SearchDomainsResponse
715
+ command.params['location'] = location unless location.nil?
716
+ command.query['query'] = query unless query.nil?
717
+ command.query['fields'] = fields unless fields.nil?
718
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
719
+ execute_or_queue_command(command, &block)
720
+ end
721
+
722
+ # Sets the access control policy on the specified resource. Replaces any
723
+ # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
724
+ # PERMISSION_DENIED` errors.
725
+ # @param [String] resource
726
+ # REQUIRED: The resource for which the policy is being specified. See the
727
+ # operation documentation for the appropriate value for this field.
728
+ # @param [Google::Apis::DomainsV1alpha2::SetIamPolicyRequest] set_iam_policy_request_object
729
+ # @param [String] fields
730
+ # Selector specifying which fields to include in a partial response.
731
+ # @param [String] quota_user
732
+ # Available to use for quota purposes for server-side applications. Can be any
733
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
734
+ # @param [Google::Apis::RequestOptions] options
735
+ # Request-specific options
736
+ #
737
+ # @yield [result, err] Result & error if block supplied
738
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::Policy] parsed result object
739
+ # @yieldparam err [StandardError] error object if request failed
740
+ #
741
+ # @return [Google::Apis::DomainsV1alpha2::Policy]
742
+ #
743
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
744
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
745
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
746
+ def set_registration_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
747
+ command = make_simple_command(:post, 'v1alpha2/{+resource}:setIamPolicy', options)
748
+ command.request_representation = Google::Apis::DomainsV1alpha2::SetIamPolicyRequest::Representation
749
+ command.request_object = set_iam_policy_request_object
750
+ command.response_representation = Google::Apis::DomainsV1alpha2::Policy::Representation
751
+ command.response_class = Google::Apis::DomainsV1alpha2::Policy
752
+ command.params['resource'] = resource unless resource.nil?
753
+ command.query['fields'] = fields unless fields.nil?
754
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
755
+ execute_or_queue_command(command, &block)
756
+ end
757
+
758
+ # Returns permissions that a caller has on the specified resource. If the
759
+ # resource does not exist, this will return an empty set of permissions, not a `
760
+ # NOT_FOUND` error. Note: This operation is designed to be used for building
761
+ # permission-aware UIs and command-line tools, not for authorization checking.
762
+ # This operation may "fail open" without warning.
763
+ # @param [String] resource
764
+ # REQUIRED: The resource for which the policy detail is being requested. See the
765
+ # operation documentation for the appropriate value for this field.
766
+ # @param [Google::Apis::DomainsV1alpha2::TestIamPermissionsRequest] test_iam_permissions_request_object
767
+ # @param [String] fields
768
+ # Selector specifying which fields to include in a partial response.
769
+ # @param [String] quota_user
770
+ # Available to use for quota purposes for server-side applications. Can be any
771
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
772
+ # @param [Google::Apis::RequestOptions] options
773
+ # Request-specific options
774
+ #
775
+ # @yield [result, err] Result & error if block supplied
776
+ # @yieldparam result [Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse] parsed result object
777
+ # @yieldparam err [StandardError] error object if request failed
778
+ #
779
+ # @return [Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse]
780
+ #
781
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
782
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
783
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
784
+ def test_registration_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
785
+ command = make_simple_command(:post, 'v1alpha2/{+resource}:testIamPermissions', options)
786
+ command.request_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsRequest::Representation
787
+ command.request_object = test_iam_permissions_request_object
788
+ command.response_representation = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse::Representation
789
+ command.response_class = Google::Apis::DomainsV1alpha2::TestIamPermissionsResponse
790
+ command.params['resource'] = resource unless resource.nil?
791
+ command.query['fields'] = fields unless fields.nil?
792
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
793
+ execute_or_queue_command(command, &block)
794
+ end
795
+
796
+ protected
797
+
798
+ def apply_command_defaults(command)
799
+ command.query['key'] = key unless key.nil?
800
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
801
+ end
802
+ end
803
+ end
804
+ end
805
+ end