google-cloud-access_approval-v1 0.1.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -24,7 +24,7 @@ module Google
24
24
  module V1
25
25
  module AccessApproval
26
26
  # Credentials for the AccessApproval API.
27
- class Credentials < Google::Auth::Credentials
27
+ class Credentials < ::Google::Auth::Credentials
28
28
  self.scope = [
29
29
  "https://www.googleapis.com/auth/cloud-platform"
30
30
  ]
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AccessApproval
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.2.1"
25
25
  end
26
26
  end
27
27
  end
@@ -128,7 +128,7 @@ module Google
128
128
  # - pattern: "shelves/{shelf}"
129
129
  # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
130
  # @!attribute [rw] type
131
- # @return [String]
131
+ # @return [::String]
132
132
  # The resource type. It must be in the format of
133
133
  # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
134
  # singular and must not include version numbers.
@@ -140,7 +140,7 @@ module Google
140
140
  # should use PascalCase (UpperCamelCase). The maximum number of
141
141
  # characters allowed for the `resource_type_kind` is 100.
142
142
  # @!attribute [rw] pattern
143
- # @return [Array<String>]
143
+ # @return [::Array<::String>]
144
144
  # Optional. The relative resource name pattern associated with this resource
145
145
  # type. The DNS prefix of the full resource name shouldn't be specified here.
146
146
  #
@@ -161,11 +161,11 @@ module Google
161
161
  # the same component name (e.g. "project") refers to IDs of the same
162
162
  # type of resource.
163
163
  # @!attribute [rw] name_field
164
- # @return [String]
164
+ # @return [::String]
165
165
  # Optional. The field on the resource that designates the resource name
166
166
  # field. If omitted, this is assumed to be "name".
167
167
  # @!attribute [rw] history
168
- # @return [Google::Api::ResourceDescriptor::History]
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
169
  # Optional. The historical or future-looking state of the resource pattern.
170
170
  #
171
171
  # Example:
@@ -182,19 +182,19 @@ module Google
182
182
  # };
183
183
  # }
184
184
  # @!attribute [rw] plural
185
- # @return [String]
185
+ # @return [::String]
186
186
  # The plural name used in the resource name, such as 'projects' for
187
187
  # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
188
  # field in k8s CRD spec
189
189
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
190
190
  # @!attribute [rw] singular
191
- # @return [String]
191
+ # @return [::String]
192
192
  # The same concept of the `singular` field in k8s CRD spec
193
193
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
194
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
195
195
  class ResourceDescriptor
196
- include Google::Protobuf::MessageExts
197
- extend Google::Protobuf::MessageExts::ClassMethods
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
198
 
199
199
  # A description of the historical or future-looking state of the
200
200
  # resource pattern.
@@ -216,7 +216,7 @@ module Google
216
216
  # Defines a proto annotation that describes a string field that refers to
217
217
  # an API resource.
218
218
  # @!attribute [rw] type
219
- # @return [String]
219
+ # @return [::String]
220
220
  # The resource type that the annotated field references.
221
221
  #
222
222
  # Example:
@@ -227,7 +227,7 @@ module Google
227
227
  # }];
228
228
  # }
229
229
  # @!attribute [rw] child_type
230
- # @return [String]
230
+ # @return [::String]
231
231
  # The resource type of a child collection that the annotated field
232
232
  # references. This is useful for annotating the `parent` field that
233
233
  # doesn't have a fixed resource type.
@@ -240,8 +240,8 @@ module Google
240
240
  # };
241
241
  # }
242
242
  class ResourceReference
243
- include Google::Protobuf::MessageExts
244
- extend Google::Protobuf::MessageExts::ClassMethods
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
245
  end
246
246
  end
247
247
  end
@@ -23,7 +23,7 @@ module Google
23
23
  module V1
24
24
  # Home office and physical location of the principal.
25
25
  # @!attribute [rw] principal_office_country
26
- # @return [String]
26
+ # @return [::String]
27
27
  # The "home office" location of the principal. A two-letter country code
28
28
  # (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some
29
29
  # limited situations Google systems may refer refer to a region code instead
@@ -40,7 +40,7 @@ module Google
40
40
  # <li>ANY: Any location</li>
41
41
  # </ol>
42
42
  # @!attribute [rw] principal_physical_location_country
43
- # @return [String]
43
+ # @return [::String]
44
44
  # Physical location of the principal at the time of the access. A
45
45
  # two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
46
46
  # a region code. In some limited situations Google systems may refer refer to
