google-api-client 0.39.2 → 0.39.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +36 -0
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1/classes.rb +7 -0
- data/generated/google/apis/appengine_v1/representations.rb +1 -0
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appengine_v1beta/classes.rb +7 -0
- data/generated/google/apis/appengine_v1beta/representations.rb +1 -0
- data/generated/google/apis/bigqueryreservation_v1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1/classes.rb +19 -15
- data/generated/google/apis/bigqueryreservation_v1/service.rb +86 -73
- data/generated/google/apis/bigqueryreservation_v1alpha2.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1beta1.rb +1 -1
- data/generated/google/apis/bigqueryreservation_v1beta1/classes.rb +0 -47
- data/generated/google/apis/bigqueryreservation_v1beta1/representations.rb +0 -16
- data/generated/google/apis/cloudkms_v1.rb +1 -1
- data/generated/google/apis/cloudkms_v1/classes.rb +26 -14
- data/generated/google/apis/cloudkms_v1/service.rb +15 -6
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v2.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2/classes.rb +26 -10
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +26 -10
- data/generated/google/apis/cloudshell_v1.rb +1 -1
- data/generated/google/apis/cloudshell_v1alpha1.rb +1 -1
- data/generated/google/apis/container_v1.rb +1 -1
- data/generated/google/apis/container_v1/classes.rb +3 -2
- data/generated/google/apis/container_v1beta1.rb +1 -1
- data/generated/google/apis/container_v1beta1/classes.rb +3 -2
- data/generated/google/apis/firebasehosting_v1beta1.rb +1 -1
- data/generated/google/apis/firebasehosting_v1beta1/classes.rb +4 -4
- data/generated/google/apis/games_management_v1management.rb +6 -4
- data/generated/google/apis/games_management_v1management/classes.rb +50 -90
- data/generated/google/apis/games_management_v1management/representations.rb +0 -17
- data/generated/google/apis/games_management_v1management/service.rb +115 -291
- data/generated/google/apis/gameservices_v1beta.rb +1 -1
- data/generated/google/apis/gameservices_v1beta/classes.rb +73 -60
- data/generated/google/apis/gameservices_v1beta/service.rb +60 -57
- data/generated/google/apis/gmail_v1.rb +2 -3
- data/generated/google/apis/gmail_v1/classes.rb +199 -258
- data/generated/google/apis/gmail_v1/service.rb +744 -552
- data/generated/google/apis/healthcare_v1.rb +1 -1
- data/generated/google/apis/healthcare_v1/classes.rb +34 -22
- data/generated/google/apis/healthcare_v1/service.rb +46 -111
- data/generated/google/apis/healthcare_v1beta1.rb +1 -1
- data/generated/google/apis/healthcare_v1beta1/classes.rb +34 -22
- data/generated/google/apis/healthcare_v1beta1/service.rb +63 -113
- data/generated/google/apis/iap_v1.rb +1 -1
- data/generated/google/apis/iap_v1/classes.rb +35 -12
- data/generated/google/apis/iap_v1/representations.rb +1 -0
- data/generated/google/apis/iap_v1/service.rb +1 -1
- data/generated/google/apis/iap_v1beta1.rb +1 -1
- data/generated/google/apis/iap_v1beta1/classes.rb +26 -10
- data/generated/google/apis/jobs_v3p1beta1.rb +1 -1
- data/generated/google/apis/osconfig_v1.rb +1 -1
- data/generated/google/apis/osconfig_v1/classes.rb +29 -27
- data/generated/google/apis/osconfig_v1beta.rb +1 -1
- data/generated/google/apis/osconfig_v1beta/classes.rb +17 -20
- data/generated/google/apis/run_v1.rb +1 -1
- data/generated/google/apis/run_v1/classes.rb +31 -49
- data/generated/google/apis/run_v1/representations.rb +1 -17
- data/generated/google/apis/run_v1/service.rb +3 -0
- data/generated/google/apis/run_v1alpha1.rb +1 -1
- data/generated/google/apis/run_v1alpha1/classes.rb +23 -10
- data/generated/google/apis/run_v1alpha1/service.rb +3 -0
- data/generated/google/apis/sheets_v4.rb +1 -1
- data/generated/google/apis/spanner_v1.rb +1 -1
- data/generated/google/apis/storage_v1.rb +1 -1
- data/generated/google/apis/storage_v1/classes.rb +18 -0
- data/generated/google/apis/storage_v1/representations.rb +3 -0
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +3 -2
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/toolresults_v1beta3/classes.rb +141 -2
- data/generated/google/apis/toolresults_v1beta3/representations.rb +77 -0
- data/generated/google/apis/youtube_partner_v1.rb +1 -1
- data/lib/google/apis/version.rb +1 -1
- metadata +3 -3
@@ -120,13 +120,13 @@ module Google
|
|
120
120
|
execute_or_queue_command(command, &block)
|
121
121
|
end
|
122
122
|
|
123
|
-
# Creates a new
|
123
|
+
# Creates a new game server deployment in a given project and location.
|
124
124
|
# @param [String] parent
|
125
125
|
# Required. The parent resource name. Uses the form:
|
126
126
|
# `projects/`project`/locations/`location``.
|
127
127
|
# @param [Google::Apis::GameservicesV1beta::GameServerDeployment] game_server_deployment_object
|
128
128
|
# @param [String] deployment_id
|
129
|
-
# Required. The ID of the
|
129
|
+
# Required. The ID of the game server delpoyment resource to be created.
|
130
130
|
# @param [String] fields
|
131
131
|
# Selector specifying which fields to include in a partial response.
|
132
132
|
# @param [String] quota_user
|
@@ -157,9 +157,9 @@ module Google
|
|
157
157
|
execute_or_queue_command(command, &block)
|
158
158
|
end
|
159
159
|
|
160
|
-
# Deletes a single
|
160
|
+
# Deletes a single game server deployment.
|
161
161
|
# @param [String] name
|
162
|
-
# Required. The name of the
|
162
|
+
# Required. The name of the game server delpoyment to delete. Uses the form:
|
163
163
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment``.
|
164
164
|
# @param [String] fields
|
165
165
|
# Selector specifying which fields to include in a partial response.
|
@@ -188,11 +188,11 @@ module Google
|
|
188
188
|
execute_or_queue_command(command, &block)
|
189
189
|
end
|
190
190
|
|
191
|
-
# Retrieves information about the current state of the
|
192
|
-
#
|
193
|
-
# including fleets running an older version of the
|
191
|
+
# Retrieves information about the current state of the game server
|
192
|
+
# deployment. Gathers all the Agones fleets and Agones autoscalers,
|
193
|
+
# including fleets running an older version of the game server deployment.
|
194
194
|
# @param [String] name
|
195
|
-
# Required. The name of the
|
195
|
+
# Required. The name of the game server delpoyment. Uses the form:
|
196
196
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment``.
|
197
197
|
# @param [Google::Apis::GameservicesV1beta::FetchDeploymentStateRequest] fetch_deployment_state_request_object
|
198
198
|
# @param [String] fields
|
@@ -224,9 +224,9 @@ module Google
|
|
224
224
|
execute_or_queue_command(command, &block)
|
225
225
|
end
|
226
226
|
|
227
|
-
# Gets details of a single
|
227
|
+
# Gets details of a single game server deployment.
|
228
228
|
# @param [String] name
|
229
|
-
# Required. The name of the
|
229
|
+
# Required. The name of the game server delpoyment to retrieve. Uses the form:
|
230
230
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment``.
|
231
231
|
# @param [String] fields
|
232
232
|
# Selector specifying which fields to include in a partial response.
|
@@ -268,6 +268,9 @@ module Google
|
|
268
268
|
# Requests for policies with any conditional bindings must specify version 3.
|
269
269
|
# Policies without any conditional bindings may specify any valid value or
|
270
270
|
# leave the field unset.
|
271
|
+
# To learn which resources support conditions in their IAM policies, see the
|
272
|
+
# [IAM
|
273
|
+
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
271
274
|
# @param [String] fields
|
272
275
|
# Selector specifying which fields to include in a partial response.
|
273
276
|
# @param [String] quota_user
|
@@ -296,9 +299,9 @@ module Google
|
|
296
299
|
execute_or_queue_command(command, &block)
|
297
300
|
end
|
298
301
|
|
299
|
-
# Gets details a single
|
302
|
+
# Gets details a single game server deployment rollout.
|
300
303
|
# @param [String] name
|
301
|
-
# Required. The name of the
|
304
|
+
# Required. The name of the game server delpoyment to retrieve. Uses the form:
|
302
305
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
303
306
|
# rollout`.
|
304
307
|
# @param [String] fields
|
@@ -328,7 +331,7 @@ module Google
|
|
328
331
|
execute_or_queue_command(command, &block)
|
329
332
|
end
|
330
333
|
|
331
|
-
# Lists
|
334
|
+
# Lists game server deployments in a given project and location.
|
332
335
|
# @param [String] parent
|
333
336
|
# Required. The parent resource name. Uses the form:
|
334
337
|
# `projects/`project`/locations/`location``.
|
@@ -338,8 +341,8 @@ module Google
|
|
338
341
|
# Optional. Specifies the ordering of results following syntax at
|
339
342
|
# https://cloud.google.com/apis/design/design_patterns#sorting_order.
|
340
343
|
# @param [Fixnum] page_size
|
341
|
-
# Optional. The maximum number of items to return. If unspecified, server
|
342
|
-
# will pick an appropriate default.
|
344
|
+
# Optional. The maximum number of items to return. If unspecified, the server
|
345
|
+
# will pick an appropriate default. The server may return fewer items than
|
343
346
|
# requested. A caller should only rely on response's
|
344
347
|
# next_page_token to
|
345
348
|
# determine if there are more GameServerDeployments left to be queried.
|
@@ -377,9 +380,9 @@ module Google
|
|
377
380
|
execute_or_queue_command(command, &block)
|
378
381
|
end
|
379
382
|
|
380
|
-
# Patches a
|
383
|
+
# Patches a game server deployment.
|
381
384
|
# @param [String] name
|
382
|
-
# The resource name of the
|
385
|
+
# The resource name of the game server deployment. Uses the form:
|
383
386
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment``.
|
384
387
|
# For example,
|
385
388
|
# `projects/my-project/locations/`location`/gameServerDeployments/my-deployment`.
|
@@ -420,10 +423,10 @@ module Google
|
|
420
423
|
execute_or_queue_command(command, &block)
|
421
424
|
end
|
422
425
|
|
423
|
-
# Previews the
|
424
|
-
#
|
426
|
+
# Previews the game server deployment rollout. This API does not mutate the
|
427
|
+
# rollout resource.
|
425
428
|
# @param [String] name
|
426
|
-
# The resource name of the
|
429
|
+
# The resource name of the game server deployment rollout. Uses the form:
|
427
430
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
428
431
|
# rollout`.
|
429
432
|
# For example,
|
@@ -433,7 +436,7 @@ module Google
|
|
433
436
|
# @param [String] preview_time
|
434
437
|
# Optional. The target timestamp to compute the preview. Defaults to the
|
435
438
|
# immediately
|
436
|
-
# after the proposed
|
439
|
+
# after the proposed rollout completes.
|
437
440
|
# @param [String] update_mask
|
438
441
|
# Optional. Mask of fields to update. At least one path must be supplied in
|
439
442
|
# this field. For the `FieldMask` definition, see
|
@@ -546,14 +549,14 @@ module Google
|
|
546
549
|
execute_or_queue_command(command, &block)
|
547
550
|
end
|
548
551
|
|
549
|
-
# Patches a single
|
552
|
+
# Patches a single game server deployment rollout.
|
550
553
|
# The method will not return an error if the update does not affect any
|
551
554
|
# existing realms. For example - if the default_game_server_config is changed
|
552
555
|
# but all existing realms use the override, that is valid. Similarly, if a
|
553
556
|
# non existing realm is explicitly called out in game_server_config_overrides
|
554
557
|
# field, that will also not result in an error.
|
555
558
|
# @param [String] name
|
556
|
-
# The resource name of the
|
559
|
+
# The resource name of the game server deployment rollout. Uses the form:
|
557
560
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
558
561
|
# rollout`.
|
559
562
|
# For example,
|
@@ -596,15 +599,15 @@ module Google
|
|
596
599
|
execute_or_queue_command(command, &block)
|
597
600
|
end
|
598
601
|
|
599
|
-
# Creates a new
|
600
|
-
#
|
601
|
-
# until referenced in the
|
602
|
+
# Creates a new game server config in a given project, location, and game
|
603
|
+
# server deployment. Game server configs are immutable, and are not applied
|
604
|
+
# until referenced in the game server deployment rollout resource.
|
602
605
|
# @param [String] parent
|
603
606
|
# Required. The parent resource name. Uses the form:
|
604
607
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/`.
|
605
608
|
# @param [Google::Apis::GameservicesV1beta::GameServerConfig] game_server_config_object
|
606
609
|
# @param [String] config_id
|
607
|
-
# Required. The ID of the
|
610
|
+
# Required. The ID of the game server config resource to be created.
|
608
611
|
# @param [String] fields
|
609
612
|
# Selector specifying which fields to include in a partial response.
|
610
613
|
# @param [String] quota_user
|
@@ -635,10 +638,10 @@ module Google
|
|
635
638
|
execute_or_queue_command(command, &block)
|
636
639
|
end
|
637
640
|
|
638
|
-
# Deletes a single
|
639
|
-
#
|
641
|
+
# Deletes a single game server config. The deletion will fail if the game
|
642
|
+
# server config is referenced in a game server deployment rollout.
|
640
643
|
# @param [String] name
|
641
|
-
# Required. The name of the
|
644
|
+
# Required. The name of the game server config to delete. Uses the form:
|
642
645
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
643
646
|
# configs/`config``.
|
644
647
|
# @param [String] fields
|
@@ -668,9 +671,9 @@ module Google
|
|
668
671
|
execute_or_queue_command(command, &block)
|
669
672
|
end
|
670
673
|
|
671
|
-
# Gets details of a single
|
674
|
+
# Gets details of a single game server config.
|
672
675
|
# @param [String] name
|
673
|
-
# Required. The name of the
|
676
|
+
# Required. The name of the game server config to retrieve. Uses the form:
|
674
677
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
675
678
|
# configs/`config``.
|
676
679
|
# @param [String] fields
|
@@ -700,8 +703,8 @@ module Google
|
|
700
703
|
execute_or_queue_command(command, &block)
|
701
704
|
end
|
702
705
|
|
703
|
-
# Lists
|
704
|
-
#
|
706
|
+
# Lists game server configs in a given project, location, and game server
|
707
|
+
# deployment.
|
705
708
|
# @param [String] parent
|
706
709
|
# Required. The parent resource name. Uses the form:
|
707
710
|
# `projects/`project`/locations/`location`/gameServerDeployments/`deployment`/
|
@@ -718,7 +721,7 @@ module Google
|
|
718
721
|
# next_page_token to
|
719
722
|
# determine if there are more GameServerConfigs left to be queried.
|
720
723
|
# @param [String] page_token
|
721
|
-
# Optional. The next_page_token value returned from a previous
|
724
|
+
# Optional. The next_page_token value returned from a previous list request, if
|
722
725
|
# any.
|
723
726
|
# @param [String] fields
|
724
727
|
# Selector specifying which fields to include in a partial response.
|
@@ -905,13 +908,13 @@ module Google
|
|
905
908
|
execute_or_queue_command(command, &block)
|
906
909
|
end
|
907
910
|
|
908
|
-
# Creates a new
|
911
|
+
# Creates a new realm in a given project and location.
|
909
912
|
# @param [String] parent
|
910
913
|
# Required. The parent resource name. Uses the form:
|
911
914
|
# `projects/`project`/locations/`location``.
|
912
915
|
# @param [Google::Apis::GameservicesV1beta::Realm] realm_object
|
913
916
|
# @param [String] realm_id
|
914
|
-
# Required. The ID of the
|
917
|
+
# Required. The ID of the realm resource to be created.
|
915
918
|
# @param [String] fields
|
916
919
|
# Selector specifying which fields to include in a partial response.
|
917
920
|
# @param [String] quota_user
|
@@ -942,9 +945,9 @@ module Google
|
|
942
945
|
execute_or_queue_command(command, &block)
|
943
946
|
end
|
944
947
|
|
945
|
-
# Deletes a single
|
948
|
+
# Deletes a single realm.
|
946
949
|
# @param [String] name
|
947
|
-
# Required. The name of the
|
950
|
+
# Required. The name of the realm to delete. Uses the form:
|
948
951
|
# `projects/`project`/locations/`location`/realms/`realm``.
|
949
952
|
# @param [String] fields
|
950
953
|
# Selector specifying which fields to include in a partial response.
|
@@ -973,9 +976,9 @@ module Google
|
|
973
976
|
execute_or_queue_command(command, &block)
|
974
977
|
end
|
975
978
|
|
976
|
-
# Gets details of a single
|
979
|
+
# Gets details of a single realm.
|
977
980
|
# @param [String] name
|
978
|
-
# Required. The name of the
|
981
|
+
# Required. The name of the realm to retrieve. Uses the form:
|
979
982
|
# `projects/`project`/locations/`location`/realms/`realm``.
|
980
983
|
# @param [String] fields
|
981
984
|
# Selector specifying which fields to include in a partial response.
|
@@ -1004,7 +1007,7 @@ module Google
|
|
1004
1007
|
execute_or_queue_command(command, &block)
|
1005
1008
|
end
|
1006
1009
|
|
1007
|
-
# Lists
|
1010
|
+
# Lists realms in a given project and location.
|
1008
1011
|
# @param [String] parent
|
1009
1012
|
# Required. The parent resource name. Uses the form:
|
1010
1013
|
# `projects/`project`/locations/`location``.
|
@@ -1018,7 +1021,7 @@ module Google
|
|
1018
1021
|
# will pick an appropriate default. Server may return fewer items than
|
1019
1022
|
# requested. A caller should only rely on response's
|
1020
1023
|
# next_page_token to
|
1021
|
-
# determine if there are more
|
1024
|
+
# determine if there are more realms left to be queried.
|
1022
1025
|
# @param [String] page_token
|
1023
1026
|
# Optional. The next_page_token value returned from a previous List request,
|
1024
1027
|
# if any.
|
@@ -1053,9 +1056,9 @@ module Google
|
|
1053
1056
|
execute_or_queue_command(command, &block)
|
1054
1057
|
end
|
1055
1058
|
|
1056
|
-
# Patches a single
|
1059
|
+
# Patches a single realm.
|
1057
1060
|
# @param [String] name
|
1058
|
-
# The resource name of the
|
1061
|
+
# The resource name of the realm. Uses the form:
|
1059
1062
|
# `projects/`project`/locations/`location`/realms/`realm``. For
|
1060
1063
|
# example, `projects/my-project/locations/`location`/realms/my-realm`.
|
1061
1064
|
# @param [Google::Apis::GameservicesV1beta::Realm] realm_object
|
@@ -1095,9 +1098,9 @@ module Google
|
|
1095
1098
|
execute_or_queue_command(command, &block)
|
1096
1099
|
end
|
1097
1100
|
|
1098
|
-
# Previews patches to a single
|
1101
|
+
# Previews patches to a single realm.
|
1099
1102
|
# @param [String] name
|
1100
|
-
# The resource name of the
|
1103
|
+
# The resource name of the realm. Uses the form:
|
1101
1104
|
# `projects/`project`/locations/`location`/realms/`realm``. For
|
1102
1105
|
# example, `projects/my-project/locations/`location`/realms/my-realm`.
|
1103
1106
|
# @param [Google::Apis::GameservicesV1beta::Realm] realm_object
|
@@ -1146,7 +1149,7 @@ module Google
|
|
1146
1149
|
# `projects/`project`/locations/`location`/realms/`realm-id``.
|
1147
1150
|
# @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object
|
1148
1151
|
# @param [String] game_server_cluster_id
|
1149
|
-
# Required. The ID of the
|
1152
|
+
# Required. The ID of the game server cluster resource to be created.
|
1150
1153
|
# @param [String] fields
|
1151
1154
|
# Selector specifying which fields to include in a partial response.
|
1152
1155
|
# @param [String] quota_user
|
@@ -1179,7 +1182,7 @@ module Google
|
|
1179
1182
|
|
1180
1183
|
# Deletes a single game server cluster.
|
1181
1184
|
# @param [String] name
|
1182
|
-
# Required. The name of the
|
1185
|
+
# Required. The name of the game server cluster to delete. Uses the form:
|
1183
1186
|
# `projects/`project`/locations/`location`/gameServerClusters/`cluster``.
|
1184
1187
|
# @param [String] fields
|
1185
1188
|
# Selector specifying which fields to include in a partial response.
|
@@ -1210,7 +1213,7 @@ module Google
|
|
1210
1213
|
|
1211
1214
|
# Gets details of a single game server cluster.
|
1212
1215
|
# @param [String] name
|
1213
|
-
# Required. The name of the
|
1216
|
+
# Required. The name of the game server cluster to retrieve. Uses the form:
|
1214
1217
|
# `projects/`project`/locations/`location`/realms/`realm-id`/gameServerClusters/`
|
1215
1218
|
# cluster``.
|
1216
1219
|
# @param [String] fields
|
@@ -1240,7 +1243,7 @@ module Google
|
|
1240
1243
|
execute_or_queue_command(command, &block)
|
1241
1244
|
end
|
1242
1245
|
|
1243
|
-
# Lists
|
1246
|
+
# Lists game server clusters in a given project and location.
|
1244
1247
|
# @param [String] parent
|
1245
1248
|
# Required. The parent resource name. Uses the form:
|
1246
1249
|
# "projects/`project`/locations/`location`/realms/`realm`".
|
@@ -1250,8 +1253,8 @@ module Google
|
|
1250
1253
|
# Optional. Specifies the ordering of results following syntax at
|
1251
1254
|
# https://cloud.google.com/apis/design/design_patterns#sorting_order.
|
1252
1255
|
# @param [Fixnum] page_size
|
1253
|
-
# Optional. The maximum number of items to return. If unspecified, server
|
1254
|
-
# will pick an appropriate default.
|
1256
|
+
# Optional. The maximum number of items to return. If unspecified, the server
|
1257
|
+
# will pick an appropriate default. The server may return fewer items than
|
1255
1258
|
# requested. A caller should only rely on response's
|
1256
1259
|
# next_page_token to
|
1257
1260
|
# determine if there are more GameServerClusters left to be queried.
|
@@ -1291,7 +1294,7 @@ module Google
|
|
1291
1294
|
|
1292
1295
|
# Patches a single game server cluster.
|
1293
1296
|
# @param [String] name
|
1294
|
-
# Required. The resource name of the
|
1297
|
+
# Required. The resource name of the game server cluster. Uses the form:
|
1295
1298
|
# `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/`
|
1296
1299
|
# cluster``.
|
1297
1300
|
# For example,
|
@@ -1341,7 +1344,7 @@ module Google
|
|
1341
1344
|
# `projects/`project`/locations/`location`/realms/`realm``.
|
1342
1345
|
# @param [Google::Apis::GameservicesV1beta::GameServerCluster] game_server_cluster_object
|
1343
1346
|
# @param [String] game_server_cluster_id
|
1344
|
-
# Required. The ID of the
|
1347
|
+
# Required. The ID of the game server cluster resource to be created.
|
1345
1348
|
# @param [String] preview_time
|
1346
1349
|
# Optional. The target timestamp to compute the preview.
|
1347
1350
|
# @param [String] fields
|
@@ -1377,7 +1380,7 @@ module Google
|
|
1377
1380
|
|
1378
1381
|
# Previews deletion of a single game server cluster.
|
1379
1382
|
# @param [String] name
|
1380
|
-
# Required. The name of the
|
1383
|
+
# Required. The name of the game server cluster to delete. Uses the form:
|
1381
1384
|
# `projects/`project`/locations/`location`/gameServerClusters/`cluster``.
|
1382
1385
|
# @param [String] preview_time
|
1383
1386
|
# Optional. The target timestamp to compute the preview.
|
@@ -1411,7 +1414,7 @@ module Google
|
|
1411
1414
|
|
1412
1415
|
# Previews updating a GameServerCluster.
|
1413
1416
|
# @param [String] name
|
1414
|
-
# Required. The resource name of the
|
1417
|
+
# Required. The resource name of the game server cluster. Uses the form:
|
1415
1418
|
# `projects/`project`/locations/`location`/realms/`realm`/gameServerClusters/`
|
1416
1419
|
# cluster``.
|
1417
1420
|
# For example,
|
@@ -20,13 +20,12 @@ module Google
|
|
20
20
|
module Apis
|
21
21
|
# Gmail API
|
22
22
|
#
|
23
|
-
#
|
24
|
-
# threads, messages, and labels.
|
23
|
+
# Access Gmail mailboxes including sending user email.
|
25
24
|
#
|
26
25
|
# @see https://developers.google.com/gmail/api/
|
27
26
|
module GmailV1
|
28
27
|
VERSION = 'V1'
|
29
|
-
REVISION = '
|
28
|
+
REVISION = '20200504'
|
30
29
|
|
31
30
|
# Read, compose, send, and permanently delete all your email from Gmail
|
32
31
|
AUTH_SCOPE = 'https://mail.google.com/'
|
@@ -31,8 +31,8 @@ module Google
|
|
31
31
|
# @return [String]
|
32
32
|
attr_accessor :disposition
|
33
33
|
|
34
|
-
# Email address to which all incoming messages are forwarded.
|
35
|
-
#
|
34
|
+
# Email address to which all incoming messages are forwarded. This email address
|
35
|
+
# must be a verified member of the forwarding addresses.
|
36
36
|
# Corresponds to the JSON property `emailAddress`
|
37
37
|
# @return [String]
|
38
38
|
attr_accessor :email_address
|
@@ -83,8 +83,7 @@ module Google
|
|
83
83
|
# @return [Array<String>]
|
84
84
|
attr_accessor :add_label_ids
|
85
85
|
|
86
|
-
# The IDs of the messages to modify. There is a limit of 1000 ids per
|
87
|
-
# request.
|
86
|
+
# The IDs of the messages to modify. There is a limit of 1000 ids per request.
|
88
87
|
# Corresponds to the JSON property `ids`
|
89
88
|
# @return [Array<String>]
|
90
89
|
attr_accessor :ids
|
@@ -107,9 +106,8 @@ module Google
|
|
107
106
|
end
|
108
107
|
|
109
108
|
# Settings for a delegate. Delegates can read, send, and delete messages, as
|
110
|
-
# well as view and add contacts, for the delegator's account. See
|
111
|
-
#
|
112
|
-
# mail delegation"</a> for more information about delegates.
|
109
|
+
# well as view and add contacts, for the delegator's account. See "Set up mail
|
110
|
+
# delegation" for more information about delegates.
|
113
111
|
class Delegate
|
114
112
|
include Google::Apis::Core::Hashable
|
115
113
|
|
@@ -118,8 +116,8 @@ module Google
|
|
118
116
|
# @return [String]
|
119
117
|
attr_accessor :delegate_email
|
120
118
|
|
121
|
-
# Indicates whether this address has been verified and can act as a delegate
|
122
|
-
#
|
119
|
+
# Indicates whether this address has been verified and can act as a delegate for
|
120
|
+
# the account. Read-only.
|
123
121
|
# Corresponds to the JSON property `verificationStatus`
|
124
122
|
# @return [String]
|
125
123
|
attr_accessor :verification_status
|
@@ -244,18 +242,16 @@ module Google
|
|
244
242
|
attr_accessor :has_attachment
|
245
243
|
alias_method :has_attachment?, :has_attachment
|
246
244
|
|
247
|
-
# Only return messages not matching the specified query. Supports the same
|
248
|
-
#
|
249
|
-
#
|
250
|
-
# is:unread"</code>.
|
245
|
+
# Only return messages not matching the specified query. Supports the same query
|
246
|
+
# format as the Gmail search box. For example, "from:someuser@example.com
|
247
|
+
# rfc822msgid: is:unread".
|
251
248
|
# Corresponds to the JSON property `negatedQuery`
|
252
249
|
# @return [String]
|
253
250
|
attr_accessor :negated_query
|
254
251
|
|
255
|
-
# Only return messages matching the specified query. Supports the same
|
256
|
-
#
|
257
|
-
#
|
258
|
-
# is:unread"</code>.
|
252
|
+
# Only return messages matching the specified query. Supports the same query
|
253
|
+
# format as the Gmail search box. For example, "from:someuser@example.com
|
254
|
+
# rfc822msgid: is:unread".
|
259
255
|
# Corresponds to the JSON property `query`
|
260
256
|
# @return [String]
|
261
257
|
attr_accessor :query
|
@@ -271,16 +267,16 @@ module Google
|
|
271
267
|
# @return [String]
|
272
268
|
attr_accessor :size_comparison
|
273
269
|
|
274
|
-
# Case-insensitive phrase found in the message's subject. Trailing and
|
275
|
-
#
|
270
|
+
# Case-insensitive phrase found in the message's subject. Trailing and leading
|
271
|
+
# whitespace are be trimmed and adjacent spaces are collapsed.
|
276
272
|
# Corresponds to the JSON property `subject`
|
277
273
|
# @return [String]
|
278
274
|
attr_accessor :subject
|
279
275
|
|
280
|
-
# The recipient's display name or email address. Includes recipients in the
|
281
|
-
# "
|
282
|
-
#
|
283
|
-
#
|
276
|
+
# The recipient's display name or email address. Includes recipients in the "to",
|
277
|
+
# "cc", and "bcc" header fields. You can use simply the local part of the email
|
278
|
+
# address. For example, "example" and "example@" both match "example@gmail.com".
|
279
|
+
# This field is case-insensitive.
|
284
280
|
# Corresponds to the JSON property `to`
|
285
281
|
# @return [String]
|
286
282
|
attr_accessor :to
|
@@ -312,8 +308,8 @@ module Google
|
|
312
308
|
# @return [String]
|
313
309
|
attr_accessor :forwarding_email
|
314
310
|
|
315
|
-
# Indicates whether this address has been verified and is usable for
|
316
|
-
#
|
311
|
+
# Indicates whether this address has been verified and is usable for forwarding.
|
312
|
+
# Read-only.
|
317
313
|
# Corresponds to the JSON property `verificationStatus`
|
318
314
|
# @return [String]
|
319
315
|
attr_accessor :verification_status
|
@@ -349,10 +345,9 @@ module Google
|
|
349
345
|
# @return [Array<Google::Apis::GmailV1::HistoryLabelRemoved>]
|
350
346
|
attr_accessor :labels_removed
|
351
347
|
|
352
|
-
# List of messages changed in this history record.
|
353
|
-
# change types, such as
|
354
|
-
#
|
355
|
-
# of this.
|
348
|
+
# List of messages changed in this history record. The fields for specific
|
349
|
+
# change types, such as messagesAdded may duplicate messages in this field. We
|
350
|
+
# recommend using the specific change-type fields instead of this.
|
356
351
|
# Corresponds to the JSON property `messages`
|
357
352
|
# @return [Array<Google::Apis::GmailV1::Message>]
|
358
353
|
attr_accessor :messages
|
@@ -475,8 +470,8 @@ module Google
|
|
475
470
|
include Google::Apis::Core::Hashable
|
476
471
|
|
477
472
|
# If this value is true, Gmail will immediately expunge a message when it is
|
478
|
-
# marked as deleted in IMAP.
|
479
|
-
#
|
473
|
+
# marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the
|
474
|
+
# client before expunging messages marked as deleted.
|
480
475
|
# Corresponds to the JSON property `autoExpunge`
|
481
476
|
# @return [Boolean]
|
482
477
|
attr_accessor :auto_expunge
|
@@ -488,15 +483,15 @@ module Google
|
|
488
483
|
attr_accessor :enabled
|
489
484
|
alias_method :enabled?, :enabled
|
490
485
|
|
491
|
-
# The action that will be executed on a message when it is marked as deleted
|
492
|
-
#
|
486
|
+
# The action that will be executed on a message when it is marked as deleted and
|
487
|
+
# expunged from the last visible IMAP folder.
|
493
488
|
# Corresponds to the JSON property `expungeBehavior`
|
494
489
|
# @return [String]
|
495
490
|
attr_accessor :expunge_behavior
|
496
491
|
|
497
|
-
# An optional limit on the number of messages that an IMAP folder may
|
498
|
-
#
|
499
|
-
#
|
492
|
+
# An optional limit on the number of messages that an IMAP folder may contain.
|
493
|
+
# Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted
|
494
|
+
# to mean that there is no limit.
|
500
495
|
# Corresponds to the JSON property `maxFolderSize`
|
501
496
|
# @return [Fixnum]
|
502
497
|
attr_accessor :max_folder_size
|
@@ -514,14 +509,12 @@ module Google
|
|
514
509
|
end
|
515
510
|
end
|
516
511
|
|
517
|
-
# Labels are used to categorize messages and threads within the
|
518
|
-
# user's mailbox.
|
512
|
+
# Labels are used to categorize messages and threads within the user's mailbox.
|
519
513
|
class Label
|
520
514
|
include Google::Apis::Core::Hashable
|
521
515
|
|
522
|
-
# The color to assign to the label. Color is only available for labels that
|
523
|
-
#
|
524
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
516
|
+
# The color to assign to the label. Color is only available for labels that have
|
517
|
+
# their type set to user.
|
525
518
|
# Corresponds to the JSON property `color`
|
526
519
|
# @return [Google::Apis::GmailV1::LabelColor]
|
527
520
|
attr_accessor :color
|
@@ -532,14 +525,11 @@ module Google
|
|
532
525
|
attr_accessor :id
|
533
526
|
|
534
527
|
# The visibility of the label in the label list in the Gmail web interface.
|
535
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
536
528
|
# Corresponds to the JSON property `labelListVisibility`
|
537
529
|
# @return [String]
|
538
530
|
attr_accessor :label_list_visibility
|
539
531
|
|
540
|
-
# The visibility of the label in the message list in the
|
541
|
-
# Gmail web interface.
|
542
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
532
|
+
# The visibility of the label in the message list in the Gmail web interface.
|
543
533
|
# Corresponds to the JSON property `messageListVisibility`
|
544
534
|
# @return [String]
|
545
535
|
attr_accessor :message_list_visibility
|
@@ -555,7 +545,6 @@ module Google
|
|
555
545
|
attr_accessor :messages_unread
|
556
546
|
|
557
547
|
# The display name of the label.
|
558
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
559
548
|
# Corresponds to the JSON property `name`
|
560
549
|
# @return [String]
|
561
550
|
attr_accessor :name
|
@@ -570,15 +559,14 @@ module Google
|
|
570
559
|
# @return [Fixnum]
|
571
560
|
attr_accessor :threads_unread
|
572
561
|
|
573
|
-
# The owner type for the label. User labels are created by the user and
|
574
|
-
#
|
575
|
-
#
|
576
|
-
#
|
577
|
-
#
|
578
|
-
#
|
579
|
-
#
|
580
|
-
# threads
|
581
|
-
# <code>SENT</code> labels from messages or threads.
|
562
|
+
# The owner type for the label. User labels are created by the user and can be
|
563
|
+
# modified and deleted by the user and can be applied to any message or thread.
|
564
|
+
# System labels are internally created and cannot be added, modified, or deleted.
|
565
|
+
# System labels may be able to be applied to or removed from messages and
|
566
|
+
# threads under some circumstances but this is not guaranteed. For example,
|
567
|
+
# users can apply and remove the INBOX and UNREAD labels from messages and
|
568
|
+
# threads, but cannot apply or remove the DRAFTS or SENT labels from messages or
|
569
|
+
# threads.
|
582
570
|
# Corresponds to the JSON property `type`
|
583
571
|
# @return [String]
|
584
572
|
attr_accessor :type
|
@@ -606,46 +594,40 @@ module Google
|
|
606
594
|
class LabelColor
|
607
595
|
include Google::Apis::Core::Hashable
|
608
596
|
|
609
|
-
# The background color represented as hex string #RRGGBB (ex #000000).
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
# #
|
614
|
-
# #
|
615
|
-
# #
|
616
|
-
# #
|
617
|
-
# #
|
618
|
-
# #
|
619
|
-
#
|
620
|
-
# #
|
621
|
-
# #
|
622
|
-
# #
|
623
|
-
# #
|
624
|
-
# # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
|
625
|
-
# # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
626
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
597
|
+
# The background color represented as hex string #RRGGBB (ex #000000). This
|
598
|
+
# field is required in order to set the color of a label. Only the following
|
599
|
+
# predefined set of color values are allowed:
|
600
|
+
# #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #
|
601
|
+
# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be,
|
602
|
+
# #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #
|
603
|
+
# ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b,
|
604
|
+
# #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #
|
605
|
+
# f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49,
|
606
|
+
# #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #
|
607
|
+
# 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5,
|
608
|
+
# #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #
|
609
|
+
# 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30,
|
610
|
+
# #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
611
|
+
# f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
627
612
|
# Corresponds to the JSON property `backgroundColor`
|
628
613
|
# @return [String]
|
629
614
|
attr_accessor :background_color
|
630
615
|
|
631
|
-
# The text color of the label, represented as hex string.
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
# #
|
636
|
-
# #
|
637
|
-
# #
|
638
|
-
# #
|
639
|
-
# #
|
640
|
-
# #
|
641
|
-
#
|
642
|
-
# #
|
643
|
-
# #
|
644
|
-
# #
|
645
|
-
# #
|
646
|
-
# # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46,
|
647
|
-
# # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
648
|
-
# @mutable gmail.users.labels.create gmail.users.labels.update
|
616
|
+
# The text color of the label, represented as hex string. This field is required
|
617
|
+
# in order to set the color of a label. Only the following predefined set of
|
618
|
+
# color values are allowed:
|
619
|
+
# #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #
|
620
|
+
# fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be,
|
621
|
+
# #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #
|
622
|
+
# ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b,
|
623
|
+
# #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #
|
624
|
+
# f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49,
|
625
|
+
# #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #
|
626
|
+
# 076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5,
|
627
|
+
# #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #
|
628
|
+
# 7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30,
|
629
|
+
# #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #
|
630
|
+
# f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765
|
649
631
|
# Corresponds to the JSON property `textColor`
|
650
632
|
# @return [String]
|
651
633
|
attr_accessor :text_color
|
@@ -661,28 +643,21 @@ module Google
|
|
661
643
|
end
|
662
644
|
end
|
663
645
|
|
664
|
-
# Language settings for an account. These settings correspond to
|
665
|
-
# the
|
666
|
-
# settings"</a> feature in the web interface.
|
646
|
+
# Language settings for an account. These settings correspond to the "Language
|
647
|
+
# settings" feature in the web interface.
|
667
648
|
class LanguageSettings
|
668
649
|
include Google::Apis::Core::Hashable
|
669
650
|
|
670
|
-
# The language to display Gmail in, formatted as an
|
671
|
-
#
|
672
|
-
#
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
# <a href="/gmail/api/guides/language_settings#display_language">Managing
|
681
|
-
# Language Settings guide</a>
|
682
|
-
# Not all Gmail clients can display the same set of languages. In the case
|
683
|
-
# that a user's display language is not available for use on a particular
|
684
|
-
# client, said client automatically chooses to display in the closest
|
685
|
-
# supported variant (or a reasonable default).
|
651
|
+
# The language to display Gmail in, formatted as an RFC 3066 Language Tag (for
|
652
|
+
# example en-GB, fr or ja for British English, French, or Japanese respectively).
|
653
|
+
# The set of languages supported by Gmail evolves over time, so please refer to
|
654
|
+
# the "Language" dropdown in the Gmail settings for all available options, as
|
655
|
+
# described in the language settings help article. A table of sample values is
|
656
|
+
# also provided in the Managing Language Settings guide
|
657
|
+
# Not all Gmail clients can display the same set of languages. In the case that
|
658
|
+
# a user's display language is not available for use on a particular client,
|
659
|
+
# said client automatically chooses to display in the closest supported variant (
|
660
|
+
# or a reasonable default).
|
686
661
|
# Corresponds to the JSON property `displayLanguage`
|
687
662
|
# @return [String]
|
688
663
|
attr_accessor :display_language
|
@@ -720,11 +695,9 @@ module Google
|
|
720
695
|
class ListDraftsResponse
|
721
696
|
include Google::Apis::Core::Hashable
|
722
697
|
|
723
|
-
# List of drafts. Note that the
|
724
|
-
#
|
725
|
-
#
|
726
|
-
# <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a>
|
727
|
-
# method can fetch additional message details.
|
698
|
+
# List of drafts. Note that the Message property in each Draft resource only
|
699
|
+
# contains an id and a threadId. The messages.get method can fetch additional
|
700
|
+
# message details.
|
728
701
|
# Corresponds to the JSON property `drafts`
|
729
702
|
# @return [Array<Google::Apis::GmailV1::Draft>]
|
730
703
|
attr_accessor :drafts
|
@@ -793,9 +766,8 @@ module Google
|
|
793
766
|
class ListHistoryResponse
|
794
767
|
include Google::Apis::Core::Hashable
|
795
768
|
|
796
|
-
# List of history records.
|
797
|
-
#
|
798
|
-
# <code>threadId</code> fields populated.
|
769
|
+
# List of history records. Any messages contained in the response will typically
|
770
|
+
# only have id and threadId fields populated.
|
799
771
|
# Corresponds to the JSON property `history`
|
800
772
|
# @return [Array<Google::Apis::GmailV1::History>]
|
801
773
|
attr_accessor :history
|
@@ -826,10 +798,8 @@ module Google
|
|
826
798
|
class ListLabelsResponse
|
827
799
|
include Google::Apis::Core::Hashable
|
828
800
|
|
829
|
-
# List of labels. Note that each label resource only contains an
|
830
|
-
#
|
831
|
-
# <code>labelListVisibility</code>, and <code>type</code>. The
|
832
|
-
# <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method
|
801
|
+
# List of labels. Note that each label resource only contains an id, name,
|
802
|
+
# messageListVisibility, labelListVisibility, and type. The labels.get method
|
833
803
|
# can fetch additional label details.
|
834
804
|
# Corresponds to the JSON property `labels`
|
835
805
|
# @return [Array<Google::Apis::GmailV1::Label>]
|
@@ -849,10 +819,8 @@ module Google
|
|
849
819
|
class ListMessagesResponse
|
850
820
|
include Google::Apis::Core::Hashable
|
851
821
|
|
852
|
-
# List of messages. Note that each message resource contains only an
|
853
|
-
#
|
854
|
-
# be fetched using the
|
855
|
-
# <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a>
|
822
|
+
# List of messages. Note that each message resource contains only an id and a
|
823
|
+
# threadId. Additional message details can be fetched using the messages.get
|
856
824
|
# method.
|
857
825
|
# Corresponds to the JSON property `messages`
|
858
826
|
# @return [Array<Google::Apis::GmailV1::Message>]
|
@@ -933,9 +901,8 @@ module Google
|
|
933
901
|
attr_accessor :result_size_estimate
|
934
902
|
|
935
903
|
# List of threads. Note that each thread resource does not contain a list of
|
936
|
-
#
|
937
|
-
#
|
938
|
-
# <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method.
|
904
|
+
# messages. The list of messages for a given thread can be fetched using the
|
905
|
+
# threads.get method.
|
939
906
|
# Corresponds to the JSON property `threads`
|
940
907
|
# @return [Array<Google::Apis::GmailV1::Thread>]
|
941
908
|
attr_accessor :threads
|
@@ -966,17 +933,16 @@ module Google
|
|
966
933
|
# @return [String]
|
967
934
|
attr_accessor :id
|
968
935
|
|
969
|
-
# The internal message creation timestamp (epoch ms), which determines
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
# be
|
936
|
+
# The internal message creation timestamp (epoch ms), which determines ordering
|
937
|
+
# in the inbox. For normal SMTP-received email, this represents the time the
|
938
|
+
# message was originally accepted by Google, which is more reliable than the
|
939
|
+
# Date header. However, for API-migrated mail, it can be configured by client to
|
940
|
+
# be based on the Date header.
|
974
941
|
# Corresponds to the JSON property `internalDate`
|
975
942
|
# @return [Fixnum]
|
976
943
|
attr_accessor :internal_date
|
977
944
|
|
978
945
|
# List of IDs of labels applied to this message.
|
979
|
-
# @mutable gmail.users.messages.insert gmail.users.messages.modify
|
980
946
|
# Corresponds to the JSON property `labelIds`
|
981
947
|
# @return [Array<String>]
|
982
948
|
attr_accessor :label_ids
|
@@ -986,12 +952,9 @@ module Google
|
|
986
952
|
# @return [Google::Apis::GmailV1::MessagePart]
|
987
953
|
attr_accessor :payload
|
988
954
|
|
989
|
-
# The entire email message in an RFC 2822 formatted and base64url
|
990
|
-
#
|
991
|
-
# <code>drafts.get</code> responses when the <code>format=RAW</code>
|
955
|
+
# The entire email message in an RFC 2822 formatted and base64url encoded string.
|
956
|
+
# Returned in messages.get and drafts.get responses when the format=RAW
|
992
957
|
# parameter is supplied.
|
993
|
-
# @mutable gmail.users.messages.insert gmail.users.messages.send
|
994
|
-
# @mutable gmail.users.drafts.create gmail.users.drafts.update
|
995
958
|
# Corresponds to the JSON property `raw`
|
996
959
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
997
960
|
# @return [String]
|
@@ -1007,17 +970,13 @@ module Google
|
|
1007
970
|
# @return [String]
|
1008
971
|
attr_accessor :snippet
|
1009
972
|
|
1010
|
-
# The ID of the thread the message belongs to. To add a message or draft to
|
1011
|
-
#
|
1012
|
-
#
|
1013
|
-
#
|
1014
|
-
#
|
1015
|
-
#
|
1016
|
-
#
|
1017
|
-
# <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li>
|
1018
|
-
# <li>The <code>Subject</code> headers must match.
|
1019
|
-
# @mutable gmail.users.messages.insert gmail.users.messages.send
|
1020
|
-
# @mutable gmail.users.drafts.create gmail.users.drafts.update
|
973
|
+
# The ID of the thread the message belongs to. To add a message or draft to a
|
974
|
+
# thread, the following criteria must be met:
|
975
|
+
# - The requested threadId must be specified on the Message or Draft.Message you
|
976
|
+
# supply with your request.
|
977
|
+
# - The References and In-Reply-To headers must be set in compliance with the
|
978
|
+
# RFC 2822 standard.
|
979
|
+
# - The Subject headers must match.
|
1021
980
|
# Corresponds to the JSON property `threadId`
|
1022
981
|
# @return [String]
|
1023
982
|
attr_accessor :thread_id
|
@@ -1049,16 +1008,15 @@ module Google
|
|
1049
1008
|
# @return [Google::Apis::GmailV1::MessagePartBody]
|
1050
1009
|
attr_accessor :body
|
1051
1010
|
|
1052
|
-
# The filename of the attachment. Only present if this message part
|
1053
|
-
#
|
1011
|
+
# The filename of the attachment. Only present if this message part represents
|
1012
|
+
# an attachment.
|
1054
1013
|
# Corresponds to the JSON property `filename`
|
1055
1014
|
# @return [String]
|
1056
1015
|
attr_accessor :filename
|
1057
1016
|
|
1058
1017
|
# List of headers on this message part. For the top-level message part,
|
1059
|
-
# representing the entire message payload, it will contain the standard
|
1060
|
-
#
|
1061
|
-
# <code>Subject</code>.
|
1018
|
+
# representing the entire message payload, it will contain the standard RFC 2822
|
1019
|
+
# email headers such as To, From, and Subject.
|
1062
1020
|
# Corresponds to the JSON property `headers`
|
1063
1021
|
# @return [Array<Google::Apis::GmailV1::MessagePartHeader>]
|
1064
1022
|
attr_accessor :headers
|
@@ -1073,11 +1031,10 @@ module Google
|
|
1073
1031
|
# @return [String]
|
1074
1032
|
attr_accessor :part_id
|
1075
1033
|
|
1076
|
-
# The child MIME message parts of this part. This only applies to container
|
1077
|
-
#
|
1078
|
-
#
|
1079
|
-
#
|
1080
|
-
# <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>.
|
1034
|
+
# The child MIME message parts of this part. This only applies to container MIME
|
1035
|
+
# message parts, for example multipart/*. For non- container MIME message part
|
1036
|
+
# types, such as text/plain, this field is empty. For more information, see RFC
|
1037
|
+
# 1521.
|
1081
1038
|
# Corresponds to the JSON property `parts`
|
1082
1039
|
# @return [Array<Google::Apis::GmailV1::MessagePart>]
|
1083
1040
|
attr_accessor :parts
|
@@ -1101,19 +1058,17 @@ module Google
|
|
1101
1058
|
class MessagePartBody
|
1102
1059
|
include Google::Apis::Core::Hashable
|
1103
1060
|
|
1104
|
-
# When present, contains the ID of an external attachment that can be
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
# contained in the data field.
|
1061
|
+
# When present, contains the ID of an external attachment that can be retrieved
|
1062
|
+
# in a separate messages.attachments.get request. When not present, the entire
|
1063
|
+
# content of the message part body is contained in the data field.
|
1108
1064
|
# Corresponds to the JSON property `attachmentId`
|
1109
1065
|
# @return [String]
|
1110
1066
|
attr_accessor :attachment_id
|
1111
1067
|
|
1112
|
-
# The body data of a MIME message part as a base64url encoded string.
|
1113
|
-
#
|
1114
|
-
#
|
1115
|
-
#
|
1116
|
-
# contained in a separate attachment.
|
1068
|
+
# The body data of a MIME message part as a base64url encoded string. May be
|
1069
|
+
# empty for MIME container types that have no message body or when the body data
|
1070
|
+
# is sent as a separate attachment. An attachment ID is present if the body data
|
1071
|
+
# is contained in a separate attachment.
|
1117
1072
|
# Corresponds to the JSON property `data`
|
1118
1073
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
1119
1074
|
# @return [String]
|
@@ -1140,14 +1095,13 @@ module Google
|
|
1140
1095
|
class MessagePartHeader
|
1141
1096
|
include Google::Apis::Core::Hashable
|
1142
1097
|
|
1143
|
-
# The name of the header before the
|
1144
|
-
# example, <code>To</code>.
|
1098
|
+
# The name of the header before the : separator. For example, To.
|
1145
1099
|
# Corresponds to the JSON property `name`
|
1146
1100
|
# @return [String]
|
1147
1101
|
attr_accessor :name
|
1148
1102
|
|
1149
|
-
# The value of the header after the
|
1150
|
-
#
|
1103
|
+
# The value of the header after the : separator. For example, someuser@example.
|
1104
|
+
# com.
|
1151
1105
|
# Corresponds to the JSON property `value`
|
1152
1106
|
# @return [String]
|
1153
1107
|
attr_accessor :value
|
@@ -1277,53 +1231,48 @@ module Google
|
|
1277
1231
|
end
|
1278
1232
|
|
1279
1233
|
# Settings associated with a send-as alias, which can be either the primary
|
1280
|
-
# login address associated with the account or a custom "from" address.
|
1281
|
-
#
|
1282
|
-
# <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a>
|
1283
|
-
# feature in the web interface.
|
1234
|
+
# login address associated with the account or a custom "from" address. Send-as
|
1235
|
+
# aliases correspond to the "Send Mail As" feature in the web interface.
|
1284
1236
|
class SendAs
|
1285
1237
|
include Google::Apis::Core::Hashable
|
1286
1238
|
|
1287
|
-
# A name that appears in the "From:" header for mail sent using this alias.
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1292
|
-
# format, requests to update this field for the primary login will silently
|
1293
|
-
# fail.
|
1239
|
+
# A name that appears in the "From:" header for mail sent using this alias. For
|
1240
|
+
# custom "from" addresses, when this is empty, Gmail will populate the "From:"
|
1241
|
+
# header with the name that is used for the primary address associated with the
|
1242
|
+
# account. If the admin has disabled the ability for users to update their name
|
1243
|
+
# format, requests to update this field for the primary login will silently fail.
|
1294
1244
|
# Corresponds to the JSON property `displayName`
|
1295
1245
|
# @return [String]
|
1296
1246
|
attr_accessor :display_name
|
1297
1247
|
|
1298
|
-
# Whether this address is selected as the default "From:" address in
|
1299
|
-
#
|
1300
|
-
#
|
1301
|
-
#
|
1302
|
-
#
|
1303
|
-
#
|
1304
|
-
# <code>false</code> for the other previous default address.
|
1248
|
+
# Whether this address is selected as the default "From:" address in situations
|
1249
|
+
# such as composing a new message or sending a vacation auto-reply. Every Gmail
|
1250
|
+
# account has exactly one default send-as address, so the only legal value that
|
1251
|
+
# clients may write to this field is true. Changing this from false to true for
|
1252
|
+
# an address will result in this field becoming false for the other previous
|
1253
|
+
# default address.
|
1305
1254
|
# Corresponds to the JSON property `isDefault`
|
1306
1255
|
# @return [Boolean]
|
1307
1256
|
attr_accessor :is_default
|
1308
1257
|
alias_method :is_default?, :is_default
|
1309
1258
|
|
1310
1259
|
# Whether this address is the primary address used to login to the account.
|
1311
|
-
# Every Gmail account has exactly one primary address, and it cannot be
|
1312
|
-
#
|
1260
|
+
# Every Gmail account has exactly one primary address, and it cannot be deleted
|
1261
|
+
# from the collection of send-as aliases. This field is read-only.
|
1313
1262
|
# Corresponds to the JSON property `isPrimary`
|
1314
1263
|
# @return [Boolean]
|
1315
1264
|
attr_accessor :is_primary
|
1316
1265
|
alias_method :is_primary?, :is_primary
|
1317
1266
|
|
1318
1267
|
# An optional email address that is included in a "Reply-To:" header for mail
|
1319
|
-
# sent using this alias.
|
1320
|
-
#
|
1268
|
+
# sent using this alias. If this is empty, Gmail will not generate a "Reply-To:"
|
1269
|
+
# header.
|
1321
1270
|
# Corresponds to the JSON property `replyToAddress`
|
1322
1271
|
# @return [String]
|
1323
1272
|
attr_accessor :reply_to_address
|
1324
1273
|
|
1325
|
-
# The email address that appears in the "From:" header for mail sent using
|
1326
|
-
#
|
1274
|
+
# The email address that appears in the "From:" header for mail sent using this
|
1275
|
+
# alias. This is read-only for all operations except create.
|
1327
1276
|
# Corresponds to the JSON property `sendAsEmail`
|
1328
1277
|
# @return [String]
|
1329
1278
|
attr_accessor :send_as_email
|
@@ -1339,16 +1288,15 @@ module Google
|
|
1339
1288
|
# @return [Google::Apis::GmailV1::SmtpMsa]
|
1340
1289
|
attr_accessor :smtp_msa
|
1341
1290
|
|
1342
|
-
# Whether Gmail should
|
1343
|
-
#
|
1344
|
-
# This setting only applies to custom "from" aliases.
|
1291
|
+
# Whether Gmail should treat this address as an alias for the user's primary
|
1292
|
+
# email address. This setting only applies to custom "from" aliases.
|
1345
1293
|
# Corresponds to the JSON property `treatAsAlias`
|
1346
1294
|
# @return [Boolean]
|
1347
1295
|
attr_accessor :treat_as_alias
|
1348
1296
|
alias_method :treat_as_alias?, :treat_as_alias
|
1349
1297
|
|
1350
|
-
# Indicates whether this address has been verified for use as a send-as
|
1351
|
-
#
|
1298
|
+
# Indicates whether this address has been verified for use as a send-as alias.
|
1299
|
+
# Read-only. This setting only applies to custom "from" aliases.
|
1352
1300
|
# Corresponds to the JSON property `verificationStatus`
|
1353
1301
|
# @return [String]
|
1354
1302
|
attr_accessor :verification_status
|
@@ -1401,18 +1349,18 @@ module Google
|
|
1401
1349
|
# @return [String]
|
1402
1350
|
attr_accessor :issuer_cn
|
1403
1351
|
|
1404
|
-
# PEM formatted X509 concatenated certificate string (standard base64
|
1405
|
-
#
|
1406
|
-
#
|
1352
|
+
# PEM formatted X509 concatenated certificate string (standard base64 encoding).
|
1353
|
+
# Format used for returning key, which includes public key as well as
|
1354
|
+
# certificate chain (not private key).
|
1407
1355
|
# Corresponds to the JSON property `pem`
|
1408
1356
|
# @return [String]
|
1409
1357
|
attr_accessor :pem
|
1410
1358
|
|
1411
|
-
# PKCS#12 format containing a single private/public key pair and
|
1412
|
-
#
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1359
|
+
# PKCS#12 format containing a single private/public key pair and certificate
|
1360
|
+
# chain. This format is only accepted from client for creating a new SmimeInfo
|
1361
|
+
# and is never returned, because the private key is not intended to be exported.
|
1362
|
+
# PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set
|
1363
|
+
# appropriately.
|
1416
1364
|
# Corresponds to the JSON property `pkcs12`
|
1417
1365
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
1418
1366
|
# @return [String]
|
@@ -1438,32 +1386,32 @@ module Google
|
|
1438
1386
|
class SmtpMsa
|
1439
1387
|
include Google::Apis::Core::Hashable
|
1440
1388
|
|
1441
|
-
# The hostname of the SMTP service.
|
1389
|
+
# The hostname of the SMTP service. Required.
|
1442
1390
|
# Corresponds to the JSON property `host`
|
1443
1391
|
# @return [String]
|
1444
1392
|
attr_accessor :host
|
1445
1393
|
|
1446
|
-
# The password that will be used for authentication with the SMTP service.
|
1447
|
-
#
|
1448
|
-
#
|
1394
|
+
# The password that will be used for authentication with the SMTP service. This
|
1395
|
+
# is a write-only field that can be specified in requests to create or update
|
1396
|
+
# SendAs settings; it is never populated in responses.
|
1449
1397
|
# Corresponds to the JSON property `password`
|
1450
1398
|
# @return [String]
|
1451
1399
|
attr_accessor :password
|
1452
1400
|
|
1453
|
-
# The port of the SMTP service.
|
1401
|
+
# The port of the SMTP service. Required.
|
1454
1402
|
# Corresponds to the JSON property `port`
|
1455
1403
|
# @return [Fixnum]
|
1456
1404
|
attr_accessor :port
|
1457
1405
|
|
1458
|
-
# The protocol that will be used to secure communication with the SMTP
|
1459
|
-
#
|
1406
|
+
# The protocol that will be used to secure communication with the SMTP service.
|
1407
|
+
# Required.
|
1460
1408
|
# Corresponds to the JSON property `securityMode`
|
1461
1409
|
# @return [String]
|
1462
1410
|
attr_accessor :security_mode
|
1463
1411
|
|
1464
|
-
# The username that will be used for authentication with the SMTP service.
|
1465
|
-
#
|
1466
|
-
#
|
1412
|
+
# The username that will be used for authentication with the SMTP service. This
|
1413
|
+
# is a write-only field that can be specified in requests to create or update
|
1414
|
+
# SendAs settings; it is never populated in responses.
|
1467
1415
|
# Corresponds to the JSON property `username`
|
1468
1416
|
# @return [String]
|
1469
1417
|
attr_accessor :username
|
@@ -1519,9 +1467,8 @@ module Google
|
|
1519
1467
|
end
|
1520
1468
|
end
|
1521
1469
|
|
1522
|
-
# Vacation auto-reply settings for an account.
|
1523
|
-
# the
|
1524
|
-
# responder"</a> feature in the web interface.
|
1470
|
+
# Vacation auto-reply settings for an account. These settings correspond to the "
|
1471
|
+
# Vacation responder" feature in the web interface.
|
1525
1472
|
class VacationSettings
|
1526
1473
|
include Google::Apis::Core::Hashable
|
1527
1474
|
|
@@ -1531,17 +1478,15 @@ module Google
|
|
1531
1478
|
attr_accessor :enable_auto_reply
|
1532
1479
|
alias_method :enable_auto_reply?, :enable_auto_reply
|
1533
1480
|
|
1534
|
-
# An optional end time for sending auto-replies (epoch ms).
|
1535
|
-
#
|
1536
|
-
#
|
1537
|
-
#
|
1538
|
-
# <code>endTime</code>.
|
1481
|
+
# An optional end time for sending auto-replies (epoch ms). When this is
|
1482
|
+
# specified, Gmail will automatically reply only to messages that it receives
|
1483
|
+
# before the end time. If both startTime and endTime are specified, startTime
|
1484
|
+
# must precede endTime.
|
1539
1485
|
# Corresponds to the JSON property `endTime`
|
1540
1486
|
# @return [Fixnum]
|
1541
1487
|
attr_accessor :end_time
|
1542
1488
|
|
1543
|
-
# Response body in HTML format.
|
1544
|
-
# storing it.
|
1489
|
+
# Response body in HTML format. Gmail will sanitize the HTML before storing it.
|
1545
1490
|
# Corresponds to the JSON property `responseBodyHtml`
|
1546
1491
|
# @return [String]
|
1547
1492
|
attr_accessor :response_body_html
|
@@ -1551,33 +1496,31 @@ module Google
|
|
1551
1496
|
# @return [String]
|
1552
1497
|
attr_accessor :response_body_plain_text
|
1553
1498
|
|
1554
|
-
# Optional text to prepend to the subject line in vacation responses.
|
1555
|
-
#
|
1556
|
-
#
|
1499
|
+
# Optional text to prepend to the subject line in vacation responses. In order
|
1500
|
+
# to enable auto-replies, either the response subject or the response body must
|
1501
|
+
# be nonempty.
|
1557
1502
|
# Corresponds to the JSON property `responseSubject`
|
1558
1503
|
# @return [String]
|
1559
1504
|
attr_accessor :response_subject
|
1560
1505
|
|
1561
|
-
# Flag that determines whether responses are sent to recipients who are not
|
1562
|
-
#
|
1506
|
+
# Flag that determines whether responses are sent to recipients who are not in
|
1507
|
+
# the user's list of contacts.
|
1563
1508
|
# Corresponds to the JSON property `restrictToContacts`
|
1564
1509
|
# @return [Boolean]
|
1565
1510
|
attr_accessor :restrict_to_contacts
|
1566
1511
|
alias_method :restrict_to_contacts?, :restrict_to_contacts
|
1567
1512
|
|
1568
|
-
# Flag that determines whether responses are sent to recipients who are
|
1569
|
-
#
|
1570
|
-
# users.
|
1513
|
+
# Flag that determines whether responses are sent to recipients who are outside
|
1514
|
+
# of the user's domain. This feature is only available for G Suite users.
|
1571
1515
|
# Corresponds to the JSON property `restrictToDomain`
|
1572
1516
|
# @return [Boolean]
|
1573
1517
|
attr_accessor :restrict_to_domain
|
1574
1518
|
alias_method :restrict_to_domain?, :restrict_to_domain
|
1575
1519
|
|
1576
|
-
# An optional start time for sending auto-replies (epoch ms).
|
1577
|
-
#
|
1578
|
-
#
|
1579
|
-
#
|
1580
|
-
# <code>endTime</code>.
|
1520
|
+
# An optional start time for sending auto-replies (epoch ms). When this is
|
1521
|
+
# specified, Gmail will automatically reply only to messages that it receives
|
1522
|
+
# after the start time. If both startTime and endTime are specified, startTime
|
1523
|
+
# must precede endTime.
|
1581
1524
|
# Corresponds to the JSON property `startTime`
|
1582
1525
|
# @return [Fixnum]
|
1583
1526
|
attr_accessor :start_time
|
@@ -1608,21 +1551,20 @@ module Google
|
|
1608
1551
|
# @return [String]
|
1609
1552
|
attr_accessor :label_filter_action
|
1610
1553
|
|
1611
|
-
# List of label_ids to restrict notifications about.
|
1612
|
-
#
|
1613
|
-
#
|
1614
|
-
# be generated.
|
1554
|
+
# List of label_ids to restrict notifications about. By default, if unspecified,
|
1555
|
+
# all changes are pushed out. If specified then dictates which labels are
|
1556
|
+
# required for a push notification to be generated.
|
1615
1557
|
# Corresponds to the JSON property `labelIds`
|
1616
1558
|
# @return [Array<String>]
|
1617
1559
|
attr_accessor :label_ids
|
1618
1560
|
|
1619
|
-
# A fully qualified Google Cloud Pub/Sub API topic name to publish the
|
1620
|
-
#
|
1621
|
-
#
|
1622
|
-
#
|
1623
|
-
#
|
1624
|
-
# Note that the "my-project-identifier" portion must exactly match your
|
1625
|
-
#
|
1561
|
+
# A fully qualified Google Cloud Pub/Sub API topic name to publish the events to.
|
1562
|
+
# This topic name **must** already exist in Cloud Pub/Sub and you **must** have
|
1563
|
+
# already granted gmail "publish" permission on it. For example, "projects/my-
|
1564
|
+
# project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic
|
1565
|
+
# naming format).
|
1566
|
+
# Note that the "my-project-identifier" portion must exactly match your Google
|
1567
|
+
# developer project id (the one executing this watch request).
|
1626
1568
|
# Corresponds to the JSON property `topicName`
|
1627
1569
|
# @return [String]
|
1628
1570
|
attr_accessor :topic_name
|
@@ -1643,9 +1585,8 @@ module Google
|
|
1643
1585
|
class WatchResponse
|
1644
1586
|
include Google::Apis::Core::Hashable
|
1645
1587
|
|
1646
|
-
# When Gmail will stop sending notifications for mailbox updates
|
1647
|
-
#
|
1648
|
-
# the watch.
|
1588
|
+
# When Gmail will stop sending notifications for mailbox updates (epoch millis).
|
1589
|
+
# Call watch again before this time to renew the watch.
|
1649
1590
|
# Corresponds to the JSON property `expiration`
|
1650
1591
|
# @return [Fixnum]
|
1651
1592
|
attr_accessor :expiration
|