google-cloud-functions-v1 0.8.1 → 0.10.0

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.
@@ -22,7 +22,7 @@ module Google
22
22
  module Functions
23
23
  module V1
24
24
  # Describes a Cloud Function that contains user computation executed in
25
- # response to an event. It encapsulate function and triggers configurations.
25
+ # response to an event. It encapsulates function and triggers configurations.
26
26
  # @!attribute [rw] name
27
27
  # @return [::String]
28
28
  # A user-defined name of the function. Function names must be unique
@@ -41,7 +41,7 @@ module Google
41
41
  # The source repository where a function is hosted.
42
42
  # @!attribute [rw] source_upload_url
43
43
  # @return [::String]
44
- # The Google Cloud Storage signed URL used for source uploading, generated
44
+ # The Google Cloud Storage-signed URL used for source uploading, generated
45
45
  # by calling [google.cloud.functions.v1.GenerateUploadUrl].
46
46
  #
47
47
  # The signature is validated on write methods (Create, Update)
@@ -58,12 +58,12 @@ module Google
58
58
  # Output only. Status of the function deployment.
59
59
  # @!attribute [rw] entry_point
60
60
  # @return [::String]
61
- # The name of the function (as defined in source code) that will be
62
- # executed. Defaults to the resource name suffix, if not specified. For
63
- # backward compatibility, if function with given name is not found, then the
64
- # system will try to use function named "function".
65
- # For Node.js this is name of a function exported by the module specified
66
- # in `source_location`.
61
+ # The name of the function (as defined in source code) that is executed.
62
+ # Defaults to the resource name suffix, if not specified. For
63
+ # backward compatibility, if function with given name is not found, the
64
+ # system tries to use the function named "function".
65
+ # For Node.js, this is the name of a function exported by the module
66
+ # as specified in `source_location`.
67
67
  # @!attribute [rw] runtime
68
68
  # @return [::String]
69
69
  # The runtime in which to run the function. Required when deploying a new
@@ -89,8 +89,8 @@ module Google
89
89
  # Output only. The last update timestamp of a Cloud Function.
90
90
  # @!attribute [r] version_id
91
91
  # @return [::Integer]
92
- # Output only. The version identifier of the Cloud Function. Each deployment attempt
93
- # results in a new version of a function being created.
92
+ # Output only. The version identifier of the Cloud Function. Each deployment
93
+ # attempt results in a new version of a function being created.
94
94
  # @!attribute [rw] labels
95
95
  # @return [::Google::Protobuf::Map{::String => ::String}]
96
96
  # Labels associated with this Cloud Function.
@@ -102,11 +102,11 @@ module Google
102
102
  # Build environment variables that shall be available during build time.
103
103
  # @!attribute [rw] network
104
104
  # @return [::String]
105
- # The VPC Network that this cloud function can connect to. It can be
106
- # either the fully-qualified URI, or the short name of the network resource.
107
- # If the short network name is used, the network must belong to the same
108
- # project. Otherwise, it must belong to a project within the same
109
- # organization. The format of this field is either
105
+ # The Serverless VPC Access connector that this cloud function can connect
106
+ # to. It can be either the fully qualified URI, or the short name of the
107
+ # connector resource. If the connector name is used, the connector must
108
+ # belong to the same project as the function. Otherwise, it must belong to a
109
+ # project within the same organization. The format of this field is either
110
110
  # `projects/{project}/global/networks/{network}` or `{network}`, where
111
111
  # `{project}` is a project id where the network is defined, and `{network}`
112
112
  # is the short name of the network.
@@ -118,13 +118,13 @@ module Google
118
118
  # more information on connecting Cloud projects.
119
119
  # @!attribute [rw] max_instances
120
120
  # @return [::Integer]
121
- # The limit on the maximum number of function instances that may coexist at a
121
+ # The limit on the maximum number of function instances that can coexist at a
122
122
  # given time.
123
123
  #
124
- # In some cases, such as rapid traffic surges, Cloud Functions may, for a
125
- # short period of time, create more instances than the specified max
124
+ # In some cases, such as rapid traffic surges, Cloud Functions can for a
125
+ # short period of time create more instances than the specified max
126
126
  # instances limit. If your function cannot tolerate this temporary behavior,
127
- # you may want to factor in a safety margin and set a lower max instances
127
+ # you might want to factor in a safety margin and set a lower max instances
128
128
  # value than your function can tolerate.
129
129
  #
130
130
  # See the [Max
