google-api-client 0.51.0 → 0.52.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (218) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/release-please.yml +23 -45
  3. data/CHANGELOG.md +100 -0
  4. data/README.md +2 -2
  5. data/generated/google/apis/admin_datatransfer_v1.rb +2 -2
  6. data/generated/google/apis/admin_datatransfer_v1/classes.rb +6 -16
  7. data/generated/google/apis/admin_datatransfer_v1/service.rb +3 -3
  8. data/generated/google/apis/admin_directory_v1.rb +2 -2
  9. data/generated/google/apis/admin_directory_v1/classes.rb +453 -321
  10. data/generated/google/apis/admin_directory_v1/representations.rb +15 -15
  11. data/generated/google/apis/admin_directory_v1/service.rb +323 -183
  12. data/generated/google/apis/admin_reports_v1.rb +2 -2
  13. data/generated/google/apis/admin_reports_v1/classes.rb +48 -43
  14. data/generated/google/apis/admin_reports_v1/service.rb +198 -179
  15. data/generated/google/apis/alertcenter_v1beta1.rb +1 -1
  16. data/generated/google/apis/analytics_v3/service.rb +1 -1
  17. data/generated/google/apis/analyticsadmin_v1alpha.rb +1 -1
  18. data/generated/google/apis/analyticsadmin_v1alpha/classes.rb +2 -2
  19. data/generated/google/apis/analyticsadmin_v1alpha/service.rb +5 -12
  20. data/generated/google/apis/analyticsdata_v1alpha.rb +1 -1
  21. data/generated/google/apis/analyticsdata_v1alpha/classes.rb +11 -11
  22. data/generated/google/apis/androidmanagement_v1.rb +1 -1
  23. data/generated/google/apis/apigateway_v1beta.rb +1 -1
  24. data/generated/google/apis/apigateway_v1beta/classes.rb +3 -9
  25. data/generated/google/apis/apigateway_v1beta/representations.rb +0 -1
  26. data/generated/google/apis/apigee_v1.rb +1 -1
  27. data/generated/google/apis/apigee_v1/classes.rb +71 -0
  28. data/generated/google/apis/apigee_v1/representations.rb +42 -0
  29. data/generated/google/apis/apigee_v1/service.rb +206 -0
  30. data/generated/google/apis/appengine_v1.rb +1 -1
  31. data/generated/google/apis/appengine_v1/classes.rb +7 -0
  32. data/generated/google/apis/appengine_v1/representations.rb +1 -0
  33. data/generated/google/apis/artifactregistry_v1beta1.rb +1 -1
  34. data/generated/google/apis/artifactregistry_v1beta1/classes.rb +2 -2
  35. data/generated/google/apis/artifactregistry_v1beta1/service.rb +4 -1
  36. data/generated/google/apis/artifactregistry_v1beta2.rb +1 -1
  37. data/generated/google/apis/artifactregistry_v1beta2/classes.rb +2 -2
  38. data/generated/google/apis/artifactregistry_v1beta2/service.rb +4 -1
  39. data/generated/google/apis/cloudasset_v1.rb +1 -1
  40. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  41. data/generated/google/apis/cloudbuild_v1alpha1.rb +1 -1
  42. data/generated/google/apis/cloudbuild_v1alpha2.rb +1 -1
  43. data/generated/google/apis/cloudfunctions_v1.rb +1 -1
  44. data/generated/google/apis/cloudfunctions_v1/classes.rb +6 -0
  45. data/generated/google/apis/cloudfunctions_v1/representations.rb +1 -0
  46. data/generated/google/apis/cloudidentity_v1.rb +1 -1
  47. data/generated/google/apis/cloudidentity_v1/classes.rb +240 -0
  48. data/generated/google/apis/cloudidentity_v1/representations.rb +125 -0
  49. data/generated/google/apis/cloudidentity_v1/service.rb +202 -2
  50. data/generated/google/apis/cloudidentity_v1beta1.rb +1 -1
  51. data/generated/google/apis/cloudidentity_v1beta1/service.rb +8 -2
  52. data/generated/google/apis/cloudkms_v1.rb +1 -1
  53. data/generated/google/apis/cloudkms_v1/classes.rb +0 -6
  54. data/generated/google/apis/cloudkms_v1/representations.rb +0 -1
  55. data/generated/google/apis/cloudscheduler_v1beta1.rb +1 -1
  56. data/generated/google/apis/cloudscheduler_v1beta1/classes.rb +19 -0
  57. data/generated/google/apis/cloudscheduler_v1beta1/representations.rb +2 -0
  58. data/generated/google/apis/cloudscheduler_v1beta1/service.rb +12 -2
  59. data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
  60. data/generated/google/apis/cloudtasks_v2beta2/classes.rb +59 -0
  61. data/generated/google/apis/cloudtasks_v2beta2/representations.rb +19 -0
  62. data/generated/google/apis/cloudtasks_v2beta3.rb +1 -1
  63. data/generated/google/apis/cloudtasks_v2beta3/classes.rb +102 -0
  64. data/generated/google/apis/cloudtasks_v2beta3/representations.rb +35 -0
  65. data/generated/google/apis/cloudtasks_v2beta3/service.rb +16 -2
  66. data/generated/google/apis/composer_v1beta1.rb +1 -1
  67. data/generated/google/apis/composer_v1beta1/classes.rb +64 -0
  68. data/generated/google/apis/composer_v1beta1/representations.rb +18 -0
  69. data/generated/google/apis/compute_alpha.rb +1 -1
  70. data/generated/google/apis/compute_alpha/classes.rb +1071 -341
  71. data/generated/google/apis/compute_alpha/representations.rb +248 -19
  72. data/generated/google/apis/compute_alpha/service.rb +291 -15
  73. data/generated/google/apis/compute_beta.rb +1 -1
  74. data/generated/google/apis/compute_beta/classes.rb +926 -283
  75. data/generated/google/apis/compute_beta/representations.rb +221 -18
  76. data/generated/google/apis/compute_beta/service.rb +24 -15
  77. data/generated/google/apis/compute_v1.rb +1 -1
  78. data/generated/google/apis/compute_v1/classes.rb +419 -158
  79. data/generated/google/apis/compute_v1/representations.rb +55 -0
  80. data/generated/google/apis/compute_v1/service.rb +9 -7
  81. data/generated/google/apis/container_v1.rb +1 -1
  82. data/generated/google/apis/container_v1/classes.rb +48 -9
  83. data/generated/google/apis/container_v1/representations.rb +17 -0
  84. data/generated/google/apis/container_v1/service.rb +4 -2
  85. data/generated/google/apis/container_v1beta1.rb +1 -1
  86. data/generated/google/apis/container_v1beta1/classes.rb +24 -13
  87. data/generated/google/apis/container_v1beta1/representations.rb +2 -0
  88. data/generated/google/apis/container_v1beta1/service.rb +6 -2
  89. data/generated/google/apis/content_v2_1.rb +1 -1
  90. data/generated/google/apis/content_v2_1/classes.rb +16 -7
  91. data/generated/google/apis/content_v2_1/representations.rb +1 -0
  92. data/generated/google/apis/datamigration_v1beta1.rb +1 -1
  93. data/generated/google/apis/datamigration_v1beta1/classes.rb +0 -6
  94. data/generated/google/apis/datamigration_v1beta1/representations.rb +0 -1
  95. data/generated/google/apis/deploymentmanager_alpha.rb +6 -5
  96. data/generated/google/apis/deploymentmanager_alpha/classes.rb +276 -644
  97. data/generated/google/apis/deploymentmanager_alpha/representations.rb +10 -143
  98. data/generated/google/apis/deploymentmanager_alpha/service.rb +247 -398
  99. data/generated/google/apis/deploymentmanager_v2.rb +1 -1
  100. data/generated/google/apis/deploymentmanager_v2/service.rb +5 -25
  101. data/generated/google/apis/deploymentmanager_v2beta.rb +1 -1
  102. data/generated/google/apis/deploymentmanager_v2beta/service.rb +8 -40
  103. data/generated/google/apis/dialogflow_v2.rb +1 -1
  104. data/generated/google/apis/dialogflow_v2/classes.rb +692 -0
  105. data/generated/google/apis/dialogflow_v2/representations.rb +326 -0
  106. data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
  107. data/generated/google/apis/dialogflow_v2beta1/classes.rb +692 -0
  108. data/generated/google/apis/dialogflow_v2beta1/representations.rb +326 -0
  109. data/generated/google/apis/{bigqueryreservation_v1alpha2.rb → dialogflow_v3.rb} +13 -12
  110. data/generated/google/apis/dialogflow_v3/classes.rb +8943 -0
  111. data/generated/google/apis/dialogflow_v3/representations.rb +3773 -0
  112. data/generated/google/apis/dialogflow_v3/service.rb +3006 -0
  113. data/generated/google/apis/dialogflow_v3beta1.rb +1 -1
  114. data/generated/google/apis/dialogflow_v3beta1/classes.rb +784 -0
  115. data/generated/google/apis/dialogflow_v3beta1/representations.rb +360 -0
  116. data/generated/google/apis/dialogflow_v3beta1/service.rb +173 -0
  117. data/generated/google/apis/dlp_v2.rb +1 -1
  118. data/generated/google/apis/dlp_v2/service.rb +294 -1
  119. data/generated/google/apis/dns_v1.rb +1 -1
  120. data/generated/google/apis/dns_v1/classes.rb +65 -0
  121. data/generated/google/apis/dns_v1/representations.rb +32 -0
  122. data/generated/google/apis/documentai_v1beta2.rb +1 -1
  123. data/generated/google/apis/documentai_v1beta2/classes.rb +220 -102
  124. data/generated/google/apis/documentai_v1beta2/representations.rb +105 -9
  125. data/generated/google/apis/documentai_v1beta3.rb +1 -1
  126. data/generated/google/apis/documentai_v1beta3/classes.rb +241 -117
  127. data/generated/google/apis/documentai_v1beta3/representations.rb +105 -9
  128. data/generated/google/apis/documentai_v1beta3/service.rb +81 -2
  129. data/generated/google/apis/eventarc_v1beta1.rb +1 -1
  130. data/generated/google/apis/eventarc_v1beta1/classes.rb +8 -9
  131. data/generated/google/apis/eventarc_v1beta1/service.rb +25 -5
  132. data/generated/google/apis/file_v1.rb +1 -1
  133. data/generated/google/apis/file_v1/classes.rb +61 -0
  134. data/generated/google/apis/file_v1/representations.rb +19 -0
  135. data/generated/google/apis/genomics_v2alpha1.rb +1 -1
  136. data/generated/google/apis/genomics_v2alpha1/classes.rb +11 -7
  137. data/generated/google/apis/healthcare_v1.rb +1 -1
  138. data/generated/google/apis/healthcare_v1/classes.rb +0 -6
  139. data/generated/google/apis/healthcare_v1/representations.rb +0 -1
  140. data/generated/google/apis/healthcare_v1/service.rb +13 -12
  141. data/generated/google/apis/healthcare_v1beta1.rb +1 -1
  142. data/generated/google/apis/healthcare_v1beta1/classes.rb +45 -19
  143. data/generated/google/apis/healthcare_v1beta1/representations.rb +3 -1
  144. data/generated/google/apis/healthcare_v1beta1/service.rb +37 -37
  145. data/generated/google/apis/iap_v1.rb +1 -1
  146. data/generated/google/apis/iap_v1/classes.rb +0 -6
  147. data/generated/google/apis/iap_v1/representations.rb +0 -1
  148. data/generated/google/apis/iap_v1beta1.rb +1 -1
  149. data/generated/google/apis/iap_v1beta1/classes.rb +0 -6
  150. data/generated/google/apis/iap_v1beta1/representations.rb +0 -1
  151. data/generated/google/apis/metastore_v1beta.rb +35 -0
  152. data/generated/google/apis/metastore_v1beta/classes.rb +1151 -0
  153. data/generated/google/apis/metastore_v1beta/representations.rb +479 -0
  154. data/generated/google/apis/metastore_v1beta/service.rb +800 -0
  155. data/generated/google/apis/ml_v1.rb +1 -1
  156. data/generated/google/apis/ml_v1/classes.rb +51 -18
  157. data/generated/google/apis/ml_v1/representations.rb +16 -0
  158. data/generated/google/apis/monitoring_v3.rb +1 -1
  159. data/generated/google/apis/monitoring_v3/classes.rb +8 -4
  160. data/generated/google/apis/privateca_v1beta1.rb +1 -1
  161. data/generated/google/apis/privateca_v1beta1/classes.rb +2 -1
  162. data/generated/google/apis/prod_tt_sasportal_v1alpha1.rb +1 -1
  163. data/generated/google/apis/prod_tt_sasportal_v1alpha1/classes.rb +37 -0
  164. data/generated/google/apis/prod_tt_sasportal_v1alpha1/representations.rb +18 -0
  165. data/generated/google/apis/recommender_v1beta1.rb +1 -1
  166. data/generated/google/apis/recommender_v1beta1/service.rb +317 -0
  167. data/generated/google/apis/redis_v1.rb +1 -1
  168. data/generated/google/apis/redis_v1/classes.rb +2 -2
  169. data/generated/google/apis/redis_v1beta1.rb +1 -1
  170. data/generated/google/apis/redis_v1beta1/classes.rb +2 -2
  171. data/generated/google/apis/safebrowsing_v4.rb +1 -1
  172. data/generated/google/apis/safebrowsing_v4/classes.rb +277 -277
  173. data/generated/google/apis/safebrowsing_v4/representations.rb +128 -128
  174. data/generated/google/apis/safebrowsing_v4/service.rb +44 -44
  175. data/generated/google/apis/searchconsole_v1.rb +1 -1
  176. data/generated/google/apis/searchconsole_v1/classes.rb +7 -0
  177. data/generated/google/apis/searchconsole_v1/representations.rb +1 -0
  178. data/generated/google/apis/serviceconsumermanagement_v1beta1.rb +1 -1
  179. data/generated/google/apis/serviceconsumermanagement_v1beta1/classes.rb +11 -10
  180. data/generated/google/apis/servicecontrol_v1.rb +3 -3
  181. data/generated/google/apis/servicecontrol_v1/service.rb +2 -2
  182. data/generated/google/apis/servicecontrol_v2.rb +3 -3
  183. data/generated/google/apis/servicecontrol_v2/service.rb +2 -2
  184. data/generated/google/apis/servicedirectory_v1.rb +35 -0
  185. data/generated/google/apis/servicedirectory_v1/classes.rb +721 -0
  186. data/generated/google/apis/servicedirectory_v1/representations.rb +304 -0
  187. data/generated/google/apis/servicedirectory_v1/service.rb +957 -0
  188. data/generated/google/apis/servicenetworking_v1.rb +1 -1
  189. data/generated/google/apis/servicenetworking_v1/classes.rb +1 -1
  190. data/generated/google/apis/servicenetworking_v1beta.rb +1 -1
  191. data/generated/google/apis/servicenetworking_v1beta/classes.rb +1 -1
  192. data/generated/google/apis/serviceusage_v1.rb +1 -1
  193. data/generated/google/apis/serviceusage_v1/classes.rb +11 -10
  194. data/generated/google/apis/serviceusage_v1beta1.rb +1 -1
  195. data/generated/google/apis/serviceusage_v1beta1/classes.rb +11 -10
  196. data/generated/google/apis/slides_v1.rb +1 -1
  197. data/generated/google/apis/slides_v1/classes.rb +9 -3
  198. data/generated/google/apis/speech_v1p1beta1.rb +1 -1
  199. data/generated/google/apis/speech_v1p1beta1/classes.rb +0 -22
  200. data/generated/google/apis/speech_v1p1beta1/representations.rb +0 -2
  201. data/generated/google/apis/testing_v1.rb +1 -1
  202. data/generated/google/apis/testing_v1/classes.rb +1 -1
  203. data/generated/google/apis/trafficdirector_v2.rb +2 -2
  204. data/generated/google/apis/trafficdirector_v2/service.rb +1 -1
  205. data/generated/google/apis/transcoder_v1beta1.rb +1 -1
  206. data/generated/google/apis/transcoder_v1beta1/classes.rb +12 -2
  207. data/generated/google/apis/transcoder_v1beta1/representations.rb +1 -0
  208. data/generated/google/apis/translate_v3.rb +1 -1
  209. data/generated/google/apis/translate_v3/classes.rb +1 -1
  210. data/generated/google/apis/translate_v3beta1.rb +1 -1
  211. data/generated/google/apis/translate_v3beta1/classes.rb +1 -1
  212. data/generated/google/apis/workflows_v1beta.rb +1 -1
  213. data/generated/google/apis/workflows_v1beta/classes.rb +4 -4
  214. data/lib/google/apis/version.rb +1 -1
  215. metadata +15 -7
  216. data/generated/google/apis/bigqueryreservation_v1alpha2/classes.rb +0 -426
  217. data/generated/google/apis/bigqueryreservation_v1alpha2/representations.rb +0 -195
  218. data/generated/google/apis/bigqueryreservation_v1alpha2/service.rb +0 -622
