google-cloud-functions-v1 0.5.1 → 0.8.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2b62ee06bcbe00ff7f477e8a5395f6f09ac6730228f4967091110bbc41f0d55e
4
- data.tar.gz: 0f861008869f48a8ee2544f8552513ac548c061486c048bb8b0571960a334309
3
+ metadata.gz: 13db09e57aa8aeb741f71beeb73d4c79e77900221993f87989abd3d3246223a6
4
+ data.tar.gz: 5e50d002ece3a483ea6d6e4130b830f59e3cbb92db112d8528574500b2a24ac2
5
5
  SHA512:
6
- metadata.gz: 1363011305eba68eef67d190a204f9ed1a9203112197a4e7fb17b9963b03cf639c4e18318a93d60fb044c076b932555044886a983129c2a1978d73725f0b220f
7
- data.tar.gz: e04f2bdfa4cc5e162723c0d1659a4d1232ec626d069f1127f5560850bbffd04ee547e12b9fa08cf591cb6ee684788b8ef809a6c2bb6c4d0dc5c13a0cb4bd1d31
6
+ metadata.gz: 50b5650eb8b17b94364f44c217d26b483d5311be43fcc6fc80a6f2346724ebff5bd82df8d98914148de53a783590e5bbc82fca58b29a1f300fe3d14516ec9b8f
7
+ data.tar.gz: 28b02abdfbb9c3a621e65f4ac474e625ca517177b9e3a8dc1e8d47e4f177279d6de10e50502712d5dc147f1b8f9797289496b53abb4135af5ced96df9fc3386d
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::Functions::V1::ListFunctionsRequest.new # (request fi
37
37
  response = client.list_functions request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-functions-v1/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-functions-v1/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/functions)
@@ -69,16 +69,21 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
- This library is supported on Ruby 2.5+.
79
+ This library is supported on Ruby 2.6+.
75
80
 
76
81
  Google provides official support for Ruby versions that are actively supported
77
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
78
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
79
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
80
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
81
- about the Ruby support schedule.
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
82
87
 
83
88
  ## Which client should I use?
84
89
 
@@ -489,7 +489,7 @@ module Google
489
489
  # @param function [::Google::Cloud::Functions::V1::CloudFunction, ::Hash]
490
490
  # Required. New version of the function.
491
491
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
492
- # Required list of fields to be updated in this request.
492
+ # Required. The list of fields in `CloudFunction` that have to be updated.
493
493
  #
494
494
  # @yield [response, operation] Access the result along with the RPC operation
495
495
  # @yieldparam response [::Gapic::Operation]
@@ -785,7 +785,7 @@ module Google
785
785
  # @param options [::Gapic::CallOptions, ::Hash]
786
786
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
787
787
  #
788
- # @overload generate_upload_url(parent: nil)
788
+ # @overload generate_upload_url(parent: nil, kms_key_name: nil)
789
789
  # Pass arguments to `generate_upload_url` via keyword arguments. Note that at
790
790
  # least one keyword argument is required. To specify no parameters, or to keep all
791
791
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -793,6 +793,24 @@ module Google
793
793
  # @param parent [::String]
794
794
  # The project and location in which the Google Cloud Storage signed URL
795
795
  # should be generated, specified in the format `projects/*/locations/*`.
796
+ # @param kms_key_name [::String]
797
+ # Resource name of a KMS crypto key (managed by the user) used to
798
+ # encrypt/decrypt function source code objects in staging Cloud Storage
799
+ # buckets. When you generate an upload url and upload your source code, it
800
+ # gets copied to a staging Cloud Storage bucket in an internal regional
801
+ # project. The source code is then copied to a versioned directory in the
802
+ # sources bucket in the consumer project during the function deployment.
803
+ #
804
+ # It must match the pattern
805
+ # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
806
+ #
807
+ # The Google Cloud Functions service account
808
+ # (service-\\{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be
809
+ # granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter
810
+ # (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the
811
+ # Key/KeyRing/Project/Organization (least access preferred). GCF will
812
+ # delegate access to the Google Storage service account in the internal
813
+ # project.
796
814
  #
797
815
  # @yield [response, operation] Access the result along with the RPC operation