@@ -132,12 +132,12 @@ module Google
132
132
  # more details.
133
133
  # @!attribute [rw] min_instances
134
134
  # @return [::Integer]
135
- # A lower bound for the number function instances that may coexist at a
135
+ # A lower bound for the number function instances that can coexist at a
136
136
  # given time.
137
137
  # @!attribute [rw] vpc_connector
138
138
  # @return [::String]
139
139
  # The VPC Network Connector that this cloud function can connect to. It can
140
- # be either the fully-qualified URI, or the short name of the network
140
+ # be either the fully qualified URI, or the short name of the network
141
141
  # connector resource. The format of this field is
142
142
  # `projects/*/locations/*/connectors/*`
143
143
  #
@@ -215,8 +215,8 @@ module Google
215
215
  # Secret volumes configuration.
216
216
  # @!attribute [rw] source_token
217
217
  # @return [::String]
218
- # Input only. An identifier for Firebase function sources. Disclaimer: This field is only
219
- # supported for Firebase function deployments.
218
+ # Input only. An identifier for Firebase function sources. Disclaimer: This
219
+ # field is only supported for Firebase function deployments.
220
220
  # @!attribute [rw] docker_repository
221
221
  # @return [::String]
222
222
  # User managed repository created in Artifact Registry optionally with a
@@ -224,7 +224,7 @@ module Google
224
224
  # Artifact Registry. If unspecified and the deployment is eligible to use
225
225
  # Artifact Registry, GCF will create and use a repository named
226
226
  # 'gcf-artifacts' for every deployed region. This is the repository to which
227
- # the function docker image will be pushed after it is built by Cloud Build.
227
+ # the function docker image is pushed after it is built by Cloud Build.
228
228
  #
229
229
  # It must match the pattern
230
230
  # `projects/{project}/locations/{location}/repositories/{repository}`.
@@ -236,7 +236,7 @@ module Google
236
236
  # @return [::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry]
237
237
  # Docker Registry to use for this deployment.
238
238
  #
239
- # If `docker_repository` field is specified, this field will be automatically
239
+ # If `docker_repository` field is specified, this field is automatically
240
240
  # set as `ARTIFACT_REGISTRY`.
241
241
  # If unspecified, it currently defaults to `CONTAINER_REGISTRY`.
242
242
  # This field may be overridden by the backend for eligible deployments.
@@ -273,17 +273,18 @@ module Google
273
273
 
274
274
  # Available egress settings.
275
275
  #
276
- # This controls what traffic is diverted through the VPC Access Connector
277
- # resource. By default PRIVATE_RANGES_ONLY will be used.
276
+ # This controls what traffic is diverted through the Serverless VPC Access
277
+ # connector resource. By default, PRIVATE_RANGES_ONLY is used.
278
278
  module VpcConnectorEgressSettings
279
279
  # Unspecified.
280
280
  VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0
281
281
 
282
- # Use the VPC Access Connector only for private IP space from RFC1918.
282
+ # Use the Serverless VPC Access connector only for private IP space from
283
+ # RFC1918.
283
284
  PRIVATE_RANGES_ONLY = 1
284
285
 
285
- # Force the use of VPC Access Connector for all egress traffic from the
286
- # function.
286
+ # Force the use of Serverless VPC Access connector for all egress traffic
287
+ # from the function.
287
288
  ALL_TRAFFIC = 2
288
289
  end
289
290
 
@@ -291,7 +292,7 @@ module Google
291
292
  #
292
293
  # This controls what traffic can reach the function.
293
294
  #
294
- # If unspecified, ALLOW_ALL will be used.
295
+ # If unspecified, ALLOW_ALL is used.
295
296
  module IngressSettings
296
297
  # Unspecified.
297
298
  INGRESS_SETTINGS_UNSPECIFIED = 0
@@ -311,15 +312,15 @@ module Google
311
312
  # Unspecified.
312
313
  DOCKER_REGISTRY_UNSPECIFIED = 0
313
314
 
314
- # Docker images will be stored in multi-regional Container Registry
315
+ # Docker images are stored in multi-regional Container Registry
315
316
  # repositories named `gcf`.
316
317
  CONTAINER_REGISTRY = 1
317
318
 