@@ -133,12 +133,6 @@ module Google
133
133
  include Google::Apis::Core::JsonObjectSupport
134
134
  end
135
135
 
136
- class RecentUser
137
- class Representation < Google::Apis::Core::JsonRepresentation; end
138
-
139
- include Google::Apis::Core::JsonObjectSupport
140
- end
141
-
142
136
  class SystemRamFreeReport
143
137
  class Representation < Google::Apis::Core::JsonRepresentation; end
144
138
 
@@ -334,6 +328,12 @@ module Google
334
328
  include Google::Apis::Core::JsonObjectSupport
335
329
  end
336
330
 
331
+ class RecentUsers
332
+ class Representation < Google::Apis::Core::JsonRepresentation; end
333
+
334
+ include Google::Apis::Core::JsonObjectSupport
335
+ end
336
+
337
337
  class Role
338
338
  class Representation < Google::Apis::Core::JsonRepresentation; end
339
339
 
@@ -715,7 +715,7 @@ module Google
715
715
  property :org_unit_path, as: 'orgUnitPath'
716
716
  property :os_version, as: 'osVersion'
717
717
  property :platform_version, as: 'platformVersion'
718
- collection :recent_users, as: 'recentUsers', class: Google::Apis::AdminDirectoryV1::ChromeOsDevice::RecentUser, decorator: Google::Apis::AdminDirectoryV1::ChromeOsDevice::RecentUser::Representation
718
+ collection :recent_users, as: 'recentUsers', class: Google::Apis::AdminDirectoryV1::RecentUsers, decorator: Google::Apis::AdminDirectoryV1::RecentUsers::Representation
719
719
 
720
720
  property :serial_number, as: 'serialNumber'
721
721
  property :status, as: 'status'
@@ -793,14 +793,6 @@ module Google
793
793
  end
794
794
  end
795
795
 
796
- class RecentUser
797
- # @private
798
- class Representation < Google::Apis::Core::JsonRepresentation
799
- property :email, as: 'email'
800
- property :type, as: 'type'
801
- end
802
- end
803
-
804
796
  class SystemRamFreeReport
805
797
  # @private
806
798
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -1186,6 +1178,14 @@ module Google
1186
1178
  end
