strongdm 1.0.32 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (251) hide show
  1. checksums.yaml +4 -4
  2. data/.git/ORIG_HEAD +1 -1
  3. data/.git/config +0 -3
  4. data/.git/index +0 -0
  5. data/.git/logs/HEAD +3 -4
  6. data/.git/logs/refs/heads/master +2 -2
  7. data/.git/logs/refs/remotes/origin/HEAD +1 -1
  8. data/.git/objects/pack/pack-799dc839a811c2fbe50b5281a9266fcc3a8f5154.idx +0 -0
  9. data/.git/objects/pack/{pack-760024d2d3e635c44bfe6b54af80a8b21674032d.pack → pack-799dc839a811c2fbe50b5281a9266fcc3a8f5154.pack} +0 -0
  10. data/.git/packed-refs +5 -2
  11. data/.git/refs/heads/master +1 -1
  12. data/.yardopts +9 -0
  13. data/README.md +18 -6
  14. data/lib/errors/errors.rb +1 -1
  15. data/lib/grpc/account_attachments_services_pb.rb +1 -1
  16. data/lib/grpc/accounts_services_pb.rb +2 -2
  17. data/lib/grpc/drivers_pb.rb +38 -0
  18. data/lib/grpc/nodes_services_pb.rb +1 -1
  19. data/lib/grpc/options_pb.rb +35 -40
  20. data/lib/grpc/plumbing.rb +1258 -965
  21. data/lib/grpc/resources_services_pb.rb +3 -1
  22. data/lib/grpc/role_attachments_services_pb.rb +10 -0
  23. data/lib/grpc/role_grants_services_pb.rb +10 -0
  24. data/lib/grpc/roles_services_pb.rb +4 -6
  25. data/lib/grpc/secret_store_types_pb.rb +25 -0
  26. data/lib/grpc/secret_stores_services_pb.rb +1 -1
  27. data/lib/models/porcelain.rb +1243 -2897
  28. data/lib/strongdm.rb +39 -15
  29. data/lib/svc.rb +162 -14
  30. data/lib/version +1 -1
  31. data/lib/version.rb +1 -1
  32. metadata +5 -222
  33. data/.git/FETCH_HEAD +0 -2
  34. data/.git/logs/refs/heads/development +0 -1
  35. data/.git/objects/pack/pack-760024d2d3e635c44bfe6b54af80a8b21674032d.idx +0 -0
  36. data/.git/refs/heads/development +0 -1
  37. data/doc/LICENSE.html +0 -187
  38. data/doc/Object.html +0 -114
  39. data/doc/README_md.html +0 -146
  40. data/doc/SDM/AKS.html +0 -352
  41. data/doc/SDM/AKSBasicAuth.html +0 -337
  42. data/doc/SDM/AKSServiceAccount.html +0 -322
  43. data/doc/SDM/AKSServiceAccountUserImpersonation.html +0 -322
  44. data/doc/SDM/AKSUserImpersonation.html +0 -352
  45. data/doc/SDM/AWS.html +0 -337
  46. data/doc/SDM/AWSStore.html +0 -232
  47. data/doc/SDM/AccountAttachment.html +0 -219
  48. data/doc/SDM/AccountAttachmentCreateResponse.html +0 -219
  49. data/doc/SDM/AccountAttachmentDeleteResponse.html +0 -204
  50. data/doc/SDM/AccountAttachmentGetResponse.html +0 -219
  51. data/doc/SDM/AccountAttachments.html +0 -354
  52. data/doc/SDM/AccountCreateResponse.html +0 -234
  53. data/doc/SDM/AccountDeleteResponse.html +0 -204
  54. data/doc/SDM/AccountGetResponse.html +0 -219
  55. data/doc/SDM/AccountGrant.html +0 -249
  56. data/doc/SDM/AccountGrantCreateResponse.html +0 -219
  57. data/doc/SDM/AccountGrantDeleteResponse.html +0 -204
  58. data/doc/SDM/AccountGrantGetResponse.html +0 -219
  59. data/doc/SDM/AccountGrants.html +0 -354
  60. data/doc/SDM/AccountUpdateResponse.html +0 -219
  61. data/doc/SDM/Accounts.html +0 -409
  62. data/doc/SDM/AlreadyExistsError.html +0 -140
  63. data/doc/SDM/AmazonEKS.html +0 -397
  64. data/doc/SDM/AmazonEKSUserImpersonation.html +0 -397
  65. data/doc/SDM/AmazonES.html +0 -367
  66. data/doc/SDM/AmazonMQAMQP091.html +0 -352
  67. data/doc/SDM/Athena.html +0 -367
  68. data/doc/SDM/AuroraMysql.html +0 -352
  69. data/doc/SDM/AuroraPostgres.html +0 -367
  70. data/doc/SDM/AuthenticationError.html +0 -140
  71. data/doc/SDM/Azure.html +0 -307
  72. data/doc/SDM/AzureCertificate.html +0 -307
  73. data/doc/SDM/AzurePostgres.html +0 -367
  74. data/doc/SDM/BadRequestError.html +0 -140
  75. data/doc/SDM/BigQuery.html +0 -337
  76. data/doc/SDM/Cassandra.html +0 -352
  77. data/doc/SDM/Citus.html +0 -367
  78. data/doc/SDM/Client.html +0 -443
  79. data/doc/SDM/Clustrix.html +0 -352
  80. data/doc/SDM/Cockroach.html +0 -367
  81. data/doc/SDM/ControlPanel.html +0 -248
  82. data/doc/SDM/ControlPanelGetSSHCAPublicKeyResponse.html +0 -219
  83. data/doc/SDM/ControlPanelVerifyJWTResponse.html +0 -219
  84. data/doc/SDM/CreateResponseMetadata.html +0 -169
  85. data/doc/SDM/DB2LUW.html +0 -352
  86. data/doc/SDM/DB2i.html +0 -352
  87. data/doc/SDM/DeadlineExceededError.html +0 -140
  88. data/doc/SDM/DeleteResponseMetadata.html +0 -169
  89. data/doc/SDM/DocumentDBHost.html +0 -352
  90. data/doc/SDM/DocumentDBReplicaSet.html +0 -367
  91. data/doc/SDM/Druid.html +0 -337
  92. data/doc/SDM/DynamoDB.html +0 -367
  93. data/doc/SDM/Elastic.html +0 -352
  94. data/doc/SDM/ElasticacheRedis.html +0 -337
  95. data/doc/SDM/GCP.html +0 -292
  96. data/doc/SDM/Gateway.html +0 -279
  97. data/doc/SDM/GetResponseMetadata.html +0 -169
  98. data/doc/SDM/GoogleGKE.html +0 -322
  99. data/doc/SDM/GoogleGKEUserImpersonation.html +0 -322
  100. data/doc/SDM/Greenplum.html +0 -367
  101. data/doc/SDM/HTTPAuth.html +0 -352
  102. data/doc/SDM/HTTPBasicAuth.html +0 -367
  103. data/doc/SDM/HTTPNoAuth.html +0 -337
  104. data/doc/SDM/InternalError.html +0 -140
  105. data/doc/SDM/Kubernetes.html +0 -352
  106. data/doc/SDM/KubernetesBasicAuth.html +0 -337
  107. data/doc/SDM/KubernetesServiceAccount.html +0 -322
  108. data/doc/SDM/KubernetesServiceAccountUserImpersonation.html +0 -322
  109. data/doc/SDM/KubernetesUserImpersonation.html +0 -352
  110. data/doc/SDM/Maria.html +0 -352
  111. data/doc/SDM/Memcached.html +0 -307
  112. data/doc/SDM/Memsql.html +0 -352
  113. data/doc/SDM/MongoHost.html +0 -367
  114. data/doc/SDM/MongoLegacyHost.html +0 -382
  115. data/doc/SDM/MongoLegacyReplicaset.html +0 -397
  116. data/doc/SDM/MongoReplicaSet.html +0 -397
  117. data/doc/SDM/Mysql.html +0 -352
  118. data/doc/SDM/Neptune.html +0 -307
  119. data/doc/SDM/NeptuneIAM.html +0 -382
  120. data/doc/SDM/NodeCreateResponse.html +0 -234
  121. data/doc/SDM/NodeDeleteResponse.html +0 -204
  122. data/doc/SDM/NodeGetResponse.html +0 -219
  123. data/doc/SDM/NodeUpdateResponse.html +0 -219
  124. data/doc/SDM/Nodes.html +0 -409
  125. data/doc/SDM/NotFoundError.html +0 -140
  126. data/doc/SDM/Oracle.html +0 -367
  127. data/doc/SDM/PermissionError.html +0 -140
  128. data/doc/SDM/Plumbing.html +0 -15828
  129. data/doc/SDM/Postgres.html +0 -367
  130. data/doc/SDM/Presto.html +0 -367
  131. data/doc/SDM/RDP.html +0 -337
  132. data/doc/SDM/RPCError.html +0 -157
  133. data/doc/SDM/RabbitMQAMQP091.html +0 -352
  134. data/doc/SDM/RateLimitError.html +0 -157
  135. data/doc/SDM/RateLimitMetadata.html +0 -234
  136. data/doc/SDM/RawTCP.html +0 -307
  137. data/doc/SDM/Redis.html +0 -322
  138. data/doc/SDM/Redshift.html +0 -367
  139. data/doc/SDM/Relay.html +0 -249
  140. data/doc/SDM/ResourceCreateResponse.html +0 -219
  141. data/doc/SDM/ResourceDeleteResponse.html +0 -204
  142. data/doc/SDM/ResourceGetResponse.html +0 -219
  143. data/doc/SDM/ResourceUpdateResponse.html +0 -219
  144. data/doc/SDM/Resources.html +0 -456
  145. data/doc/SDM/Role.html +0 -249
  146. data/doc/SDM/RoleAttachment.html +0 -219
  147. data/doc/SDM/RoleAttachmentCreateResponse.html +0 -219
  148. data/doc/SDM/RoleAttachmentDeleteResponse.html +0 -204
  149. data/doc/SDM/RoleAttachmentGetResponse.html +0 -219
  150. data/doc/SDM/RoleAttachments.html +0 -354
  151. data/doc/SDM/RoleCreateResponse.html +0 -219
  152. data/doc/SDM/RoleDeleteResponse.html +0 -204
  153. data/doc/SDM/RoleGetResponse.html +0 -219
  154. data/doc/SDM/RoleGrant.html +0 -219
  155. data/doc/SDM/RoleGrantCreateResponse.html +0 -219
  156. data/doc/SDM/RoleGrantDeleteResponse.html +0 -204
  157. data/doc/SDM/RoleGrantGetResponse.html +0 -219
  158. data/doc/SDM/RoleGrants.html +0 -354
  159. data/doc/SDM/RoleUpdateResponse.html +0 -219
  160. data/doc/SDM/Roles.html +0 -403
  161. data/doc/SDM/SQLServer.html +0 -382
  162. data/doc/SDM/SSH.html +0 -352
  163. data/doc/SDM/SSHCert.html +0 -337
  164. data/doc/SDM/SSHCustomerKey.html +0 -352
  165. data/doc/SDM/SecretStoreCreateResponse.html +0 -219
  166. data/doc/SDM/SecretStoreDeleteResponse.html +0 -204
  167. data/doc/SDM/SecretStoreGetResponse.html +0 -219
  168. data/doc/SDM/SecretStoreUpdateResponse.html +0 -219
  169. data/doc/SDM/SecretStores.html +0 -403
  170. data/doc/SDM/Service.html +0 -234
  171. data/doc/SDM/SingleStore.html +0 -352
  172. data/doc/SDM/Snowflake.html +0 -352
  173. data/doc/SDM/Sybase.html +0 -337
  174. data/doc/SDM/SybaseIQ.html +0 -337
  175. data/doc/SDM/Tag.html +0 -202
  176. data/doc/SDM/Teradata.html +0 -337
  177. data/doc/SDM/UpdateResponseMetadata.html +0 -169
  178. data/doc/SDM/User.html +0 -264
  179. data/doc/SDM/VaultTLSStore.html +0 -292
  180. data/doc/SDM/VaultTokenStore.html +0 -247
  181. data/doc/SDM.html +0 -122
  182. data/doc/V1/AccountAttachments/Service.html +0 -107
  183. data/doc/V1/AccountAttachments.html +0 -100
  184. data/doc/V1/AccountGrants/Service.html +0 -107
  185. data/doc/V1/AccountGrants.html +0 -100
  186. data/doc/V1/Accounts/Service.html +0 -112
  187. data/doc/V1/Accounts.html +0 -100
  188. data/doc/V1/ControlPanel/Service.html +0 -107
  189. data/doc/V1/ControlPanel.html +0 -100
  190. data/doc/V1/Nodes/Service.html +0 -112
  191. data/doc/V1/Nodes.html +0 -100
  192. data/doc/V1/Resources/Service.html +0 -105
  193. data/doc/V1/Resources.html +0 -100
  194. data/doc/V1/RoleAttachments/Service.html +0 -107
  195. data/doc/V1/RoleAttachments.html +0 -100
  196. data/doc/V1/RoleGrants/Service.html +0 -107
  197. data/doc/V1/RoleGrants.html +0 -100
  198. data/doc/V1/Roles/Service.html +0 -107
  199. data/doc/V1/Roles.html +0 -100
  200. data/doc/V1/SecretStores/Service.html +0 -107
  201. data/doc/V1/SecretStores.html +0 -100
  202. data/doc/V1/Tags.html +0 -100
  203. data/doc/V1.html +0 -502
  204. data/doc/created.rid +0 -37
  205. data/doc/css/fonts.css +0 -167
  206. data/doc/css/rdoc.css +0 -639
  207. data/doc/examples/Gemfile.html +0 -89
  208. data/doc/fonts/Lato-Light.ttf +0 -0
  209. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  210. data/doc/fonts/Lato-Regular.ttf +0 -0
  211. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  212. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  213. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  214. data/doc/images/add.png +0 -0
  215. data/doc/images/arrow_up.png +0 -0
  216. data/doc/images/brick.png +0 -0
  217. data/doc/images/brick_link.png +0 -0
  218. data/doc/images/bug.png +0 -0
  219. data/doc/images/bullet_black.png +0 -0
  220. data/doc/images/bullet_toggle_minus.png +0 -0
  221. data/doc/images/bullet_toggle_plus.png +0 -0
  222. data/doc/images/date.png +0 -0
  223. data/doc/images/delete.png +0 -0
  224. data/doc/images/find.png +0 -0
  225. data/doc/images/loadingAnimation.gif +0 -0
  226. data/doc/images/macFFBgHack.png +0 -0
  227. data/doc/images/package.png +0 -0
  228. data/doc/images/page_green.png +0 -0
  229. data/doc/images/page_white_text.png +0 -0
  230. data/doc/images/page_white_width.png +0 -0
  231. data/doc/images/plugin.png +0 -0
  232. data/doc/images/ruby.png +0 -0
  233. data/doc/images/tag_blue.png +0 -0
  234. data/doc/images/tag_green.png +0 -0
  235. data/doc/images/transparent.png +0 -0
  236. data/doc/images/wrench.png +0 -0
  237. data/doc/images/wrench_orange.png +0 -0
  238. data/doc/images/zoom.png +0 -0
  239. data/doc/index.html +0 -255
  240. data/doc/js/darkfish.js +0 -84
  241. data/doc/js/navigation.js +0 -105
  242. data/doc/js/navigation.js.gz +0 -0
  243. data/doc/js/search.js +0 -110
  244. data/doc/js/search_index.js +0 -1
  245. data/doc/js/search_index.js.gz +0 -0
  246. data/doc/js/searcher.js +0 -229
  247. data/doc/js/searcher.js.gz +0 -0
  248. data/doc/lib/version.html +0 -92
  249. data/doc/table_of_contents.html +0 -4614
  250. data/examples/Gemfile +0 -3
  251. data/examples/listUsers.rb +0 -21