798
816
  # @yieldparam response [::Google::Cloud::Functions::V1::GenerateUploadUrlResponse]
@@ -965,7 +983,7 @@ module Google
965
983
  # @param options [::Gapic::CallOptions, ::Hash]
966
984
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
967
985
  #
968
- # @overload set_iam_policy(resource: nil, policy: nil)
986
+ # @overload set_iam_policy(resource: nil, policy: nil, update_mask: nil)
969
987
  # Pass arguments to `set_iam_policy` via keyword arguments. Note that at
970
988
  # least one keyword argument is required. To specify no parameters, or to keep all
971
989
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -978,6 +996,12 @@ module Google
978
996
  # the policy is limited to a few 10s of KB. An empty policy is a
979
997
  # valid policy but certain Cloud Platform services (such as Projects)
980
998
  # might reject them.
999
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
1000
+ # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
1001
+ # the fields in the mask will be modified. If no mask is provided, the
1002
+ # following default mask is used:
1003
+ #
1004
+ # `paths: "bindings, etag"`
981
1005
  #
982
1006
  # @yield [response, operation] Access the result along with the RPC operation
983
1007
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -1068,7 +1092,7 @@ module Google
1068
1092
  # See the operation documentation for the appropriate value for this field.
1069
1093
  # @param options [::Google::Iam::V1::GetPolicyOptions, ::Hash]
1070
1094
  # OPTIONAL: A `GetPolicyOptions` object for specifying options to
1071
- # `GetIamPolicy`. This field is only used by Cloud IAM.
1095
+ # `GetIamPolicy`.
1072
1096
  #
1073
1097
  # @yield [response, operation] Access the result along with the RPC operation
1074
1098
  # @yieldparam response [::Google::Iam::V1::Policy]
@@ -95,6 +95,9 @@ module Google
95
95
  channel_args: @config.channel_args,
96
96
  interceptors: @config.interceptors
97
97
  )
98
+
99
+ # Used by an LRO wrapper for some methods of this service
100
+ @operations_client = self
98
101
  end
99
102
 
100
103
  # Service calls
@@ -1,6 +1,8 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/functions/v1/functions.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/api/annotations_pb'
5
7
  require 'google/api/client_pb'
6
8
  require 'google/api/field_behavior_pb'
@@ -11,7 +13,6 @@ require 'google/longrunning/operations_pb'
11
13
  require 'google/protobuf/duration_pb'
12
14
  require 'google/protobuf/field_mask_pb'
13
15
  require 'google/protobuf/timestamp_pb'
14
- require 'google/protobuf'
15
16
 
16
17
  Google::Protobuf::DescriptorPool.generated_pool.build do
17
18
  add_file("google/cloud/functions/v1/functions.proto", :syntax => :proto3) do
@@ -43,6 +44,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
43
44
  repeated :secret_volumes, :message, 30, "google.cloud.functions.v1.SecretVolume"
44
45
  optional :source_token, :string, 31
45
46
  optional :docker_repository, :string, 34
47
+ optional :docker_registry, :enum, 35, "google.cloud.functions.v1.CloudFunction.DockerRegistry"
46
48
  oneof :source_code do
47
49
  optional :source_archive_url, :string, 3
48
50
  optional :source_repository, :message, 4, "google.cloud.functions.v1.SourceRepository"
@@ -64,6 +66,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
64
66
  value :ALLOW_INTERNAL_ONLY, 2
65
67
  value :ALLOW_INTERNAL_AND_GCLB, 3
66
68
  end
69
+ add_enum "google.cloud.functions.v1.CloudFunction.DockerRegistry" do
70
+ value :DOCKER_REGISTRY_UNSPECIFIED, 0
71
+ value :CONTAINER_REGISTRY, 1
72
+ value :ARTIFACT_REGISTRY, 2
73
+ end
67
74
  add_message "google.cloud.functions.v1.SourceRepository" do
68
75
  optional :url, :string, 1
69
76
  optional :deployed_url, :string, 2
@@ -141,6 +148,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
141
148
  end
142
149
  add_message "google.cloud.functions.v1.GenerateUploadUrlRequest" do
143
150
  optional :parent, :string, 1