1187
1179
  end
1188
1180
 
1181
+ class RecentUsers
1182
+ # @private
1183
+ class Representation < Google::Apis::Core::JsonRepresentation
1184
+ property :email, as: 'email'
1185
+ property :type, as: 'type'
1186
+ end
1187
+ end
1188
+
1189
1189
  class Role
1190
1190
  # @private
1191
1191
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -20,7 +20,7 @@ require 'google/apis/errors'
20
20
  module Google
21
21
  module Apis
22
22
  module AdminDirectoryV1
23
- # Admin SDK
23
+ # Admin SDK API
24
24
  #
25
25
  # Admin SDK lets administrators of enterprise domains to view and manage
26
26
  # resources like user, groups etc. It also provides audit and usage reports of
@@ -45,8 +45,8 @@ module Google
45
45
  attr_accessor :quota_user
46
46
 
47
47
  def initialize
48
- super('https://www.googleapis.com/', '')
49
- @batch_path = 'batch/admin/directory_v1'
48
+ super('https://admin.googleapis.com/', '')
49
+ @batch_path = 'batch'
50
50
  end
51
51
 
52
52
  # Delete an ASP issued by a user.
@@ -174,11 +174,24 @@ module Google
174
174
  execute_or_queue_command(command, &block)
175
175
  end
176
176
 
177
- # Take action on Chrome OS Device
177
+ # Takes an action that affects a Chrome OS Device. This includes deprovisioning,
178
+ # disabling, and re-enabling devices. *Warning:* * Deprovisioning a device will
179
+ # stop device policy syncing and remove device-level printers. After a device is
180
+ # deprovisioned, it must be wiped before it can be re-enrolled. * Lost or stolen
181
+ # devices should use the disable action. * Re-enabling a disabled device will
182
+ # consume a device license. If you do not have sufficient licenses available
183
+ # when completing the re-enable action, you will receive an error. For more
184
+ # information about deprovisioning and disabling devices, visit the [help center]
185
+ # (https://support.google.com/chrome/a/answer/3523633).
178
186
  # @param [String] customer_id
179
- # Immutable ID of the G Suite account
187
+ # The unique ID for the customer's G Suite account. As an account administrator,
188
+ # you can also use the `my_customer` alias to represent your account's `
189
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
190
+ # /admin-sdk/directory/v1/reference/users).
180
191
  # @param [String] resource_id
181
- # Immutable ID of Chrome OS Device
192
+ # The unique ID of the device. The `resourceId`s are returned in the response
193
+ # from the [chromeosdevices.list](/admin-sdk/directory/v1/reference/
194
+ # chromeosdevices/list) method.
182
195
  # @param [Google::Apis::AdminDirectoryV1::ChromeOsDeviceAction] chrome_os_device_action_object
183
196
  # @param [String] fields
184
197
  # Selector specifying which fields to include in a partial response.
@@ -208,13 +221,19 @@ module Google
208
221
  execute_or_queue_command(command, &block)
209
222
  end
210
223
 
211
- # Retrieve Chrome OS Device
224
+ # Retrieves a Chrome OS device's properties.
212
225
  # @param [String] customer_id
213
- # Immutable ID of the G Suite account
226
+ # The unique ID for the customer's G Suite account. As an account administrator,
227
+ # you can also use the `my_customer` alias to represent your account's `
228
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
229
+ # /admin-sdk/directory/v1/reference/users).
214
230
  # @param [String] device_id
215
- # Immutable ID of Chrome OS Device
231
+ # The unique ID of the device. The `deviceId`s are returned in the response from
232
+ # the [chromeosdevices.list](/admin-sdk/directory/v1/reference/chromeosdevices/
233
+ # list) method.
216
234
  # @param [String] projection
217
- # Restrict information returned to a set of selected fields.
235
+ # Determines whether the response contains the full list of properties or only a
236
+ # subset.
218
237
  # @param [String] fields
219
238
  # Selector specifying which fields to include in a partial response.
220
239
  # @param [String] quota_user
@@ -244,25 +263,30 @@ module Google
244
263
  execute_or_queue_command(command, &block)
245
264
  end
246
265
 
247
- # Retrieve all Chrome OS Devices of a customer (paginated)
266
+ # Retrieves a paginated list of Chrome OS devices within an account.
248
267
  # @param [String] customer_id
249
- # Immutable ID of the G Suite account
268
+ # The unique ID for the customer's G Suite account. As an account administrator,
269
+ # you can also use the `my_customer` alias to represent your account's `
270
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
271
+ # /admin-sdk/directory/v1/reference/users).
250
272
  # @param [Fixnum] max_results
251
273
  # Maximum number of results to return.
252
274
  # @param [String] order_by
253
- # Column to use for sorting results
275
+ # Device property to use for sorting results.
254
276
  # @param [String] org_unit_path
255
- # Full path of the organizational unit or its ID
277
+ # The full path of the organizational unit or its unique ID.
256
278
  # @param [String] page_token
257
- # Token to specify next page in the list
279
+ # The `pageToken` query parameter is used to request the next page of query
280
+ # results. The follow-on request's `pageToken` query parameter is the `
281
+ # nextPageToken` from your previous response.
258
282
  # @param [String] projection
259
283
  # Restrict information returned to a set of selected fields.
260
284
  # @param [String] query
261
285
  # Search string in the format given at http://support.google.com/chromeos/a/bin/
262
286
  # answer.py?answer=1698333
263
287
  # @param [String] sort_order
264
- # Whether to return results in ascending or descending order. Only of use when
265
- # orderBy is also used
288
+ # Whether to return results in ascending or descending order. Must be used with
289
+ # the `orderBy` parameter.
266
290
  # @param [String] fields
267
291
  # Selector specifying which fields to include in a partial response.
268
292
  # @param [String] quota_user
@@ -297,7 +321,8 @@ module Google
297
321
  execute_or_queue_command(command, &block)
298
322
  end
299
323
 
300
- # Move or insert multiple Chrome OS Devices to organizational unit
324
+ # Move or insert multiple Chrome OS devices to an organizational unit. You can
325
+ # move up to 50 devices at once.
301
326
  # @param [String] customer_id
302
327
  # Immutable ID of the G Suite account
303
328
  # @param [String] org_unit_path
@@ -331,11 +356,18 @@ module Google
331
356
  execute_or_queue_command(command, &block)
332
357
  end
333
358
 
334
- # Patch Chrome OS Device
359
+ # Updates a device's updatable properties, such as `annotatedUser`, `
360
+ # annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`. This method
361
+ # supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).
335
362
  # @param [String] customer_id
336
- # Immutable ID of the G Suite account
363
+ # The unique ID for the customer's G Suite account. As an account administrator,
364
+ # you can also use the `my_customer` alias to represent your account's `
365
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
366
+ # /admin-sdk/directory/v1/reference/users).
337
367
  # @param [String] device_id
338
- # Immutable ID of Chrome OS Device
368
+ # The unique ID of the device. The `deviceId`s are returned in the response from
369
+ # the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list)
370
+ # method.
339
371
  # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object
340
372
  # @param [String] projection
341
373
  # Restrict information returned to a set of selected fields.
@@ -370,11 +402,17 @@ module Google
370
402
  execute_or_queue_command(command, &block)
371
403
  end
372
404
 
373
- # Update Chrome OS Device
405
+ # Updates a device's updatable properties, such as `annotatedUser`, `
406
+ # annotatedLocation`, `notes`, `orgUnitPath`, or `annotatedAssetId`.
374
407
  # @param [String] customer_id
375
- # Immutable ID of the G Suite account
408
+ # The unique ID for the customer's G Suite account. As an account administrator,
409
+ # you can also use the `my_customer` alias to represent your account's `
410
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
411
+ # /admin-sdk/directory/v1/reference/users).
376
412
  # @param [String] device_id
377
- # Immutable ID of Chrome OS Device
413
+ # The unique ID of the device. The `deviceId`s are returned in the response from
414
+ # the [chromeosdevices.list](/admin-sdk/v1/reference/chromeosdevices/list)
415
+ # method.
378
416
  # @param [Google::Apis::AdminDirectoryV1::ChromeOsDevice] chrome_os_device_object
379
417
  # @param [String] projection
380
418
  # Restrict information returned to a set of selected fields.
@@ -834,9 +872,10 @@ module Google
834
872
  execute_or_queue_command(command, &block)
835
873
  end
836
874
 
837
- # Delete Group
875
+ # Deletes a group.
838
876
  # @param [String] group_key
839
- # Email or immutable ID of the group
877
+ # Identifies the group in the API request. The value can be the group's email
878
+ # address, group alias, or the unique group ID.
840
879
  # @param [String] fields
841
880
  # Selector specifying which fields to include in a partial response.
842
881
  # @param [String] quota_user
@@ -862,9 +901,10 @@ module Google
862
901
  execute_or_queue_command(command, &block)
863
902
  end
864
903
 
865
- # Retrieve Group
904
+ # Retrieves a group's properties.
866
905
  # @param [String] group_key
867
- # Email or immutable ID of the group
906
+ # Identifies the group in the API request. The value can be the group's email
907
+ # address, group alias, or the unique group ID.
868
908
  # @param [String] fields
869
909
  # Selector specifying which fields to include in a partial response.
870
910
  # @param [String] quota_user
@@ -892,7 +932,7 @@ module Google
892
932
  execute_or_queue_command(command, &block)
893
933
  end
894
934
 
895
- # Create Group
935
+ # Creates a group.
896
936
  # @param [Google::Apis::AdminDirectoryV1::Group] group_object
897
937
  # @param [String] fields
898
938
  # Selector specifying which fields to include in a partial response.
@@ -924,11 +964,14 @@ module Google
924
964
 