@@ -57,19 +57,19 @@ module Google
57
57
  # <li>ANY: Any location</li>
58
58
  # </ol>
59
59
  class AccessLocations
60
- include Google::Protobuf::MessageExts
61
- extend Google::Protobuf::MessageExts::ClassMethods
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
62
  end
63
63
 
64
64
  # @!attribute [rw] type
65
- # @return [Google::Cloud::AccessApproval::V1::AccessReason::Type]
65
+ # @return [::Google::Cloud::AccessApproval::V1::AccessReason::Type]
66
66
  # Type of access justification.
67
67
  # @!attribute [rw] detail
68
- # @return [String]
68
+ # @return [::String]
69
69
  # More detail about certain reason types. See comments for each type above.
70
70
  class AccessReason
71
- include Google::Protobuf::MessageExts
72
- extend Google::Protobuf::MessageExts::ClassMethods
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
73
 
74
74
  # Type of access justification.
75
75
  module Type
@@ -102,42 +102,42 @@ module Google
102
102
 
103
103
  # A decision that has been made to approve access to a resource.
104
104
  # @!attribute [rw] approve_time
105
- # @return [Google::Protobuf::Timestamp]
105
+ # @return [::Google::Protobuf::Timestamp]
106
106
  # The time at which approval was granted.
107
107
  # @!attribute [rw] expire_time
108
- # @return [Google::Protobuf::Timestamp]
108
+ # @return [::Google::Protobuf::Timestamp]
109
109
  # The time at which the approval expires.
110
110
  class ApproveDecision
111
- include Google::Protobuf::MessageExts
112
- extend Google::Protobuf::MessageExts::ClassMethods
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
113
  end
114
114
 
115
115
  # A decision that has been made to dismiss an approval request.
116
116
  # @!attribute [rw] dismiss_time
117
- # @return [Google::Protobuf::Timestamp]
117
+ # @return [::Google::Protobuf::Timestamp]
118
118
  # The time at which the approval request was dismissed.
119
119
  class DismissDecision
120
- include Google::Protobuf::MessageExts
121
- extend Google::Protobuf::MessageExts::ClassMethods
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
122
  end
123
123
 
124
124
  # The properties associated with the resource of the request.
125
125
  # @!attribute [rw] excludes_descendants
126
- # @return [Boolean]
126
+ # @return [::Boolean]
127
127
  # Whether an approval will exclude the descendants of the resource being
128
128
  # requested.
129
129
  class ResourceProperties
130
- include Google::Protobuf::MessageExts
131
- extend Google::Protobuf::MessageExts::ClassMethods
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
132
  end
133
133
 
134
134
  # A request for the customer to approve access to a resource.
135
135
  # @!attribute [rw] name
136
- # @return [String]
136
+ # @return [::String]
137
137
  # The resource name of the request. Format is
138
138
  # "\\{projects|folders|organizations}/\\{id}/approvalRequests/\\{approval_request_id}".
139
139
  # @!attribute [rw] requested_resource_name
140
- # @return [String]
140
+ # @return [::String]
141
141
  # The resource for which approval is being requested. The format of the
142
142
  # resource name is defined at
143
143
  # https://cloud.google.com/apis/design/resource_names. The resource name here
@@ -146,35 +146,35 @@ module Google
146
146
  # resource name (e.g. "shelves/shelf1/books/book2") as described in the
147
147
  # resource name specification.
148
148
  # @!attribute [rw] requested_resource_properties
149
- # @return [Google::Cloud::AccessApproval::V1::ResourceProperties]
149
+ # @return [::Google::Cloud::AccessApproval::V1::ResourceProperties]
150
150
  # Properties related to the resource represented by requested_resource_name.
151
151
  # @!attribute [rw] requested_reason
152
- # @return [Google::Cloud::AccessApproval::V1::AccessReason]
152
+ # @return [::Google::Cloud::AccessApproval::V1::AccessReason]
153
153
  # The justification for which approval is being requested.
154
154
  # @!attribute [rw] requested_locations
155
- # @return [Google::Cloud::AccessApproval::V1::AccessLocations]
155
+ # @return [::Google::Cloud::AccessApproval::V1::AccessLocations]
156
156
  # The locations for which approval is being requested.
157
157
  # @!attribute [rw] request_time
158
- # @return [Google::Protobuf::Timestamp]
158
+ # @return [::Google::Protobuf::Timestamp]
159
159
  # The time at which approval was requested.
160
160
  # @!attribute [rw] requested_expiration