151
+ optional :kms_key_name, :string, 2
144
152
  end
145
153
  add_message "google.cloud.functions.v1.GenerateUploadUrlResponse" do
146
154
  optional :upload_url, :string, 1
@@ -170,6 +178,7 @@ module Google
170
178
  CloudFunction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.CloudFunction").msgclass
171
179
  CloudFunction::VpcConnectorEgressSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings").enummodule
172
180
  CloudFunction::IngressSettings = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.CloudFunction.IngressSettings").enummodule
181
+ CloudFunction::DockerRegistry = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.CloudFunction.DockerRegistry").enummodule
173
182
  SourceRepository = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.SourceRepository").msgclass
174
183
  HttpsTrigger = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.HttpsTrigger").msgclass
175
184
  HttpsTrigger::SecurityLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.functions.v1.HttpsTrigger.SecurityLevel").enummodule
@@ -1,10 +1,10 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/functions/v1/operations.proto
3
3
 
4
+ require 'google/protobuf'
5
+
4
6
  require 'google/protobuf/any_pb'
5
7
  require 'google/protobuf/timestamp_pb'
6
- require 'google/api/annotations_pb'
7
- require 'google/protobuf'
8
8
 
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/cloud/functions/v1/operations.proto", :syntax => :proto3) do
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Functions
23
23
  module V1
24
- VERSION = "0.5.1"
24
+ VERSION = "0.8.0"
25
25
  end
26
26
  end
27
27
  end
@@ -25,6 +25,8 @@ module Google
25
25
  ##
26
26
  # To load this package, including all its services, and instantiate a client:
27
27
  #
28
+ # @example
29
+ #
28
30
  # require "google/cloud/functions/v1"
29
31
  # client = ::Google::Cloud::Functions::V1::CloudFunctionsService::Client.new
30
32
  #
@@ -23,7 +23,6 @@ module Google
23
23
  module V1
24
24
  # Describes a Cloud Function that contains user computation executed in
25
25
  # response to an event. It encapsulate function and triggers configurations.
26
- # Next tag: 36
27
26
  # @!attribute [rw] name
28
27
  # @return [::String]
29
28
  # A user-defined name of the function. Function names must be unique
@@ -167,8 +166,9 @@ module Google
167
166
  # the `docker_repository` field that was created with the same KMS crypto
168
167
  # key.
169
168
  #
170
- # The following service accounts need to be granted Cloud KMS crypto key
171
- # encrypter/decrypter roles on the key.
169
+ # The following service accounts need to be granted the role 'Cloud KMS
170
+ # CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)'
171
+ # on the Key/KeyRing/Project/Organization (least access preferred).
172
172
  #
173
173
  # 1. Google Cloud Functions service account
174
174
  # (service-\\{project_number}@gcf-admin-robot.iam.gserviceaccount.com) -
@@ -232,6 +232,14 @@ module Google
232
232
  # Cross-project repositories are not supported.
233
233
  # Cross-location repositories are not supported.
234
234
  # Repository format must be 'DOCKER'.
235
+ # @!attribute [rw] docker_registry
236
+ # @return [::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry]
237
+ # Docker Registry to use for this deployment.
238
+ #
239
+ # If `docker_repository` field is specified, this field will be automatically
240
+ # set as `ARTIFACT_REGISTRY`.
241
+ # If unspecified, it currently defaults to `CONTAINER_REGISTRY`.
242
+ # This field may be overridden by the backend for eligible deployments.
235
243
  class CloudFunction
236
244
  include ::Google::Protobuf::MessageExts
237
245
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,6 +305,23 @@ module Google
297
305
  # Allow HTTP traffic from private VPC sources and through GCLB.
298
306
  ALLOW_INTERNAL_AND_GCLB = 3
299
307
  end
308
+
309
+ # Docker Registry to use for storing function Docker images.
310
+ module DockerRegistry
311
+ # Unspecified.
312
+ DOCKER_REGISTRY_UNSPECIFIED = 0
313
+
314
+ # Docker images will be stored in multi-regional Container Registry
315
+ # repositories named `gcf`.
316
+ CONTAINER_REGISTRY = 1
317
+
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.
323
+ ARTIFACT_REGISTRY = 2
324
+ end
300
325
  end