925
965
  # Retrieve all groups of a domain or of a user given a userKey (paginated)
926
966
  # @param [String] customer
927
- # Immutable ID of the G Suite account. In case of multi-domain, to fetch all
928
- # groups for a customer, fill this field instead of domain.
967
+ # The unique ID for the customer's G Suite account. In case of a multi-domain
968
+ # account, to fetch all groups for a customer, fill this field instead of domain.
969
+ # As an account administrator, you can also use the `my_customer` alias to
970
+ # represent your account's `customerId`. The `customerId` is also returned as
971
+ # part of the [Users](/admin-sdk/directory/v1/reference/users)
929
972
  # @param [String] domain
930
- # Name of the domain. Fill this field to get groups from only this domain. To
931
- # return all groups in a multi-domain fill customer field instead.
973
+ # The domain name. Use this field to get fields from only one domain. To return
974
+ # all domains for a customer account, use the `customer` query parameter instead.
932
975
  # @param [Fixnum] max_results
933
976
  # Maximum number of results to return. Max allowed value is 200.
934
977
  # @param [String] order_by
@@ -979,10 +1022,11 @@ module Google
979
1022
  execute_or_queue_command(command, &block)
980
1023
  end
981
1024
 
982
- # Patch Groups via Apiary Patch Orchestration
1025
+ # Updates a group's properties. This method supports [patch semantics](/admin-
1026
+ # sdk/directory/v1/guides/performance#patch).
983
1027
  # @param [String] group_key
984
- # Email or immutable ID of the group. If ID, it should match with id of group
985
- # object
1028
+ # Identifies the group in the API request. The value can be the group's email
1029
+ # address, group alias, or the unique group ID.
986
1030
  # @param [Google::Apis::AdminDirectoryV1::Group] group_object
987
1031
  # @param [String] fields
988
1032
  # Selector specifying which fields to include in a partial response.
@@ -1013,10 +1057,10 @@ module Google
1013
1057
  execute_or_queue_command(command, &block)
1014
1058
  end
1015
1059
 
1016
- # Update Group
1060
+ # Updates a group's properties.
1017
1061
  # @param [String] group_key
1018
- # Email or immutable ID of the group. If ID, it should match with id of group
1019
- # object
1062
+ # Identifies the group in the API request. The value can be the group's email
1063
+ # address, group alias, or the unique group ID.
1020
1064
  # @param [Google::Apis::AdminDirectoryV1::Group] group_object
1021
1065
  # @param [String] fields
1022
1066
  # Selector specifying which fields to include in a partial response.
@@ -1047,9 +1091,10 @@ module Google
1047
1091
  execute_or_queue_command(command, &block)
1048
1092
  end
1049
1093
 
1050
- # Remove a alias for the group
1094
+ # Removes an alias.
1051
1095
  # @param [String] group_key
1052
- # Email or immutable ID of the group
1096
+ # Identifies the group in the API request. The value can be the group's email
1097
+ # address, group alias, or the unique group ID.
1053
1098
  # @param [String] group_alias
1054
1099
  # The alias to be removed
1055
1100
  # @param [String] fields
@@ -1078,9 +1123,10 @@ module Google
1078
1123
  execute_or_queue_command(command, &block)
1079
1124
  end
1080
1125
 
1081
- # Add a alias for the group
1126
+ # Adds an alias for the group.
1082
1127
  # @param [String] group_key
1083
- # Email or immutable ID of the group
1128
+ # Identifies the group in the API request. The value can be the group's email
1129
+ # address, group alias, or the unique group ID.
1084
1130
  # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object
1085
1131
  # @param [String] fields
1086
1132
  # Selector specifying which fields to include in a partial response.
@@ -1111,9 +1157,10 @@ module Google
1111
1157
  execute_or_queue_command(command, &block)
1112
1158
  end
1113
1159
 
1114
- # List all aliases for a group
1160
+ # Lists all aliases for a group.
1115
1161
  # @param [String] group_key
1116
- # Email or immutable ID of the group
1162
+ # Identifies the group in the API request. The value can be the group's email
1163
+ # address, group alias, or the unique group ID.
1117
1164
  # @param [String] fields
1118
1165
  # Selector specifying which fields to include in a partial response.
1119
1166
  # @param [String] quota_user
@@ -1141,11 +1188,14 @@ module Google
1141
1188
  execute_or_queue_command(command, &block)
1142
1189
  end
1143
1190
 
1144
- # Remove membership.
1191
+ # Removes a member from a group.
1145
1192
  # @param [String] group_key
1146
- # Email or immutable ID of the group
1193
+ # Identifies the group in the API request. The value can be the group's email
1194
+ # address, group alias, or the unique group ID.
1147
1195
  # @param [String] member_key
1148
- # Email or immutable ID of the member
1196
+ # Identifies the group member in the API request. A group member can be a user
1197
+ # or another group. The value can be the member's (group or user) primary email
1198
+ # address, alias, or unique ID.
1149
1199
  # @param [String] fields
1150
1200
  # Selector specifying which fields to include in a partial response.
1151
1201
  # @param [String] quota_user
@@ -1172,11 +1222,14 @@ module Google
1172
1222
  execute_or_queue_command(command, &block)
1173
1223
  end
1174
1224
 
1175
- # Retrieve Group Member
1225
+ # Retrieves a group member's properties.
1176
1226
  # @param [String] group_key
1177
- # Email or immutable ID of the group
1227
+ # Identifies the group in the API request. The value can be the group's email
1228
+ # address, group alias, or the unique group ID.
1178
1229
  # @param [String] member_key
1179
- # Email or immutable ID of the member
1230
+ # Identifies the group member in the API request. A group member can be a user
1231
+ # or another group. The value can be the member's (group or user) primary email
1232
+ # address, alias, or unique ID.
1180
1233
  # @param [String] fields
1181
1234
  # Selector specifying which fields to include in a partial response.
1182
1235
  # @param [String] quota_user
@@ -1241,9 +1294,10 @@ module Google
1241
1294
  execute_or_queue_command(command, &block)
1242
1295
  end
1243
1296
 
1244
- # Add user to the specified group.
1297
+ # Adds a user to the specified group.
1245
1298
  # @param [String] group_key
1246
- # Email or immutable ID of the group
1299
+ # Identifies the group in the API request. The value can be the group's email
1300
+ # address, group alias, or the unique group ID.
1247
1301
  # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1248
1302
  # @param [String] fields
1249
1303
  # Selector specifying which fields to include in a partial response.
@@ -1274,17 +1328,19 @@ module Google
1274
1328
  execute_or_queue_command(command, &block)
1275
1329
  end
1276
1330
 
1277
- # Retrieve all members in a group (paginated)
1331
+ # Retrieves a paginated list of all members in a group.
1278
1332
  # @param [String] group_key
1279
- # Email or immutable ID of the group
1333
+ # Identifies the group in the API request. The value can be the group's email
1334
+ # address, group alias, or the unique group ID.
1280
1335
  # @param [Boolean] include_derived_membership
1281
1336
  # Whether to list indirect memberships. Default: false.
1282
1337
  # @param [Fixnum] max_results
1283
1338
  # Maximum number of results to return. Max allowed value is 200.
1284
1339
  # @param [String] page_token
1285
- # Token to specify next page in the list
1340
+ # Token to specify next page in the list.
1286
1341
  # @param [String] roles
1287
- # Comma separated role values to filter list results on.
1342
+ # The `roles` query parameter allows you to retrieve group members by role.
1343
+ # Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.
1288
1344
  # @param [String] fields
1289
1345
  # Selector specifying which fields to include in a partial response.
1290
1346
  # @param [String] quota_user
@@ -1316,13 +1372,16 @@ module Google
1316
1372
  execute_or_queue_command(command, &block)
1317
1373
  end
1318
1374
 
1319
- # Patch Member via Apiary Patch Orchestration
1375
+ # Updates the membership properties of a user in the specified group. This
1376
+ # method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#
1377
+ # patch).
1320
1378
  # @param [String] group_key
1321
- # Email or immutable ID of the group. If ID, it should match with id of group
1322
- # object
1379
+ # Identifies the group in the API request. The value can be the group's email
1380
+ # address, group alias, or the unique group ID.
1323
1381
  # @param [String] member_key
1324
- # Email or immutable ID of the user. If ID, it should match with id of member
1325
- # object
1382
+ # Identifies the group member in the API request. A group member can be a user
1383
+ # or another group. The value can be the member's (group or user) primary email
1384
+ # address, alias, or unique ID.
1326
1385
  # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1327
1386
  # @param [String] fields
1328
1387
  # Selector specifying which fields to include in a partial response.
@@ -1354,13 +1413,14 @@ module Google
1354
1413
  execute_or_queue_command(command, &block)
1355
1414
  end
1356
1415
 
1357
- # Update membership of a user in the specified group.
1416
+ # Updates the membership of a user in the specified group.
1358
1417
  # @param [String] group_key
1359
- # Email or immutable ID of the group. If ID, it should match with id of group
1360
- # object
1418
+ # Identifies the group in the API request. The value can be the group's email
1419
+ # address, group alias, or the unique group ID.
1361
1420
  # @param [String] member_key
1362
- # Email or immutable ID of the user. If ID, it should match with id of member
1363
- # object
1421
+ # Identifies the group member in the API request. A group member can be a user
1422
+ # or another group. The value can be the member's (group or user) primary email
1423
+ # address, alias, or unique ID.
1364
1424
  # @param [Google::Apis::AdminDirectoryV1::Member] member_object
1365
1425
  # @param [String] fields
1366
1426
  # Selector specifying which fields to include in a partial response.
@@ -1392,11 +1452,15 @@ module Google
1392
1452
  execute_or_queue_command(command, &block)
