google-apis-servicedirectory_v1 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +13 -0
- data/CHANGELOG.md +7 -0
- data/LICENSE.md +202 -0
- data/OVERVIEW.md +96 -0
- data/lib/google-apis-servicedirectory_v1.rb +15 -0
- data/lib/google/apis/servicedirectory_v1.rb +37 -0
- data/lib/google/apis/servicedirectory_v1/classes.rb +721 -0
- data/lib/google/apis/servicedirectory_v1/gem_version.rb +28 -0
- data/lib/google/apis/servicedirectory_v1/representations.rb +304 -0
- data/lib/google/apis/servicedirectory_v1/service.rb +959 -0
- metadata +76 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 9d8039fa501a95e7aa75fe8505c9f048fd4219827344b0c9126366892253a615
|
4
|
+
data.tar.gz: 93b04132e3156f04889c4bb233ef8cee7bc8a35ddd016c598fe4cfde1ed72144
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b3e43c3f6976bf883bde946550c56ebfcaf5689b9c41ab188175fbcbdc44613246072f284a631ff4fdcd2a1efdc53ba9ab83b69df11fe7214df273036fed0606
|
7
|
+
data.tar.gz: cd4ca7d34a3087c0361994d656aff15e264085aaf42a45c5a3c88ee544436da36df069686740ac96067bac6edde2679107c8dd382450cf8971ad9612d8e68e80
|
data/.yardopts
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
--hide-void-return
|
2
|
+
--no-private
|
3
|
+
--verbose
|
4
|
+
--title=google-apis-servicedirectory_v1
|
5
|
+
--markup-provider=redcarpet
|
6
|
+
--markup=markdown
|
7
|
+
--main OVERVIEW.md
|
8
|
+
lib/google/apis/servicedirectory_v1/*.rb
|
9
|
+
lib/google/apis/servicedirectory_v1.rb
|
10
|
+
-
|
11
|
+
OVERVIEW.md
|
12
|
+
CHANGELOG.md
|
13
|
+
LICENSE.md
|
data/CHANGELOG.md
ADDED
data/LICENSE.md
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/OVERVIEW.md
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
# Simple REST client for version V1 of the Service Directory API
|
2
|
+
|
3
|
+
This is a simple client library for version V1 of the Service Directory API. It provides:
|
4
|
+
|
5
|
+
* A client object that connects to the HTTP/JSON REST endpoint for the service.
|
6
|
+
* Ruby objects for data structures related to the service.
|
7
|
+
* Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
|
8
|
+
* Control of retry, pagination, and timeouts.
|
9
|
+
|
10
|
+
Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
|
11
|
+
|
12
|
+
## Getting started
|
13
|
+
|
14
|
+
### Before you begin
|
15
|
+
|
16
|
+
There are a few setup steps you need to complete before you can use this library:
|
17
|
+
|
18
|
+
1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
|
19
|
+
2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
|
20
|
+
3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/servicedirectory.googleapis.com) in the console.
|
21
|
+
|
22
|
+
### Installation
|
23
|
+
|
24
|
+
Add this line to your application's Gemfile:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
gem 'google-apis-servicedirectory_v1', '~> 0.1'
|
28
|
+
```
|
29
|
+
|
30
|
+
And then execute:
|
31
|
+
|
32
|
+
```
|
33
|
+
$ bundle
|
34
|
+
```
|
35
|
+
|
36
|
+
Or install it yourself as:
|
37
|
+
|
38
|
+
```
|
39
|
+
$ gem install google-apis-servicedirectory_v1
|
40
|
+
```
|
41
|
+
|
42
|
+
### Creating a client object
|
43
|
+
|
44
|
+
Once the gem is installed, you can load the client code and instantiate a client.
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
# Load the client
|
48
|
+
require "google/apis/servicedirectory_v1"
|
49
|
+
|
50
|
+
# Create a client object
|
51
|
+
client = Google::Apis::ServicedirectoryV1::ServiceDirectoryService.new
|
52
|
+
|
53
|
+
# Authenticate calls
|
54
|
+
client.authentication = # ... use the googleauth gem to create credentials
|
55
|
+
```
|
56
|
+
|
57
|
+
See the class reference docs for information on the methods you can call from a client.
|
58
|
+
|
59
|
+
## Documentation
|
60
|
+
|
61
|
+
More detailed descriptions of the Google simple REST clients are available in two documents.
|
62
|
+
|
63
|
+
* The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
|
64
|
+
* The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
|
65
|
+
|
66
|
+
(Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Servicedirectory service in particular.)
|
67
|
+
|
68
|
+
For reference information on specific calls in the Service Directory API, see the {Google::Apis::ServicedirectoryV1::ServiceDirectoryService class reference docs}.
|
69
|
+
|
70
|
+
## Which client should I use?
|
71
|
+
|
72
|
+
Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
|
73
|
+
|
74
|
+
This library, `google-apis-servicedirectory_v1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
|
75
|
+
|
76
|
+
Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
|
77
|
+
|
78
|
+
Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
|
79
|
+
|
80
|
+
**For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
|
81
|
+
|
82
|
+
The [product documentation](https://cloud.google.com/service-directory) may provide guidance regarding the preferred client library to use.
|
83
|
+
|
84
|
+
## Supported Ruby versions
|
85
|
+
|
86
|
+
This library is supported on Ruby 2.5+.
|
87
|
+
|
88
|
+
Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
|
89
|
+
|
90
|
+
## License
|
91
|
+
|
92
|
+
This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
|
93
|
+
|
94
|
+
## Support
|
95
|
+
|
96
|
+
Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
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/servicedirectory_v1"
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
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/servicedirectory_v1/service.rb'
|
16
|
+
require 'google/apis/servicedirectory_v1/classes.rb'
|
17
|
+
require 'google/apis/servicedirectory_v1/representations.rb'
|
18
|
+
require 'google/apis/servicedirectory_v1/gem_version.rb'
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Apis
|
22
|
+
# Service Directory API
|
23
|
+
#
|
24
|
+
# Service Directory is a platform for discovering, publishing, and connecting
|
25
|
+
# services.
|
26
|
+
#
|
27
|
+
# @see https://cloud.google.com/service-directory
|
28
|
+
module ServicedirectoryV1
|
29
|
+
# Version of the Service Directory API this client connects to.
|
30
|
+
# This is NOT the gem version.
|
31
|
+
VERSION = 'V1'
|
32
|
+
|
33
|
+
# View and manage your data across Google Cloud Platform services
|
34
|
+
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,721 @@
|
|
1
|
+
# Copyright 2020 Google LLC
|
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 ServicedirectoryV1
|
24
|
+
|
25
|
+
# Associates `members` with a `role`.
|
26
|
+
class Binding
|
27
|
+
include Google::Apis::Core::Hashable
|
28
|
+
|
29
|
+
# Represents a textual expression in the Common Expression Language (CEL) syntax.
|
30
|
+
# CEL is a C-like expression language. The syntax and semantics of CEL are
|
31
|
+
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
|
32
|
+
# "Summary size limit" description: "Determines if a summary is less than 100
|
33
|
+
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
|
34
|
+
# Requestor is owner" description: "Determines if requestor is the document
|
35
|
+
# owner" expression: "document.owner == request.auth.claims.email" Example (
|
36
|
+
# Logic): title: "Public documents" description: "Determine whether the document
|
37
|
+
# should be publicly visible" expression: "document.type != 'private' &&
|
38
|
+
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
|
39
|
+
# string" description: "Create a notification string with a timestamp."
|
40
|
+
# expression: "'New message received at ' + string(document.create_time)" The
|
41
|
+
# exact variables and functions that may be referenced within an expression are
|
42
|
+
# determined by the service that evaluates it. See the service documentation for
|
43
|
+
# additional information.
|
44
|
+
# Corresponds to the JSON property `condition`
|
45
|
+
# @return [Google::Apis::ServicedirectoryV1::Expr]
|
46
|
+
attr_accessor :condition
|
47
|
+
|
48
|
+
# Specifies the identities requesting access for a Cloud Platform resource. `
|
49
|
+
# members` can have the following values: * `allUsers`: A special identifier
|
50
|
+
# that represents anyone who is on the internet; with or without a Google
|
51
|
+
# account. * `allAuthenticatedUsers`: A special identifier that represents
|
52
|
+
# anyone who is authenticated with a Google account or a service account. * `
|
53
|
+
# user:`emailid``: An email address that represents a specific Google account.
|
54
|
+
# For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
|
55
|
+
# address that represents a service account. For example, `my-other-app@appspot.
|
56
|
+
# gserviceaccount.com`. * `group:`emailid``: An email address that represents a
|
57
|
+
# Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid=
|
58
|
+
# `uniqueid``: An email address (plus unique identifier) representing a user
|
59
|
+
# that has been recently deleted. For example, `alice@example.com?uid=
|
60
|
+
# 123456789012345678901`. If the user is recovered, this value reverts to `user:`
|
61
|
+
# emailid`` and the recovered user retains the role in the binding. * `deleted:
|
62
|
+
# serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique
|
63
|
+
# identifier) representing a service account that has been recently deleted. For
|
64
|
+
# example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
|
65
|
+
# If the service account is undeleted, this value reverts to `serviceAccount:`
|
66
|
+
# emailid`` and the undeleted service account retains the role in the binding. *
|
67
|
+
# `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
|
68
|
+
# identifier) representing a Google group that has been recently deleted. For
|
69
|
+
# example, `admins@example.com?uid=123456789012345678901`. If the group is
|
70
|
+
# recovered, this value reverts to `group:`emailid`` and the recovered group
|
71
|
+
# retains the role in the binding. * `domain:`domain``: The G Suite domain (
|
72
|
+
# primary) that represents all the users of that domain. For example, `google.
|
73
|
+
# com` or `example.com`.
|
74
|
+
# Corresponds to the JSON property `members`
|
75
|
+
# @return [Array<String>]
|
76
|
+
attr_accessor :members
|
77
|
+
|
78
|
+
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
|
79
|
+
# , or `roles/owner`.
|
80
|
+
# Corresponds to the JSON property `role`
|
81
|
+
# @return [String]
|
82
|
+
attr_accessor :role
|
83
|
+
|
84
|
+
def initialize(**args)
|
85
|
+
update!(**args)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Update properties of this object
|
89
|
+
def update!(**args)
|
90
|
+
@condition = args[:condition] if args.key?(:condition)
|
91
|
+
@members = args[:members] if args.key?(:members)
|
92
|
+
@role = args[:role] if args.key?(:role)
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
# A generic empty message that you can re-use to avoid defining duplicated empty
|
97
|
+
# messages in your APIs. A typical example is to use it as the request or the
|
98
|
+
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
99
|
+
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
100
|
+
# `Empty` is empty JSON object ````.
|
101
|
+
class Empty
|
102
|
+
include Google::Apis::Core::Hashable
|
103
|
+
|
104
|
+
def initialize(**args)
|
105
|
+
update!(**args)
|
106
|
+
end
|
107
|
+
|
108
|
+
# Update properties of this object
|
109
|
+
def update!(**args)
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
# An individual endpoint that provides a service. The service must already exist
|
114
|
+
# to create an endpoint.
|
115
|
+
class Endpoint
|
116
|
+
include Google::Apis::Core::Hashable
|
117
|
+
|
118
|
+
# Optional. An IPv4 or IPv6 address. Service Directory will reject bad addresses
|
119
|
+
# like: "8.8.8" "8.8.8.8:53" "test:bad:address" "[::1]" "[::1]:8080" Limited to
|
120
|
+
# 45 characters.
|
121
|
+
# Corresponds to the JSON property `address`
|
122
|
+
# @return [String]
|
123
|
+
attr_accessor :address
|
124
|
+
|
125
|
+
# Optional. Annotations for the endpoint. This data can be consumed by service
|
126
|
+
# clients. Restrictions: - The entire annotations dictionary may contain up to
|
127
|
+
# 512 characters, spread accoss all key-value pairs. Annotations that goes
|
128
|
+
# beyond any these limits will be rejected. - Valid annotation keys have two
|
129
|
+
# segments: an optional prefix and name, separated by a slash (/). The name
|
130
|
+
# segment is required and must be 63 characters or less, beginning and ending
|
131
|
+
# with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
|
132
|
+
# dots (.), and alphanumerics between. The prefix is optional. If specified, the
|
133
|
+
# prefix must be a DNS subdomain: a series of DNS labels separated by dots (.),
|
134
|
+
# not longer than 253 characters in total, followed by a slash (/). Annotations
|
135
|
+
# that fails to meet these requirements will be rejected. - The '(*.)google.com/'
|
136
|
+
# and '(*.)googleapis.com/' prefixes are reserved for system annotations
|
137
|
+
# managed by Service Directory. If the user tries to write to these keyspaces,
|
138
|
+
# those entries will be silently ignored by the system. Note: This field is
|
139
|
+
# equivalent to the 'metadata' field in the v1beta1 API. They have the same
|
140
|
+
# syntax and read/write to the same location in Service Directory.
|
141
|
+
# Corresponds to the JSON property `annotations`
|
142
|
+
# @return [Hash<String,String>]
|
143
|
+
attr_accessor :annotations
|
144
|
+
|
145
|
+
# Immutable. The resource name for the endpoint in the format 'projects/*/
|
146
|
+
# locations/*/namespaces/*/services/*/endpoints/*'.
|
147
|
+
# Corresponds to the JSON property `name`
|
148
|
+
# @return [String]
|
149
|
+
attr_accessor :name
|
150
|
+
|
151
|
+
# Optional. Service Directory will reject values outside of [0, 65535].
|
152
|
+
# Corresponds to the JSON property `port`
|
153
|
+
# @return [Fixnum]
|
154
|
+
attr_accessor :port
|
155
|
+
|
156
|
+
def initialize(**args)
|
157
|
+
update!(**args)
|
158
|
+
end
|
159
|
+
|
160
|
+
# Update properties of this object
|
161
|
+
def update!(**args)
|
162
|
+
@address = args[:address] if args.key?(:address)
|
163
|
+
@annotations = args[:annotations] if args.key?(:annotations)
|
164
|
+
@name = args[:name] if args.key?(:name)
|
165
|
+
@port = args[:port] if args.key?(:port)
|
166
|
+
end
|
167
|
+
end
|
168
|
+
|
169
|
+
# Represents a textual expression in the Common Expression Language (CEL) syntax.
|
170
|
+
# CEL is a C-like expression language. The syntax and semantics of CEL are
|
171
|
+
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
|
172
|
+
# "Summary size limit" description: "Determines if a summary is less than 100
|
173
|
+
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
|
174
|
+
# Requestor is owner" description: "Determines if requestor is the document
|
175
|
+
# owner" expression: "document.owner == request.auth.claims.email" Example (
|
176
|
+
# Logic): title: "Public documents" description: "Determine whether the document
|
177
|
+
# should be publicly visible" expression: "document.type != 'private' &&
|
178
|
+
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
|
179
|
+
# string" description: "Create a notification string with a timestamp."
|
180
|
+
# expression: "'New message received at ' + string(document.create_time)" The
|
181
|
+
# exact variables and functions that may be referenced within an expression are
|
182
|
+
# determined by the service that evaluates it. See the service documentation for
|
183
|
+
# additional information.
|
184
|
+
class Expr
|
185
|
+
include Google::Apis::Core::Hashable
|
186
|
+
|
187
|
+
# Optional. Description of the expression. This is a longer text which describes
|
188
|
+
# the expression, e.g. when hovered over it in a UI.
|
189
|
+
# Corresponds to the JSON property `description`
|
190
|
+
# @return [String]
|
191
|
+
attr_accessor :description
|
192
|
+
|
193
|
+
# Textual representation of an expression in Common Expression Language syntax.
|
194
|
+
# Corresponds to the JSON property `expression`
|
195
|
+
# @return [String]
|
196
|
+
attr_accessor :expression
|
197
|
+
|
198
|
+
# Optional. String indicating the location of the expression for error reporting,
|
199
|
+
# e.g. a file name and a position in the file.
|
200
|
+
# Corresponds to the JSON property `location`
|
201
|
+
# @return [String]
|
202
|
+
attr_accessor :location
|
203
|
+
|
204
|
+
# Optional. Title for the expression, i.e. a short string describing its purpose.
|
205
|
+
# This can be used e.g. in UIs which allow to enter the expression.
|
206
|
+
# Corresponds to the JSON property `title`
|
207
|
+
# @return [String]
|
208
|
+
attr_accessor :title
|
209
|
+
|
210
|
+
def initialize(**args)
|
211
|
+
update!(**args)
|
212
|
+
end
|
213
|
+
|
214
|
+
# Update properties of this object
|
215
|
+
def update!(**args)
|
216
|
+
@description = args[:description] if args.key?(:description)
|
217
|
+
@expression = args[:expression] if args.key?(:expression)
|
218
|
+
@location = args[:location] if args.key?(:location)
|
219
|
+
@title = args[:title] if args.key?(:title)
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
# Request message for `GetIamPolicy` method.
|
224
|
+
class GetIamPolicyRequest
|
225
|
+
include Google::Apis::Core::Hashable
|
226
|
+
|
227
|
+
# Encapsulates settings provided to GetIamPolicy.
|
228
|
+
# Corresponds to the JSON property `options`
|
229
|
+
# @return [Google::Apis::ServicedirectoryV1::GetPolicyOptions]
|
230
|
+
attr_accessor :options
|
231
|
+
|
232
|
+
def initialize(**args)
|
233
|
+
update!(**args)
|
234
|
+
end
|
235
|
+
|
236
|
+
# Update properties of this object
|
237
|
+
def update!(**args)
|
238
|
+
@options = args[:options] if args.key?(:options)
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
# Encapsulates settings provided to GetIamPolicy.
|
243
|
+
class GetPolicyOptions
|
244
|
+
include Google::Apis::Core::Hashable
|
245
|
+
|
246
|
+
# Optional. The policy format version to be returned. Valid values are 0, 1, and
|
247
|
+
# 3. Requests specifying an invalid value will be rejected. Requests for
|
248
|
+
# policies with any conditional bindings must specify version 3. Policies
|
249
|
+
# without any conditional bindings may specify any valid value or leave the
|
250
|
+
# field unset. To learn which resources support conditions in their IAM policies,
|
251
|
+
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
252
|
+
# resource-policies).
|
253
|
+
# Corresponds to the JSON property `requestedPolicyVersion`
|
254
|
+
# @return [Fixnum]
|
255
|
+
attr_accessor :requested_policy_version
|
256
|
+
|
257
|
+
def initialize(**args)
|
258
|
+
update!(**args)
|
259
|
+
end
|
260
|
+
|
261
|
+
# Update properties of this object
|
262
|
+
def update!(**args)
|
263
|
+
@requested_policy_version = args[:requested_policy_version] if args.key?(:requested_policy_version)
|
264
|
+
end
|
265
|
+
end
|
266
|
+
|
267
|
+
# The response message for RegistrationService.ListEndpoints.
|
268
|
+
class ListEndpointsResponse
|
269
|
+
include Google::Apis::Core::Hashable
|
270
|
+
|
271
|
+
# The list of endpoints.
|
272
|
+
# Corresponds to the JSON property `endpoints`
|
273
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Endpoint>]
|
274
|
+
attr_accessor :endpoints
|
275
|
+
|
276
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
277
|
+
# results in the list.
|
278
|
+
# Corresponds to the JSON property `nextPageToken`
|
279
|
+
# @return [String]
|
280
|
+
attr_accessor :next_page_token
|
281
|
+
|
282
|
+
def initialize(**args)
|
283
|
+
update!(**args)
|
284
|
+
end
|
285
|
+
|
286
|
+
# Update properties of this object
|
287
|
+
def update!(**args)
|
288
|
+
@endpoints = args[:endpoints] if args.key?(:endpoints)
|
289
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
290
|
+
end
|
291
|
+
end
|
292
|
+
|
293
|
+
# The response message for Locations.ListLocations.
|
294
|
+
class ListLocationsResponse
|
295
|
+
include Google::Apis::Core::Hashable
|
296
|
+
|
297
|
+
# A list of locations that matches the specified filter in the request.
|
298
|
+
# Corresponds to the JSON property `locations`
|
299
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Location>]
|
300
|
+
attr_accessor :locations
|
301
|
+
|
302
|
+
# The standard List next-page token.
|
303
|
+
# Corresponds to the JSON property `nextPageToken`
|
304
|
+
# @return [String]
|
305
|
+
attr_accessor :next_page_token
|
306
|
+
|
307
|
+
def initialize(**args)
|
308
|
+
update!(**args)
|
309
|
+
end
|
310
|
+
|
311
|
+
# Update properties of this object
|
312
|
+
def update!(**args)
|
313
|
+
@locations = args[:locations] if args.key?(:locations)
|
314
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
315
|
+
end
|
316
|
+
end
|
317
|
+
|
318
|
+
# The response message for RegistrationService.ListNamespaces.
|
319
|
+
class ListNamespacesResponse
|
320
|
+
include Google::Apis::Core::Hashable
|
321
|
+
|
322
|
+
# The list of namespaces.
|
323
|
+
# Corresponds to the JSON property `namespaces`
|
324
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Namespace>]
|
325
|
+
attr_accessor :namespaces
|
326
|
+
|
327
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
328
|
+
# results in the list.
|
329
|
+
# Corresponds to the JSON property `nextPageToken`
|
330
|
+
# @return [String]
|
331
|
+
attr_accessor :next_page_token
|
332
|
+
|
333
|
+
def initialize(**args)
|
334
|
+
update!(**args)
|
335
|
+
end
|
336
|
+
|
337
|
+
# Update properties of this object
|
338
|
+
def update!(**args)
|
339
|
+
@namespaces = args[:namespaces] if args.key?(:namespaces)
|
340
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
341
|
+
end
|
342
|
+
end
|
343
|
+
|
344
|
+
# The response message for RegistrationService.ListServices.
|
345
|
+
class ListServicesResponse
|
346
|
+
include Google::Apis::Core::Hashable
|
347
|
+
|
348
|
+
# Token to retrieve the next page of results, or empty if there are no more
|
349
|
+
# results in the list.
|
350
|
+
# Corresponds to the JSON property `nextPageToken`
|
351
|
+
# @return [String]
|
352
|
+
attr_accessor :next_page_token
|
353
|
+
|
354
|
+
# The list of services.
|
355
|
+
# Corresponds to the JSON property `services`
|
356
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Service>]
|
357
|
+
attr_accessor :services
|
358
|
+
|
359
|
+
def initialize(**args)
|
360
|
+
update!(**args)
|
361
|
+
end
|
362
|
+
|
363
|
+
# Update properties of this object
|
364
|
+
def update!(**args)
|
365
|
+
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
366
|
+
@services = args[:services] if args.key?(:services)
|
367
|
+
end
|
368
|
+
end
|
369
|
+
|
370
|
+
# A resource that represents Google Cloud Platform location.
|
371
|
+
class Location
|
372
|
+
include Google::Apis::Core::Hashable
|
373
|
+
|
374
|
+
# The friendly name for this location, typically a nearby city name. For example,
|
375
|
+
# "Tokyo".
|
376
|
+
# Corresponds to the JSON property `displayName`
|
377
|
+
# @return [String]
|
378
|
+
attr_accessor :display_name
|
379
|
+
|
380
|
+
# Cross-service attributes for the location. For example `"cloud.googleapis.com/
|
381
|
+
# region": "us-east1"`
|
382
|
+
# Corresponds to the JSON property `labels`
|
383
|
+
# @return [Hash<String,String>]
|
384
|
+
attr_accessor :labels
|
385
|
+
|
386
|
+
# The canonical id for this location. For example: `"us-east1"`.
|
387
|
+
# Corresponds to the JSON property `locationId`
|
388
|
+
# @return [String]
|
389
|
+
attr_accessor :location_id
|
390
|
+
|
391
|
+
# Service-specific metadata. For example the available capacity at the given
|
392
|
+
# location.
|
393
|
+
# Corresponds to the JSON property `metadata`
|
394
|
+
# @return [Hash<String,Object>]
|
395
|
+
attr_accessor :metadata
|
396
|
+
|
397
|
+
# Resource name for the location, which may vary between implementations. For
|
398
|
+
# example: `"projects/example-project/locations/us-east1"`
|
399
|
+
# Corresponds to the JSON property `name`
|
400
|
+
# @return [String]
|
401
|
+
attr_accessor :name
|
402
|
+
|
403
|
+
def initialize(**args)
|
404
|
+
update!(**args)
|
405
|
+
end
|
406
|
+
|
407
|
+
# Update properties of this object
|
408
|
+
def update!(**args)
|
409
|
+
@display_name = args[:display_name] if args.key?(:display_name)
|
410
|
+
@labels = args[:labels] if args.key?(:labels)
|
411
|
+
@location_id = args[:location_id] if args.key?(:location_id)
|
412
|
+
@metadata = args[:metadata] if args.key?(:metadata)
|
413
|
+
@name = args[:name] if args.key?(:name)
|
414
|
+
end
|
415
|
+
end
|
416
|
+
|
417
|
+
# A container for services. Namespaces allow administrators to group services
|
418
|
+
# together and define permissions for a collection of services.
|
419
|
+
class Namespace
|
420
|
+
include Google::Apis::Core::Hashable
|
421
|
+
|
422
|
+
# Optional. Resource labels associated with this Namespace. No more than 64 user
|
423
|
+
# labels can be associated with a given resource. Label keys and values can be
|
424
|
+
# no longer than 63 characters.
|
425
|
+
# Corresponds to the JSON property `labels`
|
426
|
+
# @return [Hash<String,String>]
|
427
|
+
attr_accessor :labels
|
428
|
+
|
429
|
+
# Immutable. The resource name for the namespace in the format 'projects/*/
|
430
|
+
# locations/*/namespaces/*'.
|
431
|
+
# Corresponds to the JSON property `name`
|
432
|
+
# @return [String]
|
433
|
+
attr_accessor :name
|
434
|
+
|
435
|
+
def initialize(**args)
|
436
|
+
update!(**args)
|
437
|
+
end
|
438
|
+
|
439
|
+
# Update properties of this object
|
440
|
+
def update!(**args)
|
441
|
+
@labels = args[:labels] if args.key?(:labels)
|
442
|
+
@name = args[:name] if args.key?(:name)
|
443
|
+
end
|
444
|
+
end
|
445
|
+
|
446
|
+
# An Identity and Access Management (IAM) policy, which specifies access
|
447
|
+
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
|
448
|
+
# A `binding` binds one or more `members` to a single `role`. Members can be
|
449
|
+
# user accounts, service accounts, Google groups, and domains (such as G Suite).
|
450
|
+
# A `role` is a named list of permissions; each `role` can be an IAM predefined
|
451
|
+
# role or a user-created custom role. For some types of Google Cloud resources,
|
452
|
+
# a `binding` can also specify a `condition`, which is a logical expression that
|
453
|
+
# allows access to a resource only if the expression evaluates to `true`. A
|
454
|
+
# condition can add constraints based on attributes of the request, the resource,
|
455
|
+
# or both. To learn which resources support conditions in their IAM policies,
|
456
|
+
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
457
|
+
# resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
|
458
|
+
# resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
|
459
|
+
# group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
|
460
|
+
# appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
|
461
|
+
# organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
|
462
|
+
# title": "expirable access", "description": "Does not grant access after Sep
|
463
|
+
# 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
|
464
|
+
# ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
|
465
|
+
# members: - user:mike@example.com - group:admins@example.com - domain:google.
|
466
|
+
# com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
|
467
|
+
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
|
468
|
+
# roles/resourcemanager.organizationViewer condition: title: expirable access
|
469
|
+
# description: Does not grant access after Sep 2020 expression: request.time <
|
470
|
+
# timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
|
471
|
+
# description of IAM and its features, see the [IAM documentation](https://cloud.
|
472
|
+
# google.com/iam/docs/).
|
473
|
+
class Policy
|
474
|
+
include Google::Apis::Core::Hashable
|
475
|
+
|
476
|
+
# Associates a list of `members` to a `role`. Optionally, may specify a `
|
477
|
+
# condition` that determines how and when the `bindings` are applied. Each of
|
478
|
+
# the `bindings` must contain at least one member.
|
479
|
+
# Corresponds to the JSON property `bindings`
|
480
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Binding>]
|
481
|
+
attr_accessor :bindings
|
482
|
+
|
483
|
+
# `etag` is used for optimistic concurrency control as a way to help prevent
|
484
|
+
# simultaneous updates of a policy from overwriting each other. It is strongly
|
485
|
+
# suggested that systems make use of the `etag` in the read-modify-write cycle
|
486
|
+
# to perform policy updates in order to avoid race conditions: An `etag` is
|
487
|
+
# returned in the response to `getIamPolicy`, and systems are expected to put
|
488
|
+
# that etag in the request to `setIamPolicy` to ensure that their change will be
|
489
|
+
# applied to the same version of the policy. **Important:** If you use IAM
|
490
|
+
# Conditions, you must include the `etag` field whenever you call `setIamPolicy`.
|
491
|
+
# If you omit this field, then IAM allows you to overwrite a version `3` policy
|
492
|
+
# with a version `1` policy, and all of the conditions in the version `3` policy
|
493
|
+
# are lost.
|
494
|
+
# Corresponds to the JSON property `etag`
|
495
|
+
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
496
|
+
# @return [String]
|
497
|
+
attr_accessor :etag
|
498
|
+
|
499
|
+
# Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
|
500
|
+
# Requests that specify an invalid value are rejected. Any operation that
|
501
|
+
# affects conditional role bindings must specify version `3`. This requirement
|
502
|
+
# applies to the following operations: * Getting a policy that includes a
|
503
|
+
# conditional role binding * Adding a conditional role binding to a policy *
|
504
|
+
# Changing a conditional role binding in a policy * Removing any role binding,
|
505
|
+
# with or without a condition, from a policy that includes conditions **
|
506
|
+
# Important:** If you use IAM Conditions, you must include the `etag` field
|
507
|
+
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
|
508
|
+
# to overwrite a version `3` policy with a version `1` policy, and all of the
|
509
|
+
# conditions in the version `3` policy are lost. If a policy does not include
|
510
|
+
# any conditions, operations on that policy may specify any valid version or
|
511
|
+
# leave the field unset. To learn which resources support conditions in their
|
512
|
+
# IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/
|
513
|
+
# conditions/resource-policies).
|
514
|
+
# Corresponds to the JSON property `version`
|
515
|
+
# @return [Fixnum]
|
516
|
+
attr_accessor :version
|
517
|
+
|
518
|
+
def initialize(**args)
|
519
|
+
update!(**args)
|
520
|
+
end
|
521
|
+
|
522
|
+
# Update properties of this object
|
523
|
+
def update!(**args)
|
524
|
+
@bindings = args[:bindings] if args.key?(:bindings)
|
525
|
+
@etag = args[:etag] if args.key?(:etag)
|
526
|
+
@version = args[:version] if args.key?(:version)
|
527
|
+
end
|
528
|
+
end
|
529
|
+
|
530
|
+
# The request message for LookupService.ResolveService. Looks up a service by
|
531
|
+
# its name, returns the service and its endpoints.
|
532
|
+
class ResolveServiceRequest
|
533
|
+
include Google::Apis::Core::Hashable
|
534
|
+
|
535
|
+
# Optional. The filter applied to the endpoints of the resolved service. General
|
536
|
+
# filter string syntax: () can be "name" or "metadata." for map field. can be "<,
|
537
|
+
# >, <=, >=, !=, =, :". Of which ":" means HAS and is roughly the same as "=".
|
538
|
+
# must be the same data type as the field. can be "AND, OR, NOT". Examples of
|
539
|
+
# valid filters: * "metadata.owner" returns Endpoints that have a label with the
|
540
|
+
# key "owner", this is the same as "metadata:owner" * "metadata.protocol=gRPC"
|
541
|
+
# returns Endpoints that have key/value "protocol=gRPC" * "metadata.owner!=sd
|
542
|
+
# AND metadata.foo=bar" returns Endpoints that have "owner" field in metadata
|
543
|
+
# with a value that is not "sd" AND have the key/value foo=bar.
|
544
|
+
# Corresponds to the JSON property `endpointFilter`
|
545
|
+
# @return [String]
|
546
|
+
attr_accessor :endpoint_filter
|
547
|
+
|
548
|
+
# Optional. The maximum number of endpoints to return. Defaults to 25. Maximum
|
549
|
+
# is 100. If a value less than one is specified, the Default is used. If a value
|
550
|
+
# greater than the Maximum is specified, the Maximum is used.
|
551
|
+
# Corresponds to the JSON property `maxEndpoints`
|
552
|
+
# @return [Fixnum]
|
553
|
+
attr_accessor :max_endpoints
|
554
|
+
|
555
|
+
def initialize(**args)
|
556
|
+
update!(**args)
|
557
|
+
end
|
558
|
+
|
559
|
+
# Update properties of this object
|
560
|
+
def update!(**args)
|
561
|
+
@endpoint_filter = args[:endpoint_filter] if args.key?(:endpoint_filter)
|
562
|
+
@max_endpoints = args[:max_endpoints] if args.key?(:max_endpoints)
|
563
|
+
end
|
564
|
+
end
|
565
|
+
|
566
|
+
# The response message for LookupService.ResolveService.
|
567
|
+
class ResolveServiceResponse
|
568
|
+
include Google::Apis::Core::Hashable
|
569
|
+
|
570
|
+
# An individual service. A service contains a name and optional metadata. A
|
571
|
+
# service must exist before endpoints can be added to it.
|
572
|
+
# Corresponds to the JSON property `service`
|
573
|
+
# @return [Google::Apis::ServicedirectoryV1::Service]
|
574
|
+
attr_accessor :service
|
575
|
+
|
576
|
+
def initialize(**args)
|
577
|
+
update!(**args)
|
578
|
+
end
|
579
|
+
|
580
|
+
# Update properties of this object
|
581
|
+
def update!(**args)
|
582
|
+
@service = args[:service] if args.key?(:service)
|
583
|
+
end
|
584
|
+
end
|
585
|
+
|
586
|
+
# An individual service. A service contains a name and optional metadata. A
|
587
|
+
# service must exist before endpoints can be added to it.
|
588
|
+
class Service
|
589
|
+
include Google::Apis::Core::Hashable
|
590
|
+
|
591
|
+
# Optional. Annotations for the service. This data can be consumed by service
|
592
|
+
# clients. Restrictions: - The entire annotations dictionary may contain up to
|
593
|
+
# 2000 characters, spread accoss all key-value pairs. Annotations that goes
|
594
|
+
# beyond any these limits will be rejected. - Valid annotation keys have two
|
595
|
+
# segments: an optional prefix and name, separated by a slash (/). The name
|
596
|
+
# segment is required and must be 63 characters or less, beginning and ending
|
597
|
+
# with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_),
|
598
|
+
# dots (.), and alphanumerics between. The prefix is optional. If specified, the
|
599
|
+
# prefix must be a DNS subdomain: a series of DNS labels separated by dots (.),
|
600
|
+
# not longer than 253 characters in total, followed by a slash (/). Annotations
|
601
|
+
# that fails to meet these requirements will be rejected. - The '(*.)google.com/'
|
602
|
+
# and '(*.)googleapis.com/' prefixes are reserved for system annotations
|
603
|
+
# managed by Service Directory. If the user tries to write to these keyspaces,
|
604
|
+
# those entries will be silently ignored by the system. Note: This field is
|
605
|
+
# equivalent to the 'metadata' field in the v1beta1 API. They have the same
|
606
|
+
# syntax and read/write to the same location in Service Directory.
|
607
|
+
# Corresponds to the JSON property `annotations`
|
608
|
+
# @return [Hash<String,String>]
|
609
|
+
attr_accessor :annotations
|
610
|
+
|
611
|
+
# Output only. Endpoints associated with this service. Returned on LookupService.
|
612
|
+
# Resolve. Control plane clients should use RegistrationService.ListEndpoints.
|
613
|
+
# Corresponds to the JSON property `endpoints`
|
614
|
+
# @return [Array<Google::Apis::ServicedirectoryV1::Endpoint>]
|
615
|
+
attr_accessor :endpoints
|
616
|
+
|
617
|
+
# Immutable. The resource name for the service in the format 'projects/*/
|
618
|
+
# locations/*/namespaces/*/services/*'.
|
619
|
+
# Corresponds to the JSON property `name`
|
620
|
+
# @return [String]
|
621
|
+
attr_accessor :name
|
622
|
+
|
623
|
+
def initialize(**args)
|
624
|
+
update!(**args)
|
625
|
+
end
|
626
|
+
|
627
|
+
# Update properties of this object
|
628
|
+
def update!(**args)
|
629
|
+
@annotations = args[:annotations] if args.key?(:annotations)
|
630
|
+
@endpoints = args[:endpoints] if args.key?(:endpoints)
|
631
|
+
@name = args[:name] if args.key?(:name)
|
632
|
+
end
|
633
|
+
end
|
634
|
+
|
635
|
+
# Request message for `SetIamPolicy` method.
|
636
|
+
class SetIamPolicyRequest
|
637
|
+
include Google::Apis::Core::Hashable
|
638
|
+
|
639
|
+
# An Identity and Access Management (IAM) policy, which specifies access
|
640
|
+
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
|
641
|
+
# A `binding` binds one or more `members` to a single `role`. Members can be
|
642
|
+
# user accounts, service accounts, Google groups, and domains (such as G Suite).
|
643
|
+
# A `role` is a named list of permissions; each `role` can be an IAM predefined
|
644
|
+
# role or a user-created custom role. For some types of Google Cloud resources,
|
645
|
+
# a `binding` can also specify a `condition`, which is a logical expression that
|
646
|
+
# allows access to a resource only if the expression evaluates to `true`. A
|
647
|
+
# condition can add constraints based on attributes of the request, the resource,
|
648
|
+
# or both. To learn which resources support conditions in their IAM policies,
|
649
|
+
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
650
|
+
# resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
|
651
|
+
# resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
|
652
|
+
# group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
|
653
|
+
# appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
|
654
|
+
# organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
|
655
|
+
# title": "expirable access", "description": "Does not grant access after Sep
|
656
|
+
# 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
|
657
|
+
# ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
|
658
|
+
# members: - user:mike@example.com - group:admins@example.com - domain:google.
|
659
|
+
# com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
|
660
|
+
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
|
661
|
+
# roles/resourcemanager.organizationViewer condition: title: expirable access
|
662
|
+
# description: Does not grant access after Sep 2020 expression: request.time <
|
663
|
+
# timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
|
664
|
+
# description of IAM and its features, see the [IAM documentation](https://cloud.
|
665
|
+
# google.com/iam/docs/).
|
666
|
+
# Corresponds to the JSON property `policy`
|
667
|
+
# @return [Google::Apis::ServicedirectoryV1::Policy]
|
668
|
+
attr_accessor :policy
|
669
|
+
|
670
|
+
def initialize(**args)
|
671
|
+
update!(**args)
|
672
|
+
end
|
673
|
+
|
674
|
+
# Update properties of this object
|
675
|
+
def update!(**args)
|
676
|
+
@policy = args[:policy] if args.key?(:policy)
|
677
|
+
end
|
678
|
+
end
|
679
|
+
|
680
|
+
# Request message for `TestIamPermissions` method.
|
681
|
+
class TestIamPermissionsRequest
|
682
|
+
include Google::Apis::Core::Hashable
|
683
|
+
|
684
|
+
# The set of permissions to check for the `resource`. Permissions with wildcards
|
685
|
+
# (such as '*' or 'storage.*') are not allowed. For more information see [IAM
|
686
|
+
# Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
687
|
+
# Corresponds to the JSON property `permissions`
|
688
|
+
# @return [Array<String>]
|
689
|
+
attr_accessor :permissions
|
690
|
+
|
691
|
+
def initialize(**args)
|
692
|
+
update!(**args)
|
693
|
+
end
|
694
|
+
|
695
|
+
# Update properties of this object
|
696
|
+
def update!(**args)
|
697
|
+
@permissions = args[:permissions] if args.key?(:permissions)
|
698
|
+
end
|
699
|
+
end
|
700
|
+
|
701
|
+
# Response message for `TestIamPermissions` method.
|
702
|
+
class TestIamPermissionsResponse
|
703
|
+
include Google::Apis::Core::Hashable
|
704
|
+
|
705
|
+
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
|
706
|
+
# Corresponds to the JSON property `permissions`
|
707
|
+
# @return [Array<String>]
|
708
|
+
attr_accessor :permissions
|
709
|
+
|
710
|
+
def initialize(**args)
|
711
|
+
update!(**args)
|
712
|
+
end
|
713
|
+
|
714
|
+
# Update properties of this object
|
715
|
+
def update!(**args)
|
716
|
+
@permissions = args[:permissions] if args.key?(:permissions)
|
717
|
+
end
|
718
|
+
end
|
719
|
+
end
|
720
|
+
end
|
721
|
+
end
|