strongdm 1.0.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 +7 -0
- data/LICENSE +201 -0
- data/README.md +30 -0
- data/doc/Google.html +95 -0
- data/doc/Google/Protobuf.html +95 -0
- data/doc/LICENSE.html +294 -0
- data/doc/Object.html +290 -0
- data/doc/README_md.html +128 -0
- data/doc/SDM.html +143 -0
- data/doc/SDM/AKS.html +347 -0
- data/doc/SDM/AKSBasicAuth.html +279 -0
- data/doc/SDM/AKSServiceAccount.html +262 -0
- data/doc/SDM/AccountAttachment.html +217 -0
- data/doc/SDM/AccountAttachmentCreateOptions.html +182 -0
- data/doc/SDM/AccountAttachmentCreateResponse.html +216 -0
- data/doc/SDM/AccountAttachmentDeleteResponse.html +199 -0
- data/doc/SDM/AccountAttachmentGetResponse.html +215 -0
- data/doc/SDM/AccountAttachments.html +429 -0
- data/doc/SDM/AccountCreateResponse.html +232 -0
- data/doc/SDM/AccountDeleteResponse.html +197 -0
- data/doc/SDM/AccountGetResponse.html +214 -0
- data/doc/SDM/AccountGrant.html +253 -0
- data/doc/SDM/AccountGrantCreateResponse.html +215 -0
- data/doc/SDM/AccountGrantDeleteResponse.html +198 -0
- data/doc/SDM/AccountGrantGetResponse.html +214 -0
- data/doc/SDM/AccountGrants.html +425 -0
- data/doc/SDM/AccountUpdateResponse.html +214 -0
- data/doc/SDM/Accounts.html +492 -0
- data/doc/SDM/AlreadyExistsError.html +161 -0
- data/doc/SDM/AmazonEKS.html +330 -0
- data/doc/SDM/AmazonES.html +296 -0
- data/doc/SDM/Athena.html +296 -0
- data/doc/SDM/AuroraMysql.html +313 -0
- data/doc/SDM/AuroraPostgres.html +330 -0
- data/doc/SDM/AuthenticationError.html +161 -0
- data/doc/SDM/BadRequestError.html +161 -0
- data/doc/SDM/BigQuery.html +296 -0
- data/doc/SDM/Cassandra.html +313 -0
- data/doc/SDM/Client.html +549 -0
- data/doc/SDM/Clustrix.html +313 -0
- data/doc/SDM/Cockroach.html +330 -0
- data/doc/SDM/CreateResponseMetadata.html +156 -0
- data/doc/SDM/DeadlineExceededError.html +161 -0
- data/doc/SDM/DeleteResponseMetadata.html +156 -0
- data/doc/SDM/Druid.html +296 -0
- data/doc/SDM/DynamoDB.html +296 -0
- data/doc/SDM/Elastic.html +313 -0
- data/doc/SDM/ElasticacheRedis.html +296 -0
- data/doc/SDM/Gateway.html +252 -0
- data/doc/SDM/GetResponseMetadata.html +156 -0
- data/doc/SDM/GoogleGKE.html +296 -0
- data/doc/SDM/Greenplum.html +330 -0
- data/doc/SDM/HTTPAuth.html +313 -0
- data/doc/SDM/HTTPBasicAuth.html +330 -0
- data/doc/SDM/HTTPNoAuth.html +296 -0
- data/doc/SDM/InternalError.html +161 -0
- data/doc/SDM/Kubernetes.html +347 -0
- data/doc/SDM/KubernetesBasicAuth.html +279 -0
- data/doc/SDM/KubernetesServiceAccount.html +262 -0
- data/doc/SDM/Maria.html +313 -0
- data/doc/SDM/Memcached.html +262 -0
- data/doc/SDM/Memsql.html +313 -0
- data/doc/SDM/MongoHost.html +330 -0
- data/doc/SDM/MongoLegacyHost.html +347 -0
- data/doc/SDM/MongoLegacyReplicaset.html +364 -0
- data/doc/SDM/MongoReplicaSet.html +364 -0
- data/doc/SDM/Mysql.html +313 -0
- data/doc/SDM/NodeCreateResponse.html +232 -0
- data/doc/SDM/NodeDeleteResponse.html +197 -0
- data/doc/SDM/NodeGetResponse.html +214 -0
- data/doc/SDM/NodeUpdateResponse.html +214 -0
- data/doc/SDM/Nodes.html +493 -0
- data/doc/SDM/NotFoundError.html +161 -0
- data/doc/SDM/Oracle.html +330 -0
- data/doc/SDM/PermissionError.html +161 -0
- data/doc/SDM/Plumbing.html +15821 -0
- data/doc/SDM/Postgres.html +330 -0
- data/doc/SDM/Presto.html +330 -0
- data/doc/SDM/RDP.html +296 -0
- data/doc/SDM/RPCError.html +182 -0
- data/doc/SDM/RateLimitError.html +183 -0
- data/doc/SDM/RateLimitMetadata.html +233 -0
- data/doc/SDM/Redis.html +279 -0
- data/doc/SDM/Redshift.html +330 -0
- data/doc/SDM/Relay.html +216 -0
- data/doc/SDM/ResourceCreateResponse.html +214 -0
- data/doc/SDM/ResourceDeleteResponse.html +197 -0
- data/doc/SDM/ResourceGetResponse.html +214 -0
- data/doc/SDM/ResourceUpdateResponse.html +215 -0
- data/doc/SDM/Resources.html +482 -0
- data/doc/SDM/Role.html +216 -0
- data/doc/SDM/RoleAttachment.html +216 -0
- data/doc/SDM/RoleAttachmentCreateResponse.html +216 -0
- data/doc/SDM/RoleAttachmentDeleteResponse.html +199 -0
- data/doc/SDM/RoleAttachmentGetResponse.html +214 -0
- data/doc/SDM/RoleAttachments.html +427 -0
- data/doc/SDM/RoleCreateResponse.html +215 -0
- data/doc/SDM/RoleDeleteResponse.html +197 -0
- data/doc/SDM/RoleGetResponse.html +214 -0
- data/doc/SDM/RoleGrant.html +214 -0
- data/doc/SDM/RoleGrantCreateResponse.html +215 -0
- data/doc/SDM/RoleGrantDeleteResponse.html +198 -0
- data/doc/SDM/RoleGrantGetResponse.html +214 -0
- data/doc/SDM/RoleGrants.html +427 -0
- data/doc/SDM/RoleUpdateResponse.html +215 -0
- data/doc/SDM/Roles.html +490 -0
- data/doc/SDM/SQLServer.html +347 -0
- data/doc/SDM/SSH.html +296 -0
- data/doc/SDM/Service.html +215 -0
- data/doc/SDM/Snowflake.html +313 -0
- data/doc/SDM/Sybase.html +296 -0
- data/doc/SDM/SybaseIQ.html +296 -0
- data/doc/SDM/Teradata.html +296 -0
- data/doc/SDM/UpdateResponseMetadata.html +156 -0
- data/doc/SDM/User.html +248 -0
- data/doc/V1.html +864 -0
- data/doc/V1/AccountAttachments.html +109 -0
- data/doc/V1/AccountAttachments/Service.html +116 -0
- data/doc/V1/AccountGrants.html +109 -0
- data/doc/V1/AccountGrants/Service.html +117 -0
- data/doc/V1/Accounts.html +109 -0
- data/doc/V1/Accounts/Service.html +122 -0
- data/doc/V1/Nodes.html +109 -0
- data/doc/V1/Nodes/Service.html +124 -0
- data/doc/V1/Resources.html +109 -0
- data/doc/V1/Resources/Service.html +113 -0
- data/doc/V1/RoleAttachments.html +109 -0
- data/doc/V1/RoleAttachments/Service.html +119 -0
- data/doc/V1/RoleGrants.html +109 -0
- data/doc/V1/RoleGrants/Service.html +119 -0
- data/doc/V1/Roles.html +109 -0
- data/doc/V1/Roles/Service.html +120 -0
- data/doc/created.rid +37 -0
- data/doc/css/fonts.css +167 -0
- data/doc/css/rdoc.css +590 -0
- data/doc/examples/Gemfile.html +95 -0
- data/doc/examples/Gemfile_lock.html +112 -0
- data/doc/examples/README_md.html +95 -0
- data/doc/fonts/Lato-Light.ttf +0 -0
- data/doc/fonts/Lato-LightItalic.ttf +0 -0
- data/doc/fonts/Lato-Regular.ttf +0 -0
- data/doc/fonts/Lato-RegularItalic.ttf +0 -0
- data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
- data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +353 -0
- data/doc/js/darkfish.js +161 -0
- data/doc/js/jquery.js +4 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/navigation.js.gz +0 -0
- data/doc/js/search.js +109 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/search_index.js.gz +0 -0
- data/doc/js/searcher.js +228 -0
- data/doc/js/searcher.js.gz +0 -0
- data/doc/lib/version.html +98 -0
- data/doc/strongdm_gemspec.html +117 -0
- data/doc/table_of_contents.html +3002 -0
- data/examples/Gemfile +3 -0
- data/examples/Gemfile.lock +14 -0
- data/examples/README.md +5 -0
- data/examples/listUsers.rb +21 -0
- data/examples/panicButton.rb +154 -0
- data/lib/errors/errors.rb +85 -0
- data/lib/grpc/account_attachments_pb.rb +84 -0
- data/lib/grpc/account_attachments_services_pb.rb +44 -0
- data/lib/grpc/account_grants_pb.rb +82 -0
- data/lib/grpc/account_grants_services_pb.rb +44 -0
- data/lib/grpc/accounts_pb.rb +107 -0
- data/lib/grpc/accounts_services_pb.rb +49 -0
- data/lib/grpc/drivers_pb.rb +601 -0
- data/lib/grpc/nodes_pb.rb +107 -0
- data/lib/grpc/nodes_services_pb.rb +49 -0
- data/lib/grpc/options_pb.rb +60 -0
- data/lib/grpc/plumbing.rb +4283 -0
- data/lib/grpc/protoc-gen-swagger/options/annotations_pb.rb +15 -0
- data/lib/grpc/resources_pb.rb +85 -0
- data/lib/grpc/resources_services_pb.rb +45 -0
- data/lib/grpc/role_attachments_pb.rb +79 -0
- data/lib/grpc/role_attachments_services_pb.rb +47 -0
- data/lib/grpc/role_grants_pb.rb +79 -0
- data/lib/grpc/role_grants_services_pb.rb +47 -0
- data/lib/grpc/roles_pb.rb +91 -0
- data/lib/grpc/roles_services_pb.rb +50 -0
- data/lib/grpc/spec_pb.rb +95 -0
- data/lib/models/porcelain.rb +4033 -0
- data/lib/strongdm.rb +128 -0
- data/lib/svc.rb +1331 -0
- data/lib/version +3 -0
- data/lib/version.rb +17 -0
- data/strongdm.gemspec +23 -0
- metadata +318 -0
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class SDM::NodeUpdateResponse - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="../Object.html">Object</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<div id="method-list-section" class="nav-section">
|
|
69
|
+
<h3>Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list" role="directory">
|
|
72
|
+
|
|
73
|
+
<li ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
</ul>
|
|
76
|
+
</div>
|
|
77
|
+
|
|
78
|
+
</div>
|
|
79
|
+
</nav>
|
|
80
|
+
|
|
81
|
+
<main role="main" aria-labelledby="class-SDM::NodeUpdateResponse">
|
|
82
|
+
<h1 id="class-SDM::NodeUpdateResponse" class="class">
|
|
83
|
+
class SDM::NodeUpdateResponse
|
|
84
|
+
</h1>
|
|
85
|
+
|
|
86
|
+
<section class="description">
|
|
87
|
+
|
|
88
|
+
<p><a href="NodeUpdateResponse.html">NodeUpdateResponse</a> returns the fields
|
|
89
|
+
of a Node after it has been updated by a NodeUpdateRequest.</p>
|
|
90
|
+
|
|
91
|
+
</section>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<section class="attribute-method-details" class="method-section">
|
|
105
|
+
<header>
|
|
106
|
+
<h3>Attributes</h3>
|
|
107
|
+
</header>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
<div id="attribute-i-meta" class="method-detail">
|
|
111
|
+
<div class="method-heading attribute-method-heading">
|
|
112
|
+
<span class="method-name">meta</span><span
|
|
113
|
+
class="attribute-access-type">[RW]</span>
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
<div class="method-description">
|
|
117
|
+
|
|
118
|
+
<p>Reserved for future use.</p>
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
<div id="attribute-i-node" class="method-detail">
|
|
124
|
+
<div class="method-heading attribute-method-heading">
|
|
125
|
+
<span class="method-name">node</span><span
|
|
126
|
+
class="attribute-access-type">[RW]</span>
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
<div class="method-description">
|
|
130
|
+
|
|
131
|
+
<p>The updated Node.</p>
|
|
132
|
+
|
|
133
|
+
</div>
|
|
134
|
+
</div>
|
|
135
|
+
|
|
136
|
+
<div id="attribute-i-rate_limit" class="method-detail">
|
|
137
|
+
<div class="method-heading attribute-method-heading">
|
|
138
|
+
<span class="method-name">rate_limit</span><span
|
|
139
|
+
class="attribute-access-type">[RW]</span>
|
|
140
|
+
</div>
|
|
141
|
+
|
|
142
|
+
<div class="method-description">
|
|
143
|
+
|
|
144
|
+
<p>Rate limit information.</p>
|
|
145
|
+
|
|
146
|
+
</div>
|
|
147
|
+
</div>
|
|
148
|
+
|
|
149
|
+
</section>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
154
|
+
<header>
|
|
155
|
+
<h3>Public Class Methods</h3>
|
|
156
|
+
</header>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<div id="method-c-new" class="method-detail ">
|
|
160
|
+
|
|
161
|
+
<div class="method-heading">
|
|
162
|
+
<span class="method-name">new</span><span
|
|
163
|
+
class="method-args">( meta:nil \ , node:nil \ , rate_limit:nil \ )</span>
|
|
164
|
+
|
|
165
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
166
|
+
|
|
167
|
+
</div>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<div class="method-description">
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<div class="method-source-code" id="new-source">
|
|
178
|
+
<pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 3509</span>
|
|
179
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(
|
|
180
|
+
<span class="ruby-identifier">meta</span><span class="ruby-value">:nil</span> ,
|
|
181
|
+
<span class="ruby-identifier">node</span><span class="ruby-value">:nil</span> ,
|
|
182
|
+
<span class="ruby-identifier">rate_limit</span><span class="ruby-value">:nil</span> )
|
|
183
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">meta</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
184
|
+
<span class="ruby-ivar">@meta</span> = <span class="ruby-identifier">meta</span>
|
|
185
|
+
<span class="ruby-keyword">end</span>
|
|
186
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
187
|
+
<span class="ruby-ivar">@node</span> = <span class="ruby-identifier">node</span>
|
|
188
|
+
<span class="ruby-keyword">end</span>
|
|
189
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">rate_limit</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
|
|
190
|
+
<span class="ruby-ivar">@rate_limit</span> = <span class="ruby-identifier">rate_limit</span>
|
|
191
|
+
<span class="ruby-keyword">end</span>
|
|
192
|
+
<span class="ruby-keyword">end</span></pre>
|
|
193
|
+
</div>
|
|
194
|
+
|
|
195
|
+
</div>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</div>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</section>
|
|
204
|
+
|
|
205
|
+
</section>
|
|
206
|
+
</main>
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<footer id="validator-badges" role="contentinfo">
|
|
210
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
211
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
212
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
213
|
+
</footer>
|
|
214
|
+
|
data/doc/SDM/Nodes.html
ADDED
|
@@ -0,0 +1,493 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
<title>class SDM::Nodes - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<script type="text/javascript">
|
|
10
|
+
var rdoc_rel_prefix = "../";
|
|
11
|
+
</script>
|
|
12
|
+
|
|
13
|
+
<script src="../js/jquery.js"></script>
|
|
14
|
+
<script src="../js/darkfish.js"></script>
|
|
15
|
+
|
|
16
|
+
<link href="../css/fonts.css" rel="stylesheet">
|
|
17
|
+
<link href="../css/rdoc.css" rel="stylesheet">
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<body id="top" role="document" class="class">
|
|
22
|
+
<nav role="navigation">
|
|
23
|
+
<div id="project-navigation">
|
|
24
|
+
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
25
|
+
<h2>
|
|
26
|
+
<a href="../index.html" rel="home">Home</a>
|
|
27
|
+
</h2>
|
|
28
|
+
|
|
29
|
+
<div id="table-of-contents-navigation">
|
|
30
|
+
<a href="../table_of_contents.html#pages">Pages</a>
|
|
31
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
|
32
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
|
33
|
+
</div>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
37
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
38
|
+
<div id="search-field-wrapper">
|
|
39
|
+
<input id="search-field" role="combobox" aria-label="Search"
|
|
40
|
+
aria-autocomplete="list" aria-controls="search-results"
|
|
41
|
+
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
42
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<ul id="search-results" aria-label="Search Results"
|
|
46
|
+
aria-busy="false" aria-expanded="false"
|
|
47
|
+
aria-atomic="false" class="initially-hidden"></ul>
|
|
48
|
+
</form>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
<div id="class-metadata">
|
|
56
|
+
|
|
57
|
+
<div id="parent-class-section" class="nav-section">
|
|
58
|
+
<h3>Parent</h3>
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<p class="link"><a href="../Object.html">Object</a>
|
|
62
|
+
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<div id="method-list-section" class="nav-section">
|
|
69
|
+
<h3>Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list" role="directory">
|
|
72
|
+
|
|
73
|
+
<li ><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li ><a href="#method-i-create">#create</a>
|
|
76
|
+
|
|
77
|
+
<li ><a href="#method-i-delete">#delete</a>
|
|
78
|
+
|
|
79
|
+
<li ><a href="#method-i-get">#get</a>
|
|
80
|
+
|
|
81
|
+
<li ><a href="#method-i-list">#list</a>
|
|
82
|
+
|
|
83
|
+
<li ><a href="#method-i-update">#update</a>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
</div>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
</nav>
|
|
90
|
+
|
|
91
|
+
<main role="main" aria-labelledby="class-SDM::Nodes">
|
|
92
|
+
<h1 id="class-SDM::Nodes" class="class">
|
|
93
|
+
class SDM::Nodes
|
|
94
|
+
</h1>
|
|
95
|
+
|
|
96
|
+
<section class="description">
|
|
97
|
+
|
|
98
|
+
<p><a href="Nodes.html">Nodes</a> make up the strongDM network, and allow your
|
|
99
|
+
users to connect securely to your resources. There are two types of nodes:</p>
|
|
100
|
+
<ol><li>
|
|
101
|
+
<p>*<strong>Relay:</strong>* creates connectivity to your datasources, while
|
|
102
|
+
maintaining the egress-only nature of your firewall</p>
|
|
103
|
+
</li><li>
|
|
104
|
+
<p>*<strong>Gateways:</strong>* a relay that also listens for connections from
|
|
105
|
+
strongDM clients</p>
|
|
106
|
+
</li></ol>
|
|
107
|
+
|
|
108
|
+
</section>
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
124
|
+
<header>
|
|
125
|
+
<h3>Public Class Methods</h3>
|
|
126
|
+
</header>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<div id="method-c-new" class="method-detail ">
|
|
130
|
+
|
|
131
|
+
<div class="method-heading">
|
|
132
|
+
<span class="method-name">new</span><span
|
|
133
|
+
class="method-args">(host, insecure, parent)</span>
|
|
134
|
+
|
|
135
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<div class="method-description">
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<div class="method-source-code" id="new-source">
|
|
148
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 504</span>
|
|
149
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">insecure</span>, <span class="ruby-identifier">parent</span>)
|
|
150
|
+
<span class="ruby-keyword">begin</span>
|
|
151
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">insecure</span>
|
|
152
|
+
<span class="ruby-ivar">@stub</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Stub</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">host</span>, <span class="ruby-value">:this_channel_is_insecure</span>)
|
|
153
|
+
<span class="ruby-keyword">else</span>
|
|
154
|
+
<span class="ruby-identifier">cred</span> = <span class="ruby-constant">GRPC</span><span class="ruby-operator">::</span><span class="ruby-constant">Core</span><span class="ruby-operator">::</span><span class="ruby-constant">ChannelCredentials</span>.<span class="ruby-identifier">new</span>()
|
|
155
|
+
<span class="ruby-ivar">@stub</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">Nodes</span><span class="ruby-operator">::</span><span class="ruby-constant">Stub</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">host</span>, <span class="ruby-identifier">cred</span>)
|
|
156
|
+
<span class="ruby-keyword">end</span>
|
|
157
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
158
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
159
|
+
<span class="ruby-keyword">end</span>
|
|
160
|
+
<span class="ruby-ivar">@parent</span> = <span class="ruby-identifier">parent</span>
|
|
161
|
+
<span class="ruby-keyword">end</span></pre>
|
|
162
|
+
</div>
|
|
163
|
+
|
|
164
|
+
</div>
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</div>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</section>
|
|
173
|
+
|
|
174
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
175
|
+
<header>
|
|
176
|
+
<h3>Public Instance Methods</h3>
|
|
177
|
+
</header>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
<div id="method-i-create" class="method-detail ">
|
|
181
|
+
|
|
182
|
+
<div class="method-heading">
|
|
183
|
+
<span class="method-name">create</span><span
|
|
184
|
+
class="method-args">( node \ , deadline:nil)</span>
|
|
185
|
+
|
|
186
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
187
|
+
|
|
188
|
+
</div>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<div class="method-description">
|
|
192
|
+
|
|
193
|
+
<p>Create registers a new Node.</p>
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<div class="method-source-code" id="create-source">
|
|
199
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 518</span>
|
|
200
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span>(
|
|
201
|
+
<span class="ruby-identifier">node</span> ,
|
|
202
|
+
<span class="ruby-identifier">deadline</span><span class="ruby-value">:nil</span>)
|
|
203
|
+
<span class="ruby-identifier">req</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">NodeCreateRequest</span>.<span class="ruby-identifier">new</span>()
|
|
204
|
+
|
|
205
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_plumbing</span>(<span class="ruby-identifier">node</span>)
|
|
206
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
207
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-keyword">nil</span>
|
|
208
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
209
|
+
<span class="ruby-keyword">begin</span>
|
|
210
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-ivar">@stub</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">metadata</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-string">'Nodes.Create'</span>, <span class="ruby-identifier">req</span>), <span class="ruby-identifier">deadline</span><span class="ruby-value">:deadline</span>)
|
|
211
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
212
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">shouldRetry</span>(<span class="ruby-identifier">tries</span>, <span class="ruby-identifier">exception</span>))
|
|
213
|
+
<span class="ruby-identifier">tries</span><span class="ruby-operator">+</span><span class="ruby-operator">+</span>
|
|
214
|
+
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jitterSleep</span>(<span class="ruby-identifier">tries</span>)
|
|
215
|
+
<span class="ruby-keyword">next</span>
|
|
216
|
+
<span class="ruby-keyword">end</span>
|
|
217
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
218
|
+
<span class="ruby-keyword">end</span>
|
|
219
|
+
<span class="ruby-keyword">break</span>
|
|
220
|
+
<span class="ruby-keyword">end</span>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-constant">NodeCreateResponse</span>.<span class="ruby-identifier">new</span>()
|
|
224
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">create_response_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>)
|
|
225
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">node</span>)
|
|
226
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">token</span> = <span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">token</span>
|
|
227
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
|
|
228
|
+
<span class="ruby-identifier">resp</span>
|
|
229
|
+
<span class="ruby-keyword">end</span></pre>
|
|
230
|
+
</div>
|
|
231
|
+
|
|
232
|
+
</div>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
</div>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
<div id="method-i-delete" class="method-detail ">
|
|
241
|
+
|
|
242
|
+
<div class="method-heading">
|
|
243
|
+
<span class="method-name">delete</span><span
|
|
244
|
+
class="method-args">( id \ , deadline:nil)</span>
|
|
245
|
+
|
|
246
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
247
|
+
|
|
248
|
+
</div>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<div class="method-description">
|
|
252
|
+
|
|
253
|
+
<p>Delete removes a Node by ID.</p>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<div class="method-source-code" id="delete-source">
|
|
259
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 612</span>
|
|
260
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete</span>(
|
|
261
|
+
<span class="ruby-identifier">id</span> ,
|
|
262
|
+
<span class="ruby-identifier">deadline</span><span class="ruby-value">:nil</span>)
|
|
263
|
+
<span class="ruby-identifier">req</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">NodeDeleteRequest</span>.<span class="ruby-identifier">new</span>()
|
|
264
|
+
|
|
265
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">id</span>
|
|
266
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
267
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-keyword">nil</span>
|
|
268
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
269
|
+
<span class="ruby-keyword">begin</span>
|
|
270
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-ivar">@stub</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">metadata</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-string">'Nodes.Delete'</span>, <span class="ruby-identifier">req</span>), <span class="ruby-identifier">deadline</span><span class="ruby-value">:deadline</span>)
|
|
271
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
272
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">shouldRetry</span>(<span class="ruby-identifier">tries</span>, <span class="ruby-identifier">exception</span>))
|
|
273
|
+
<span class="ruby-identifier">tries</span><span class="ruby-operator">+</span><span class="ruby-operator">+</span>
|
|
274
|
+
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jitterSleep</span>(<span class="ruby-identifier">tries</span>)
|
|
275
|
+
<span class="ruby-keyword">next</span>
|
|
276
|
+
<span class="ruby-keyword">end</span>
|
|
277
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
278
|
+
<span class="ruby-keyword">end</span>
|
|
279
|
+
<span class="ruby-keyword">break</span>
|
|
280
|
+
<span class="ruby-keyword">end</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-constant">NodeDeleteResponse</span>.<span class="ruby-identifier">new</span>()
|
|
284
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">delete_response_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>)
|
|
285
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
|
|
286
|
+
<span class="ruby-identifier">resp</span>
|
|
287
|
+
<span class="ruby-keyword">end</span></pre>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
</div>
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<div id="method-i-get" class="method-detail ">
|
|
299
|
+
|
|
300
|
+
<div class="method-heading">
|
|
301
|
+
<span class="method-name">get</span><span
|
|
302
|
+
class="method-args">( id \ , deadline:nil)</span>
|
|
303
|
+
|
|
304
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
305
|
+
|
|
306
|
+
</div>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<div class="method-description">
|
|
310
|
+
|
|
311
|
+
<p>Get reads one Node by ID.</p>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<div class="method-source-code" id="get-source">
|
|
317
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 550</span>
|
|
318
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(
|
|
319
|
+
<span class="ruby-identifier">id</span> ,
|
|
320
|
+
<span class="ruby-identifier">deadline</span><span class="ruby-value">:nil</span>)
|
|
321
|
+
<span class="ruby-identifier">req</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">NodeGetRequest</span>.<span class="ruby-identifier">new</span>()
|
|
322
|
+
|
|
323
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">id</span> = <span class="ruby-identifier">id</span>
|
|
324
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
325
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-keyword">nil</span>
|
|
326
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
327
|
+
<span class="ruby-keyword">begin</span>
|
|
328
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-ivar">@stub</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">metadata</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-string">'Nodes.Get'</span>, <span class="ruby-identifier">req</span>), <span class="ruby-identifier">deadline</span><span class="ruby-value">:deadline</span>)
|
|
329
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
330
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">shouldRetry</span>(<span class="ruby-identifier">tries</span>, <span class="ruby-identifier">exception</span>))
|
|
331
|
+
<span class="ruby-identifier">tries</span><span class="ruby-operator">+</span><span class="ruby-operator">+</span>
|
|
332
|
+
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jitterSleep</span>(<span class="ruby-identifier">tries</span>)
|
|
333
|
+
<span class="ruby-keyword">next</span>
|
|
334
|
+
<span class="ruby-keyword">end</span>
|
|
335
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
336
|
+
<span class="ruby-keyword">end</span>
|
|
337
|
+
<span class="ruby-keyword">break</span>
|
|
338
|
+
<span class="ruby-keyword">end</span>
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-constant">NodeGetResponse</span>.<span class="ruby-identifier">new</span>()
|
|
342
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">get_response_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>)
|
|
343
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">node</span>)
|
|
344
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
|
|
345
|
+
<span class="ruby-identifier">resp</span>
|
|
346
|
+
<span class="ruby-keyword">end</span></pre>
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
</div>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<div id="method-i-list" class="method-detail ">
|
|
358
|
+
|
|
359
|
+
<div class="method-heading">
|
|
360
|
+
<span class="method-name">list</span><span
|
|
361
|
+
class="method-args">( filter \ , *args, deadline:nil)</span>
|
|
362
|
+
|
|
363
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
364
|
+
|
|
365
|
+
</div>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<div class="method-description">
|
|
369
|
+
|
|
370
|
+
<p>List gets a list of <a href="Nodes.html">Nodes</a> matching a given set of
|
|
371
|
+
criteria.</p>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
<div class="method-source-code" id="list-source">
|
|
377
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 642</span>
|
|
378
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">list</span>(
|
|
379
|
+
<span class="ruby-identifier">filter</span> ,
|
|
380
|
+
<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>,
|
|
381
|
+
<span class="ruby-identifier">deadline</span><span class="ruby-value">:nil</span>)
|
|
382
|
+
<span class="ruby-identifier">req</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">NodeListRequest</span>.<span class="ruby-identifier">new</span>()
|
|
383
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">ListRequestMetadata</span>.<span class="ruby-identifier">new</span>()
|
|
384
|
+
<span class="ruby-identifier">page_size_option</span> = <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">_test_options</span>[<span class="ruby-string">'PageSize'</span>]
|
|
385
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">page_size_option</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Integer</span>
|
|
386
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">meta</span>.<span class="ruby-identifier">limit</span> = <span class="ruby-identifier">page_size_option</span>
|
|
387
|
+
<span class="ruby-keyword">end</span>
|
|
388
|
+
|
|
389
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">filter</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">quote_filter_args</span>(<span class="ruby-identifier">filter</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
390
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-constant">Enumerator</span><span class="ruby-operator">::</span><span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">g</span><span class="ruby-operator">|</span>
|
|
391
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
392
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
393
|
+
<span class="ruby-keyword">begin</span>
|
|
394
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-ivar">@stub</span>.<span class="ruby-identifier">list</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">metadata</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-string">'Nodes.List'</span>, <span class="ruby-identifier">req</span>), <span class="ruby-identifier">deadline</span><span class="ruby-value">:deadline</span>)
|
|
395
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
396
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">shouldRetry</span>(<span class="ruby-identifier">tries</span>, <span class="ruby-identifier">exception</span>))
|
|
397
|
+
<span class="ruby-identifier">tries</span><span class="ruby-operator">+</span><span class="ruby-operator">+</span>
|
|
398
|
+
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jitterSleep</span>(<span class="ruby-identifier">tries</span>)
|
|
399
|
+
<span class="ruby-keyword">next</span>
|
|
400
|
+
<span class="ruby-keyword">end</span>
|
|
401
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
402
|
+
<span class="ruby-keyword">end</span>
|
|
403
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
404
|
+
<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">nodes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">plumbing_item</span><span class="ruby-operator">|</span>
|
|
405
|
+
<span class="ruby-identifier">g</span>.<span class="ruby-identifier">yield</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_porcelain</span>(<span class="ruby-identifier">plumbing_item</span>)
|
|
406
|
+
<span class="ruby-keyword">end</span>
|
|
407
|
+
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>.<span class="ruby-identifier">next_cursor</span> <span class="ruby-operator">==</span> <span class="ruby-string">""</span>
|
|
408
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">meta</span>.<span class="ruby-identifier">cursor</span> = <span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>.<span class="ruby-identifier">next_cursor</span>
|
|
409
|
+
<span class="ruby-keyword">end</span>
|
|
410
|
+
}
|
|
411
|
+
<span class="ruby-identifier">resp</span>
|
|
412
|
+
<span class="ruby-keyword">end</span></pre>
|
|
413
|
+
</div>
|
|
414
|
+
|
|
415
|
+
</div>
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<div id="method-i-update" class="method-detail ">
|
|
424
|
+
|
|
425
|
+
<div class="method-heading">
|
|
426
|
+
<span class="method-name">update</span><span
|
|
427
|
+
class="method-args">( node \ , deadline:nil)</span>
|
|
428
|
+
|
|
429
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
430
|
+
|
|
431
|
+
</div>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<div class="method-description">
|
|
435
|
+
|
|
436
|
+
<p>Update patches a Node by ID.</p>
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
<div class="method-source-code" id="update-source">
|
|
442
|
+
<pre><span class="ruby-comment"># File lib/svc.rb, line 581</span>
|
|
443
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>(
|
|
444
|
+
<span class="ruby-identifier">node</span> ,
|
|
445
|
+
<span class="ruby-identifier">deadline</span><span class="ruby-value">:nil</span>)
|
|
446
|
+
<span class="ruby-identifier">req</span> = <span class="ruby-constant">V1</span><span class="ruby-operator">::</span><span class="ruby-constant">NodeUpdateRequest</span>.<span class="ruby-identifier">new</span>()
|
|
447
|
+
|
|
448
|
+
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_plumbing</span>(<span class="ruby-identifier">node</span>)
|
|
449
|
+
<span class="ruby-identifier">tries</span> = <span class="ruby-value">0</span>
|
|
450
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-keyword">nil</span>
|
|
451
|
+
<span class="ruby-identifier">loop</span> <span class="ruby-keyword">do</span>
|
|
452
|
+
<span class="ruby-keyword">begin</span>
|
|
453
|
+
<span class="ruby-identifier">plumbing_response</span> = <span class="ruby-ivar">@stub</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">metadata</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-string">'Nodes.Update'</span>, <span class="ruby-identifier">req</span>), <span class="ruby-identifier">deadline</span><span class="ruby-value">:deadline</span>)
|
|
454
|
+
<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">exception</span>
|
|
455
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">shouldRetry</span>(<span class="ruby-identifier">tries</span>, <span class="ruby-identifier">exception</span>))
|
|
456
|
+
<span class="ruby-identifier">tries</span><span class="ruby-operator">+</span><span class="ruby-operator">+</span>
|
|
457
|
+
<span class="ruby-ivar">@parent</span>.<span class="ruby-identifier">jitterSleep</span>(<span class="ruby-identifier">tries</span>)
|
|
458
|
+
<span class="ruby-keyword">next</span>
|
|
459
|
+
<span class="ruby-keyword">end</span>
|
|
460
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">error_to_porcelain</span>(<span class="ruby-identifier">exception</span>)
|
|
461
|
+
<span class="ruby-keyword">end</span>
|
|
462
|
+
<span class="ruby-keyword">break</span>
|
|
463
|
+
<span class="ruby-keyword">end</span>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="ruby-identifier">resp</span> = <span class="ruby-constant">NodeUpdateResponse</span>.<span class="ruby-identifier">new</span>()
|
|
467
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">meta</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">update_response_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">meta</span>)
|
|
468
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">node</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">node_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">node</span>)
|
|
469
|
+
<span class="ruby-identifier">resp</span>.<span class="ruby-identifier">rate_limit</span> = <span class="ruby-constant">Plumbing</span><span class="ruby-operator">::</span><span class="ruby-identifier">rate_limit_metadata_to_porcelain</span>(<span class="ruby-identifier">plumbing_response</span>.<span class="ruby-identifier">rate_limit</span>)
|
|
470
|
+
<span class="ruby-identifier">resp</span>
|
|
471
|
+
<span class="ruby-keyword">end</span></pre>
|
|
472
|
+
</div>
|
|
473
|
+
|
|
474
|
+
</div>
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
</div>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
</section>
|
|
483
|
+
|
|
484
|
+
</section>
|
|
485
|
+
</main>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<footer id="validator-badges" role="contentinfo">
|
|
489
|
+
<p><a href="http://validator.w3.org/check/referer">Validate</a>
|
|
490
|
+
<p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
|
|
491
|
+
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
492
|
+
</footer>
|
|
493
|
+
|