1393
1453
  end
1394
1454
 
1395
- # Take action on Mobile Device
1455
+ # Takes an action that affects a mobile device. For example, remotely wiping a
1456
+ # device.
1396
1457
  # @param [String] customer_id
1397
- # Immutable ID of the G Suite account
1458
+ # The unique ID for the customer's G Suite account. As an account administrator,
1459
+ # you can also use the `my_customer` alias to represent your account's `
1460
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1461
+ # /admin-sdk/directory/v1/reference/users).
1398
1462
  # @param [String] resource_id
1399
- # Immutable ID of Mobile Device
1463
+ # The unique ID the API service uses to identify the mobile device.
1400
1464
  # @param [Google::Apis::AdminDirectoryV1::MobileDeviceAction] mobile_device_action_object
1401
1465
  # @param [String] fields
1402
1466
  # Selector specifying which fields to include in a partial response.
@@ -1426,11 +1490,14 @@ module Google
1426
1490
  execute_or_queue_command(command, &block)
1427
1491
  end
1428
1492
 
1429
- # Delete Mobile Device
1493
+ # Removes a mobile device.
1430
1494
  # @param [String] customer_id
1431
- # Immutable ID of the G Suite account
1495
+ # The unique ID for the customer's G Suite account. As an account administrator,
1496
+ # you can also use the `my_customer` alias to represent your account's `
1497
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1498
+ # /admin-sdk/directory/v1/reference/users).
1432
1499
  # @param [String] resource_id
1433
- # Immutable ID of Mobile Device
1500
+ # The unique ID the API service uses to identify the mobile device.
1434
1501
  # @param [String] fields
1435
1502
  # Selector specifying which fields to include in a partial response.
1436
1503
  # @param [String] quota_user
@@ -1457,11 +1524,14 @@ module Google
1457
1524
  execute_or_queue_command(command, &block)
1458
1525
  end
1459
1526
 
1460
- # Retrieve Mobile Device
1527
+ # Retrieves a mobile device's properties.
1461
1528
  # @param [String] customer_id
1462
- # Immutable ID of the G Suite account
1529
+ # The unique ID for the customer's G Suite account. As an account administrator,
1530
+ # you can also use the `my_customer` alias to represent your account's `
1531
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1532
+ # /admin-sdk/directory/v1/reference/users).
1463
1533
  # @param [String] resource_id
1464
- # Immutable ID of Mobile Device
1534
+ # The unique ID the API service uses to identify the mobile device.
1465
1535
  # @param [String] projection
1466
1536
  # Restrict information returned to a set of selected fields.
1467
1537
  # @param [String] fields
@@ -1493,13 +1563,16 @@ module Google
1493
1563
  execute_or_queue_command(command, &block)
1494
1564
  end
1495
1565
 
1496
- # Retrieve all Mobile Devices of a customer (paginated)
1566
+ # Retrieves a paginated list of all mobile devices for an account.
1497
1567
  # @param [String] customer_id
1498
- # Immutable ID of the G Suite account
1568
+ # The unique ID for the customer's G Suite account. As an account administrator,
1569
+ # you can also use the `my_customer` alias to represent your account's `
1570
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1571
+ # /admin-sdk/directory/v1/reference/users).
1499
1572
  # @param [Fixnum] max_results
1500
1573
  # Maximum number of results to return. Max allowed value is 100.
1501
1574
  # @param [String] order_by
1502
- # Column to use for sorting results
1575
+ # Device property to use for sorting results.
1503
1576
  # @param [String] page_token
1504
1577
  # Token to specify next page in the list
1505
1578
  # @param [String] projection
@@ -1508,8 +1581,8 @@ module Google
1508
1581
  # Search string in the format given at http://support.google.com/a/bin/answer.py?
1509
1582
  # answer=1408863#search
1510
1583
  # @param [String] sort_order
1511
- # Whether to return results in ascending or descending order. Only of use when
1512
- # orderBy is also used
1584
+ # Whether to return results in ascending or descending order. Must be used with
1585
+ # the `orderBy` parameter.
1513
1586
  # @param [String] fields
1514
1587
  # Selector specifying which fields to include in a partial response.
1515
1588
  # @param [String] quota_user
@@ -1543,11 +1616,14 @@ module Google
1543
1616
  execute_or_queue_command(command, &block)
1544
1617
  end
1545
1618
 
1546
- # Remove organizational unit
1619
+ # Removes an organizational unit.
1547
1620
  # @param [String] customer_id
1548
- # Immutable ID of the G Suite account
1621
+ # The unique ID for the customer's G Suite account. As an account administrator,
1622
+ # you can also use the `my_customer` alias to represent your account's `
1623
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1624
+ # /admin-sdk/directory/v1/reference/users).
1549
1625
  # @param [String] org_unit_path
1550
- # Full path of the organizational unit or its ID
1626
+ # The full path of the organizational unit or its unique ID.
1551
1627
  # @param [String] fields
1552
1628
  # Selector specifying which fields to include in a partial response.
1553
1629
  # @param [String] quota_user
@@ -1574,11 +1650,14 @@ module Google
1574
1650
  execute_or_queue_command(command, &block)
1575
1651
  end
1576
1652
 
1577
- # Retrieve organizational unit
1653
+ # Retrieves an organizational unit.
1578
1654
  # @param [String] customer_id
1579
- # Immutable ID of the G Suite account
1655
+ # The unique ID for the customer's G Suite account. As an account administrator,
1656
+ # you can also use the `my_customer` alias to represent your account's `
1657
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1658
+ # /admin-sdk/directory/v1/reference/users).
1580
1659
  # @param [String] org_unit_path
1581
- # Full path of the organizational unit or its ID
1660
+ # The full path of the organizational unit or its unique ID.
1582
1661
  # @param [String] fields
1583
1662
  # Selector specifying which fields to include in a partial response.
1584
1663
  # @param [String] quota_user
@@ -1607,9 +1686,12 @@ module Google
1607
1686
  execute_or_queue_command(command, &block)
1608
1687
  end
1609
1688
 
1610
- # Add organizational unit
1689
+ # Adds an organizational unit.
1611
1690
  # @param [String] customer_id
1612
- # Immutable ID of the G Suite account
1691
+ # The unique ID for the customer's G Suite account. As an account administrator,
1692
+ # you can also use the `my_customer` alias to represent your account's `
1693
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1694
+ # /admin-sdk/directory/v1/reference/users).
1613
1695
  # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1614
1696
  # @param [String] fields
1615
1697
  # Selector specifying which fields to include in a partial response.
@@ -1640,13 +1722,17 @@ module Google
1640
1722
  execute_or_queue_command(command, &block)
1641
1723
  end
1642
1724
 
1643
- # Retrieve all organizational units
1725
+ # Retrieves a list of all organizational units for an account.
1644
1726
  # @param [String] customer_id
1645
- # Immutable ID of the G Suite account
1727
+ # The unique ID for the customer's G Suite account. As an account administrator,
1728
+ # you can also use the `my_customer` alias to represent your account's `
1729
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1730
+ # /admin-sdk/directory/v1/reference/users).
1646
1731
  # @param [String] org_unit_path
1647
- # the URL-encoded organizational unit's path or its ID
1732
+ # The full path to the organizational unit or its unique ID. Returns the
1733
+ # children of the specified organizational unit.
1648
1734
  # @param [String] type
1649
- # Whether to return all sub-organizations or just immediate children
1735
+ # Whether to return all sub-organizations or just immediate children.
1650
1736
  # @param [String] fields
1651
1737
  # Selector specifying which fields to include in a partial response.
1652
1738
  # @param [String] quota_user
@@ -1676,11 +1762,15 @@ module Google
1676
1762
  execute_or_queue_command(command, &block)
1677
1763
  end
1678
1764
 
1679
- # Patch organization unit via Apiary Patch Orchestration
1765
+ # Updates an organizational unit. This method supports [patch semantics](/admin-
1766
+ # sdk/directory/v1/guides/performance#patch)
1680
1767
  # @param [String] customer_id
1681
- # Immutable ID of the G Suite account
1768
+ # The unique ID for the customer's G Suite account. As an account administrator,
1769
+ # you can also use the `my_customer` alias to represent your account's `
1770
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1771
+ # /admin-sdk/directory/v1/reference/users).
1682
1772
  # @param [String] org_unit_path
1683
- # Full path of the organizational unit or its ID
1773
+ # The full path of the organizational unit or its unique ID.
1684
1774
  # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1685
1775
  # @param [String] fields
1686
1776
  # Selector specifying which fields to include in a partial response.
@@ -1712,11 +1802,14 @@ module Google
1712
1802
  execute_or_queue_command(command, &block)
1713
1803
  end
1714
1804
 
1715
- # Update organizational unit
1805
+ # Updates an organizational unit.
1716
1806
  # @param [String] customer_id
1717
- # Immutable ID of the G Suite account
1807
+ # The unique ID for the customer's G Suite account. As an account administrator,
1808
+ # you can also use the `my_customer` alias to represent your account's `
1809
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
1810
+ # /admin-sdk/directory/v1/reference/users).
1718
1811
  # @param [String] org_unit_path
1719
- # Full path of the organizational unit or its ID
1812
+ # The full path of the organizational unit or its unique ID.
1720
1813
  # @param [Google::Apis::AdminDirectoryV1::OrgUnit] org_unit_object
1721
1814
  # @param [String] fields
1722
1815
  # Selector specifying which fields to include in a partial response.
@@ -1781,7 +1874,8 @@ module Google
1781
1874
  # Deletes a building.
1782
1875
  # @param [String] customer
1783
1876
  # The unique ID for the customer's G Suite account. As an account administrator,