301
326
 
302
327
  # Describes SourceRepository, used to represent parameters related to
@@ -434,8 +459,7 @@ module Google
434
459
 
435
460
  # Configuration for a secret environment variable. It has the information
436
461
  # necessary to fetch the secret value from secret manager and expose it as an
437
- # environment variable. Secret value is not a part of the configuration. Secret
438
- # values are only fetched when a new clone starts.
462
+ # environment variable.
439
463
  # @!attribute [rw] key
440
464
  # @return [::String]
441
465
  # Name of the environment variable.
@@ -452,7 +476,7 @@ module Google
452
476
  # @return [::String]
453
477
  # Version of the secret (version number or the string 'latest'). It is
454
478
  # recommended to use a numeric version for secret environment variables as
455
- # any updates to the secret value is not reflected until new clones start.
479
+ # any updates to the secret value is not reflected until new instances start.
456
480
  class SecretEnvVar
457
481
  include ::Google::Protobuf::MessageExts
458
482
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -527,7 +551,7 @@ module Google
527
551
  # Required. New version of the function.
528
552
  # @!attribute [rw] update_mask
529
553
  # @return [::Google::Protobuf::FieldMask]
530
- # Required list of fields to be updated in this request.
554
+ # Required. The list of fields in `CloudFunction` that have to be updated.
531
555
  class UpdateFunctionRequest
532
556
  include ::Google::Protobuf::MessageExts
533
557
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -627,6 +651,25 @@ module Google
627
651
  # @return [::String]
628
652
  # The project and location in which the Google Cloud Storage signed URL
629
653
  # should be generated, specified in the format `projects/*/locations/*`.
654
+ # @!attribute [rw] kms_key_name
655
+ # @return [::String]
656
+ # Resource name of a KMS crypto key (managed by the user) used to
657
+ # encrypt/decrypt function source code objects in staging Cloud Storage
658
+ # buckets. When you generate an upload url and upload your source code, it
659
+ # gets copied to a staging Cloud Storage bucket in an internal regional
660
+ # project. The source code is then copied to a versioned directory in the
661
+ # sources bucket in the consumer project during the function deployment.
662
+ #
663
+ # It must match the pattern
664
+ # `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
665
+ #
666
+ # The Google Cloud Functions service account
667
+ # (service-\\{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be
668
+ # granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter
669
+ # (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the
670
+ # Key/KeyRing/Project/Organization (least access preferred). GCF will
671
+ # delegate access to the Google Storage service account in the internal
672
+ # project.
630
673
  class GenerateUploadUrlRequest
631
674
  include ::Google::Protobuf::MessageExts
632
675
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -31,6 +31,13 @@ module Google
31
31
  # the policy is limited to a few 10s of KB. An empty policy is a
32
32
  # valid policy but certain Cloud Platform services (such as Projects)
33
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"`
34
41
  class SetIamPolicyRequest
35
42
  include ::Google::Protobuf::MessageExts
36
43
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -44,7 +51,7 @@ module Google
44
51
  # @!attribute [rw] options
45
52
  # @return [::Google::Iam::V1::GetPolicyOptions]
46
53
  # OPTIONAL: A `GetPolicyOptions` object for specifying options to
47
- # `GetIamPolicy`. This field is only used by Cloud IAM.
54
+ # `GetIamPolicy`.
48
55
  class GetIamPolicyRequest
49
56
  include ::Google::Protobuf::MessageExts
50
57
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -23,14 +23,24 @@ module Google
23
23
  # Encapsulates settings provided to GetIamPolicy.
24
24
  # @!attribute [rw] requested_policy_version
25
25
  # @return [::Integer]
26
- # Optional. The policy format version to be returned.
26
+ # Optional. The maximum policy version that will be used to format the
27
+ # policy.
27
28
  #
28
29
  # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
29
30
  # rejected.
30
31
  #
31
- # Requests for policies with any conditional bindings must specify version 3.
32
- # Policies without any conditional bindings may specify any valid value or
33
- # leave the field unset.
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).
34
44
  class GetPolicyOptions
35
45
  include ::Google::Protobuf::MessageExts