161
- # @return [Google::Protobuf::Timestamp]
161
+ # @return [::Google::Protobuf::Timestamp]
162
162
  # The requested expiration for the approval. If the request is approved,
163
163
  # access will be granted from the time of approval until the expiration time.
164
164
  # @!attribute [rw] approve
165
- # @return [Google::Cloud::AccessApproval::V1::ApproveDecision]
165
+ # @return [::Google::Cloud::AccessApproval::V1::ApproveDecision]
166
166
  # Access was approved.
167
167
  # @!attribute [rw] dismiss
168
- # @return [Google::Cloud::AccessApproval::V1::DismissDecision]
168
+ # @return [::Google::Cloud::AccessApproval::V1::DismissDecision]
169
169
  # The request was dismissed.
170
170
  class ApprovalRequest
171
- include Google::Protobuf::MessageExts
172
- extend Google::Protobuf::MessageExts::ClassMethods
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
173
  end
174
174
 
175
175
  # Represents the enrollment of a cloud resource into a specific service.
176
176
  # @!attribute [rw] cloud_product
177
- # @return [String]
177
+ # @return [::String]
178
178
  # The product for which Access Approval will be enrolled. Allowed values are
179
179
  # listed below (case-sensitive):
180
180
  # <ol>
@@ -190,16 +190,16 @@ module Google
190
190
  # <li>storage.googleapis.com</li>
191
191
  # <ol>
192
192
  # @!attribute [rw] enrollment_level
193
- # @return [Google::Cloud::AccessApproval::V1::EnrollmentLevel]
193
+ # @return [::Google::Cloud::AccessApproval::V1::EnrollmentLevel]
194
194
  # The enrollment level of the service.
195
195
  class EnrolledService
196
- include Google::Protobuf::MessageExts
197
- extend Google::Protobuf::MessageExts::ClassMethods
196
+ include ::Google::Protobuf::MessageExts
197
+ extend ::Google::Protobuf::MessageExts::ClassMethods
198
198
  end
199
199
 
200
200
  # Settings on a Project/Folder/Organization related to Access Approval.
201
201
  # @!attribute [rw] name
202
- # @return [String]
202
+ # @return [::String]
203
203
  # The resource name of the settings. Format is one of:
204
204
  # <ol>
205
205
  # <li>"projects/\\{project_id}/accessApprovalSettings"</li>
@@ -207,13 +207,13 @@ module Google
207
207
  # <li>"organizations/\\{organization_id}/accessApprovalSettings"</li>
208
208
  # <ol>
209
209
  # @!attribute [rw] notification_emails
210
- # @return [Array<String>]
210
+ # @return [::Array<::String>]
211
211
  # A list of email addresses to which notifications relating to approval
212
212
  # requests should be sent. Notifications relating to a resource will be sent
213
213
  # to all emails in the settings of ancestor resources of that resource. A
214
214
  # maximum of 50 email addresses are allowed.
215
215
  # @!attribute [rw] enrolled_services
216
- # @return [Array<Google::Cloud::AccessApproval::V1::EnrolledService>]
216
+ # @return [::Array<::Google::Cloud::AccessApproval::V1::EnrolledService>]
217
217
  # A list of Google Cloud Services for which the given resource has Access
218
218
  # Approval enrolled. Access requests for the resource given by name against
219
219
  # any of these services contained here will be required to have explicit
@@ -226,24 +226,24 @@ module Google
226
226
  # enrolled services will be enforced, to be expanded as the set of supported
227
227
  # services is expanded.
228
228
  # @!attribute [r] enrolled_ancestor
229
- # @return [Boolean]
229
+ # @return [::Boolean]
230
230
  # Output only. This field is read only (not settable via
231
231
  # UpdateAccessAccessApprovalSettings method). If the field is true, that
232
232
  # indicates that at least one service is enrolled for Access Approval in one
233
233
  # or more ancestors of the Project or Folder (this field will always be
234
234
  # unset for the organization since organizations do not have ancestors).
235
235
  class AccessApprovalSettings
236
- include Google::Protobuf::MessageExts
237
- extend Google::Protobuf::MessageExts::ClassMethods
236
+ include ::Google::Protobuf::MessageExts
237
+ extend ::Google::Protobuf::MessageExts::ClassMethods
238
238
  end
239
239
 
240
240
  # Request to list approval requests.
241
241
  # @!attribute [rw] parent
242
- # @return [String]
242
+ # @return [::String]
243
243
  # The parent resource. This may be "projects/\\{project_id}",
244
244
  # "folders/\\{folder_id}", or "organizations/\\{organization_id}".