318
- # Docker images will be stored in regional Artifact Registry repositories.
319
- # By default, GCF will create and use repositories named `gcf-artifacts`
320
- # in every region in which a function is deployed. But the repository to
321
- # use can also be specified by the user using the `docker_repository`
322
- # field.
319
+ # Docker images are stored in regional Artifact Registry repositories.
320
+ # By default, Cloud Functions creates and uses repositories named
321
+ # `gcf-artifacts` in every region in which a function is deployed. But the
322
+ # repository to use can also be specified by the user by using the
323
+ # `docker_repository` field.
323
324
  ARTIFACT_REGISTRY = 2
324
325
  end
325
326
  end
@@ -340,7 +341,7 @@ module Google
340
341
  # To refer to a specific fixed alias (tag):
341
342
  # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`
342
343
  #
343
- # You may omit `paths/*` if you want to use the main directory.
344
+ # You can omit `paths/*` if you want to use the main directory.
344
345
  # @!attribute [r] deployed_url
345
346
  # @return [::String]
346
347
  # Output only. The URL pointing to the hosted repository where the function
@@ -354,7 +355,7 @@ module Google
354
355
  # Describes HttpsTrigger, could be used to connect web hooks to function.
355
356
  # @!attribute [r] url
356
357
  # @return [::String]
357
- # Output only. The deployed url for the function.
358
+ # Output only. The deployed URL for the function.
358
359
  # @!attribute [rw] security_level
359
360
  # @return [::Google::Cloud::Functions::V1::HttpsTrigger::SecurityLevel]
360
361
  # The security level for the function.
@@ -362,11 +363,11 @@ module Google
362
363
  include ::Google::Protobuf::MessageExts
363
364
  extend ::Google::Protobuf::MessageExts::ClassMethods
364
365
 
365
- # Available security level settings.
366
+ # Available security-level settings.
366
367
  #
367
368
  # This controls the methods to enforce security (HTTPS) on a URL.
368
369
  #
369
- # If unspecified, SECURE_OPTIONAL will be used.
370
+ # If unspecified, SECURE_OPTIONAL is used.
370
371
  module SecurityLevel
371
372
  # Unspecified.
372
373
  SECURITY_LEVEL_UNSPECIFIED = 0
@@ -383,7 +384,7 @@ module Google
383
384
  end
384
385
  end
385
386
 
386
- # Describes EventTrigger, used to request events be sent from another
387
+ # Describes EventTrigger, used to request that events be sent from another
387
388
  # service.
388
389
  # @!attribute [rw] event_type
389
390
  # @return [::String]
@@ -400,7 +401,7 @@ module Google
400
401
  # example, the Google Cloud Storage API includes the type `object`.
401
402
  # 3. action: The action that generates the event. For example, action for
402
403
  # a Google Cloud Storage Object is 'change'.
403
- # These parts are lower case.
404
+ # These parts are lowercase.
404
405
  # @!attribute [rw] resource
405
406
  # @return [::String]
406
407
  # Required. The resource(s) from which to observe events, for example,
@@ -418,7 +419,7 @@ module Google
418
419
  # that matches Google Cloud Pub/Sub topics.
419
420
  #
420
421
  # Additionally, some services may support short names when creating an
421
- # `EventTrigger`. These will always be returned in the normalized "long"
422
+ # `EventTrigger`. These are always returned in the normalized "long"
422
423
  # format.
423
424
  #
424
425
  # See each *service's* documentation for supported formats.
@@ -438,17 +439,17 @@ module Google
438
439
  end
439
440
 
440
441
  # Describes the policy in case of function's execution failure.
441
- # If empty, then defaults to ignoring failures (i.e. not retrying them).
442
+ # If empty, then defaults to ignoring failures (i.e., not retrying them).
442
443
  # @!attribute [rw] retry
443
444
  # @return [::Google::Cloud::Functions::V1::FailurePolicy::Retry]
444
- # If specified, then the function will be retried in case of a failure.
445
+ # If specified, the function is retried in case of a failure.
445
446
  class FailurePolicy
446
447
  include ::Google::Protobuf::MessageExts
447
448
  extend ::Google::Protobuf::MessageExts::ClassMethods
448
449
 
449
450
  # Describes the retry policy in case of function's execution failure.
450
- # A function execution will be retried on any failure.
451
- # A failed execution will be retried up to 7 days with an exponential backoff
451
+ # A function execution is retried on any failure.
452
+ # A failed execution is retried up to 7 days with an exponential backoff
452
453
  # (capped at 10 seconds).
453
454
  # Retried execution is charged as any other execution.
454
455
  class Retry
@@ -458,7 +459,7 @@ module Google
458
459
  end