36
46
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -20,19 +20,24 @@
20
20
  module Google
21
21
  module Iam
22
22
  module V1
23
- # Defines an Identity and Access Management (IAM) policy. It is used to
24
- # specify access control policies for Cloud Platform resources.
23
+ # An Identity and Access Management (IAM) policy, which specifies access
24
+ # controls for Google Cloud resources.
25
25
  #
26
26
  #
27
27
  # A `Policy` is a collection of `bindings`. A `binding` binds one or more
28
- # `members` to a single `role`. Members can be user accounts, service accounts,
29
- # Google groups, and domains (such as G Suite). A `role` is a named list of
30
- # permissions (defined by IAM or configured by users). A `binding` can
31
- # optionally specify a `condition`, which is a logic expression that further
32
- # constrains the role binding based on attributes about the request and/or
33
- # target resource.
28
+ # `members`, or principals, to a single `role`. Principals can be user
29
+ # accounts, service accounts, Google groups, and domains (such as G Suite). A
30
+ # `role` is a named list of permissions; each `role` can be an IAM predefined
31
+ # role or a user-created custom role.
34
32
  #
35
- # **JSON Example**
33
+ # For some types of Google Cloud resources, a `binding` can also specify a
34
+ # `condition`, which is a logical expression that allows access to a resource
35
+ # only if the expression evaluates to `true`. A condition can add constraints
36
+ # based on attributes of the request, the resource, or both. To learn which
37
+ # resources support conditions in their IAM policies, see the
38
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
39
+ #
40
+ # **JSON example:**
36
41
  #
37
42
  # {
38
43
  # "bindings": [
@@ -47,18 +52,21 @@ module Google
47
52
  # },
48
53
  # {
49
54
  # "role": "roles/resourcemanager.organizationViewer",
50
- # "members": ["user:eve@example.com"],
55
+ # "members": [
56
+ # "user:eve@example.com"
57
+ # ],
51
58
  # "condition": {
52
59
  # "title": "expirable access",
53
60
  # "description": "Does not grant access after Sep 2020",
54
- # "expression": "request.time <
55
- # timestamp('2020-10-01T00:00:00.000Z')",
61
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
56
62
  # }
57
63
  # }
58
- # ]
64
+ # ],
65
+ # "etag": "BwWWja0YfJA=",
66
+ # "version": 3
59
67
  # }
60
68
  #
61
- # **YAML Example**
69
+ # **YAML example:**
62
70
  #
63
71
  # bindings:
64
72
  # - members:
@@ -74,30 +82,52 @@ module Google
74
82
  # title: expirable access
75
83
  # description: Does not grant access after Sep 2020
76
84
  # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
85
+ # etag: BwWWja0YfJA=
86
+ # version: 3
77
87
  #
78
88
  # For a description of IAM and its features, see the
79
- # [IAM developer's guide](https://cloud.google.com/iam/docs).
89
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
80
90
  # @!attribute [rw] version
81
91
  # @return [::Integer]
82
92
  # Specifies the format of the policy.
83
93
  #
84
- # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
85
- # rejected.
94
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
95
+ # are rejected.
96
+ #
97
+ # Any operation that affects conditional role bindings must specify version
98
+ # `3`. This requirement applies to the following operations:
86
99
  #
87
- # Operations affecting conditional bindings must specify version 3. This can
88
- # be either setting a conditional policy, modifying a conditional binding,
89
- # or removing a binding (conditional or unconditional) from the stored
90
- # conditional policy.
91
- # Operations on non-conditional policies may specify any valid value or
92
- # leave the field unset.
100
+ # * Getting a policy that includes a conditional role binding
101
+ # * Adding a conditional role binding to a policy
102
+ # * Changing a conditional role binding in a policy
103
+ # * Removing any role binding, with or without a condition, from a policy
104
+ # that includes conditions
93
105
  #
94
- # If no etag is provided in the call to `setIamPolicy`, version compliance
95
- # checks against the stored policy is skipped.
106
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
107
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
108
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
109
+ # the conditions in the version `3` policy are lost.
110
+ #
111
+ # If a policy does not include any conditions, operations on that policy may
112
+ # specify any valid version or leave the field unset.
113
+ #
114
+ # To learn which resources support conditions in their IAM policies, see the
115
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
96
116
  # @!attribute [rw] bindings