245
245
  # @!attribute [rw] filter
246
- # @return [String]
246
+ # @return [::String]
247
247
  # A filter on the type of approval requests to retrieve. Must be one of the
248
248
  # following values:
249
249
  # <ol>
@@ -254,73 +254,73 @@ module Google
254
254
  # <li>DISMISSED: Only dismissed (including expired) requests.</li>
255
255
  # </ol>
256
256
  # @!attribute [rw] page_size
257
- # @return [Integer]
257
+ # @return [::Integer]
258
258
  # Requested page size.
259
259
  # @!attribute [rw] page_token
260
- # @return [String]
260
+ # @return [::String]
261
261
  # A token identifying the page of results to return.
262
262
  class ListApprovalRequestsMessage
263
- include Google::Protobuf::MessageExts
264
- extend Google::Protobuf::MessageExts::ClassMethods
263
+ include ::Google::Protobuf::MessageExts
264
+ extend ::Google::Protobuf::MessageExts::ClassMethods
265
265
  end
266
266
 
267
267
  # Response to listing of ApprovalRequest objects.
268
268
  # @!attribute [rw] approval_requests
269
- # @return [Array<Google::Cloud::AccessApproval::V1::ApprovalRequest>]
269
+ # @return [::Array<::Google::Cloud::AccessApproval::V1::ApprovalRequest>]
270
270
  # Approval request details.
271
271
  # @!attribute [rw] next_page_token
272
- # @return [String]
272
+ # @return [::String]
273
273
  # Token to retrieve the next page of results, or empty if there are no more.
274
274
  class ListApprovalRequestsResponse
275
- include Google::Protobuf::MessageExts
276
- extend Google::Protobuf::MessageExts::ClassMethods
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
277
  end
278
278
 
279
279
  # Request to get an approval request.
280
280
  # @!attribute [rw] name
281
- # @return [String]
281
+ # @return [::String]
282
282
  # Name of the approval request to retrieve.
283
283
  class GetApprovalRequestMessage
284
- include Google::Protobuf::MessageExts
285
- extend Google::Protobuf::MessageExts::ClassMethods
284
+ include ::Google::Protobuf::MessageExts
285
+ extend ::Google::Protobuf::MessageExts::ClassMethods
286
286
  end
287
287
 
288
288
  # Request to approve an ApprovalRequest.
289
289
  # @!attribute [rw] name
290
- # @return [String]
290
+ # @return [::String]
291
291
  # Name of the approval request to approve.
292
292
  # @!attribute [rw] expire_time
293
- # @return [Google::Protobuf::Timestamp]
293
+ # @return [::Google::Protobuf::Timestamp]
294
294
  # The expiration time of this approval.
295
295
  class ApproveApprovalRequestMessage
296
- include Google::Protobuf::MessageExts
297
- extend Google::Protobuf::MessageExts::ClassMethods
296
+ include ::Google::Protobuf::MessageExts
297
+ extend ::Google::Protobuf::MessageExts::ClassMethods
298
298
  end
299
299
 
300
300
  # Request to dismiss an approval request.
301
301
  # @!attribute [rw] name
302
- # @return [String]
302
+ # @return [::String]
303
303
  # Name of the ApprovalRequest to dismiss.
304
304
  class DismissApprovalRequestMessage
305
- include Google::Protobuf::MessageExts
306
- extend Google::Protobuf::MessageExts::ClassMethods
305
+ include ::Google::Protobuf::MessageExts
306
+ extend ::Google::Protobuf::MessageExts::ClassMethods
307
307
  end
308
308
 
309
309
  # Request to get access approval settings.
310
310
  # @!attribute [rw] name
311
- # @return [String]
311
+ # @return [::String]
312
312
  # Name of the AccessApprovalSettings to retrieve.
313
313
  class GetAccessApprovalSettingsMessage
314
- include Google::Protobuf::MessageExts
315
- extend Google::Protobuf::MessageExts::ClassMethods
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
316
  end
317
317
 
318
318
  # Request to update access approval settings.
319
319
  # @!attribute [rw] settings
320
- # @return [Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
320
+ # @return [::Google::Cloud::AccessApproval::V1::AccessApprovalSettings]
321
321
  # The new AccessApprovalSettings.
322
322
  # @!attribute [rw] update_mask
323
- # @return [Google::Protobuf::FieldMask]
323
+ # @return [::Google::Protobuf::FieldMask]
324
324
  # The update mask applies to the settings. Only the top level fields of
325
325
  # AccessApprovalSettings (notification_emails & enrolled_services) are