459
460
 
460
461
  # Configuration for a secret environment variable. It has the information
461
- # necessary to fetch the secret value from secret manager and expose it as an
462
+ # necessary to fetch the secret value from Secret Manager and expose it as an
462
463
  # environment variable.
463
464
  # @!attribute [rw] key
464
465
  # @return [::String]
@@ -466,12 +467,12 @@ module Google
466
467
  # @!attribute [rw] project_id
467
468
  # @return [::String]
468
469
  # Project identifier (preferrably project number but can also be the project
469
- # ID) of the project that contains the secret. If not set, it will be
470
- # populated with the function's project assuming that the secret exists in
471
- # the same project as of the function.
470
+ # ID) of the project that contains the secret. If not set, it is
471
+ # populated with the function's project, assuming that the secret exists in
472
+ # the same project as the function.
472
473
  # @!attribute [rw] secret
473
474
  # @return [::String]
474
- # Name of the secret in secret manager (not the full resource name).
475
+ # Name of the secret in Secret Manager (not the full resource name).
475
476
  # @!attribute [rw] version
476
477
  # @return [::String]
477
478
  # Version of the secret (version number or the string 'latest'). It is
@@ -483,15 +484,15 @@ module Google
483
484
  end
484
485
 
485
486
  # Configuration for a secret volume. It has the information necessary to fetch
486
- # the secret value from secret manager and make it available as files mounted
487
+ # the secret value from Secret Manager and make it available as files mounted
487
488
  # at the requested paths within the application container. Secret value is not
488
- # a part of the configuration. Every filesystem read operation performs a
489
- # lookup in secret manager to retrieve the secret value.
489
+ # a part of the configuration. Every file system read operation performs a
490
+ # lookup in Secret Manager to retrieve the secret value.
490
491
  # @!attribute [rw] mount_path
491
492
  # @return [::String]
492
493
  # The path within the container to mount the secret volume. For example,
493
- # setting the mount_path as `/etc/secrets` would mount the secret value files
494
- # under the `/etc/secrets` directory. This directory will also be completely
494
+ # setting the mount_path as `/etc/secrets` mounts the secret value files
495
+ # under the `/etc/secrets` directory. This directory is also completely
495
496
  # shadowed and unavailable to mount any other secrets.
496
497
  #
497
498
  # Recommended mount paths: /etc/secrets
@@ -499,16 +500,16 @@ module Google
499
500
  # @!attribute [rw] project_id
500
501
  # @return [::String]
501
502
  # Project identifier (preferrably project number but can also be the project
502
- # ID) of the project that contains the secret. If not set, it will be
503
- # populated with the function's project assuming that the secret exists in
504
- # the same project as of the function.
503
+ # ID) of the project that contains the secret. If not set, it is
504
+ # populated with the function's project, assuming that the secret exists in
505
+ # the same project as the function.
505
506
  # @!attribute [rw] secret
506
507
  # @return [::String]
507
- # Name of the secret in secret manager (not the full resource name).
508
+ # Name of the secret in Secret Manager (not the full resource name).
508
509
  # @!attribute [rw] versions
509
510
  # @return [::Array<::Google::Cloud::Functions::V1::SecretVolume::SecretVersion>]
510
511
  # List of secret versions to mount for this secret. If empty, the `latest`
511
- # version of the secret will be made available in a file named after the
512
+ # version of the secret is made available in a file named after the
512
513
  # secret under the mount point.
513
514
  class SecretVolume
514
515
  include ::Google::Protobuf::MessageExts
@@ -518,13 +519,13 @@ module Google
518
519
  # @!attribute [rw] version
519
520
  # @return [::String]
520
521
  # Version of the secret (version number or the string 'latest'). It is
521
- # preferrable to use `latest` version with secret volumes as secret value
522
+ # preferable to use `latest` version with secret volumes as secret value
522
523
  # changes are reflected immediately.
523
524
  # @!attribute [rw] path
524
525
  # @return [::String]
525
526
  # Relative path of the file under the mount path where the secret value for
526
- # this version will be fetched and made available. For example, setting the
527
- # mount_path as '/etc/secrets' and path as `/secret_foo` would mount the
527
+ # this version is fetched and made available. For example, setting the
528
+ # mount_path as '/etc/secrets' and path as `/secret_foo` mounts the
528
529
  # secret value file at `/etc/secrets/secret_foo`.
529
530
  class SecretVersion
530
531
  include ::Google::Protobuf::MessageExts
