google-api-client 0.18.0 → 0.18.1
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 +41 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
- data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +9 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +1 -0
- data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +1 -1
- data/generated/google/apis/admin_directory_v1.rb +1 -1
- data/generated/google/apis/admin_directory_v1/classes.rb +238 -10
- data/generated/google/apis/admin_directory_v1/representations.rb +101 -0
- data/generated/google/apis/admin_directory_v1/service.rb +529 -1
- data/generated/google/apis/androidmanagement_v1.rb +1 -1
- data/generated/google/apis/androidmanagement_v1/classes.rb +7 -0
- data/generated/google/apis/androidmanagement_v1/representations.rb +1 -0
- data/generated/google/apis/androidpublisher_v1_1.rb +1 -1
- data/generated/google/apis/androidpublisher_v1_1/classes.rb +9 -0
- data/generated/google/apis/androidpublisher_v1_1/representations.rb +1 -0
- data/generated/google/apis/androidpublisher_v2.rb +1 -1
- data/generated/google/apis/androidpublisher_v2/classes.rb +34 -0
- data/generated/google/apis/androidpublisher_v2/representations.rb +3 -0
- data/generated/google/apis/appengine_v1.rb +1 -1
- data/generated/google/apis/appengine_v1/classes.rb +21 -17
- data/generated/google/apis/appengine_v1beta.rb +1 -1
- data/generated/google/apis/appengine_v1beta/classes.rb +21 -17
- data/generated/google/apis/bigquerydatatransfer_v1.rb +1 -1
- data/generated/google/apis/bigquerydatatransfer_v1/classes.rb +2 -2
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/calendar_v3/classes.rb +326 -0
- data/generated/google/apis/calendar_v3/representations.rb +118 -0
- data/generated/google/apis/calendar_v3/service.rb +28 -4
- data/generated/google/apis/classroom_v1.rb +1 -1
- data/generated/google/apis/classroom_v1/classes.rb +69 -0
- data/generated/google/apis/classroom_v1/representations.rb +31 -0
- data/generated/google/apis/classroom_v1/service.rb +88 -0
- data/generated/google/apis/cloudbuild_v1.rb +1 -1
- data/generated/google/apis/cloudbuild_v1/classes.rb +49 -0
- data/generated/google/apis/cloudbuild_v1/representations.rb +20 -0
- data/generated/google/apis/cloudfunctions_v1.rb +1 -1
- data/generated/google/apis/cloudfunctions_v1/classes.rb +9 -12
- data/generated/google/apis/cloudresourcemanager_v1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1/classes.rb +25 -0
- data/generated/google/apis/cloudresourcemanager_v1/representations.rb +4 -0
- data/generated/google/apis/cloudresourcemanager_v1/service.rb +8 -3
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +7 -3
- data/generated/google/apis/cloudresourcemanager_v2beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v2beta1/classes.rb +8 -6
- data/generated/google/apis/cloudresourcemanager_v2beta1/service.rb +19 -13
- data/generated/google/apis/cloudshell_v1.rb +35 -0
- data/generated/google/apis/cloudshell_v1/classes.rb +409 -0
- data/generated/google/apis/cloudshell_v1/representations.rb +161 -0
- data/generated/google/apis/cloudshell_v1/service.rb +214 -0
- data/generated/google/apis/cloudshell_v1alpha1.rb +35 -0
- data/generated/google/apis/cloudshell_v1alpha1/classes.rb +403 -0
- data/generated/google/apis/cloudshell_v1alpha1/representations.rb +160 -0
- data/generated/google/apis/cloudshell_v1alpha1/service.rb +237 -0
- data/generated/google/apis/cloudtasks_v2beta2.rb +1 -1
- data/generated/google/apis/cloudtasks_v2beta2/classes.rb +106 -13
- data/generated/google/apis/cloudtasks_v2beta2/representations.rb +31 -1
- data/generated/google/apis/cloudtasks_v2beta2/service.rb +63 -8
- data/generated/google/apis/cloudtrace_v2.rb +1 -1
- data/generated/google/apis/cloudtrace_v2/service.rb +2 -2
- data/generated/google/apis/container_v1.rb +2 -2
- data/generated/google/apis/container_v1/classes.rb +6 -7
- data/generated/google/apis/container_v1/service.rb +2 -2
- data/generated/google/apis/container_v1beta1.rb +2 -2
- data/generated/google/apis/container_v1beta1/classes.rb +4 -4
- data/generated/google/apis/container_v1beta1/service.rb +3 -3
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +257 -0
- data/generated/google/apis/content_v2/representations.rb +114 -0
- data/generated/google/apis/content_v2/service.rb +84 -0
- data/generated/google/apis/content_v2sandbox.rb +1 -1
- data/generated/google/apis/content_v2sandbox/classes.rb +257 -0
- data/generated/google/apis/content_v2sandbox/representations.rb +114 -0
- data/generated/google/apis/content_v2sandbox/service.rb +84 -0
- data/generated/google/apis/dialogflow_v2beta1.rb +1 -1
- data/generated/google/apis/dialogflow_v2beta1/classes.rb +16 -0
- data/generated/google/apis/digitalassetlinks_v1.rb +32 -0
- data/generated/google/apis/digitalassetlinks_v1/classes.rb +305 -0
- data/generated/google/apis/digitalassetlinks_v1/representations.rb +133 -0
- data/generated/google/apis/digitalassetlinks_v1/service.rb +324 -0
- data/generated/google/apis/dlp_v2beta2.rb +36 -0
- data/generated/google/apis/dlp_v2beta2/classes.rb +5475 -0
- data/generated/google/apis/dlp_v2beta2/representations.rb +2734 -0
- data/generated/google/apis/dlp_v2beta2/service.rb +1135 -0
- data/generated/google/apis/drive_v2.rb +1 -1
- data/generated/google/apis/drive_v2/service.rb +25 -16
- data/generated/google/apis/drive_v3.rb +1 -1
- data/generated/google/apis/drive_v3/service.rb +1 -1
- data/generated/google/apis/monitoring_v3.rb +1 -1
- data/generated/google/apis/monitoring_v3/classes.rb +50 -1
- data/generated/google/apis/monitoring_v3/representations.rb +16 -0
- data/generated/google/apis/serviceconsumermanagement_v1.rb +1 -1
- data/generated/google/apis/serviceconsumermanagement_v1/classes.rb +6 -5
- data/generated/google/apis/slides_v1.rb +4 -1
- data/generated/google/apis/speech_v1.rb +1 -4
- data/generated/google/apis/speech_v1beta1.rb +1 -4
- data/generated/google/apis/streetviewpublish_v1.rb +1 -1
- data/generated/google/apis/streetviewpublish_v1/classes.rb +0 -2
- data/generated/google/apis/streetviewpublish_v1/service.rb +6 -0
- data/generated/google/apis/testing_v1.rb +1 -1
- data/generated/google/apis/testing_v1/classes.rb +81 -0
- data/generated/google/apis/testing_v1/representations.rb +45 -0
- data/generated/google/apis/toolresults_v1beta3.rb +1 -1
- data/generated/google/apis/youtube_v3.rb +1 -1
- data/generated/google/apis/youtube_v3/classes.rb +0 -6
- data/generated/google/apis/youtube_v3/representations.rb +0 -1
- data/generated/google/apis/youtubereporting_v1.rb +1 -1
- data/generated/google/apis/youtubereporting_v1/classes.rb +576 -19
- data/generated/google/apis/youtubereporting_v1/representations.rb +218 -12
- data/generated/google/apis/youtubereporting_v1/service.rb +4 -4
- data/lib/google/apis/version.rb +1 -1
- metadata +18 -2
@@ -160,6 +160,12 @@ module Google
|
|
160
160
|
include Google::Apis::Core::JsonObjectSupport
|
161
161
|
end
|
162
162
|
|
163
|
+
class TimeSpan
|
164
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
|
+
|
166
|
+
include Google::Apis::Core::JsonObjectSupport
|
167
|
+
end
|
168
|
+
|
163
169
|
class Volume
|
164
170
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
165
171
|
|
@@ -195,6 +201,8 @@ module Google
|
|
195
201
|
hash :substitutions, as: 'substitutions'
|
196
202
|
collection :tags, as: 'tags'
|
197
203
|
property :timeout, as: 'timeout'
|
204
|
+
hash :timing, as: 'timing', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation
|
205
|
+
|
198
206
|
end
|
199
207
|
end
|
200
208
|
|
@@ -228,6 +236,8 @@ module Google
|
|
228
236
|
property :id, as: 'id'
|
229
237
|
property :name, as: 'name'
|
230
238
|
collection :secret_env, as: 'secretEnv'
|
239
|
+
property :timing, as: 'timing', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation
|
240
|
+
|
231
241
|
collection :volumes, as: 'volumes', class: Google::Apis::CloudbuildV1::Volume, decorator: Google::Apis::CloudbuildV1::Volume::Representation
|
232
242
|
|
233
243
|
collection :wait_for, as: 'waitFor'
|
@@ -255,6 +265,8 @@ module Google
|
|
255
265
|
class Representation < Google::Apis::Core::JsonRepresentation
|
256
266
|
property :digest, as: 'digest'
|
257
267
|
property :name, as: 'name'
|
268
|
+
property :push_timing, as: 'pushTiming', class: Google::Apis::CloudbuildV1::TimeSpan, decorator: Google::Apis::CloudbuildV1::TimeSpan::Representation
|
269
|
+
|
258
270
|
end
|
259
271
|
end
|
260
272
|
|
@@ -405,6 +417,14 @@ module Google
|
|
405
417
|
end
|
406
418
|
end
|
407
419
|
|
420
|
+
class TimeSpan
|
421
|
+
# @private
|
422
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
423
|
+
property :end_time, as: 'endTime'
|
424
|
+
property :start_time, as: 'startTime'
|
425
|
+
end
|
426
|
+
end
|
427
|
+
|
408
428
|
class Volume
|
409
429
|
# @private
|
410
430
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://cloud.google.com/functions
|
27
27
|
module CloudfunctionsV1
|
28
28
|
VERSION = 'V1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20171206'
|
30
30
|
|
31
31
|
# View and manage your data across Google Cloud Platform services
|
32
32
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
@@ -199,20 +199,17 @@ module Google
|
|
199
199
|
include Google::Apis::Core::Hashable
|
200
200
|
|
201
201
|
# Required. The type of event to observe. For example:
|
202
|
-
# `
|
203
|
-
# `
|
204
|
-
# Event
|
205
|
-
#
|
206
|
-
#
|
207
|
-
# specific subdivisions. If the organization's top-level domain is `com`,
|
208
|
-
# the top-level domain is ommited (e.g. `google.com` appears as
|
209
|
-
# `google`). For example, `google.storage` and
|
202
|
+
# `providers/cloud.storage/eventTypes/object.change` and
|
203
|
+
# `providers/cloud.pubsub/eventTypes/topic.publish`.
|
204
|
+
# Event types match pattern `providers/*/eventTypes/*.*`.
|
205
|
+
# The pattern contains:
|
206
|
+
# 1. namespace: For example, `cloud.storage` and
|
210
207
|
# `google.firebase.analytics`.
|
211
|
-
# 2. resource type: The type of resource on which event
|
208
|
+
# 2. resource type: The type of resource on which event occurs. For
|
212
209
|
# example, the Google Cloud Storage API includes the type `object`.
|
213
|
-
# 3. action: The action that generates the event. For example,
|
214
|
-
# a Google Cloud Storage Object
|
215
|
-
# These parts are lower case
|
210
|
+
# 3. action: The action that generates the event. For example, action for
|
211
|
+
# a Google Cloud Storage Object is 'change'.
|
212
|
+
# These parts are lower case.
|
216
213
|
# Corresponds to the JSON property `eventType`
|
217
214
|
# @return [String]
|
218
215
|
attr_accessor :event_type
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://cloud.google.com/resource-manager
|
27
27
|
module CloudresourcemanagerV1
|
28
28
|
VERSION = 'V1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20171211'
|
30
30
|
|
31
31
|
# View and manage your data across Google Cloud Platform services
|
32
32
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
@@ -318,6 +318,14 @@ module Google
|
|
318
318
|
class Constraint
|
319
319
|
include Google::Apis::Core::Hashable
|
320
320
|
|
321
|
+
# A `Constraint` that is either enforced or not.
|
322
|
+
# For example a constraint `constraints/compute.disableSerialPortAccess`.
|
323
|
+
# If it is enforced on a VM instance, serial port connections will not be
|
324
|
+
# opened to that instance.
|
325
|
+
# Corresponds to the JSON property `booleanConstraint`
|
326
|
+
# @return [Google::Apis::CloudresourcemanagerV1::BooleanConstraint]
|
327
|
+
attr_accessor :boolean_constraint
|
328
|
+
|
321
329
|
# The evaluation behavior of this constraint in the absense of 'Policy'.
|
322
330
|
# Corresponds to the JSON property `constraintDefault`
|
323
331
|
# @return [String]
|
@@ -359,6 +367,7 @@ module Google
|
|
359
367
|
|
360
368
|
# Update properties of this object
|
361
369
|
def update!(**args)
|
370
|
+
@boolean_constraint = args[:boolean_constraint] if args.key?(:boolean_constraint)
|
362
371
|
@constraint_default = args[:constraint_default] if args.key?(:constraint_default)
|
363
372
|
@description = args[:description] if args.key?(:description)
|
364
373
|
@display_name = args[:display_name] if args.key?(:display_name)
|
@@ -1066,6 +1075,21 @@ module Google
|
|
1066
1075
|
# @return [Google::Apis::CloudresourcemanagerV1::ListPolicy]
|
1067
1076
|
attr_accessor :list_policy
|
1068
1077
|
|
1078
|
+
# Ignores policies set above this resource and restores the
|
1079
|
+
# `constraint_default` enforcement behavior of the specific `Constraint` at
|
1080
|
+
# this resource.
|
1081
|
+
# Suppose that `constraint_default` is set to `ALLOW` for the
|
1082
|
+
# `Constraint` `constraints/serviceuser.services`. Suppose that organization
|
1083
|
+
# foo.com sets a `Policy` at their Organization resource node that restricts
|
1084
|
+
# the allowed service activations to deny all service activations. They
|
1085
|
+
# could then set a `Policy` with the `policy_type` `restore_default` on
|
1086
|
+
# several experimental projects, restoring the `constraint_default`
|
1087
|
+
# enforcement of the `Constraint` for only those projects, allowing those
|
1088
|
+
# projects to have all services activated.
|
1089
|
+
# Corresponds to the JSON property `restoreDefault`
|
1090
|
+
# @return [Google::Apis::CloudresourcemanagerV1::RestoreDefault]
|
1091
|
+
attr_accessor :restore_default
|
1092
|
+
|
1069
1093
|
# The time stamp the `Policy` was previously updated. This is set by the
|
1070
1094
|
# server, not specified by the caller, and represents the last time a call to
|
1071
1095
|
# `SetOrgPolicy` was made for that `Policy`. Any value set by the client will
|
@@ -1089,6 +1113,7 @@ module Google
|
|
1089
1113
|
@constraint = args[:constraint] if args.key?(:constraint)
|
1090
1114
|
@etag = args[:etag] if args.key?(:etag)
|
1091
1115
|
@list_policy = args[:list_policy] if args.key?(:list_policy)
|
1116
|
+
@restore_default = args[:restore_default] if args.key?(:restore_default)
|
1092
1117
|
@update_time = args[:update_time] if args.key?(:update_time)
|
1093
1118
|
@version = args[:version] if args.key?(:version)
|
1094
1119
|
end
|
@@ -331,6 +331,8 @@ module Google
|
|
331
331
|
class Constraint
|
332
332
|
# @private
|
333
333
|
class Representation < Google::Apis::Core::JsonRepresentation
|
334
|
+
property :boolean_constraint, as: 'booleanConstraint', class: Google::Apis::CloudresourcemanagerV1::BooleanConstraint, decorator: Google::Apis::CloudresourcemanagerV1::BooleanConstraint::Representation
|
335
|
+
|
334
336
|
property :constraint_default, as: 'constraintDefault'
|
335
337
|
property :description, as: 'description'
|
336
338
|
property :display_name, as: 'displayName'
|
@@ -501,6 +503,8 @@ module Google
|
|
501
503
|
property :etag, :base64 => true, as: 'etag'
|
502
504
|
property :list_policy, as: 'listPolicy', class: Google::Apis::CloudresourcemanagerV1::ListPolicy, decorator: Google::Apis::CloudresourcemanagerV1::ListPolicy::Representation
|
503
505
|
|
506
|
+
property :restore_default, as: 'restoreDefault', class: Google::Apis::CloudresourcemanagerV1::RestoreDefault, decorator: Google::Apis::CloudresourcemanagerV1::RestoreDefault::Representation
|
507
|
+
|
504
508
|
property :update_time, as: 'updateTime'
|
505
509
|
property :version, as: 'version'
|
506
510
|
end
|
@@ -1080,7 +1080,11 @@ module Google
|
|
1080
1080
|
|
1081
1081
|
# Lists Projects that are visible to the user and satisfy the
|
1082
1082
|
# specified filter. This method returns Projects in an unspecified order.
|
1083
|
-
#
|
1083
|
+
# This method is eventually consistent with project mutations; this means
|
1084
|
+
# that a newly created project may not appear in the results or recent
|
1085
|
+
# updates to an existing project may not be reflected in the results. To
|
1086
|
+
# retrieve the latest state of a project, use the
|
1087
|
+
# GetProject method.
|
1084
1088
|
# @param [String] filter
|
1085
1089
|
# An expression for filtering the results of the request. Filter rules are
|
1086
1090
|
# case insensitive. The fields eligible for filtering are:
|
@@ -1211,7 +1215,7 @@ module Google
|
|
1211
1215
|
execute_or_queue_command(command, &block)
|
1212
1216
|
end
|
1213
1217
|
|
1214
|
-
# Sets the IAM access control policy for the specified Project.
|
1218
|
+
# Sets the IAM access control policy for the specified Project. Overwrites
|
1215
1219
|
# any existing policy.
|
1216
1220
|
# The following constraints apply when using `setIamPolicy()`:
|
1217
1221
|
# + Project does not support `allUsers` and `allAuthenticatedUsers` as
|
@@ -1235,7 +1239,8 @@ module Google
|
|
1235
1239
|
# projects that no longer have owners who have accepted the ToS. Edits to
|
1236
1240
|
# IAM policies will be rejected until the lack of a ToS-accepting owner is
|
1237
1241
|
# rectified.
|
1238
|
-
# +
|
1242
|
+
# + This method will replace the existing policy, and cannot be used to
|
1243
|
+
# append additional IAM settings.
|
1239
1244
|
# Note: Removing service accounts from policies or changing their roles
|
1240
1245
|
# can render services completely inoperable. It is important to understand
|
1241
1246
|
# how the service account is being used before removing or updating its
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://cloud.google.com/resource-manager
|
27
27
|
module CloudresourcemanagerV1beta1
|
28
28
|
VERSION = 'V1beta1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20171211'
|
30
30
|
|
31
31
|
# View and manage your data across Google Cloud Platform services
|
32
32
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
@@ -468,7 +468,10 @@ module Google
|
|
468
468
|
|
469
469
|
# Lists Projects that are visible to the user and satisfy the
|
470
470
|
# specified filter. This method returns Projects in an unspecified order.
|
471
|
-
#
|
471
|
+
# This method is eventually consistent with project mutations; this means
|
472
|
+
# that a newly created project may not appear in the results or recent
|
473
|
+
# updates to an existing project may not be reflected in the results. To
|
474
|
+
# retrieve the latest state of a project, use the GetProjectmethod.
|
472
475
|
# @param [String] filter
|
473
476
|
# An expression for filtering the results of the request. Filter rules are
|
474
477
|
# case insensitive. The fields eligible for filtering are:
|
@@ -533,7 +536,7 @@ module Google
|
|
533
536
|
execute_or_queue_command(command, &block)
|
534
537
|
end
|
535
538
|
|
536
|
-
# Sets the IAM access control policy for the specified Project.
|
539
|
+
# Sets the IAM access control policy for the specified Project. Overwrites
|
537
540
|
# any existing policy.
|
538
541
|
# The following constraints apply when using `setIamPolicy()`:
|
539
542
|
# + Project does not support `allUsers` and `allAuthenticatedUsers` as
|
@@ -556,7 +559,8 @@ module Google
|
|
556
559
|
# projects that no longer have owners who have accepted the ToS. Edits to
|
557
560
|
# IAM policies will be rejected until the lack of a ToS-accepting owner is
|
558
561
|
# rectified.
|
559
|
-
# +
|
562
|
+
# + This method will replace the existing policy, and cannot be used to
|
563
|
+
# append additional IAM settings.
|
560
564
|
# Note: Removing service accounts from policies or changing their roles
|
561
565
|
# can render services completely inoperable. It is important to understand
|
562
566
|
# how the service account is being used before removing or updating its
|
@@ -26,7 +26,7 @@ module Google
|
|
26
26
|
# @see https://cloud.google.com/resource-manager
|
27
27
|
module CloudresourcemanagerV2beta1
|
28
28
|
VERSION = 'V2beta1'
|
29
|
-
REVISION = '
|
29
|
+
REVISION = '20171211'
|
30
30
|
|
31
31
|
# View and manage your data across Google Cloud Platform services
|
32
32
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
@@ -202,7 +202,8 @@ module Google
|
|
202
202
|
|
203
203
|
# Output only. The lifecycle state of the folder.
|
204
204
|
# Updates to the lifecycle_state must be performed via
|
205
|
-
#
|
205
|
+
# DeleteFolder and
|
206
|
+
# UndeleteFolder.
|
206
207
|
# Corresponds to the JSON property `lifecycleState`
|
207
208
|
# @return [String]
|
208
209
|
attr_accessor :lifecycle_state
|
@@ -214,7 +215,8 @@ module Google
|
|
214
215
|
attr_accessor :name
|
215
216
|
|
216
217
|
# The Folder’s parent's resource name.
|
217
|
-
# Updates to the folder's parent must be performed via
|
218
|
+
# Updates to the folder's parent must be performed via
|
219
|
+
# MoveFolder.
|
218
220
|
# Corresponds to the JSON property `parent`
|
219
221
|
# @return [String]
|
220
222
|
attr_accessor :parent
|
@@ -583,13 +585,13 @@ module Google
|
|
583
585
|
# lifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`
|
584
586
|
# can be used along with the suffix wildcard symbol `*`.
|
585
587
|
# Some example queries are:
|
586
|
-
# |Query|Description|
|
587
|
-
#
|
588
|
+
# |Query | Description|
|
589
|
+
# |----- | -----------|
|
588
590
|
# |displayName=Test*|Folders whose display name starts with "Test".|
|
589
591
|
# |lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|
|
590
592
|
# |parent=folders/123|Folders whose parent is "folders/123".|
|
591
|
-
# |parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose
|
592
|
-
#
|
593
|
+
# |parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is "
|
594
|
+
# folders/123".|
|
593
595
|
# Corresponds to the JSON property `query`
|
594
596
|
# @return [String]
|
595
597
|
attr_accessor :query
|
@@ -105,10 +105,12 @@ module Google
|
|
105
105
|
end
|
106
106
|
|
107
107
|
# Requests deletion of a Folder. The Folder is moved into the
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
108
|
+
# DELETE_REQUESTED state
|
109
|
+
# immediately, and is deleted approximately 30 days later. This method may
|
110
|
+
# only be called on an empty Folder in the
|
111
|
+
# ACTIVE state, where a Folder is empty if
|
112
|
+
# it doesn't contain any Folders or Projects in the
|
113
|
+
# ACTIVE state.
|
112
114
|
# The caller must have `resourcemanager.folders.delete` permission on the
|
113
115
|
# identified folder.
|
114
116
|
# @param [String] name
|
@@ -235,8 +237,9 @@ module Google
|
|
235
237
|
# Access to this method is controlled by checking the
|
236
238
|
# `resourcemanager.folders.list` permission on the `parent`.
|
237
239
|
# @param [Boolean] show_deleted
|
238
|
-
# Controls whether Folders in the
|
239
|
-
#
|
240
|
+
# Controls whether Folders in the
|
241
|
+
# DELETE_REQUESTED
|
242
|
+
# state should be returned.
|
240
243
|
# @param [String] fields
|
241
244
|
# Selector specifying which fields to include in a partial response.
|
242
245
|
# @param [String] quota_user
|
@@ -280,7 +283,8 @@ module Google
|
|
280
283
|
# In addition, the Operation.metadata field will be populated with a
|
281
284
|
# FolderOperation message as an aid to stateless clients.
|
282
285
|
# Folder moves will be rejected if they violate either the naming, height
|
283
|
-
# or fanout constraints described in the
|
286
|
+
# or fanout constraints described in the
|
287
|
+
# CreateFolder documentation.
|
284
288
|
# The caller must have `resourcemanager.folders.move` permission on the
|
285
289
|
# folder's current and proposed new parent.
|
286
290
|
# @param [String] name
|
@@ -318,9 +322,9 @@ module Google
|
|
318
322
|
|
319
323
|
# Updates a Folder, changing its display_name.
|
320
324
|
# Changes to the folder display_name will be rejected if they violate either
|
321
|
-
# the display_name formatting rules or naming constraints described in
|
322
|
-
#
|
323
|
-
#
|
325
|
+
# the display_name formatting rules or naming constraints described in the
|
326
|
+
# CreateFolder documentation.
|
327
|
+
# The Folder's display name must start and end with a letter or digit,
|
324
328
|
# may contain letters, digits, spaces, hyphens and underscores and can be
|
325
329
|
# no longer than 30 characters. This is captured by the regular expression:
|
326
330
|
# [\p`L`\p`N`](`\p`L`\p`N`_- ]`0,28`[\p`L`\p`N`])?.
|
@@ -476,11 +480,13 @@ module Google
|
|
476
480
|
end
|
477
481
|
|
478
482
|
# Cancels the deletion request for a Folder. This method may only be
|
479
|
-
# called on a Folder in the
|
480
|
-
#
|
483
|
+
# called on a Folder in the
|
484
|
+
# DELETE_REQUESTED state.
|
485
|
+
# In order to succeed, the Folder's parent must be in the
|
486
|
+
# ACTIVE state.
|
481
487
|
# In addition, reintroducing the folder into the tree must not violate
|
482
488
|
# folder naming, height and fanout constraints described in the
|
483
|
-
#
|
489
|
+
# CreateFolder documentation.
|
484
490
|
# The caller must have `resourcemanager.folders.undelete` permission on the
|
485
491
|
# identified folder.
|
486
492
|
# @param [String] name
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# Copyright 2015 Google Inc.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'google/apis/cloudshell_v1/service.rb'
|
16
|
+
require 'google/apis/cloudshell_v1/classes.rb'
|
17
|
+
require 'google/apis/cloudshell_v1/representations.rb'
|
18
|
+
|
19
|
+
module Google
|
20
|
+
module Apis
|
21
|
+
# Cloud Shell API
|
22
|
+
#
|
23
|
+
# Allows users to start, configure, and connect to interactive shell sessions
|
24
|
+
# running in the cloud.
|
25
|
+
#
|
26
|
+
# @see https://cloud.google.com/shell/docs/
|
27
|
+
module CloudshellV1
|
28
|
+
VERSION = 'V1'
|
29
|
+
REVISION = '20171211'
|
30
|
+
|
31
|
+
# View and manage your data across Google Cloud Platform services
|
32
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,409 @@
|
|
1
|
+
# Copyright 2015 Google Inc.
|
2
|
+
#
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4
|
+
# you may not use this file except in compliance with the License.
|
5
|
+
# You may obtain a copy of the License at
|
6
|
+
#
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8
|
+
#
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12
|
+
# See the License for the specific language governing permissions and
|
13
|
+
# limitations under the License.
|
14
|
+
|
15
|
+
require 'date'
|
16
|
+
require 'google/apis/core/base_service'
|
17
|
+
require 'google/apis/core/json_representation'
|
18
|
+
require 'google/apis/core/hashable'
|
19
|
+
require 'google/apis/errors'
|
20
|
+
|
21
|
+
module Google
|
22
|
+
module Apis
|
23
|
+
module CloudshellV1
|
24
|
+
|
25
|
+
# The request message for Operations.CancelOperation.
|
26
|
+
class CancelOperationRequest
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
def initialize(**args)
|
30
|
+
update!(**args)
|
31
|
+
end
|
32
|
+
|
33
|
+
# Update properties of this object
|
34
|
+
def update!(**args)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
38
|
+
# A generic empty message that you can re-use to avoid defining duplicated
|
39
|
+
# empty messages in your APIs. A typical example is to use it as the request
|
40
|
+
# or the response type of an API method. For instance:
|
41
|
+
# service Foo `
|
42
|
+
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
43
|
+
# `
|
44
|
+
# The JSON representation for `Empty` is empty JSON object ````.
|
45
|
+
class Empty
|
46
|
+
include Google::Apis::Core::Hashable
|
47
|
+
|
48
|
+
def initialize(**args)
|
49
|
+
update!(**args)
|
50
|
+
end
|
51
|
+
|
52
|
+
# Update properties of this object
|
53
|
+
def update!(**args)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# A Cloud Shell environment, which is defined as the combination of a Docker
|
58
|
+
# image specifying what is installed on the environment and a home directory
|
59
|
+
# containing the user's data that will remain across sessions. Each user has a
|
60
|
+
# single environment with the ID "default".
|
61
|
+
class Environment
|
62
|
+
include Google::Apis::Core::Hashable
|
63
|
+
|
64
|
+
# Required. Full path to the Docker image used to run this environment, e.g.
|
65
|
+
# "gcr.io/dev-con/cloud-devshell:latest".
|
66
|
+
# Corresponds to the JSON property `dockerImage`
|
67
|
+
# @return [String]
|
68
|
+
attr_accessor :docker_image
|
69
|
+
|
70
|
+
# Output only. The environment's identifier, which is always "default".
|
71
|
+
# Corresponds to the JSON property `id`
|
72
|
+
# @return [String]
|
73
|
+
attr_accessor :id
|
74
|
+
|
75
|
+
# Output only. Full name of this resource, in the format
|
76
|
+
# `users/`owner_email`/environments/`environment_id``. ``owner_email`` is the
|
77
|
+
# email address of the user to whom this environment belongs, and
|
78
|
+
# ``environment_id`` is the identifier of this environment. For example,
|
79
|
+
# `users/someone@example.com/environments/default`.
|
80
|
+
# Corresponds to the JSON property `name`
|
81
|
+
# @return [String]
|
82
|
+
attr_accessor :name
|
83
|
+
|
84
|
+
# Output only. Public keys associated with the environment. Clients can
|
85
|
+
# connect to this environment via SSH only if they possess a private key
|
86
|
+
# corresponding to at least one of these public keys. Keys can be added to or
|
87
|
+
# removed from the environment using the CreatePublicKey and DeletePublicKey
|
88
|
+
# methods.
|
89
|
+
# Corresponds to the JSON property `publicKeys`
|
90
|
+
# @return [Array<Google::Apis::CloudshellV1::PublicKey>]
|
91
|
+
attr_accessor :public_keys
|
92
|
+
|
93
|
+
# Output only. Host to which clients can connect to initiate SSH sessions
|
94
|
+
# with the environment.
|
95
|
+
# Corresponds to the JSON property `sshHost`
|
96
|
+
# @return [String]
|
97
|
+
attr_accessor :ssh_host
|
98
|
+
|
99
|
+
# Output only. Port to which clients can connect to initiate SSH sessions
|
100
|
+
# with the environment.
|
101
|
+
# Corresponds to the JSON property `sshPort`
|
102
|
+
# @return [Fixnum]
|
103
|
+
attr_accessor :ssh_port
|
104
|
+
|
105
|
+
# Output only. Username that clients should use when initiating SSH sessions
|
106
|
+
# with the environment.
|
107
|
+
# Corresponds to the JSON property `sshUsername`
|
108
|
+
# @return [String]
|
109
|
+
attr_accessor :ssh_username
|
110
|
+
|
111
|
+
# Output only. Current execution state of this environment.
|
112
|
+
# Corresponds to the JSON property `state`
|
113
|
+
# @return [String]
|
114
|
+
attr_accessor :state
|
115
|
+
|
116
|
+
def initialize(**args)
|
117
|
+
update!(**args)
|
118
|
+
end
|
119
|
+
|
120
|
+
# Update properties of this object
|
121
|
+
def update!(**args)
|
122
|
+
@docker_image = args[:docker_image] if args.key?(:docker_image)
|
123
|
+
@id = args[:id] if args.key?(:id)
|
124
|
+
@name = args[:name] if args.key?(:name)
|
125
|
+
@public_keys = args[:public_keys] if args.key?(:public_keys)
|
126
|
+
@ssh_host = args[:ssh_host] if args.key?(:ssh_host)
|
127
|
+
@ssh_port = args[:ssh_port] if args.key?(:ssh_port)
|
128
|
+
@ssh_username = args[:ssh_username] if args.key?(:ssh_username)
|
129
|
+
@state = args[:state] if args.key?(:state)
|
130
|
+
end
|
131
|
+
end
|
132
|
+
|
133
|
+
# The response message for Operations.ListOperations.
|
134
|
+
class ListOperationsResponse
|
135
|
+
include Google::Apis::Core::Hashable
|
136
|
+
|
137
|
+
# The standard List next-page token.
|
138
|
+
# Corresponds to the JSON property `nextPageToken`
|
139
|
+
# @return [String]
|
140
|
+
attr_accessor :next_page_token
|
141
|
+
|
142
|
+
# A list of operations that matches the specified filter in the request.
|
143
|
+
# Corresponds to the JSON property `operations`
|
144
|
+
# @return [Array<Google::Apis::CloudshellV1::Operation>]
|
145
|
+
attr_accessor :operations
|
146
|
+
|
147
|
+
def initialize(**args)
|
148
|
+
update!(**args)
|
149
|
+
end
|
150
|
+
|
151
|
+
# Update properties of this object
|
152
|
+
def update!(**args)
|
153
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
154
|
+
@operations = args[:operations] if args.key?(:operations)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# This resource represents a long-running operation that is the result of a
|
159
|
+
# network API call.
|
160
|
+
class Operation
|
161
|
+
include Google::Apis::Core::Hashable
|
162
|
+
|
163
|
+
# If the value is `false`, it means the operation is still in progress.
|
164
|
+
# If `true`, the operation is completed, and either `error` or `response` is
|
165
|
+
# available.
|
166
|
+
# Corresponds to the JSON property `done`
|
167
|
+
# @return [Boolean]
|
168
|
+
attr_accessor :done
|
169
|
+
alias_method :done?, :done
|
170
|
+
|
171
|
+
# The `Status` type defines a logical error model that is suitable for different
|
172
|
+
# programming environments, including REST APIs and RPC APIs. It is used by
|
173
|
+
# [gRPC](https://github.com/grpc). The error model is designed to be:
|
174
|
+
# - Simple to use and understand for most users
|
175
|
+
# - Flexible enough to meet unexpected needs
|
176
|
+
# # Overview
|
177
|
+
# The `Status` message contains three pieces of data: error code, error message,
|
178
|
+
# and error details. The error code should be an enum value of
|
179
|
+
# google.rpc.Code, but it may accept additional error codes if needed. The
|
180
|
+
# error message should be a developer-facing English message that helps
|
181
|
+
# developers *understand* and *resolve* the error. If a localized user-facing
|
182
|
+
# error message is needed, put the localized message in the error details or
|
183
|
+
# localize it in the client. The optional error details may contain arbitrary
|
184
|
+
# information about the error. There is a predefined set of error detail types
|
185
|
+
# in the package `google.rpc` that can be used for common error conditions.
|
186
|
+
# # Language mapping
|
187
|
+
# The `Status` message is the logical representation of the error model, but it
|
188
|
+
# is not necessarily the actual wire format. When the `Status` message is
|
189
|
+
# exposed in different client libraries and different wire protocols, it can be
|
190
|
+
# mapped differently. For example, it will likely be mapped to some exceptions
|
191
|
+
# in Java, but more likely mapped to some error codes in C.
|
192
|
+
# # Other uses
|
193
|
+
# The error model and the `Status` message can be used in a variety of
|
194
|
+
# environments, either with or without APIs, to provide a
|
195
|
+
# consistent developer experience across different environments.
|
196
|
+
# Example uses of this error model include:
|
197
|
+
# - Partial errors. If a service needs to return partial errors to the client,
|
198
|
+
# it may embed the `Status` in the normal response to indicate the partial
|
199
|
+
# errors.
|
200
|
+
# - Workflow errors. A typical workflow has multiple steps. Each step may
|
201
|
+
# have a `Status` message for error reporting.
|
202
|
+
# - Batch operations. If a client uses batch request and batch response, the
|
203
|
+
# `Status` message should be used directly inside batch response, one for
|
204
|
+
# each error sub-response.
|
205
|
+
# - Asynchronous operations. If an API call embeds asynchronous operation
|
206
|
+
# results in its response, the status of those operations should be
|
207
|
+
# represented directly using the `Status` message.
|
208
|
+
# - Logging. If some API errors are stored in logs, the message `Status` could
|
209
|
+
# be used directly after any stripping needed for security/privacy reasons.
|
210
|
+
# Corresponds to the JSON property `error`
|
211
|
+
# @return [Google::Apis::CloudshellV1::Status]
|
212
|
+
attr_accessor :error
|
213
|
+
|
214
|
+
# Service-specific metadata associated with the operation. It typically
|
215
|
+
# contains progress information and common metadata such as create time.
|
216
|
+
# Some services might not provide such metadata. Any method that returns a
|
217
|
+
# long-running operation should document the metadata type, if any.
|
218
|
+
# Corresponds to the JSON property `metadata`
|
219
|
+
# @return [Hash<String,Object>]
|
220
|
+
attr_accessor :metadata
|
221
|
+
|
222
|
+
# The server-assigned name, which is only unique within the same service that
|
223
|
+
# originally returns it. If you use the default HTTP mapping, the
|
224
|
+
# `name` should have the format of `operations/some/unique/name`.
|
225
|
+
# Corresponds to the JSON property `name`
|
226
|
+
# @return [String]
|
227
|
+
attr_accessor :name
|
228
|
+
|
229
|
+
# The normal response of the operation in case of success. If the original
|
230
|
+
# method returns no data on success, such as `Delete`, the response is
|
231
|
+
# `google.protobuf.Empty`. If the original method is standard
|
232
|
+
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
233
|
+
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
234
|
+
# is the original method name. For example, if the original method name
|
235
|
+
# is `TakeSnapshot()`, the inferred response type is
|
236
|
+
# `TakeSnapshotResponse`.
|
237
|
+
# Corresponds to the JSON property `response`
|
238
|
+
# @return [Hash<String,Object>]
|
239
|
+
attr_accessor :response
|
240
|
+
|
241
|
+
def initialize(**args)
|
242
|
+
update!(**args)
|
243
|
+
end
|
244
|
+
|
245
|
+
# Update properties of this object
|
246
|
+
def update!(**args)
|
247
|
+
@done = args[:done] if args.key?(:done)
|
248
|
+
@error = args[:error] if args.key?(:error)
|
249
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
250
|
+
@name = args[:name] if args.key?(:name)
|
251
|
+
@response = args[:response] if args.key?(:response)
|
252
|
+
end
|
253
|
+
end
|
254
|
+
|
255
|
+
# A public SSH key, corresponding to a private SSH key held by the client.
|
256
|
+
class PublicKey
|
257
|
+
include Google::Apis::Core::Hashable
|
258
|
+
|
259
|
+
# Required. Format of this key's content.
|
260
|
+
# Corresponds to the JSON property `format`
|
261
|
+
# @return [String]
|
262
|
+
attr_accessor :format
|
263
|
+
|
264
|
+
# Required. Content of this key.
|
265
|
+
# Corresponds to the JSON property `key`
|
266
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
267
|
+
# @return [String]
|
268
|
+
attr_accessor :key
|
269
|
+
|
270
|
+
# Output only. Full name of this resource, in the format
|
271
|
+
# `users/`owner_email`/environments/`environment_id`/publicKeys/`key_id``.
|
272
|
+
# ``owner_email`` is the email address of the user to whom the key belongs.
|
273
|
+
# ``environment_id`` is the identifier of the environment to which the key
|
274
|
+
# grants access. ``key_id`` is the unique identifier of the key. For example,
|
275
|
+
# `users/someone@example.com/environments/default/publicKeys/myKey`.
|
276
|
+
# Corresponds to the JSON property `name`
|
277
|
+
# @return [String]
|
278
|
+
attr_accessor :name
|
279
|
+
|
280
|
+
def initialize(**args)
|
281
|
+
update!(**args)
|
282
|
+
end
|
283
|
+
|
284
|
+
# Update properties of this object
|
285
|
+
def update!(**args)
|
286
|
+
@format = args[:format] if args.key?(:format)
|
287
|
+
@key = args[:key] if args.key?(:key)
|
288
|
+
@name = args[:name] if args.key?(:name)
|
289
|
+
end
|
290
|
+
end
|
291
|
+
|
292
|
+
# Message included in the metadata field of operations returned from
|
293
|
+
# StartEnvironment.
|
294
|
+
class StartEnvironmentMetadata
|
295
|
+
include Google::Apis::Core::Hashable
|
296
|
+
|
297
|
+
# Current state of the environment being started.
|
298
|
+
# Corresponds to the JSON property `state`
|
299
|
+
# @return [String]
|
300
|
+
attr_accessor :state
|
301
|
+
|
302
|
+
def initialize(**args)
|
303
|
+
update!(**args)
|
304
|
+
end
|
305
|
+
|
306
|
+
# Update properties of this object
|
307
|
+
def update!(**args)
|
308
|
+
@state = args[:state] if args.key?(:state)
|
309
|
+
end
|
310
|
+
end
|
311
|
+
|
312
|
+
# Message included in the response field of operations returned from
|
313
|
+
# StartEnvironment once the
|
314
|
+
# operation is complete.
|
315
|
+
class StartEnvironmentResponse
|
316
|
+
include Google::Apis::Core::Hashable
|
317
|
+
|
318
|
+
# A Cloud Shell environment, which is defined as the combination of a Docker
|
319
|
+
# image specifying what is installed on the environment and a home directory
|
320
|
+
# containing the user's data that will remain across sessions. Each user has a
|
321
|
+
# single environment with the ID "default".
|
322
|
+
# Corresponds to the JSON property `environment`
|
323
|
+
# @return [Google::Apis::CloudshellV1::Environment]
|
324
|
+
attr_accessor :environment
|
325
|
+
|
326
|
+
def initialize(**args)
|
327
|
+
update!(**args)
|
328
|
+
end
|
329
|
+
|
330
|
+
# Update properties of this object
|
331
|
+
def update!(**args)
|
332
|
+
@environment = args[:environment] if args.key?(:environment)
|
333
|
+
end
|
334
|
+
end
|
335
|
+
|
336
|
+
# The `Status` type defines a logical error model that is suitable for different
|
337
|
+
# programming environments, including REST APIs and RPC APIs. It is used by
|
338
|
+
# [gRPC](https://github.com/grpc). The error model is designed to be:
|
339
|
+
# - Simple to use and understand for most users
|
340
|
+
# - Flexible enough to meet unexpected needs
|
341
|
+
# # Overview
|
342
|
+
# The `Status` message contains three pieces of data: error code, error message,
|
343
|
+
# and error details. The error code should be an enum value of
|
344
|
+
# google.rpc.Code, but it may accept additional error codes if needed. The
|
345
|
+
# error message should be a developer-facing English message that helps
|
346
|
+
# developers *understand* and *resolve* the error. If a localized user-facing
|
347
|
+
# error message is needed, put the localized message in the error details or
|
348
|
+
# localize it in the client. The optional error details may contain arbitrary
|
349
|
+
# information about the error. There is a predefined set of error detail types
|
350
|
+
# in the package `google.rpc` that can be used for common error conditions.
|
351
|
+
# # Language mapping
|
352
|
+
# The `Status` message is the logical representation of the error model, but it
|
353
|
+
# is not necessarily the actual wire format. When the `Status` message is
|
354
|
+
# exposed in different client libraries and different wire protocols, it can be
|
355
|
+
# mapped differently. For example, it will likely be mapped to some exceptions
|
356
|
+
# in Java, but more likely mapped to some error codes in C.
|
357
|
+
# # Other uses
|
358
|
+
# The error model and the `Status` message can be used in a variety of
|
359
|
+
# environments, either with or without APIs, to provide a
|
360
|
+
# consistent developer experience across different environments.
|
361
|
+
# Example uses of this error model include:
|
362
|
+
# - Partial errors. If a service needs to return partial errors to the client,
|
363
|
+
# it may embed the `Status` in the normal response to indicate the partial
|
364
|
+
# errors.
|
365
|
+
# - Workflow errors. A typical workflow has multiple steps. Each step may
|
366
|
+
# have a `Status` message for error reporting.
|
367
|
+
# - Batch operations. If a client uses batch request and batch response, the
|
368
|
+
# `Status` message should be used directly inside batch response, one for
|
369
|
+
# each error sub-response.
|
370
|
+
# - Asynchronous operations. If an API call embeds asynchronous operation
|
371
|
+
# results in its response, the status of those operations should be
|
372
|
+
# represented directly using the `Status` message.
|
373
|
+
# - Logging. If some API errors are stored in logs, the message `Status` could
|
374
|
+
# be used directly after any stripping needed for security/privacy reasons.
|
375
|
+
class Status
|
376
|
+
include Google::Apis::Core::Hashable
|
377
|
+
|
378
|
+
# The status code, which should be an enum value of google.rpc.Code.
|
379
|
+
# Corresponds to the JSON property `code`
|
380
|
+
# @return [Fixnum]
|
381
|
+
attr_accessor :code
|
382
|
+
|
383
|
+
# A list of messages that carry the error details. There is a common set of
|
384
|
+
# message types for APIs to use.
|
385
|
+
# Corresponds to the JSON property `details`
|
386
|
+
# @return [Array<Hash<String,Object>>]
|
387
|
+
attr_accessor :details
|
388
|
+
|
389
|
+
# A developer-facing error message, which should be in English. Any
|
390
|
+
# user-facing error message should be localized and sent in the
|
391
|
+
# google.rpc.Status.details field, or localized by the client.
|
392
|
+
# Corresponds to the JSON property `message`
|
393
|
+
# @return [String]
|
394
|
+
attr_accessor :message
|
395
|
+
|
396
|
+
def initialize(**args)
|
397
|
+
update!(**args)
|
398
|
+
end
|
399
|
+
|
400
|
+
# Update properties of this object
|
401
|
+
def update!(**args)
|
402
|
+
@code = args[:code] if args.key?(:code)
|
403
|
+
@details = args[:details] if args.key?(:details)
|
404
|
+
@message = args[:message] if args.key?(:message)
|
405
|
+
end
|
406
|
+
end
|
407
|
+
end
|
408
|
+
end
|
409
|
+
end
|