ionoscloud-dbaas-postgres 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +70 -0
- data/LICENSE +201 -0
- data/README.md +65 -0
- data/Rakefile +10 -0
- data/docs/README.md +163 -0
- data/docs/api/BackupsApi.md +232 -0
- data/docs/api/ClustersApi.md +540 -0
- data/docs/api/LogsApi.md +91 -0
- data/docs/api/MetadataApi.md +153 -0
- data/docs/api/RestoresApi.md +84 -0
- data/docs/models/APIVersion.md +20 -0
- data/docs/models/BackupLocation.md +15 -0
- data/docs/models/BackupMetadata.md +20 -0
- data/docs/models/BackupResponse.md +24 -0
- data/docs/models/ClusterBackup.md +26 -0
- data/docs/models/ClusterBackupList.md +28 -0
- data/docs/models/ClusterBackupListAllOf.md +22 -0
- data/docs/models/ClusterList.md +28 -0
- data/docs/models/ClusterListAllOf.md +22 -0
- data/docs/models/ClusterLogs.md +18 -0
- data/docs/models/ClusterLogsInstances.md +20 -0
- data/docs/models/ClusterLogsMessages.md +20 -0
- data/docs/models/ClusterProperties.md +40 -0
- data/docs/models/ClusterResponse.md +24 -0
- data/docs/models/Connection.md +22 -0
- data/docs/models/CreateClusterProperties.md +42 -0
- data/docs/models/CreateClusterRequest.md +20 -0
- data/docs/models/CreateRestoreRequest.md +20 -0
- data/docs/models/DBUser.md +20 -0
- data/docs/models/DayOfTheWeek.md +15 -0
- data/docs/models/ErrorMessage.md +20 -0
- data/docs/models/ErrorResponse.md +20 -0
- data/docs/models/Location.md +15 -0
- data/docs/models/MaintenanceWindow.md +20 -0
- data/docs/models/Metadata.md +30 -0
- data/docs/models/Pagination.md +22 -0
- data/docs/models/PaginationLinks.md +22 -0
- data/docs/models/PatchClusterProperties.md +32 -0
- data/docs/models/PatchClusterRequest.md +20 -0
- data/docs/models/PostgresVersionList.md +18 -0
- data/docs/models/PostgresVersionListData.md +18 -0
- data/docs/models/ResourceType.md +15 -0
- data/docs/models/State.md +15 -0
- data/docs/models/StorageType.md +15 -0
- data/docs/models/SynchronizationMode.md +15 -0
- data/docs/summary.md +50 -0
- data/git_push.sh +58 -0
- data/ionoscloud-dbaas-postgres.gemspec +38 -0
- data/lib/ionoscloud-dbaas-postgres/api/backups_api.rb +205 -0
- data/lib/ionoscloud-dbaas-postgres/api/clusters_api.rb +464 -0
- data/lib/ionoscloud-dbaas-postgres/api/logs_api.rb +102 -0
- data/lib/ionoscloud-dbaas-postgres/api/metadata_api.rb +136 -0
- data/lib/ionoscloud-dbaas-postgres/api/restores_api.rb +93 -0
- data/lib/ionoscloud-dbaas-postgres/api_client.rb +471 -0
- data/lib/ionoscloud-dbaas-postgres/api_error.rb +57 -0
- data/lib/ionoscloud-dbaas-postgres/configuration.rb +291 -0
- data/lib/ionoscloud-dbaas-postgres/models/api_version.rb +227 -0
- data/lib/ionoscloud-dbaas-postgres/models/backup_location.rb +36 -0
- data/lib/ionoscloud-dbaas-postgres/models/backup_metadata.rb +229 -0
- data/lib/ionoscloud-dbaas-postgres/models/backup_response.rb +247 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_backup.rb +260 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_backup_list.rb +305 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_backup_list_all_of.rb +237 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_list.rb +305 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_list_all_of.rb +237 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_logs.rb +219 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_logs_instances.rb +228 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_logs_messages.rb +227 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_properties.rb +417 -0
- data/lib/ionoscloud-dbaas-postgres/models/cluster_response.rb +247 -0
- data/lib/ionoscloud-dbaas-postgres/models/connection.rb +255 -0
- data/lib/ionoscloud-dbaas-postgres/models/create_cluster_properties.rb +501 -0
- data/lib/ionoscloud-dbaas-postgres/models/create_cluster_request.rb +228 -0
- data/lib/ionoscloud-dbaas-postgres/models/create_restore_request.rb +235 -0
- data/lib/ionoscloud-dbaas-postgres/models/day_of_the_week.rb +42 -0
- data/lib/ionoscloud-dbaas-postgres/models/db_user.rb +239 -0
- data/lib/ionoscloud-dbaas-postgres/models/error_message.rb +229 -0
- data/lib/ionoscloud-dbaas-postgres/models/error_response.rb +228 -0
- data/lib/ionoscloud-dbaas-postgres/models/location.rb +41 -0
- data/lib/ionoscloud-dbaas-postgres/models/maintenance_window.rb +238 -0
- data/lib/ionoscloud-dbaas-postgres/models/metadata.rb +275 -0
- data/lib/ionoscloud-dbaas-postgres/models/pagination.rb +268 -0
- data/lib/ionoscloud-dbaas-postgres/models/pagination_links.rb +240 -0
- data/lib/ionoscloud-dbaas-postgres/models/patch_cluster_properties.rb +381 -0
- data/lib/ionoscloud-dbaas-postgres/models/patch_cluster_request.rb +228 -0
- data/lib/ionoscloud-dbaas-postgres/models/postgres_version_list.rb +219 -0
- data/lib/ionoscloud-dbaas-postgres/models/postgres_version_list_data.rb +218 -0
- data/lib/ionoscloud-dbaas-postgres/models/resource_type.rb +38 -0
- data/lib/ionoscloud-dbaas-postgres/models/state.rb +40 -0
- data/lib/ionoscloud-dbaas-postgres/models/storage_type.rb +37 -0
- data/lib/ionoscloud-dbaas-postgres/models/synchronization_mode.rb +38 -0
- data/lib/ionoscloud-dbaas-postgres/version.rb +15 -0
- data/lib/ionoscloud-dbaas-postgres.rb +79 -0
- data/lib/test_driver.rb +119 -0
- data/sonar-project.properties +12 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/spec_helper.rb +111 -0
- metadata +190 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 3810993a5be1481231747c0377fbc70f4aae591d1bda0fddb68d25bbe453cdb2
|
4
|
+
data.tar.gz: 991b5e19058c36248090c37ec6f8504f8fca80bf967fcab52ac7e05803363532
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8fc750c4d1fde1351dd22df0efd5d48c6a9e07575cb37b7b437f7dd8fed923540a2faf7855e65ded90d01cea2c8b6ebcf5b79326be504e7c2a37af019eb79487
|
7
|
+
data.tar.gz: c49cd74140ddd263f5a80f49abcc633c731d6bf960f29cf35c559f8c34fec2270022feaf5094fb9df876b38d85443d6de2c6fb874514b404ebb55fa7a76bc738
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,70 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
ionoscloud-dbaas-postgres (1.0.0)
|
5
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.4.2)
|
11
|
+
byebug (11.1.3)
|
12
|
+
coderay (1.1.3)
|
13
|
+
diff-lcs (1.5.0)
|
14
|
+
ethon (0.15.0)
|
15
|
+
ffi (>= 1.15.0)
|
16
|
+
ffi (1.15.4)
|
17
|
+
jaro_winkler (1.5.4)
|
18
|
+
method_source (1.0.0)
|
19
|
+
parallel (1.21.0)
|
20
|
+
parser (3.1.0.0)
|
21
|
+
ast (~> 2.4.1)
|
22
|
+
pry (0.13.1)
|
23
|
+
coderay (~> 1.1)
|
24
|
+
method_source (~> 1.0)
|
25
|
+
pry-byebug (3.9.0)
|
26
|
+
byebug (~> 11.0)
|
27
|
+
pry (~> 0.13.0)
|
28
|
+
psych (4.0.3)
|
29
|
+
stringio
|
30
|
+
rainbow (3.0.0)
|
31
|
+
rake (13.0.6)
|
32
|
+
rspec (3.10.0)
|
33
|
+
rspec-core (~> 3.10.0)
|
34
|
+
rspec-expectations (~> 3.10.0)
|
35
|
+
rspec-mocks (~> 3.10.0)
|
36
|
+
rspec-core (3.10.1)
|
37
|
+
rspec-support (~> 3.10.0)
|
38
|
+
rspec-expectations (3.10.1)
|
39
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
40
|
+
rspec-support (~> 3.10.0)
|
41
|
+
rspec-mocks (3.10.2)
|
42
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
43
|
+
rspec-support (~> 3.10.0)
|
44
|
+
rspec-support (3.10.3)
|
45
|
+
rubocop (0.66.0)
|
46
|
+
jaro_winkler (~> 1.5.1)
|
47
|
+
parallel (~> 1.10)
|
48
|
+
parser (>= 2.5, != 2.5.1.1)
|
49
|
+
psych (>= 3.1.0)
|
50
|
+
rainbow (>= 2.2.2, < 4.0)
|
51
|
+
ruby-progressbar (~> 1.7)
|
52
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
53
|
+
ruby-progressbar (1.11.0)
|
54
|
+
stringio (3.0.1)
|
55
|
+
typhoeus (1.4.0)
|
56
|
+
ethon (>= 0.9.0)
|
57
|
+
unicode-display_width (1.5.0)
|
58
|
+
|
59
|
+
PLATFORMS
|
60
|
+
x86_64-linux
|
61
|
+
|
62
|
+
DEPENDENCIES
|
63
|
+
ionoscloud-dbaas-postgres!
|
64
|
+
pry-byebug
|
65
|
+
rake (~> 13.0.1)
|
66
|
+
rspec (~> 3.6, >= 3.6.0)
|
67
|
+
rubocop (~> 0.66.0)
|
68
|
+
|
69
|
+
BUNDLED WITH
|
70
|
+
2.3.4
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
![CI Ruby DBaaS Postgres](https://github.com/ionos-cloud/sdk-resources/workflows/[%20CI%20]%20DBaaS%20Postgres%20/%20Ruby/badge.svg)
|
2
|
+
[![Gem Version](https://img.shields.io/gem/v/ionoscloud-dbaas-postgres)](https://rubygems.org/gems/ionoscloud-dbaas-postgres)
|
3
|
+
[![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
|
4
|
+
|
5
|
+
![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true "Title")
|
6
|
+
|
7
|
+
# ionoscloud-dbaas-postgres
|
8
|
+
|
9
|
+
IonoscloudDbaasPostgres - the Ruby gem for the IONOS DBaaS REST API
|
10
|
+
|
11
|
+
An enterprise-grade Database is provided as a Service (DBaaS) solution that
|
12
|
+
can be managed through a browser-based \"Data Center Designer\" (DCD) tool or
|
13
|
+
via an easy to use API.
|
14
|
+
|
15
|
+
The API allows you to create additional database clusters or modify existing
|
16
|
+
ones. It is designed to allow users to leverage the same power and
|
17
|
+
flexibility found within the DCD visual tool. Both tools are consistent with
|
18
|
+
their concepts and lend well to making the experience smooth and intuitive.
|
19
|
+
|
20
|
+
|
21
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
22
|
+
|
23
|
+
- API version: 0.0.1
|
24
|
+
- Package version: 1.0.0
|
25
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
26
|
+
|
27
|
+
## Installation
|
28
|
+
|
29
|
+
### Build a gem
|
30
|
+
|
31
|
+
To build the Ruby code into a gem:
|
32
|
+
|
33
|
+
```shell
|
34
|
+
gem build ionoscloud-dbaas-postgres.gemspec
|
35
|
+
```
|
36
|
+
|
37
|
+
Then either install the gem locally:
|
38
|
+
|
39
|
+
```shell
|
40
|
+
gem install ./ionoscloud-dbaas-postgres-1.0.0.gem
|
41
|
+
```
|
42
|
+
|
43
|
+
(for development, run `gem install --dev ./ionoscloud-dbaas-postgres-1.0.0.gem` to install the development dependencies)
|
44
|
+
|
45
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
46
|
+
|
47
|
+
Finally add this to the Gemfile:
|
48
|
+
|
49
|
+
gem 'ionoscloud-dbaas-postgres', '~> 1.0.0'
|
50
|
+
|
51
|
+
### Install from Git
|
52
|
+
|
53
|
+
If the Ruby gem is hosted at a git repository: https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres, then add the following in the Gemfile:
|
54
|
+
|
55
|
+
gem 'ionoscloud-dbaas-postgres', :git => 'https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres.git'
|
56
|
+
|
57
|
+
### Include the Ruby code directly
|
58
|
+
|
59
|
+
Include the Ruby code directly using `-I` as follows:
|
60
|
+
|
61
|
+
```shell
|
62
|
+
ruby -Ilib script.rb
|
63
|
+
```
|
64
|
+
|
65
|
+
## Our latest, most up to date documentation is available [here](https://docs.ionos.com/ruby-sdk-dbaas-postgres/)
|
data/Rakefile
ADDED
data/docs/README.md
ADDED
@@ -0,0 +1,163 @@
|
|
1
|
+
# Introduction
|
2
|
+
|
3
|
+
## Overview
|
4
|
+
|
5
|
+
An enterprise-grade Database is provided as a Service (DBaaS) solution that
|
6
|
+
can be managed through a browser-based \"Data Center Designer\" (DCD) tool or
|
7
|
+
via an easy to use API.
|
8
|
+
|
9
|
+
The API allows you to create additional database clusters or modify existing
|
10
|
+
ones. It is designed to allow users to leverage the same power and
|
11
|
+
flexibility found within the DCD visual tool. Both tools are consistent with
|
12
|
+
their concepts and lend well to making the experience smooth and intuitive.
|
13
|
+
|
14
|
+
## Getting Started
|
15
|
+
|
16
|
+
### Instalation
|
17
|
+
|
18
|
+
### 1. Build a gem
|
19
|
+
|
20
|
+
To build the Ruby code into a gem:
|
21
|
+
|
22
|
+
```text
|
23
|
+
gem build ionoscloud-dbaas-postgres.gemspec
|
24
|
+
```
|
25
|
+
|
26
|
+
Then either install the gem locally:
|
27
|
+
|
28
|
+
```text
|
29
|
+
gem install ./ionoscloud-dbaas-postgres-<gem-version>.gem
|
30
|
+
```
|
31
|
+
|
32
|
+
\(for development, run `gem install --dev ./ionoscloud-dbaas-postgres-<gem-version>.gem` to install the development dependencies\)
|
33
|
+
|
34
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
|
+
|
36
|
+
Finally add this to the Gemfile:
|
37
|
+
|
38
|
+
```text
|
39
|
+
gem 'ionoscloud-dbaas-postgres', '~> <gem-version>'
|
40
|
+
```
|
41
|
+
|
42
|
+
### 2. Install from Git
|
43
|
+
|
44
|
+
If the Ruby gem is hosted at a git repository: [https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres](https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres), then add the following in the Gemfile:
|
45
|
+
|
46
|
+
```text
|
47
|
+
gem 'ionoscloud-dbaas-postgres', :git => 'https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres.git'
|
48
|
+
```
|
49
|
+
|
50
|
+
### 3. Include the Ruby code directly
|
51
|
+
|
52
|
+
Include the Ruby code directly using `-I` as follows:
|
53
|
+
|
54
|
+
```text
|
55
|
+
ruby -Ilib script.rb
|
56
|
+
```
|
57
|
+
|
58
|
+
### 4. Install from RubyGems
|
59
|
+
|
60
|
+
Just add this to the Gemfile:
|
61
|
+
|
62
|
+
```text
|
63
|
+
gem 'ionoscloud-dbaas-postgres', '~> <gem-version>'
|
64
|
+
```
|
65
|
+
|
66
|
+
### After installing please run the following code:
|
67
|
+
|
68
|
+
```ruby
|
69
|
+
# Load the gem
|
70
|
+
require 'ionoscloud-dbaas-postgres'
|
71
|
+
|
72
|
+
# Setup authorization
|
73
|
+
IonoscloudDbaasPostgres.configure do |config|
|
74
|
+
# Configure HTTP basic authorization: Basic Authentication
|
75
|
+
config.username = 'YOUR_USERNAME'
|
76
|
+
config.password = 'YOUR_PASSWORD'
|
77
|
+
|
78
|
+
# Configure API key authorization: Token Authentication
|
79
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
81
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
82
|
+
end
|
83
|
+
|
84
|
+
api_instance = IonoscloudDbaasPostgres::DefaultApi.new
|
85
|
+
opts = {
|
86
|
+
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
87
|
+
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
88
|
+
x_contract_number: 56 # Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed
|
89
|
+
}
|
90
|
+
|
91
|
+
begin
|
92
|
+
#Display API information
|
93
|
+
result = api_instance.api_info_get(opts)
|
94
|
+
p result
|
95
|
+
rescue IonoscloudDbaasPostgres::ApiError => e
|
96
|
+
puts "Exception when calling DefaultApi->api_info_get: #{e}"
|
97
|
+
end
|
98
|
+
```
|
99
|
+
|
100
|
+
### Authentication
|
101
|
+
|
102
|
+
The username and password or the authentication token can be manually specified when initializing the SDK client:
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
IonoscloudDbaasPostgres.configure do |config|
|
106
|
+
# Configure HTTP basic authorization: Basic Authentication
|
107
|
+
config.username = 'YOUR_USERNAME'
|
108
|
+
config.password = 'YOUR_PASSWORD'
|
109
|
+
|
110
|
+
# Configure API key authorization: Token Authentication
|
111
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
112
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
113
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
Environment variables can also be used for initialization. For example:
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
IonoscloudDbaasPostgres.configure do |config|
|
121
|
+
config.username = ENV['IONOS_USERNAME']
|
122
|
+
config.password = ENV['IONOS_PASSWORD']
|
123
|
+
config.api_key['Authorization'] = ENV['IONOS_TOKEN']
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
{% hint style="danger" %}
|
128
|
+
**Warning**: Make sure to follow the Information Security Best Practices when using credentials within your code or storing them in a file.
|
129
|
+
{% endhint %}
|
130
|
+
|
131
|
+
### Changing the base URL
|
132
|
+
|
133
|
+
Base URL for the HTTP operation can be changed in the following way:
|
134
|
+
|
135
|
+
```ruby
|
136
|
+
IonoscloudDbaasPostgres.configure do |config|
|
137
|
+
config.username = ENV['IONOS_USERNAME']
|
138
|
+
config.password = ENV['IONOS_PASSWORD']
|
139
|
+
|
140
|
+
# Configure the url used by the SDK
|
141
|
+
config.host = 'https://api.ionos.com/databases/postgresql'
|
142
|
+
# This must be set as well because of the way the API works, otherwise the set url will not be used
|
143
|
+
condif.server_index = nil
|
144
|
+
end
|
145
|
+
```
|
146
|
+
|
147
|
+
## Feature Reference
|
148
|
+
|
149
|
+
The IONOS Cloud SDK for Ruby aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:
|
150
|
+
|
151
|
+
* authentication for API calls
|
152
|
+
* handling of asynchronous requests
|
153
|
+
|
154
|
+
## FAQ
|
155
|
+
|
156
|
+
1. How can I open a bug/feature request?
|
157
|
+
|
158
|
+
Bugs & feature requests can be open on the repository issues: [https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres/issues/new/choose](https://github.com/ionos-cloud/sdk-ruby-dbaas-postgres/issues/new/choose)
|
159
|
+
|
160
|
+
2. Can I contribute to the Ruby SDK?
|
161
|
+
|
162
|
+
Pure SDKs are automatically generated using OpenAPI Generator and don’t support manual changes. If you need changes please open an issue and we’ll try to take care of it.
|
163
|
+
|