@@ -535,8 +536,8 @@ module Google
535
536
  # Request for the `CreateFunction` method.
536
537
  # @!attribute [rw] location
537
538
  # @return [::String]
538
- # Required. The project and location in which the function should be created, specified
539
- # in the format `projects/*/locations/*`
539
+ # Required. The project and location in which the function should be created,
540
+ # specified in the format `projects/*/locations/*`
540
541
  # @!attribute [rw] function
541
542
  # @return [::Google::Cloud::Functions::V1::CloudFunction]
542
543
  # Required. Function to be created.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-functions-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.1
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-17 00:00:00.000000000 Z
11
+ date: 2023-05-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.17.1
19
+ version: 0.18.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.17.1
29
+ version: 0.18.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -45,19 +45,45 @@ dependencies:
45
45
  - !ruby/object:Gem::Version
46
46
  version: '1.0'
47
47
  - !ruby/object:Gem::Dependency
48
- name: grpc-google-iam-v1
48
+ name: google-cloud-location
49
49
  requirement: !ruby/object:Gem::Requirement
50
50
  requirements:
51
- - - "~>"
51
+ - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '1.1'
53
+ version: '0.4'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: 2.a
54
57
  type: :runtime
55
58
  prerelease: false
56
59
  version_requirements: !ruby/object:Gem::Requirement
57
60
  requirements:
58
- - - "~>"
61
+ - - ">="
59
62
  - !ruby/object:Gem::Version
60
- version: '1.1'
63
+ version: '0.4'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: 2.a
67
+ - !ruby/object:Gem::Dependency
68
+ name: google-iam-v1
69
+ requirement: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ version: '0.4'
74
+ - - "<"
75
+ - !ruby/object:Gem::Version
76
+ version: 2.a
77
+ type: :runtime
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0.4'
84
+ - - "<"
85
+ - !ruby/object:Gem::Version
86
+ version: 2.a
61
87
  - !ruby/object:Gem::Dependency
62
88
  name: google-style
63
89
  requirement: !ruby/object:Gem::Requirement
@@ -185,14 +211,20 @@ files:
185
211
  - README.md
186
212
  - lib/google-cloud-functions-v1.rb
187
213
  - lib/google/cloud/functions/v1.rb
214
+ - lib/google/cloud/functions/v1/bindings_override.rb
188
215
  - lib/google/cloud/functions/v1/cloud_functions_service.rb
189
216
  - lib/google/cloud/functions/v1/cloud_functions_service/client.rb
190
217
  - lib/google/cloud/functions/v1/cloud_functions_service/credentials.rb
191
218
  - lib/google/cloud/functions/v1/cloud_functions_service/operations.rb
192
219
  - lib/google/cloud/functions/v1/cloud_functions_service/paths.rb
220
+ - lib/google/cloud/functions/v1/cloud_functions_service/rest.rb
221
+ - lib/google/cloud/functions/v1/cloud_functions_service/rest/client.rb
222
+ - lib/google/cloud/functions/v1/cloud_functions_service/rest/operations.rb
223
+ - lib/google/cloud/functions/v1/cloud_functions_service/rest/service_stub.rb
193
224
  - lib/google/cloud/functions/v1/functions_pb.rb
194
225
  - lib/google/cloud/functions/v1/functions_services_pb.rb
195
226
  - lib/google/cloud/functions/v1/operations_pb.rb
227
+ - lib/google/cloud/functions/v1/rest.rb
196
228
  - lib/google/cloud/functions/v1/version.rb
197
229
  - proto_docs/README.md
198
230
  - proto_docs/google/api/client.rb
@@ -201,9 +233,6 @@ files:
201
233
  - proto_docs/google/api/resource.rb
202
234
  - proto_docs/google/cloud/functions/v1/functions.rb
203
235
  - proto_docs/google/cloud/functions/v1/operations.rb
204
- - proto_docs/google/iam/v1/iam_policy.rb
205
- - proto_docs/google/iam/v1/options.rb
206
- - proto_docs/google/iam/v1/policy.rb
207
236
  - proto_docs/google/longrunning/operations.rb
208
237
  - proto_docs/google/protobuf/any.rb
209
238
  - proto_docs/google/protobuf/duration.rb
@@ -234,5 +263,5 @@ requirements: []
234
263
  rubygems_version: 3.4.2
235
264
  signing_key:
236
265
  specification_version: 4