97
117
  # @return [::Array<::Google::Iam::V1::Binding>]
98
- # Associates a list of `members` to a `role`. Optionally may specify a
99
- # `condition` that determines when binding is in effect.
100
- # `bindings` with no members will result in an error.
118
+ # Associates a list of `members`, or principals, with a `role`. Optionally,
119
+ # may specify a `condition` that determines how and when the `bindings` are
120
+ # applied. Each of the `bindings` must contain at least one principal.
121
+ #
122
+ # The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250
123
+ # of these principals can be Google groups. Each occurrence of a principal
124
+ # counts towards these limits. For example, if the `bindings` grant 50
125
+ # different roles to `user:alice@example.com`, and not to any other
126
+ # principal, then you can add another 1,450 principals to the `bindings` in
127
+ # the `Policy`.
128
+ # @!attribute [rw] audit_configs
129
+ # @return [::Array<::Google::Iam::V1::AuditConfig>]
130
+ # Specifies cloud audit logging configuration for this policy.
101
131
  # @!attribute [rw] etag
102
132
  # @return [::String]
103
133
  # `etag` is used for optimistic concurrency control as a way to help
@@ -108,23 +138,23 @@ module Google
108
138
  # systems are expected to put that etag in the request to `setIamPolicy` to
109
139
  # ensure that their change will be applied to the same version of the policy.
110
140
  #
111
- # If no `etag` is provided in the call to `setIamPolicy`, then the existing
112
- # policy is overwritten. Due to blind-set semantics of an etag-less policy,
113
- # 'setIamPolicy' will not fail even if the incoming policy version does not
114
- # meet the requirements for modifying the stored policy.
141
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
142
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
143
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
144
+ # the conditions in the version `3` policy are lost.
115
145
  class Policy
116
146
  include ::Google::Protobuf::MessageExts
117
147
  extend ::Google::Protobuf::MessageExts::ClassMethods
118
148
  end
119
149
 
120
- # Associates `members` with a `role`.
150
+ # Associates `members`, or principals, with a `role`.
121
151
  # @!attribute [rw] role
122
152
  # @return [::String]
123
- # Role that is assigned to `members`.
153
+ # Role that is assigned to the list of `members`, or principals.
124
154
  # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
125
155
  # @!attribute [rw] members
126
156
  # @return [::Array<::String>]
127
- # Specifies the identities requesting access for a Cloud Platform resource.
157
+ # Specifies the principals requesting access for a Cloud Platform resource.
128
158
  # `members` can have the following values:
129
159
  #
130
160
  # * `allUsers`: A special identifier that represents anyone who is
@@ -143,20 +173,160 @@ module Google
143
173
  # * `group:{emailid}`: An email address that represents a Google group.
144
174
  # For example, `admins@example.com`.
145
175
  #
176
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
177
+ # identifier) representing a user that has been recently deleted. For
178
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
179
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
180
+ # retains the role in the binding.
181
+ #
182
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
183
+ # unique identifier) representing a service account that has been recently
184
+ # deleted. For example,
185
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
186
+ # If the service account is undeleted, this value reverts to
187
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
188
+ # role in the binding.
189
+ #
190
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
191
+ # identifier) representing a Google group that has been recently
192
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
193
+ # the group is recovered, this value reverts to `group:{emailid}` and the
194
+ # recovered group retains the role in the binding.
195
+ #
146
196
  #
147
197
  # * `domain:{domain}`: The G Suite domain (primary) that represents all the
148
198
  # users of that domain. For example, `google.com` or `example.com`.
149
199
  # @!attribute [rw] condition
150
200
  # @return [::Google::Type::Expr]
151
201
  # The condition that is associated with this binding.
152
- # NOTE: An unsatisfied condition will not allow user access via current
153
- # binding. Different bindings, including their conditions, are examined
154
- # independently.
202
+ #
203
+ # If the condition evaluates to `true`, then this binding applies to the
204
+ # current request.
205
+ #
206
+ # If the condition evaluates to `false`, then this binding does not apply to
207
+ # the current request. However, a different role binding might grant the same
208
+ # role to one or more of the principals in this binding.
209
+ #
210
+ # To learn which resources support conditions in their IAM policies, see the
211
+ # [IAM
212
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
155
213
  class Binding