data/doc/README_md.html DELETED
@@ -1,146 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>README - RDoc Documentation</title>
8
-
9
- <script type="text/javascript">
10
- var rdoc_rel_prefix = "./";
11
- var index_rel_prefix = "./";
12
- </script>
13
-
14
- <script src="./js/navigation.js" defer></script>
15
- <script src="./js/search.js" defer></script>
16
- <script src="./js/search_index.js" defer></script>
17
- <script src="./js/searcher.js" defer></script>
18
- <script src="./js/darkfish.js" defer></script>
19
-
20
- <link href="./css/fonts.css" rel="stylesheet">
21
- <link href="./css/rdoc.css" rel="stylesheet">
22
-
23
-
24
- <body id="top" role="document" class="file">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="./index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="./table_of_contents.html#pages">Pages</a>
34
- <a href="./table_of_contents.html#classes">Classes</a>
35
- <a href="./table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
- <div id="search-section" role="search" class="project-section initially-hidden">
40
- <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
45
- title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
51
- </form>
52
- </div>
53
-
54
- </div>
55
-
56
-
57
- <div class="nav-section">
58
- <h3>Table of Contents</h3>
59
-
60
- <ul class="link-list" role="directory">
61
- <li><a href="#label-strongDM+SDK+for+Ruby">strongDM SDK for Ruby</a>
62
- <li><a href="#label-Installation">Installation</a>
63
- <li><a href="#label-Authentication">Authentication</a>
64
- <li><a href="#label-List+Users">List Users</a>
65
- <li><a href="#label-Useful+Links">Useful Links</a>
66
- <li><a href="#label-License">License</a>
67
- <li><a href="#label-Contributing">Contributing</a>
68
- </ul>
69
- </div>
70
-
71
-
72
- <div id="project-metadata">
73
-
74
- <div id="fileindex-section" class="nav-section">
75
- <h3>Pages</h3>
76
-
77
- <ul class="link-list">
78
- <li><a href="./LICENSE.html">LICENSE</a>
79
- <li><a href="./README_md.html">README</a>
80
- <li><a href="./examples/Gemfile.html">Gemfile</a>
81
- <li><a href="./lib/version.html">version</a>
82
- </ul>
83
- </div>
84
-
85
- </div>
86
- </nav>
87
-
88
- <main role="main" aria-label="Page README.md">
89
-
90
- <h1 id="label-strongDM+SDK+for+Ruby">strongDM SDK for Ruby<span><a href="#label-strongDM+SDK+for+Ruby">&para;</a> <a href="#top">&uarr;</a></span></h1>
91
-
92
- <p>This is the official <a href="https://www.strongdm.com/">strongDM</a> SDK for the Ruby programming language.</p>
93
-
94
- <p>Learn more with our <a href="https://www.strongdm.com/docs/api/">📚strongDM API docs</a> or <a href="https://www.rubydoc.info/gems/strongdm">📓browse the SDK reference</a>.</p>
95
-
96
- <h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#top">&uarr;</a></span></h2>
97
-
98
- <pre>$ gem install strongdm</pre>
99
-
100
- <h2 id="label-Authentication">Authentication<span><a href="#label-Authentication">&para;</a> <a href="#top">&uarr;</a></span></h2>
101
-
102
- <p>If you don&#39;t already have them you will need to generate a set of API keys, instructions are here: <a href="https://www.strongdm.com/docs/admin-guide/api-credentials/">API Credentials</a></p>
103
-
104
- <p>Add the keys as environment variables; the SDK will need to access these keys for every request.</p>
105
-
106
- <pre>$ export SDM_API_ACCESS_KEY=&lt;YOUR ACCESS KEY&gt;
107
- $ export SDM_API_SECRET_KEY=&lt;YOUR SECRET KEY&gt;</pre>
108
-
109
- <h2 id="label-List+Users">List Users<span><a href="#label-List+Users">&para;</a> <a href="#top">&uarr;</a></span></h2>
110
-
111
- <p>The following code lists all registered users:</p>
112
-
113
- <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&quot;strongdm&quot;</span>
114
-
115
- <span class="ruby-identifier">client</span> = <span class="ruby-constant">SDM</span><span class="ruby-operator">::</span><span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;SDM_API_ACCESS_KEY&#39;</span>], <span class="ruby-constant">ENV</span>[<span class="ruby-string">&#39;SDM_API_SECRET_KEY&#39;</span>])
116
- <span class="ruby-identifier">users</span> = <span class="ruby-identifier">client</span>.<span class="ruby-identifier">accounts</span>.<span class="ruby-identifier">list</span>(<span class="ruby-string">&#39;&#39;</span>)
117
- <span class="ruby-identifier">users</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user</span><span class="ruby-operator">|</span>
118
- <span class="ruby-identifier">p</span> <span class="ruby-identifier">user</span>
119
- <span class="ruby-keyword">end</span>
120
- </pre>
121
-
122
- <h2 id="label-Useful+Links">Useful Links<span><a href="#label-Useful+Links">&para;</a> <a href="#top">&uarr;</a></span></h2>
123
- <ul><li>
124
- <p>Documentation: <a href="https://www.rubydoc.info/gems/strongdm">strongdm gem</a></p>
125
- </li><li>
126
- <p>Examples: <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples">GitHub - strongdm/strongdm-sdk-ruby-examples</a> 1. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/1_managing_resources">Managing Resources</a> 2. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/2_managing_accounts">Managing Accounts</a> 3. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/3_managing_roles">Managing Roles</a> 4. <a href="https://github.com/strongdm/strongdm-sdk-ruby-examples/tree/master/4_managing_gateways">Managing Gateways</a></p>
127
- </li></ul>
128
-
129
- <h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#top">&uarr;</a></span></h2>
130
-
131
- <p><a href="https://github.com/strongdm/strongdm-sdk-ruby/blob/master/LICENSE">Apache 2</a></p>
132
-
133
- <h2 id="label-Contributing">Contributing<span><a href="#label-Contributing">&para;</a> <a href="#top">&uarr;</a></span></h2>
134
-
135
- <p>Currently, we are not accepting pull requests directly to this repository, but our users are some of the most resourceful and ambitious folks out there. So, if you have something to contribute, find a bug, or just want to give us some feedback, please email <a href="mailto:support@strongdm.com">support@strongdm.com</a>.</p>
136
-
137
- </main>
138
-
139
-
140
-
141
- <footer id="validator-badges" role="contentinfo">
142
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
143
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
144
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
145
- </footer>
146
-
data/doc/SDM/AKS.html DELETED
@@ -1,352 +0,0 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
6
-
7
- <title>class SDM::AKS - RDoc Documentation</title>
8
-
9
- <script type="text/javascript">
10
- var rdoc_rel_prefix = "../";
11
- var index_rel_prefix = "../";
12
- </script>
13
-
14
- <script src="../js/navigation.js" defer></script>
15
- <script src="../js/search.js" defer></script>
16
- <script src="../js/search_index.js" defer></script>
17
- <script src="../js/searcher.js" defer></script>
18
- <script src="../js/darkfish.js" defer></script>
19
-
20
- <link href="../css/fonts.css" rel="stylesheet">
21
- <link href="../css/rdoc.css" rel="stylesheet">
22
-
23
-
24
- <body id="top" role="document" class="class">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="../index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="../table_of_contents.html#pages">Pages</a>
34
- <a href="../table_of_contents.html#classes">Classes</a>
35
- <a href="../table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
- <div id="search-section" role="search" class="project-section initially-hidden">
40
- <form action="#" method="get" accept-charset="utf-8">
41
- <div id="search-field-wrapper">
42
- <input id="search-field" role="combobox" aria-label="Search"
43
- aria-autocomplete="list" aria-controls="search-results"
44
- type="text" name="search" placeholder="Search" spellcheck="false"
45
- title="Type to search, Up and Down to navigate, Enter to load">
46
- </div>
47
-
48
- <ul id="search-results" aria-label="Search Results"
49
- aria-busy="false" aria-expanded="false"
50
- aria-atomic="false" class="initially-hidden"></ul>
51
- </form>
52
- </div>
53
-
54
- </div>
55
-
56
-
57
-
58
- <div id="class-metadata">
59
-
60
-
61
- <div id="parent-class-section" class="nav-section">
62
- <h3>Parent</h3>
63
-
64
- <p class="link"><a href="../Object.html">Object</a>
65
- </div>
66
-
67
-
68
-
69
-
70
- <!-- Method Quickref -->
71
- <div id="method-list-section" class="nav-section">
72
- <h3>Methods</h3>
73
-
74
- <ul class="link-list" role="directory">
75
- <li ><a href="#method-c-new">::new</a>
76
- <li ><a href="#method-i-to_json">#to_json</a>
77
- </ul>
78
- </div>
79
-
80
- </div>
81
- </nav>
82
-
83
- <main role="main" aria-labelledby="class-SDM::AKS">
84
- <h1 id="class-SDM::AKS" class="class">
85
- class SDM::AKS
86
- </h1>
87
-
88
- <section class="description">
89
-
90
- </section>
91
-
92
- <section id="5Buntitled-5D" class="documentation-section">
93
-
94
-
95
-
96
- <section class="attribute-method-details" class="method-section">
97
- <header>
98
- <h3>Attributes</h3>
99
- </header>
100
-
101
- <div id="attribute-i-certificate_authority" class="method-detail">
102
- <div class="method-heading attribute-method-heading">
103
- <span class="method-name">certificate_authority</span><span
104
- class="attribute-access-type">[RW]</span>
105
- </div>
106
-
107
- <div class="method-description">
108
-
109
- </div>
110
- </div>
111
- <div id="attribute-i-client_certificate" class="method-detail">
112
- <div class="method-heading attribute-method-heading">
113
- <span class="method-name">client_certificate</span><span
114
- class="attribute-access-type">[RW]</span>
115
- </div>
116
-
117
- <div class="method-description">
118
-
119
- </div>
120
- </div>
121
- <div id="attribute-i-client_key" class="method-detail">
122
- <div class="method-heading attribute-method-heading">
123
- <span class="method-name">client_key</span><span
124
- class="attribute-access-type">[RW]</span>
125
- </div>
126
-
127
- <div class="method-description">
128
-
129
- </div>
130
- </div>
131
- <div id="attribute-i-egress_filter" class="method-detail">
132
- <div class="method-heading attribute-method-heading">
133
- <span class="method-name">egress_filter</span><span
134
- class="attribute-access-type">[RW]</span>
135
- </div>
136
-
137
- <div class="method-description">
138
- <p>A filter applied to the routing logic to pin datasource to nodes.</p>
139
- </div>
140
- </div>
141
- <div id="attribute-i-healthcheck_namespace" class="method-detail">
142
- <div class="method-heading attribute-method-heading">
143
- <span class="method-name">healthcheck_namespace</span><span
144
- class="attribute-access-type">[RW]</span>
145
- </div>
146
-
147
- <div class="method-description">
148
- <p>The path used to check the health of your connection. Defaults to `default`.</p>
149
- </div>
150
- </div>
151
- <div id="attribute-i-healthy" class="method-detail">
152
- <div class="method-heading attribute-method-heading">
153
- <span class="method-name">healthy</span><span
154
- class="attribute-access-type">[RW]</span>
155
- </div>
156
-
157
- <div class="method-description">
158
- <p>True if the datasource is reachable and the credentials are valid.</p>
159
- </div>
160
- </div>
161
- <div id="attribute-i-hostname" class="method-detail">
162
- <div class="method-heading attribute-method-heading">
163
- <span class="method-name">hostname</span><span
164
- class="attribute-access-type">[RW]</span>
165
- </div>
166
-
167
- <div class="method-description">
168
-
169
- </div>
170
- </div>
171
- <div id="attribute-i-id" class="method-detail">
172
- <div class="method-heading attribute-method-heading">
173
- <span class="method-name">id</span><span
174
- class="attribute-access-type">[RW]</span>
175
- </div>
176
-
177
- <div class="method-description">
178
- <p>Unique identifier of the Resource.</p>
179
- </div>
180
- </div>
181
- <div id="attribute-i-name" class="method-detail">
182
- <div class="method-heading attribute-method-heading">
183
- <span class="method-name">name</span><span
184
- class="attribute-access-type">[RW]</span>
185
- </div>
186
-
187
- <div class="method-description">
188
- <p>Unique human-readable name of the Resource.</p>
189
- </div>
190
- </div>
191
- <div id="attribute-i-port" class="method-detail">
192
- <div class="method-heading attribute-method-heading">
193
- <span class="method-name">port</span><span
194
- class="attribute-access-type">[RW]</span>
195
- </div>
196
-
197
- <div class="method-description">
198
-
199
- </div>
200
- </div>
201
- <div id="attribute-i-secret_store_id" class="method-detail">
202
- <div class="method-heading attribute-method-heading">
203
- <span class="method-name">secret_store_id</span><span
204
- class="attribute-access-type">[RW]</span>
205
- </div>
206
-
207
- <div class="method-description">
208
- <p>ID of the secret store containing credentials for this resource, if any.</p>
209
- </div>
210
- </div>
211
- <div id="attribute-i-tags" class="method-detail">
212
- <div class="method-heading attribute-method-heading">
213
- <span class="method-name">tags</span><span
214
- class="attribute-access-type">[RW]</span>
215
- </div>
216
-
217
- <div class="method-description">
218
- <p>Tags is a map of key, value pairs.</p>
219
- </div>
220
- </div>
221
- </section>
222
-
223
-
224
- <section id="public-class-5Buntitled-5D-method-details" class="method-section">
225
- <header>
226
- <h3>Public Class Methods</h3>
227
- </header>
228
-
229
- <div id="method-c-new" class="method-detail ">
230
- <div class="method-heading">
231
- <span class="method-name">new</span><span
232
- class="method-args">( certificate_authority:nil \ , client_certificate:nil \ , client_key:nil \ , egress_filter:nil \ , healthcheck_namespace:nil \ , healthy:nil \ , hostname:nil \ , id:nil \ , name:nil \ , port:nil \ , secret_store_id:nil \ , tags:nil \ )</span>
233
- <span class="method-click-advice">click to toggle source</span>
234
- </div>
235
-
236
- <div class="method-description">
237
-
238
-
239
- <div class="method-source-code" id="new-source">
240
- <pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 45</span>
241
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(
242
- <span class="ruby-value">certificate_authority:</span><span class="ruby-keyword">nil</span> \
243
- ,
244
- <span class="ruby-value">client_certificate:</span><span class="ruby-keyword">nil</span> \
245
- ,
246
- <span class="ruby-value">client_key:</span><span class="ruby-keyword">nil</span> \
247
- ,
248
- <span class="ruby-value">egress_filter:</span><span class="ruby-keyword">nil</span> \
249
- ,
250
- <span class="ruby-value">healthcheck_namespace:</span><span class="ruby-keyword">nil</span> \
251
- ,
252
- <span class="ruby-value">healthy:</span><span class="ruby-keyword">nil</span> \
253
- ,
254
- <span class="ruby-value">hostname:</span><span class="ruby-keyword">nil</span> \
255
- ,
256
- <span class="ruby-value">id:</span><span class="ruby-keyword">nil</span> \
257
- ,
258
- <span class="ruby-value">name:</span><span class="ruby-keyword">nil</span> \
259
- ,
260
- <span class="ruby-value">port:</span><span class="ruby-keyword">nil</span> \
261
- ,
262
- <span class="ruby-value">secret_store_id:</span><span class="ruby-keyword">nil</span> \
263
- ,
264
- <span class="ruby-value">tags:</span><span class="ruby-keyword">nil</span> \
265
- )
266
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">certificate_authority</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
267
- <span class="ruby-ivar">@certificate_authority</span> = <span class="ruby-identifier">certificate_authority</span>
268
- <span class="ruby-keyword">end</span>
269
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">client_certificate</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
270
- <span class="ruby-ivar">@client_certificate</span> = <span class="ruby-identifier">client_certificate</span>
271
- <span class="ruby-keyword">end</span>
272
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">client_key</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
273
- <span class="ruby-ivar">@client_key</span> = <span class="ruby-identifier">client_key</span>
274
- <span class="ruby-keyword">end</span>
275
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">egress_filter</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
276
- <span class="ruby-ivar">@egress_filter</span> = <span class="ruby-identifier">egress_filter</span>
277
- <span class="ruby-keyword">end</span>
278
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">healthcheck_namespace</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
279
- <span class="ruby-ivar">@healthcheck_namespace</span> = <span class="ruby-identifier">healthcheck_namespace</span>
280
- <span class="ruby-keyword">end</span>
281
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">healthy</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
282
- <span class="ruby-ivar">@healthy</span> = <span class="ruby-identifier">healthy</span>
283
- <span class="ruby-keyword">end</span>
284
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">hostname</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
285
- <span class="ruby-ivar">@hostname</span> = <span class="ruby-identifier">hostname</span>
286
- <span class="ruby-keyword">end</span>
287
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
288
- <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
289
- <span class="ruby-keyword">end</span>
290
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
291
- <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
292
- <span class="ruby-keyword">end</span>
293
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">port</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
294
- <span class="ruby-ivar">@port</span> = <span class="ruby-identifier">port</span>
295
- <span class="ruby-keyword">end</span>
296
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">secret_store_id</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
297
- <span class="ruby-ivar">@secret_store_id</span> = <span class="ruby-identifier">secret_store_id</span>
298
- <span class="ruby-keyword">end</span>
299
- <span class="ruby-keyword">if</span> <span class="ruby-identifier">tags</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span>
300
- <span class="ruby-ivar">@tags</span> = <span class="ruby-identifier">tags</span>
301
- <span class="ruby-keyword">end</span>
302
- <span class="ruby-keyword">end</span></pre>
303
- </div>
304
- </div>
305
-
306
-
307
- </div>
308
-
309
- </section>
310
-
311
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
312
- <header>
313
- <h3>Public Instance Methods</h3>
314
- </header>
315
-
316
- <div id="method-i-to_json" class="method-detail ">
317
- <div class="method-heading">
318
- <span class="method-name">to_json</span><span
319
- class="method-args">(options={})</span>
320
- <span class="method-click-advice">click to toggle source</span>
321
- </div>
322
-
323
- <div class="method-description">
324
-
325
-
326
- <div class="method-source-code" id="to_json-source">
327
- <pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 107</span>
328
- <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>(<span class="ruby-identifier">options</span>={})
329
- <span class="ruby-identifier">hash</span> = {}
330
- <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variables</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">var</span><span class="ruby-operator">|</span>
331
- <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">var</span>.<span class="ruby-identifier">id2name</span>.<span class="ruby-identifier">delete_prefix</span>(<span class="ruby-string">&#39;@&#39;</span>)] = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_get</span> <span class="ruby-identifier">var</span>
332
- <span class="ruby-keyword">end</span>
333
- <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">to_json</span>
334
- <span class="ruby-keyword">end</span></pre>
335
- </div>
336
- </div>
337
-
338
-
339
- </div>
340
-
341
- </section>
342
-
343
- </section>
344
- </main>
345
-
346
-
347
- <footer id="validator-badges" role="contentinfo">
348
- <p><a href="https://validator.w3.org/check/referer">Validate</a>
349
- <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
350
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
351
- </footer>
352
-