237
- summary: API Client library for the Cloud Functions V1 API
266
+ summary: Manages lightweight user-provided functions executed in response to events.
238
267
  test_files: []
@@ -1,87 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2020 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Iam
22
- module V1
23
- # Request message for `SetIamPolicy` method.
24
- # @!attribute [rw] resource
25
- # @return [::String]
26
- # REQUIRED: The resource for which the policy is being specified.
27
- # See the operation documentation for the appropriate value for this field.
28
- # @!attribute [rw] policy
29
- # @return [::Google::Iam::V1::Policy]
30
- # REQUIRED: The complete policy to be applied to the `resource`. The size of
31
- # the policy is limited to a few 10s of KB. An empty policy is a
32
- # valid policy but certain Cloud Platform services (such as Projects)
33
- # might reject them.
34
- # @!attribute [rw] update_mask
35
- # @return [::Google::Protobuf::FieldMask]
36
- # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
37
- # the fields in the mask will be modified. If no mask is provided, the
38
- # following default mask is used:
39
- #
40
- # `paths: "bindings, etag"`
41
- class SetIamPolicyRequest
42
- include ::Google::Protobuf::MessageExts
43
- extend ::Google::Protobuf::MessageExts::ClassMethods
44
- end
45
-
46
- # Request message for `GetIamPolicy` method.
47
- # @!attribute [rw] resource
48
- # @return [::String]
49
- # REQUIRED: The resource for which the policy is being requested.
50
- # See the operation documentation for the appropriate value for this field.
51
- # @!attribute [rw] options
52
- # @return [::Google::Iam::V1::GetPolicyOptions]
53
- # OPTIONAL: A `GetPolicyOptions` object for specifying options to
54
- # `GetIamPolicy`.
55
- class GetIamPolicyRequest
56
- include ::Google::Protobuf::MessageExts
57
- extend ::Google::Protobuf::MessageExts::ClassMethods
58
- end
59
-
60
- # Request message for `TestIamPermissions` method.
61
- # @!attribute [rw] resource
62
- # @return [::String]
63
- # REQUIRED: The resource for which the policy detail is being requested.
64
- # See the operation documentation for the appropriate value for this field.
65
- # @!attribute [rw] permissions
66
- # @return [::Array<::String>]
67
- # The set of permissions to check for the `resource`. Permissions with
68
- # wildcards (such as '*' or 'storage.*') are not allowed. For more
69
- # information see
70
- # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
71
- class TestIamPermissionsRequest
72
- include ::Google::Protobuf::MessageExts
73
- extend ::Google::Protobuf::MessageExts::ClassMethods
74
- end
75
-
76
- # Response message for `TestIamPermissions` method.
77
- # @!attribute [rw] permissions
78
- # @return [::Array<::String>]
79
- # A subset of `TestPermissionsRequest.permissions` that the caller is
80
- # allowed.
81
- class TestIamPermissionsResponse
82
- include ::Google::Protobuf::MessageExts
83
- extend ::Google::Protobuf::MessageExts::ClassMethods
84
- end
85
- end
86
- end
87
- end
@@ -1,50 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Copyright 2020 Google LLC
4
- #
5
- # Licensed under the Apache License, Version 2.0 (the "License");
6
- # you may not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # https://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing, software
12
- # distributed under the License is distributed on an "AS IS" BASIS,
13
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
- # See the License for the specific language governing permissions and
15
- # limitations under the License.
16
-
17
- # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
-
19
-
20
- module Google
21
- module Iam
22
- module V1
23
- # Encapsulates settings provided to GetIamPolicy.
24
- # @!attribute [rw] requested_policy_version
25
- # @return [::Integer]
26
- # Optional. The maximum policy version that will be used to format the
27
- # policy.
28
- #
29
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
30
- # rejected.
31
- #
32
- # Requests for policies with any conditional role bindings must specify
33
- # version 3. Policies with no conditional role bindings may specify any valid
34
- # value or leave the field unset.
35
- #
36
- # The policy in the response might use the policy version that you specified,
37
- # or it might use a lower policy version. For example, if you specify version
38
- # 3, but the policy has no conditional role bindings, the response uses
39
- # version 1.
40
- #
41
- # To learn which resources support conditions in their IAM policies, see the
42
- # [IAM
43
- # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
44
- class GetPolicyOptions
45
- include ::Google::Protobuf::MessageExts
46
- extend ::Google::Protobuf::MessageExts::ClassMethods
47
- end
48
- end
49
- end
50
- end