156
214
  include ::Google::Protobuf::MessageExts
157
215
  extend ::Google::Protobuf::MessageExts::ClassMethods
158
216
  end
159
217
 
218
+ # Specifies the audit configuration for a service.
219
+ # The configuration determines which permission types are logged, and what
220
+ # identities, if any, are exempted from logging.
221
+ # An AuditConfig must have one or more AuditLogConfigs.
222
+ #
223
+ # If there are AuditConfigs for both `allServices` and a specific service,
224
+ # the union of the two AuditConfigs is used for that service: the log_types
225
+ # specified in each AuditConfig are enabled, and the exempted_members in each
226
+ # AuditLogConfig are exempted.
227
+ #
228
+ # Example Policy with multiple AuditConfigs:
229
+ #
230
+ # {
231
+ # "audit_configs": [
232
+ # {
233
+ # "service": "allServices",
234
+ # "audit_log_configs": [
235
+ # {
236
+ # "log_type": "DATA_READ",
237
+ # "exempted_members": [
238
+ # "user:jose@example.com"
239
+ # ]
240
+ # },
241
+ # {
242
+ # "log_type": "DATA_WRITE"
243
+ # },
244
+ # {
245
+ # "log_type": "ADMIN_READ"
246
+ # }
247
+ # ]
248
+ # },
249
+ # {
250
+ # "service": "sampleservice.googleapis.com",
251
+ # "audit_log_configs": [
252
+ # {
253
+ # "log_type": "DATA_READ"
254
+ # },
255
+ # {
256
+ # "log_type": "DATA_WRITE",
257
+ # "exempted_members": [
258
+ # "user:aliya@example.com"
259
+ # ]
260
+ # }
261
+ # ]
262
+ # }
263
+ # ]
264
+ # }
265
+ #
266
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
267
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
268
+ # aliya@example.com from DATA_WRITE logging.
269
+ # @!attribute [rw] service
270
+ # @return [::String]
271
+ # Specifies a service that will be enabled for audit logging.
272
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
273
+ # `allServices` is a special value that covers all services.
274
+ # @!attribute [rw] audit_log_configs
275
+ # @return [::Array<::Google::Iam::V1::AuditLogConfig>]
276
+ # The configuration for logging of each type of permission.
277
+ class AuditConfig
278
+ include ::Google::Protobuf::MessageExts
279
+ extend ::Google::Protobuf::MessageExts::ClassMethods
280
+ end
281
+
282
+ # Provides the configuration for logging a type of permissions.
283
+ # Example:
284
+ #
285
+ # {
286
+ # "audit_log_configs": [
287
+ # {
288
+ # "log_type": "DATA_READ",
289
+ # "exempted_members": [
290
+ # "user:jose@example.com"
291
+ # ]
292
+ # },
293
+ # {
294
+ # "log_type": "DATA_WRITE"
295
+ # }
296
+ # ]
297
+ # }
298
+ #
299
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
300
+ # jose@example.com from DATA_READ logging.
301
+ # @!attribute [rw] log_type
302
+ # @return [::Google::Iam::V1::AuditLogConfig::LogType]
303
+ # The log type that this config enables.
304
+ # @!attribute [rw] exempted_members
305
+ # @return [::Array<::String>]
306
+ # Specifies the identities that do not cause logging for this type of
307
+ # permission.
308
+ # Follows the same format of {::Google::Iam::V1::Binding#members Binding.members}.
309
+ class AuditLogConfig
310
+ include ::Google::Protobuf::MessageExts
311
+ extend ::Google::Protobuf::MessageExts::ClassMethods
312
+
313
+ # The list of valid permission types for which logging can be configured.
314
+ # Admin writes are always logged, and are not configurable.
315
+ module LogType
316
+ # Default case. Should never be this.
317
+ LOG_TYPE_UNSPECIFIED = 0
318
+
319
+ # Admin reads. Example: CloudIAM getIamPolicy
320
+ ADMIN_READ = 1
321
+
322
+ # Data writes. Example: CloudSQL Users create
323
+ DATA_WRITE = 2
324
+
325
+ # Data reads. Example: CloudSQL Users list
326
+ DATA_READ = 3
327
+ end
328
+ end
329
+
160
330
  # The difference delta between two policies.
