google-cloud-dataproc 0.3.0 → 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +2 -0
- data/AUTHENTICATION.md +199 -0
- data/lib/google/cloud/dataproc/v1/cluster_controller_client.rb +15 -12
- data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/clusters.rb +46 -32
- data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/jobs.rb +21 -17
- data/lib/google/cloud/dataproc/v1/doc/google/cloud/dataproc/v1/workflow_templates.rb +6 -6
- data/lib/google/cloud/dataproc/v1/doc/google/longrunning/operations.rb +1 -1
- data/lib/google/cloud/dataproc/v1/doc/google/protobuf/any.rb +2 -1
- data/lib/google/cloud/dataproc/v1/doc/google/protobuf/field_mask.rb +18 -26
- data/lib/google/cloud/dataproc/v1/doc/google/protobuf/timestamp.rb +15 -13
- data/lib/google/cloud/dataproc/v1/doc/google/rpc/status.rb +17 -14
- data/lib/google/cloud/dataproc/v1/job_controller_client.rb +4 -3
- data/lib/google/cloud/dataproc/v1/jobs_services_pb.rb +2 -1
- data/lib/google/cloud/dataproc/v1/workflow_template_service_client.rb +45 -23
- data/lib/google/cloud/dataproc/v1/workflow_templates_services_pb.rb +2 -1
- data/lib/google/cloud/dataproc/v1beta2/cluster_controller_client.rb +29 -20
- data/lib/google/cloud/dataproc/v1beta2/clusters_pb.rb +1 -1
- data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/clusters.rb +58 -39
- data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/jobs.rb +23 -18
- data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb +10 -9
- data/lib/google/cloud/dataproc/v1beta2/doc/google/longrunning/operations.rb +1 -1
- data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/any.rb +2 -1
- data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/field_mask.rb +18 -26
- data/lib/google/cloud/dataproc/v1beta2/doc/google/protobuf/timestamp.rb +15 -13
- data/lib/google/cloud/dataproc/v1beta2/doc/google/rpc/status.rb +17 -14
- data/lib/google/cloud/dataproc/v1beta2/job_controller_client.rb +6 -4
- data/lib/google/cloud/dataproc/v1beta2/jobs_services_pb.rb +2 -1
- data/lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb +45 -23
- data/lib/google/cloud/dataproc/v1beta2/workflow_templates_services_pb.rb +2 -1
- metadata +6 -6
@@ -5,8 +5,8 @@
|
|
5
5
|
require 'google/protobuf'
|
6
6
|
|
7
7
|
require 'google/api/annotations_pb'
|
8
|
-
require 'google/cloud/dataproc/v1beta2/shared_pb'
|
9
8
|
require 'google/cloud/dataproc/v1beta2/operations_pb'
|
9
|
+
require 'google/cloud/dataproc/v1beta2/shared_pb'
|
10
10
|
require 'google/longrunning/operations_pb'
|
11
11
|
require 'google/protobuf/duration_pb'
|
12
12
|
require 'google/protobuf/field_mask_pb'
|
@@ -36,8 +36,9 @@ module Google
|
|
36
36
|
# Label **keys** must contain 1 to 63 characters, and must conform to
|
37
37
|
# [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
|
38
38
|
# Label **values** may be empty, but, if present, must contain 1 to 63
|
39
|
-
# characters, and must conform to [RFC
|
40
|
-
# No more than 32 labels can be
|
39
|
+
# characters, and must conform to [RFC
|
40
|
+
# 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
|
41
|
+
# associated with a cluster.
|
41
42
|
# @!attribute [rw] status
|
42
43
|
# @return [Google::Cloud::Dataproc::V1beta2::ClusterStatus]
|
43
44
|
# Output only. Cluster status.
|
@@ -52,8 +53,8 @@ module Google
|
|
52
53
|
# @return [Google::Cloud::Dataproc::V1beta2::ClusterMetrics]
|
53
54
|
# Output only. Contains cluster daemon metrics such as HDFS and YARN stats.
|
54
55
|
#
|
55
|
-
# **Beta Feature**: This report is available for testing purposes only. It
|
56
|
-
# be changed before final release.
|
56
|
+
# **Beta Feature**: This report is available for testing purposes only. It
|
57
|
+
# may be changed before final release.
|
57
58
|
class Cluster; end
|
58
59
|
|
59
60
|
# The cluster config.
|
@@ -92,9 +93,11 @@ module Google
|
|
92
93
|
# Optional. Commands to execute on each node after config is
|
93
94
|
# completed. By default, executables are run on master and all worker nodes.
|
94
95
|
# You can test a node's <code>role</code> metadata to run an executable on
|
95
|
-
# a master or worker node, as shown below using `curl` (you can also use
|
96
|
+
# a master or worker node, as shown below using `curl` (you can also use
|
97
|
+
# `wget`):
|
96
98
|
#
|
97
|
-
# ROLE=$(curl -H Metadata-Flavor:Google
|
99
|
+
# ROLE=$(curl -H Metadata-Flavor:Google
|
100
|
+
# http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
|
98
101
|
# if [[ "${ROLE}" == 'Master' ]]; then
|
99
102
|
# ... master specific actions ...
|
100
103
|
# else
|
@@ -153,11 +156,11 @@ module Google
|
|
153
156
|
# @!attribute [rw] internal_ip_only
|
154
157
|
# @return [true, false]
|
155
158
|
# Optional. If true, all instances in the cluster will only have internal IP
|
156
|
-
# addresses. By default, clusters are not restricted to internal IP
|
157
|
-
# and will have ephemeral external IP addresses assigned to each
|
158
|
-
# This `internal_ip_only` restriction can only be enabled for
|
159
|
-
# enabled networks, and all off-cluster dependencies must be
|
160
|
-
# accessible without external IP addresses.
|
159
|
+
# addresses. By default, clusters are not restricted to internal IP
|
160
|
+
# addresses, and will have ephemeral external IP addresses assigned to each
|
161
|
+
# instance. This `internal_ip_only` restriction can only be enabled for
|
162
|
+
# subnetwork enabled networks, and all off-cluster dependencies must be
|
163
|
+
# configured to be accessible without external IP addresses.
|
161
164
|
# @!attribute [rw] service_account
|
162
165
|
# @return [String]
|
163
166
|
# Optional. The service account of the instances. Defaults to the default
|
@@ -167,7 +170,8 @@ module Google
|
|
167
170
|
# * roles/logging.logWriter
|
168
171
|
# * roles/storage.objectAdmin
|
169
172
|
#
|
170
|
-
# (see
|
173
|
+
# (see
|
174
|
+
# https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts
|
171
175
|
# for more information).
|
172
176
|
# Example: `[account_id]@[project_id].iam.gserviceaccount.com`
|
173
177
|
# @!attribute [rw] service_account_scopes
|
@@ -193,7 +197,8 @@ module Google
|
|
193
197
|
# @!attribute [rw] metadata
|
194
198
|
# @return [Hash{String => String}]
|
195
199
|
# The Compute Engine metadata entries to add to all instances (see
|
196
|
-
# [Project and instance
|
200
|
+
# [Project and instance
|
201
|
+
# metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
|
197
202
|
class GceClusterConfig; end
|
198
203
|
|
199
204
|
# Optional. The config settings for Compute Engine resources in
|
@@ -222,7 +227,8 @@ module Google
|
|
222
227
|
# * `n1-standard-2`
|
223
228
|
#
|
224
229
|
# **Auto Zone Exception**: If you are using the Cloud Dataproc
|
225
|
-
# [Auto Zone
|
230
|
+
# [Auto Zone
|
231
|
+
# Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
|
226
232
|
# feature, you must use the short name of the machine type
|
227
233
|
# resource, for example, `n1-standard-2`.
|
228
234
|
# @!attribute [rw] disk_config
|
@@ -230,7 +236,8 @@ module Google
|
|
230
236
|
# Optional. Disk option config settings.
|
231
237
|
# @!attribute [rw] is_preemptible
|
232
238
|
# @return [true, false]
|
233
|
-
# Optional. Specifies that this instance group contains preemptible
|
239
|
+
# Optional. Specifies that this instance group contains preemptible
|
240
|
+
# instances.
|
234
241
|
# @!attribute [rw] managed_group_config
|
235
242
|
# @return [Google::Cloud::Dataproc::V1beta2::ManagedGroupConfig]
|
236
243
|
# Output only. The config for Compute Engine Instance Group
|
@@ -274,7 +281,8 @@ module Google
|
|
274
281
|
# * `nvidia-tesla-k80`
|
275
282
|
#
|
276
283
|
# **Auto Zone Exception**: If you are using the Cloud Dataproc
|
277
|
-
# [Auto Zone
|
284
|
+
# [Auto Zone
|
285
|
+
# Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement)
|
278
286
|
# feature, you must use the short name of the accelerator type
|
279
287
|
# resource, for example, `nvidia-tesla-k80`.
|
280
288
|
# @!attribute [rw] accelerator_count
|
@@ -393,10 +401,12 @@ module Google
|
|
393
401
|
# Specifies the selection and config of software inside the cluster.
|
394
402
|
# @!attribute [rw] image_version
|
395
403
|
# @return [String]
|
396
|
-
# Optional. The version of software inside the cluster. It must be one of the
|
397
|
-
# [Cloud Dataproc
|
404
|
+
# Optional. The version of software inside the cluster. It must be one of the
|
405
|
+
# supported [Cloud Dataproc
|
406
|
+
# Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions),
|
398
407
|
# such as "1.2" (including a subminor version, such as "1.2.29"), or the
|
399
|
-
# ["preview"
|
408
|
+
# ["preview"
|
409
|
+
# version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions).
|
400
410
|
# If unspecified, it defaults to the latest version.
|
401
411
|
# @!attribute [rw] properties
|
402
412
|
# @return [Hash{String => String}]
|
@@ -446,10 +456,11 @@ module Google
|
|
446
456
|
# @!attribute [rw] request_id
|
447
457
|
# @return [String]
|
448
458
|
# Optional. A unique id used to identify the request. If the server
|
449
|
-
# receives two
|
450
|
-
#
|
451
|
-
#
|
452
|
-
#
|
459
|
+
# receives two
|
460
|
+
# {Google::Cloud::Dataproc::V1beta2::CreateClusterRequest CreateClusterRequest}
|
461
|
+
# requests with the same id, then the second request will be ignored and the
|
462
|
+
# first {Google::Longrunning::Operation} created
|
463
|
+
# and stored in the backend is returned.
|
453
464
|
#
|
454
465
|
# It is recommended to always set this value to a
|
455
466
|
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
|
@@ -498,9 +509,10 @@ module Google
|
|
498
509
|
# }
|
499
510
|
# }
|
500
511
|
#
|
501
|
-
# Similarly, to change the number of preemptible workers in a cluster to 5,
|
502
|
-
# `update_mask` parameter would be
|
503
|
-
# and the `PATCH` request
|
512
|
+
# Similarly, to change the number of preemptible workers in a cluster to 5,
|
513
|
+
# the `update_mask` parameter would be
|
514
|
+
# `config.secondary_worker_config.num_instances`, and the `PATCH` request
|
515
|
+
# body would be set as follows:
|
504
516
|
#
|
505
517
|
# {
|
506
518
|
# "config":{
|
@@ -519,28 +531,34 @@ module Google
|
|
519
531
|
# <td>labels</td><td>Updates labels</td>
|
520
532
|
# </tr>
|
521
533
|
# <tr>
|
522
|
-
# <td>config.worker_config.num_instances</td><td>Resize primary worker
|
534
|
+
# <td>config.worker_config.num_instances</td><td>Resize primary worker
|
535
|
+
# group</td>
|
523
536
|
# </tr>
|
524
537
|
# <tr>
|
525
|
-
# <td>config.secondary_worker_config.num_instances</td><td>Resize secondary
|
538
|
+
# <td>config.secondary_worker_config.num_instances</td><td>Resize secondary
|
539
|
+
# worker group</td>
|
526
540
|
# </tr>
|
527
541
|
# <tr>
|
528
|
-
# <td>config.lifecycle_config.auto_delete_ttl</td><td>Reset MAX TTL
|
542
|
+
# <td>config.lifecycle_config.auto_delete_ttl</td><td>Reset MAX TTL
|
543
|
+
# duration</td>
|
529
544
|
# </tr>
|
530
545
|
# <tr>
|
531
|
-
# <td>config.lifecycle_config.auto_delete_time</td><td>Update MAX TTL
|
546
|
+
# <td>config.lifecycle_config.auto_delete_time</td><td>Update MAX TTL
|
547
|
+
# deletion timestamp</td>
|
532
548
|
# </tr>
|
533
549
|
# <tr>
|
534
|
-
# <td>config.lifecycle_config.idle_delete_ttl</td><td>Update Idle TTL
|
550
|
+
# <td>config.lifecycle_config.idle_delete_ttl</td><td>Update Idle TTL
|
551
|
+
# duration</td>
|
535
552
|
# </tr>
|
536
553
|
# </table>
|
537
554
|
# @!attribute [rw] request_id
|
538
555
|
# @return [String]
|
539
556
|
# Optional. A unique id used to identify the request. If the server
|
540
|
-
# receives two
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
557
|
+
# receives two
|
558
|
+
# {Google::Cloud::Dataproc::V1beta2::UpdateClusterRequest UpdateClusterRequest}
|
559
|
+
# requests with the same id, then the second request will be ignored and the
|
560
|
+
# first {Google::Longrunning::Operation} created
|
561
|
+
# and stored in the backend is returned.
|
544
562
|
#
|
545
563
|
# It is recommended to always set this value to a
|
546
564
|
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
|
@@ -567,10 +585,11 @@ module Google
|
|
567
585
|
# @!attribute [rw] request_id
|
568
586
|
# @return [String]
|
569
587
|
# Optional. A unique id used to identify the request. If the server
|
570
|
-
# receives two
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
588
|
+
# receives two
|
589
|
+
# {Google::Cloud::Dataproc::V1beta2::DeleteClusterRequest DeleteClusterRequest}
|
590
|
+
# requests with the same id, then the second request will be ignored and the
|
591
|
+
# first {Google::Longrunning::Operation} created
|
592
|
+
# and stored in the backend is returned.
|
574
593
|
#
|
575
594
|
# It is recommended to always set this value to a
|
576
595
|
# [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
|
@@ -59,8 +59,10 @@ module Google
|
|
59
59
|
end
|
60
60
|
|
61
61
|
# A Cloud Dataproc job for running
|
62
|
-
# [Apache Hadoop
|
63
|
-
#
|
62
|
+
# [Apache Hadoop
|
63
|
+
# MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html)
|
64
|
+
# jobs on [Apache Hadoop
|
65
|
+
# YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).
|
64
66
|
# @!attribute [rw] main_jar_file_uri
|
65
67
|
# @return [String]
|
66
68
|
# The HCFS URI of the jar file containing the main class.
|
@@ -75,8 +77,8 @@ module Google
|
|
75
77
|
# @!attribute [rw] args
|
76
78
|
# @return [Array<String>]
|
77
79
|
# Optional. The arguments to pass to the driver. Do not
|
78
|
-
# include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as
|
79
|
-
# properties, since a collision may occur that causes an incorrect job
|
80
|
+
# include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as
|
81
|
+
# job properties, since a collision may occur that causes an incorrect job
|
80
82
|
# submission.
|
81
83
|
# @!attribute [rw] jar_file_uris
|
82
84
|
# @return [Array<String>]
|
@@ -142,7 +144,8 @@ module Google
|
|
142
144
|
class SparkJob; end
|
143
145
|
|
144
146
|
# A Cloud Dataproc job for running
|
145
|
-
# [Apache
|
147
|
+
# [Apache
|
148
|
+
# PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html)
|
146
149
|
# applications on YARN.
|
147
150
|
# @!attribute [rw] main_python_file_uri
|
148
151
|
# @return [String]
|
@@ -210,8 +213,8 @@ module Google
|
|
210
213
|
# @!attribute [rw] continue_on_failure
|
211
214
|
# @return [true, false]
|
212
215
|
# Optional. Whether to continue executing queries if a query fails.
|
213
|
-
# The default value is `false`. Setting to `true` can be useful when
|
214
|
-
# independent parallel queries.
|
216
|
+
# The default value is `false`. Setting to `true` can be useful when
|
217
|
+
# executing independent parallel queries.
|
215
218
|
# @!attribute [rw] script_variables
|
216
219
|
# @return [Hash{String => String}]
|
217
220
|
# Optional. Mapping of query variable names to values (equivalent to the
|
@@ -229,8 +232,8 @@ module Google
|
|
229
232
|
# and UDFs.
|
230
233
|
class HiveJob; end
|
231
234
|
|
232
|
-
# A Cloud Dataproc job for running [Apache Spark
|
233
|
-
# queries.
|
235
|
+
# A Cloud Dataproc job for running [Apache Spark
|
236
|
+
# SQL](http://spark.apache.org/sql/) queries.
|
234
237
|
# @!attribute [rw] query_file_uri
|
235
238
|
# @return [String]
|
236
239
|
# The HCFS URI of the script that contains SQL queries.
|
@@ -265,8 +268,8 @@ module Google
|
|
265
268
|
# @!attribute [rw] continue_on_failure
|
266
269
|
# @return [true, false]
|
267
270
|
# Optional. Whether to continue executing queries if a query fails.
|
268
|
-
# The default value is `false`. Setting to `true` can be useful when
|
269
|
-
# independent parallel queries.
|
271
|
+
# The default value is `false`. Setting to `true` can be useful when
|
272
|
+
# executing independent parallel queries.
|
270
273
|
# @!attribute [rw] script_variables
|
271
274
|
# @return [Hash{String => String}]
|
272
275
|
# Optional. Mapping of query variable names to values (equivalent to the Pig
|
@@ -484,8 +487,8 @@ module Google
|
|
484
487
|
# @return [Array<Google::Cloud::Dataproc::V1beta2::YarnApplication>]
|
485
488
|
# Output only. The collection of YARN applications spun up by this job.
|
486
489
|
#
|
487
|
-
# **Beta** Feature: This report is available for testing purposes only. It
|
488
|
-
# be changed before final release.
|
490
|
+
# **Beta** Feature: This report is available for testing purposes only. It
|
491
|
+
# may be changed before final release.
|
489
492
|
# @!attribute [rw] submitted_by
|
490
493
|
# @return [String]
|
491
494
|
# Output only. The email address of the user submitting the job. For jobs
|
@@ -505,8 +508,9 @@ module Google
|
|
505
508
|
# Label **keys** must contain 1 to 63 characters, and must conform to
|
506
509
|
# [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt).
|
507
510
|
# Label **values** may be empty, but, if present, must contain 1 to 63
|
508
|
-
# characters, and must conform to [RFC
|
509
|
-
# No more than 32 labels can be
|
511
|
+
# characters, and must conform to [RFC
|
512
|
+
# 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be
|
513
|
+
# associated with a job.
|
510
514
|
# @!attribute [rw] scheduling
|
511
515
|
# @return [Google::Cloud::Dataproc::V1beta2::JobScheduling]
|
512
516
|
# Optional. Job scheduling configuration.
|
@@ -544,9 +548,10 @@ module Google
|
|
544
548
|
# @!attribute [rw] request_id
|
545
549
|
# @return [String]
|
546
550
|
# Optional. A unique id used to identify the request. If the server
|
547
|
-
# receives two
|
548
|
-
#
|
549
|
-
#
|
551
|
+
# receives two
|
552
|
+
# {Google::Cloud::Dataproc::V1beta2::SubmitJobRequest SubmitJobRequest} requests
|
553
|
+
# with the same id, then the second request will be ignored and the first
|
554
|
+
# {Google::Cloud::Dataproc::V1beta2::Job Job} created and stored in the backend
|
550
555
|
# is returned.
|
551
556
|
#
|
552
557
|
# It is recommended to always set this value to a
|
data/lib/google/cloud/dataproc/v1beta2/doc/google/cloud/dataproc/v1beta2/workflow_templates.rb
CHANGED
@@ -136,8 +136,8 @@ module Google
|
|
136
136
|
#
|
137
137
|
# The step id is used as prefix for job id, as job
|
138
138
|
# `goog-dataproc-workflow-step-id` label, and in
|
139
|
-
# {Google::Cloud::Dataproc::V1beta2::OrderedJob#prerequisite_step_ids prerequisiteStepIds}
|
140
|
-
# steps.
|
139
|
+
# {Google::Cloud::Dataproc::V1beta2::OrderedJob#prerequisite_step_ids prerequisiteStepIds}
|
140
|
+
# field from other steps.
|
141
141
|
#
|
142
142
|
# The id must contain only letters (a-z, A-Z), numbers (0-9),
|
143
143
|
# underscores (_), and hyphens (-). Cannot begin or end with underscore
|
@@ -202,12 +202,13 @@ module Google
|
|
202
202
|
# @!attribute [rw] fields
|
203
203
|
# @return [Array<String>]
|
204
204
|
# Required. Paths to all fields that the parameter replaces.
|
205
|
-
# A field is allowed to appear in at most one parameter's list of field
|
205
|
+
# A field is allowed to appear in at most one parameter's list of field
|
206
|
+
# paths.
|
206
207
|
#
|
207
|
-
# A field path is similar in syntax to a
|
208
|
-
# For example, a
|
209
|
-
#
|
210
|
-
# `placement.clusterSelector.zone`.
|
208
|
+
# A field path is similar in syntax to a
|
209
|
+
# {Google::Protobuf::FieldMask}. For example, a
|
210
|
+
# field path that references the zone field of a workflow template's cluster
|
211
|
+
# selector would be specified as `placement.clusterSelector.zone`.
|
211
212
|
#
|
212
213
|
# Also, field paths can reference fields using the following syntax:
|
213
214
|
#
|
@@ -499,8 +500,8 @@ module Google
|
|
499
500
|
# Output only. WorkflowTemplates list.
|
500
501
|
# @!attribute [rw] next_page_token
|
501
502
|
# @return [String]
|
502
|
-
# Output only. This token is included in the response if there are more
|
503
|
-
# to fetch. To fetch additional results, provide this value as the
|
503
|
+
# Output only. This token is included in the response if there are more
|
504
|
+
# results to fetch. To fetch additional results, provide this value as the
|
504
505
|
# page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>.
|
505
506
|
class ListWorkflowTemplatesResponse; end
|
506
507
|
|
@@ -31,7 +31,7 @@ module Google
|
|
31
31
|
# @!attribute [rw] done
|
32
32
|
# @return [true, false]
|
33
33
|
# If the value is `false`, it means the operation is still in progress.
|
34
|
-
# If true
|
34
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
35
35
|
# available.
|
36
36
|
# @!attribute [rw] error
|
37
37
|
# @return [Google::Rpc::Status]
|
@@ -97,7 +97,8 @@ module Google
|
|
97
97
|
# @!attribute [rw] type_url
|
98
98
|
# @return [String]
|
99
99
|
# A URL/resource name that uniquely identifies the type of the serialized
|
100
|
-
# protocol buffer message.
|
100
|
+
# protocol buffer message. This string must contain at least
|
101
|
+
# one "/" character. The last segment of the URL's path must represent
|
101
102
|
# the fully qualified name of the type (as in
|
102
103
|
# `path/google.protobuf.Duration`). The name should be in a canonical form
|
103
104
|
# (e.g., leading "." is not accepted).
|
@@ -83,57 +83,49 @@ module Google
|
|
83
83
|
# describe the updated values, the API ignores the values of all
|
84
84
|
# fields not covered by the mask.
|
85
85
|
#
|
86
|
-
# If a repeated field is specified for an update operation,
|
87
|
-
#
|
88
|
-
#
|
89
|
-
# string.
|
86
|
+
# If a repeated field is specified for an update operation, new values will
|
87
|
+
# be appended to the existing repeated field in the target resource. Note that
|
88
|
+
# a repeated field is only allowed in the last position of a `paths` string.
|
90
89
|
#
|
91
90
|
# If a sub-message is specified in the last position of the field mask for an
|
92
|
-
# update operation, then the existing sub-message
|
93
|
-
#
|
91
|
+
# update operation, then new value will be merged into the existing sub-message
|
92
|
+
# in the target resource.
|
93
|
+
#
|
94
|
+
# For example, given the target message:
|
94
95
|
#
|
95
96
|
# f {
|
96
97
|
# b {
|
97
|
-
# d
|
98
|
-
# x
|
98
|
+
# d: 1
|
99
|
+
# x: 2
|
99
100
|
# }
|
100
|
-
# c
|
101
|
+
# c: [1]
|
101
102
|
# }
|
102
103
|
#
|
103
104
|
# And an update message:
|
104
105
|
#
|
105
106
|
# f {
|
106
107
|
# b {
|
107
|
-
# d
|
108
|
+
# d: 10
|
108
109
|
# }
|
110
|
+
# c: [2]
|
109
111
|
# }
|
110
112
|
#
|
111
113
|
# then if the field mask is:
|
112
114
|
#
|
113
|
-
# paths: "f.b"
|
115
|
+
# paths: ["f.b", "f.c"]
|
114
116
|
#
|
115
117
|
# then the result will be:
|
116
118
|
#
|
117
119
|
# f {
|
118
120
|
# b {
|
119
|
-
# d
|
121
|
+
# d: 10
|
122
|
+
# x: 2
|
120
123
|
# }
|
121
|
-
# c
|
124
|
+
# c: [1, 2]
|
122
125
|
# }
|
123
126
|
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
# paths: "f.b.d"
|
127
|
-
#
|
128
|
-
# then the result would be:
|
129
|
-
#
|
130
|
-
# f {
|
131
|
-
# b {
|
132
|
-
# d : 10
|
133
|
-
# x : 2
|
134
|
-
# }
|
135
|
-
# c : 1
|
136
|
-
# }
|
127
|
+
# An implementation may provide options to override this default behavior for
|
128
|
+
# repeated and message fields.
|
137
129
|
#
|
138
130
|
# In order to reset a field's value to the default, the field must
|
139
131
|
# be in the mask and set to the default value in the provided resource.
|