326
326
  # supported. For each field, if it is included, the currently stored value
@@ -332,17 +332,17 @@ module Google
332
332
  # If this field is left unset, only the notification_emails field will be
333
333
  # updated.
334
334
  class UpdateAccessApprovalSettingsMessage
335
- include Google::Protobuf::MessageExts
336
- extend Google::Protobuf::MessageExts::ClassMethods
335
+ include ::Google::Protobuf::MessageExts
336
+ extend ::Google::Protobuf::MessageExts::ClassMethods
337
337
  end
338
338
 
339
339
  # Request to delete access approval settings.
340
340
  # @!attribute [rw] name
341
- # @return [String]
341
+ # @return [::String]
342
342
  # Name of the AccessApprovalSettings to delete.
343
343
  class DeleteAccessApprovalSettingsMessage
344
- include Google::Protobuf::MessageExts
345
- extend Google::Protobuf::MessageExts::ClassMethods
344
+ include ::Google::Protobuf::MessageExts
345
+ extend ::Google::Protobuf::MessageExts::ClassMethods
346
346
  end
347
347
 
348
348
  # Represents the type of enrollment for a given service to Access Approval.
@@ -29,8 +29,8 @@ module Google
29
29
  #
30
30
  # The JSON representation for `Empty` is empty JSON object `{}`.
31
31
  class Empty
32
- include Google::Protobuf::MessageExts
33
- extend Google::Protobuf::MessageExts::ClassMethods
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
34
  end
35
35
  end
36
36
  end
@@ -87,57 +87,49 @@ module Google
87
87
  # describe the updated values, the API ignores the values of all
88
88
  # fields not covered by the mask.
89
89
  #
90
- # If a repeated field is specified for an update operation, the existing
91
- # repeated values in the target resource will be overwritten by the new values.
92
- # Note that a repeated field is only allowed in the last position of a `paths`
93
- # string.
90
+ # If a repeated field is specified for an update operation, new values will
91
+ # be appended to the existing repeated field in the target resource. Note that
92
+ # a repeated field is only allowed in the last position of a `paths` string.
94
93
  #
95
94
  # If a sub-message is specified in the last position of the field mask for an
96
- # update operation, then the existing sub-message in the target resource is
97
- # overwritten. Given the target message:
95
+ # update operation, then new value will be merged into the existing sub-message
96
+ # in the target resource.
97
+ #
98
+ # For example, given the target message:
98
99
  #
99
100
  # f {
100
101
  # b {
101
- # d : 1
102
- # x : 2
102
+ # d: 1
103
+ # x: 2
103
104
  # }
104
- # c : 1
105
+ # c: [1]
105
106
  # }
106
107
  #
107
108
  # And an update message:
108
109
  #
109
110
  # f {
110
111
  # b {
111
- # d : 10
112
+ # d: 10
112
113
  # }
114
+ # c: [2]
113
115
  # }
114
116
  #
115
117
  # then if the field mask is:
116
118
  #
117
- # paths: "f.b"
119
+ # paths: ["f.b", "f.c"]
118
120
  #
119
121
  # then the result will be:
120
122
  #
121
123
  # f {
122
124
  # b {
123
- # d : 10
125
+ # d: 10
126
+ # x: 2
124
127
  # }
125
- # c : 1
128
+ # c: [1, 2]
126
129
  # }
127
130
  #
128
- # However, if the update mask was:
129
- #
130
- # paths: "f.b.d"
131
- #
132
- # then the result would be:
133
- #
134
- # f {
135
- # b {
136
- # d : 10
137
- # x : 2
138
- # }
139
- # c : 1
140
- # }
131
+ # An implementation may provide options to override this default behavior for
132
+ # repeated and message fields.
141
133
  #
142
134
  # In order to reset a field's value to the default, the field must
143
135
  # be in the mask and set to the default value in the provided resource.
@@ -225,13 +217,13 @@ module Google
225
217
  #
226
218
  # The implementation of any API method which has a FieldMask type field in the
227
219
  # request should verify the included field paths, and return an
228
- # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
220
+ # `INVALID_ARGUMENT` error if any path is unmappable.
229
221
  # @!attribute [rw] paths
230
- # @return [Array<String>]
222
+ # @return [::Array<::String>]
231
223
  # The set of field mask paths.
232
224
  class FieldMask
233
- include Google::Protobuf::MessageExts
234
- extend Google::Protobuf::MessageExts::ClassMethods
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
235
227
  end
236
228
  end
237
229
  end