1784
- # you can also use the my_customer alias to represent your account's customer ID.
1877
+ # you can also use the `my_customer` alias to represent your account's customer
1878
+ # ID.
1785
1879
  # @param [String] building_id
1786
1880
  # The id of the building to delete.
1787
1881
  # @param [String] fields
@@ -1813,7 +1907,8 @@ module Google
1813
1907
  # Retrieves a building.
1814
1908
  # @param [String] customer
1815
1909
  # The unique ID for the customer's G Suite account. As an account administrator,
1816
- # you can also use the my_customer alias to represent your account's customer ID.
1910
+ # you can also use the `my_customer` alias to represent your account's customer
1911
+ # ID.
1817
1912
  # @param [String] building_id
1818
1913
  # The unique ID of the building to retrieve.
1819
1914
  # @param [String] fields
@@ -1847,7 +1942,8 @@ module Google
1847
1942
  # Inserts a building.
1848
1943
  # @param [String] customer
1849
1944
  # The unique ID for the customer's G Suite account. As an account administrator,
1850
- # you can also use the my_customer alias to represent your account's customer ID.
1945
+ # you can also use the `my_customer` alias to represent your account's customer
1946
+ # ID.
1851
1947
  # @param [Google::Apis::AdminDirectoryV1::Building] building_object
1852
1948
  # @param [String] coordinates_source
1853
1949
  # Source from which Building.coordinates are derived.
@@ -1884,7 +1980,8 @@ module Google
1884
1980
  # Retrieves a list of buildings for an account.
1885
1981
  # @param [String] customer
1886
1982
  # The unique ID for the customer's G Suite account. As an account administrator,
1887
- # you can also use the my_customer alias to represent your account's customer ID.
1983
+ # you can also use the `my_customer` alias to represent your account's customer
1984
+ # ID.
1888
1985
  # @param [Fixnum] max_results
1889
1986
  # Maximum number of results to return.
1890
1987
  # @param [String] page_token
@@ -1921,7 +2018,8 @@ module Google
1921
2018
  # Patches a building via Apiary Patch Orchestration.
1922
2019
  # @param [String] customer
1923
2020
  # The unique ID for the customer's G Suite account. As an account administrator,
1924
- # you can also use the my_customer alias to represent your account's customer ID.
2021
+ # you can also use the `my_customer` alias to represent your account's customer
2022
+ # ID.
1925
2023
  # @param [String] building_id
1926
2024
  # The id of the building to update.
1927
2025
  # @param [Google::Apis::AdminDirectoryV1::Building] building_object
@@ -1961,7 +2059,8 @@ module Google
1961
2059
  # Updates a building.
1962
2060
  # @param [String] customer
1963
2061
  # The unique ID for the customer's G Suite account. As an account administrator,
1964
- # you can also use the my_customer alias to represent your account's customer ID.
2062
+ # you can also use the `my_customer` alias to represent your account's customer
2063
+ # ID.
1965
2064
  # @param [String] building_id
1966
2065
  # The id of the building to update.
1967
2066
  # @param [Google::Apis::AdminDirectoryV1::Building] building_object
@@ -2001,7 +2100,8 @@ module Google
2001
2100
  # Deletes a calendar resource.
2002
2101
  # @param [String] customer
2003
2102
  # The unique ID for the customer's G Suite account. As an account administrator,
2004
- # you can also use the my_customer alias to represent your account's customer ID.
2103
+ # you can also use the `my_customer` alias to represent your account's customer
2104
+ # ID.
2005
2105
  # @param [String] calendar_resource_id
2006
2106
  # The unique ID of the calendar resource to delete.
2007
2107
  # @param [String] fields
@@ -2033,7 +2133,8 @@ module Google
2033
2133
  # Retrieves a calendar resource.
2034
2134
  # @param [String] customer
2035
2135
  # The unique ID for the customer's G Suite account. As an account administrator,
2036
- # you can also use the my_customer alias to represent your account's customer ID.
2136
+ # you can also use the `my_customer` alias to represent your account's customer
2137
+ # ID.
2037
2138
  # @param [String] calendar_resource_id
2038
2139
  # The unique ID of the calendar resource to retrieve.
2039
2140
  # @param [String] fields
@@ -2067,7 +2168,8 @@ module Google
2067
2168
  # Inserts a calendar resource.
2068
2169
  # @param [String] customer
2069
2170
  # The unique ID for the customer's G Suite account. As an account administrator,
2070
- # you can also use the my_customer alias to represent your account's customer ID.
2171
+ # you can also use the `my_customer` alias to represent your account's customer
2172
+ # ID.
2071
2173
  # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
2072
2174
  # @param [String] fields
2073
2175
  # Selector specifying which fields to include in a partial response.
@@ -2101,16 +2203,17 @@ module Google
2101
2203
  # Retrieves a list of calendar resources for an account.
2102
2204
  # @param [String] customer
2103
2205
  # The unique ID for the customer's G Suite account. As an account administrator,
2104
- # you can also use the my_customer alias to represent your account's customer ID.
2206
+ # you can also use the `my_customer` alias to represent your account's customer
2207
+ # ID.
2105
2208
  # @param [Fixnum] max_results
2106
2209
  # Maximum number of results to return.
2107
2210
  # @param [String] order_by
2108
2211
  # Field(s) to sort results by in either ascending or descending order. Supported
2109
- # fields include resourceId, resourceName, capacity, buildingId, and floorName.
2110
- # If no order is specified, defaults to ascending. Should be of the form "field [
2111
- # asc|desc], field [asc|desc], ...". For example buildingId, capacity desc would
2112
- # return results sorted first by buildingId in ascending order then by capacity
2113
- # in descending order.
2212
+ # fields include `resourceId`, `resourceName`, `capacity`, `buildingId`, and `
2213
+ # floorName`. If no order is specified, defaults to ascending. Should be of the
2214
+ # form "field [asc|desc], field [asc|desc], ...". For example `buildingId,
2215
+ # capacity desc` would return results sorted first by `buildingId` in ascending
2216
+ # order then by `capacity` in descending order.
2114
2217
  # @param [String] page_token
2115
2218
  # Token to specify the next page in the list.
2116
2219
  # @param [String] query
@@ -2119,10 +2222,10 @@ module Google
2119
2222
  # supported operations. Operators include '=' for exact match, '!=' for mismatch
2120
2223
  # and ':' for prefix match or HAS match where applicable. For prefix match, the
2121
2224
  # value should always be followed by a *. Logical operators NOT and AND are
2122
- # supported (in this order of precedence). Supported fields include
2123
- # generatedResourceName, name, buildingId, floor_name, capacity,
2124
- # featureInstances.feature.name. For example buildingId=US-NYC-9TH AND
2125
- # featureInstances.feature.name:Phone.
2225
+ # supported (in this order of precedence). Supported fields include `
2226
+ # generatedResourceName`, `name`, `buildingId`, `floor_name`, `capacity`, `
2227
+ # featureInstances.feature.name`, `resourceEmail`, `resourceCategory`. For
2228
+ # example `buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone`.
2126
2229
  # @param [String] fields
2127
2230
  # Selector specifying which fields to include in a partial response.
2128
2231
  # @param [String] quota_user
@@ -2157,7 +2260,8 @@ module Google
2157
2260
  # Patches a calendar resource via Apiary Patch Orchestration.
2158
2261
  # @param [String] customer
2159
2262
  # The unique ID for the customer's G Suite account. As an account administrator,
2160
- # you can also use the my_customer alias to represent your account's customer ID.
2263
+ # you can also use the `my_customer` alias to represent your account's customer
2264
+ # ID.
2161
2265
  # @param [String] calendar_resource_id
2162
2266
  # The unique ID of the calendar resource to update.
2163
2267
  # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
@@ -2196,7 +2300,8 @@ module Google
2196
2300
  # present in the request will be preserved.
2197
2301
  # @param [String] customer
2198
2302
  # The unique ID for the customer's G Suite account. As an account administrator,
2199
- # you can also use the my_customer alias to represent your account's customer ID.
2303
+ # you can also use the `my_customer` alias to represent your account's customer
2304
+ # ID.
2200
2305
  # @param [String] calendar_resource_id
2201
2306
  # The unique ID of the calendar resource to update.
2202
2307
  # @param [Google::Apis::AdminDirectoryV1::CalendarResource] calendar_resource_object
@@ -2233,7 +2338,8 @@ module Google
2233
2338
  # Deletes a feature.
2234
2339
  # @param [String] customer
2235
2340
  # The unique ID for the customer's G Suite account. As an account administrator,
2236
- # you can also use the my_customer alias to represent your account's customer ID.
2341
+ # you can also use the `my_customer` alias to represent your account's customer
2342
+ # ID.
2237
2343
  # @param [String] feature_key
2238
2344
  # The unique ID of the feature to delete.
2239
2345
  # @param [String] fields
@@ -2265,7 +2371,8 @@ module Google
2265
2371
  # Retrieves a feature.
2266
2372
  # @param [String] customer
2267
2373
  # The unique ID for the customer's G Suite account. As an account administrator,
2268
- # you can also use the my_customer alias to represent your account's customer ID.
2374
+ # you can also use the `my_customer` alias to represent your account's customer
2375
+ # ID.
2269
2376
  # @param [String] feature_key
2270
2377
  # The unique ID of the feature to retrieve.
2271
2378
  # @param [String] fields
@@ -2299,7 +2406,8 @@ module Google
2299
2406
  # Inserts a feature.
2300
2407
  # @param [String] customer
2301
2408
  # The unique ID for the customer's G Suite account. As an account administrator,
2302
- # you can also use the my_customer alias to represent your account's customer ID.
2409
+ # you can also use the `my_customer` alias to represent your account's customer
2410
+ # ID.
2303
2411
  # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object