161
331
  # @!attribute [rw] binding_deltas
162
332
  # @return [::Array<::Google::Iam::V1::BindingDelta>]
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
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.5.1
4
+ version: 0.8.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: 2022-01-11 00:00:00.000000000 Z
11
+ date: 2022-07-02 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.7'
19
+ version: '0.10'
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.7'
29
+ version: '0.10'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -48,50 +48,44 @@ dependencies:
48
48
  name: grpc-google-iam-v1
49
49
  requirement: !ruby/object:Gem::Requirement
50
50
  requirements:
51
- - - ">="
52
- - !ruby/object:Gem::Version
53
- version: 0.6.10
54
- - - "<"
51
+ - - "~>"
55
52
  - !ruby/object:Gem::Version
56
- version: 2.a
53
+ version: '1.1'
57
54
  type: :runtime
58
55
  prerelease: false
59
56
  version_requirements: !ruby/object:Gem::Requirement
60
57
  requirements:
61
- - - ">="
62
- - !ruby/object:Gem::Version
63
- version: 0.6.10
64
- - - "<"
58
+ - - "~>"
65
59
  - !ruby/object:Gem::Version
66
- version: 2.a
60
+ version: '1.1'
67
61
  - !ruby/object:Gem::Dependency
68
62
  name: google-style
69
63
  requirement: !ruby/object:Gem::Requirement
70
64
  requirements:
71
65
  - - "~>"
72
66
  - !ruby/object:Gem::Version
73
- version: 1.25.1
67
+ version: 1.26.1
74
68
  type: :development
75
69
  prerelease: false
76
70
  version_requirements: !ruby/object:Gem::Requirement
77
71
  requirements:
78
72
  - - "~>"
79
73
  - !ruby/object:Gem::Version
80
- version: 1.25.1
74
+ version: 1.26.1
81
75
  - !ruby/object:Gem::Dependency
82
76
  name: minitest
83
77
  requirement: !ruby/object:Gem::Requirement
84
78
  requirements:
85
79
  - - "~>"
86
80
  - !ruby/object:Gem::Version
87
- version: '5.14'
81
+ version: '5.16'
88
82
  type: :development
89
83
  prerelease: false
90
84
  version_requirements: !ruby/object:Gem::Requirement
91
85
  requirements:
92
86
  - - "~>"
93
87
  - !ruby/object:Gem::Version
94
- version: '5.14'
88
+ version: '5.16'
95
89
  - !ruby/object:Gem::Dependency
96
90
  name: minitest-focus
97
91
  requirement: !ruby/object:Gem::Requirement
@@ -126,14 +120,14 @@ dependencies:
126
120
  requirements:
127
121
  - - ">="
128
122
  - !ruby/object:Gem::Version
129
- version: '12.0'
123
+ version: '13.0'
130
124
  type: :development
131
125
  prerelease: false
132
126
  version_requirements: !ruby/object:Gem::Requirement
133
127
  requirements:
134
128
  - - ">="
135
129
  - !ruby/object:Gem::Version
136
- version: '12.0'
130
+ version: '13.0'
137
131
  - !ruby/object:Gem::Dependency
138
132
  name: redcarpet
139
133
  requirement: !ruby/object:Gem::Requirement
@@ -228,14 +222,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
228
222
  requirements:
229
223
  - - ">="
230
224
  - !ruby/object:Gem::Version
231
- version: '2.5'
225
+ version: '2.6'
232
226
  required_rubygems_version: !ruby/object:Gem::Requirement
233
227
  requirements:
234
228
  - - ">="
235
229
  - !ruby/object:Gem::Version
236
230
  version: '0'
237
231
  requirements: []
238
- rubygems_version: 3.3.4
232
+ rubygems_version: 3.3.14
239
233
  signing_key:
240
234
  specification_version: 4
241
235
  summary: API Client library for the Cloud Functions V1 API