2304
2412
  # @param [String] fields
2305
2413
  # Selector specifying which fields to include in a partial response.
@@ -2333,7 +2441,8 @@ module Google
2333
2441
  # Retrieves a list of features for an account.
2334
2442
  # @param [String] customer
2335
2443
  # The unique ID for the customer's G Suite account. As an account administrator,
2336
- # you can also use the my_customer alias to represent your account's customer ID.
2444
+ # you can also use the `my_customer` alias to represent your account's customer
2445
+ # ID.
2337
2446
  # @param [Fixnum] max_results
2338
2447
  # Maximum number of results to return.
2339
2448
  # @param [String] page_token
@@ -2370,7 +2479,8 @@ module Google
2370
2479
  # Patches a feature via Apiary Patch Orchestration.
2371
2480
  # @param [String] customer
2372
2481
  # The unique ID for the customer's G Suite account. As an account administrator,
2373
- # you can also use the my_customer alias to represent your account's customer ID.
2482
+ # you can also use the `my_customer` alias to represent your account's customer
2483
+ # ID.
2374
2484
  # @param [String] feature_key
2375
2485
  # The unique ID of the feature to update.
2376
2486
  # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object
@@ -2407,7 +2517,8 @@ module Google
2407
2517
  # Renames a feature.
2408
2518
  # @param [String] customer
2409
2519
  # The unique ID for the customer's G Suite account. As an account administrator,
2410
- # you can also use the my_customer alias to represent your account's customer ID.
2520
+ # you can also use the `my_customer` alias to represent your account's customer
2521
+ # ID.
2411
2522
  # @param [String] old_name
2412
2523
  # The unique ID of the feature to rename.
2413
2524
  # @param [Google::Apis::AdminDirectoryV1::FeatureRename] feature_rename_object
@@ -2442,7 +2553,8 @@ module Google
2442
2553
  # Updates a feature.
2443
2554
  # @param [String] customer
2444
2555
  # The unique ID for the customer's G Suite account. As an account administrator,
2445
- # you can also use the my_customer alias to represent your account's customer ID.
2556
+ # you can also use the `my_customer` alias to represent your account's customer
2557
+ # ID.
2446
2558
  # @param [String] feature_key
2447
2559
  # The unique ID of the feature to update.
2448
2560
  # @param [Google::Apis::AdminDirectoryV1::Feature] feature_object
@@ -2824,9 +2936,9 @@ module Google
2824
2936
 
2825
2937
  # Delete schema
2826
2938
  # @param [String] customer_id
2827
- # Immutable ID of the G Suite account
2939
+ # Immutable ID of the G Suite account.
2828
2940
  # @param [String] schema_key
2829
- # Name or immutable ID of the schema
2941
+ # Name or immutable ID of the schema.
2830
2942
  # @param [String] fields
2831
2943
  # Selector specifying which fields to include in a partial response.
2832
2944
  # @param [String] quota_user
@@ -2855,9 +2967,9 @@ module Google
2855
2967
 
2856
2968
  # Retrieve schema
2857
2969
  # @param [String] customer_id
2858
- # Immutable ID of the G Suite account
2970
+ # Immutable ID of the G Suite account.
2859
2971
  # @param [String] schema_key
2860
- # Name or immutable ID of the schema
2972
+ # Name or immutable ID of the schema.
2861
2973
  # @param [String] fields
2862
2974
  # Selector specifying which fields to include in a partial response.
2863
2975
  # @param [String] quota_user
@@ -2888,7 +3000,7 @@ module Google
2888
3000
 
2889
3001
  # Create schema.
2890
3002
  # @param [String] customer_id
2891
- # Immutable ID of the G Suite account
3003
+ # Immutable ID of the G Suite account.
2892
3004
  # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
2893
3005
  # @param [String] fields
2894
3006
  # Selector specifying which fields to include in a partial response.
@@ -2921,7 +3033,7 @@ module Google
2921
3033
 
2922
3034
  # Retrieve all schemas for a customer
2923
3035
  # @param [String] customer_id
2924
- # Immutable ID of the G Suite account
3036
+ # Immutable ID of the G Suite account.
2925
3037
  # @param [String] fields
2926
3038
  # Selector specifying which fields to include in a partial response.
2927
3039
  # @param [String] quota_user
@@ -2951,7 +3063,7 @@ module Google
2951
3063
 
2952
3064
  # Patch Schema via Apiary Patch Orchestration
2953
3065
  # @param [String] customer_id
2954
- # Immutable ID of the G Suite account
3066
+ # Immutable ID of the G Suite account.
2955
3067
  # @param [String] schema_key
2956
3068
  # Name or immutable ID of the schema.
2957
3069
  # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
@@ -2987,7 +3099,7 @@ module Google
2987
3099
 
2988
3100
  # Update schema
2989
3101
  # @param [String] customer_id
2990
- # Immutable ID of the G Suite account
3102
+ # Immutable ID of the G Suite account.
2991
3103
  # @param [String] schema_key
2992
3104
  # Name or immutable ID of the schema.
2993
3105
  # @param [Google::Apis::AdminDirectoryV1::Schema] schema_object
@@ -3147,9 +3259,10 @@ module Google
3147
3259
  execute_or_queue_command(command, &block)
3148
3260
  end
3149
3261
 
3150
- # Delete user
3262
+ # Deletes a user.
3151
3263
  # @param [String] user_key
3152
- # Email or immutable ID of the user
3264
+ # Identifies the user in the API request. The value can be the user's primary
3265
+ # email address, alias email address, or unique user ID.
3153
3266
  # @param [String] fields
3154
3267
  # Selector specifying which fields to include in a partial response.
3155
3268
  # @param [String] quota_user
@@ -3175,16 +3288,19 @@ module Google
3175
3288
  execute_or_queue_command(command, &block)
3176
3289
  end
3177
3290
 
3178
- # retrieve user
3291
+ # Retrieves a user.
3179
3292
  # @param [String] user_key
3180
- # Email or immutable ID of the user
3293
+ # Identifies the user in the API request. The value can be the user's primary
3294
+ # email address, alias email address, or unique user ID.
3181
3295
  # @param [String] custom_field_mask
3182
- # Comma-separated list of schema names. All fields from these schemas are
3183
- # fetched. This should only be set when projection=custom.
3296
+ # A comma-separated list of schema names. All fields from these schemas are
3297
+ # fetched. This should only be set when `projection=custom`.
3184
3298
  # @param [String] projection
3185
3299
  # What subset of fields to fetch for this user.
3186
3300
  # @param [String] view_type
3187
- # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3301
+ # Whether to fetch the administrator-only or domain-wide public view of the user.
3302
+ # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
3303
+ # directory/v1/guides/manage-users#retrieve_users_non_admin).
3188
3304
  # @param [String] fields
3189
3305
  # Selector specifying which fields to include in a partial response.
3190
3306
  # @param [String] quota_user
@@ -3215,7 +3331,7 @@ module Google
3215
3331
  execute_or_queue_command(command, &block)
3216
3332
  end
3217
3333
 
3218
- # create user.
3334
+ # Creates a user.
3219
3335
  # @param [Google::Apis::AdminDirectoryV1::User] user_object
3220
3336
  # @param [String] fields
3221
3337
  # Selector specifying which fields to include in a partial response.
@@ -3245,33 +3361,41 @@ module Google
3245
3361
  execute_or_queue_command(command, &block)
3246
3362
  end
3247
3363
 
3248
- # Retrieve either deleted users or all users in a domain (paginated)
3364
+ # Retrieves a paginated list of either deleted users or all users in a domain.
3249
3365
  # @param [String] custom_field_mask
3250
- # Comma-separated list of schema names. All fields from these schemas are
3251
- # fetched. This should only be set when projection=custom.
3366
+ # A comma-separated list of schema names. All fields from these schemas are
3367
+ # fetched. This should only be set when `projection=custom`.
3252
3368
  # @param [String] customer
3253
- # Immutable ID of the G Suite account. In case of multi-domain, to fetch all
3254
- # users for a customer, fill this field instead of domain.
3369
+ # The unique ID for the customer's G Suite account. In case of a multi-domain
3370
+ # account, to fetch all groups for a customer, fill this field instead of domain.
3371
+ # You can also use the `my_customer` alias to represent your account's `
3372
+ # customerId`. The `customerId` is also returned as part of the [Users resource](
3373
+ # /admin-sdk/directory/v1/reference/users). Either the `customer` or the `domain`
3374
+ # parameter must be provided.
3255
3375
  # @param [String] domain
3256
- # Name of the domain. Fill this field to get users from only this domain. To
3257
- # return all users in a multi-domain fill customer field instead.
3376
+ # The domain name. Use this field to get fields from only one domain. To return
3377
+ # all domains for a customer account, use the `customer` query parameter instead.
3378
+ # Either the `customer` or the `domain` parameter must be provided.
3258
3379
  # @param [Fixnum] max_results
3259
3380
  # Maximum number of results to return.
3260
3381
  # @param [String] order_by
3261
- # Column to use for sorting results
3382
+ # Property to use for sorting results.
3262
3383
  # @param [String] page_token
3263
3384
  # Token to specify next page in the list
3264
3385
  # @param [String] projection
3265
3386
  # What subset of fields to fetch for this user.
3266
3387
  # @param [String] query
3267
- # Query string search. Should be of the form "". Complete documentation is at
3268
- # https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
3388
+ # Query string for searching user fields. For more information on constructing
3389
+ # user queries, see [Search for Users](/admin-sdk/directory/v1/guides/search-
3390
+ # users).
3269
3391
  # @param [String] show_deleted
3270
- # If set to true, retrieves the list of deleted users. (Default: false)
3392
+ # If set to `true`, retrieves the list of deleted users. (Default: `false`)
3271
3393
  # @param [String] sort_order
3272
3394
  # Whether to return results in ascending or descending order.
3273
3395
  # @param [String] view_type
3274
- # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3396
+ # Whether to fetch the administrator-only or domain-wide public view of the user.
3397
+ # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
3398
+ # directory/v1/guides/manage-users#retrieve_users_non_admin).
3275
3399
  # @param [String] fields
3276
3400
  # Selector specifying which fields to include in a partial response.
3277
3401
  # @param [String] quota_user
@@ -3309,9 +3433,10 @@ module Google
3309
3433
  execute_or_queue_command(command, &block)
3310
3434
  end
3311
3435
 
3312
- # change admin status of a user
3436
+ # Makes a user a super administrator.
3313
3437
  # @param [String] user_key
3314
- # Email or immutable ID of the user as admin
3438
+ # Identifies the user in the API request. The value can be the user's primary
3439
+ # email address, alias email address, or unique user ID.
3315
3440
  # @param [Google::Apis::AdminDirectoryV1::UserMakeAdmin] user_make_admin_object
3316
3441
  # @param [String] fields
3317
3442
  # Selector specifying which fields to include in a partial response.
@@ -3340,10 +3465,13 @@ module Google
3340
3465
  execute_or_queue_command(command, &block)
3341
3466
  end
3342
3467
 
3343
- # Patch Users via Apiary Patch Orchestration
3468
+ # Updates a user using patch semantics. The update method should be used instead,
3469
+ # since it also supports patch semantics and has better performance. This
3470
+ # method is unable to clear fields that contain repeated objects (`addresses`, `
3471
+ # phones`, etc). Use the update method instead.
3344
3472
  # @param [String] user_key
3345
- # Email or immutable ID of the user. If ID, it should match with id of user
3346
- # object
3473
+ # Identifies the user in the API request. The value can be the user's primary
3474
+ # email address, alias email address, or unique user ID.
3347
3475
  # @param [Google::Apis::AdminDirectoryV1::User] user_object
3348
3476
  # @param [String] fields
3349
3477
  # Selector specifying which fields to include in a partial response.
@@ -3404,7 +3532,7 @@ module Google
3404
3532
  execute_or_queue_command(command, &block)
3405
3533
  end
3406
3534
 
3407
- # Undelete a deleted user
3535
+ # Undeletes a deleted user.
3408
3536
  # @param [String] user_key
3409
3537
  # The immutable id of the user
3410
3538
  # @param [Google::Apis::AdminDirectoryV1::UserUndelete] user_undelete_object
@@ -3435,10 +3563,12 @@ module Google
3435
3563
  execute_or_queue_command(command, &block)
3436
3564
  end
3437
3565
 
3438
- # update user
3566
+ # Updates a user. This method supports patch semantics, meaning you only need to
3567
+ # include the fields you wish to update. Fields that are not present in the
3568
+ # request will be preserved, and fields set to `null` will be cleared.
3439
3569
  # @param [String] user_key
3440
- # Email or immutable ID of the user. If ID, it should match with id of user
3441
- # object
3570
+ # Identifies the user in the API request. The value can be the user's primary
3571
+ # email address, alias email address, or unique user ID.
3442
3572
  # @param [Google::Apis::AdminDirectoryV1::User] user_object
3443
3573
  # @param [String] fields
3444
3574
  # Selector specifying which fields to include in a partial response.
@@ -3481,7 +3611,7 @@ module Google
3481
3611
  # Name of the domain. Fill this field to get users from only this domain. To
3482
3612
  # return all users in a multi-domain fill customer field instead."
3483
3613
  # @param [String] event
3484
- # Event on which subscription is intended
3614
+ # Events to watch for.
3485
3615
  # @param [Fixnum] max_results
3486
3616
  # Maximum number of results to return.
3487
3617
  # @param [String] order_by
@@ -3498,7 +3628,9 @@ module Google
3498
3628
  # @param [String] sort_order
3499
3629
  # Whether to return results in ascending or descending order.
3500
3630
  # @param [String] view_type
3501
- # Whether to fetch the ADMIN_VIEW or DOMAIN_PUBLIC view of the user.
3631
+ # Whether to fetch the administrator-only or domain-wide public view of the user.
3632
+ # For more information, see [Retrieve a user as a non-administrator](/admin-sdk/
3633
+ # directory/v1/guides/manage-users#retrieve_users_non_admin).
3502
3634
  # @param [String] fields
3503
3635
  # Selector specifying which fields to include in a partial response.
3504
3636
  # @param [String] quota_user
@@ -3539,11 +3671,12 @@ module Google
3539
3671
  execute_or_queue_command(command, &block)
3540
3672
  end
3541
3673
 
3542
- # Remove a alias for the user
3674
+ # Removes an alias.
3543
3675
  # @param [String] user_key
3544
- # Email or immutable ID of the user
3676
+ # Identifies the user in the API request. The value can be the user's primary
3677
+ # email address, alias email address, or unique user ID.
3545
3678
  # @param [String] user_alias
3546
- # The alias to be removed
3679
+ # The alias to be removed.
3547
3680
  # @param [String] fields
3548
3681
  # Selector specifying which fields to include in a partial response.
3549
3682
  # @param [String] quota_user
@@ -3570,9 +3703,10 @@ module Google
3570
3703
  execute_or_queue_command(command, &block)
3571
3704
  end
3572
3705
 
3573
- # Add a alias for the user
3706
+ # Adds an alias.
3574
3707
  # @param [String] user_key
3575
- # Email or immutable ID of the user
3708
+ # Identifies the user in the API request. The value can be the user's primary
3709
+ # email address, alias email address, or unique user ID.
3576
3710
  # @param [Google::Apis::AdminDirectoryV1::Alias] alias_object
3577
3711
  # @param [String] fields
3578
3712
  # Selector specifying which fields to include in a partial response.
@@ -3603,9 +3737,10 @@ module Google
3603
3737
  execute_or_queue_command(command, &block)
3604
3738
  end
3605
3739
 
3606
- # List all aliases for a user
3740
+ # Lists all aliases for a user.
3607
3741
  # @param [String] user_key
3608
- # Email or immutable ID of the user
3742
+ # Identifies the user in the API request. The value can be the user's primary
3743
+ # email address, alias email address, or unique user ID.
3609
3744
  # @param [String] fields
3610
3745
  # Selector specifying which fields to include in a partial response.
3611
3746
  # @param [String] quota_user
@@ -3633,12 +3768,12 @@ module Google
3633
3768
  execute_or_queue_command(command, &block)
3634
3769
  end
3635
3770
 
3636
- # Watch for changes in users list
3771
+ # Watch for changes in users list.
3637
3772
  # @param [String] user_key
3638
3773
  # Email or immutable ID of the user
3639
3774
  # @param [Google::Apis::AdminDirectoryV1::Channel] channel_object
3640
3775
  # @param [String] event
3641
- # Event on which subscription is intended (if subscribing)
3776
+ # Events to watch for.
3642
3777
  # @param [String] fields
3643
3778
  # Selector specifying which fields to include in a partial response.
3644
3779
  # @param [String] quota_user
@@ -3669,9 +3804,10 @@ module Google
3669
3804
  execute_or_queue_command(command, &block)
3670
3805
  end
3671
3806
 
3672
- # Remove photos for the user
3807
+ # Removes the user's photo.
3673
3808
  # @param [String] user_key
3674
- # Email or immutable ID of the user
3809
+ # Identifies the user in the API request. The value can be the user's primary
3810
+ # email address, alias email address, or unique user ID.
3675
3811
  # @param [String] fields
3676
3812
  # Selector specifying which fields to include in a partial response.
3677
3813
  # @param [String] quota_user
@@ -3697,9 +3833,10 @@ module Google
3697
3833
  execute_or_queue_command(command, &block)
3698
3834
  end
3699
3835
 
3700
- # Retrieve photo of a user
3836
+ # Retrieves the user's photo.
3701
3837
  # @param [String] user_key
3702
- # Email or immutable ID of the user
3838
+ # Identifies the user in the API request. The value can be the user's primary
3839
+ # email address, alias email address, or unique user ID.
3703
3840
  # @param [String] fields
3704
3841
  # Selector specifying which fields to include in a partial response.
3705
3842
  # @param [String] quota_user
@@ -3727,9 +3864,11 @@ module Google
3727
3864
  execute_or_queue_command(command, &block)
3728
3865
  end
3729
3866
 
3730
- # Patch Photo via Apiary Patch Orchestration
3867
+ # Adds a photo for the user. This method supports [patch semantics](/admin-sdk/
3868
+ # directory/v1/guides/performance#patch).
3731
3869
  # @param [String] user_key
3732
- # Email or immutable ID of the user
3870
+ # Identifies the user in the API request. The value can be the user's primary
3871
+ # email address, alias email address, or unique user ID.
3733
3872
  # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object
3734
3873
  # @param [String] fields
3735
3874
  # Selector specifying which fields to include in a partial response.
@@ -3760,9 +3899,10 @@ module Google
3760
3899
  execute_or_queue_command(command, &block)
3761
3900
  end
3762
3901
 
3763
- # Add a photo for the user
3902
+ # Adds a photo for the user.
3764
3903
  # @param [String] user_key
3765
- # Email or immutable ID of the user
3904
+ # Identifies the user in the API request. The value can be the user's primary
3905
+ # email address, alias email address, or unique user ID.
3766
3906
  # @param [Google::Apis::AdminDirectoryV1::UserPhoto] user_photo_object
3767
3907
  # @param [String] fields
3768
3908
  # Selector specifying which fields to include in a partial response.