google-apis-sqladmin_v1 0.1.0 → 0.2.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.
@@ -48,6 +48,197 @@ module Google
48
48
  client_version: Google::Apis::SqladminV1::GEM_VERSION)
49
49
  @batch_path = 'batch'
50
50
  end
51
+
52
+ # Lists instances under a given project.
53
+ # @param [String] project
54
+ # Project ID of the project for which to list Cloud SQL instances.
55
+ # @param [String] filter
56
+ # A filter expression that filters resources listed in the response. The
57
+ # expression is in the form of field:value. For example, 'instanceType:
58
+ # CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON
59
+ # representation, such as 'settings.userLabels.auto_start:true'. Multiple filter
60
+ # queries are space-separated. For example. 'state:RUNNABLE instanceType:
61
+ # CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However,
62
+ # you can include AND and OR expressions explicitly.
63
+ # @param [Fixnum] max_results
64
+ # The maximum number of results to return per response.
65
+ # @param [String] page_token
66
+ # A previously-returned page token representing part of the larger set of
67
+ # results to view.
68
+ # @param [String] fields
69
+ # Selector specifying which fields to include in a partial response.
70
+ # @param [String] quota_user
71
+ # Available to use for quota purposes for server-side applications. Can be any
72
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
73
+ # @param [Google::Apis::RequestOptions] options
74
+ # Request-specific options
75
+ #
76
+ # @yield [result, err] Result & error if block supplied
77
+ # @yieldparam result [Google::Apis::SqladminV1::InstancesListResponse] parsed result object
78
+ # @yieldparam err [StandardError] error object if request failed
79
+ #
80
+ # @return [Google::Apis::SqladminV1::InstancesListResponse]
81
+ #
82
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
83
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
84
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
85
+ def list_instances(project, filter: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
86
+ command = make_simple_command(:get, 'v1/projects/{project}/instances', options)
87
+ command.response_representation = Google::Apis::SqladminV1::InstancesListResponse::Representation
88
+ command.response_class = Google::Apis::SqladminV1::InstancesListResponse
89
+ command.params['project'] = project unless project.nil?
90
+ command.query['filter'] = filter unless filter.nil?
91
+ command.query['maxResults'] = max_results unless max_results.nil?
92
+ command.query['pageToken'] = page_token unless page_token.nil?
93
+ command.query['fields'] = fields unless fields.nil?
94
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
95
+ execute_or_queue_command(command, &block)
96
+ end
97
+
98
+ # Generates a short-lived X509 certificate containing the provided public key
99
+ # and signed by a private key specific to the target instance. Users may use the
100
+ # certificate to authenticate as themselves when connecting to the database.
101
+ # @param [String] project
102
+ # Project ID of the project that contains the instance.
103
+ # @param [String] instance
104
+ # Cloud SQL instance ID. This does not include the project ID.
105
+ # @param [Google::Apis::SqladminV1::GenerateEphemeralCertRequest] generate_ephemeral_cert_request_object
106
+ # @param [String] fields
107
+ # Selector specifying which fields to include in a partial response.
108
+ # @param [String] quota_user
109
+ # Available to use for quota purposes for server-side applications. Can be any
110
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
111
+ # @param [Google::Apis::RequestOptions] options
112
+ # Request-specific options
113
+ #
114
+ # @yield [result, err] Result & error if block supplied
115
+ # @yieldparam result [Google::Apis::SqladminV1::GenerateEphemeralCertResponse] parsed result object
116
+ # @yieldparam err [StandardError] error object if request failed
117
+ #
118
+ # @return [Google::Apis::SqladminV1::GenerateEphemeralCertResponse]
119
+ #
120
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
121
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
122
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
123
+ def generate_instance_ephemeral_cert(project, instance, generate_ephemeral_cert_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
124
+ command = make_simple_command(:post, 'v1/projects/{project}/instances/{instance}:generateEphemeralCert', options)
125
+ command.request_representation = Google::Apis::SqladminV1::GenerateEphemeralCertRequest::Representation
126
+ command.request_object = generate_ephemeral_cert_request_object
127
+ command.response_representation = Google::Apis::SqladminV1::GenerateEphemeralCertResponse::Representation
128
+ command.response_class = Google::Apis::SqladminV1::GenerateEphemeralCertResponse
129
+ command.params['project'] = project unless project.nil?
130
+ command.params['instance'] = instance unless instance.nil?
131
+ command.query['fields'] = fields unless fields.nil?
132
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
133
+ execute_or_queue_command(command, &block)
134
+ end
135
+
136
+ # Retrieves a resource containing information about a Cloud SQL instance.
137
+ # @param [String] project
138
+ # Project ID of the project that contains the instance.
139
+ # @param [String] instance
140
+ # Database instance ID. This does not include the project ID.
141
+ # @param [String] fields
142
+ # Selector specifying which fields to include in a partial response.
143
+ # @param [String] quota_user
144
+ # Available to use for quota purposes for server-side applications. Can be any
145
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
146
+ # @param [Google::Apis::RequestOptions] options
147
+ # Request-specific options
148
+ #
149
+ # @yield [result, err] Result & error if block supplied
150
+ # @yieldparam result [Google::Apis::SqladminV1::DatabaseInstance] parsed result object
151
+ # @yieldparam err [StandardError] error object if request failed
152
+ #
153
+ # @return [Google::Apis::SqladminV1::DatabaseInstance]
154
+ #
155
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
156
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
157
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
158
+ def get_project_instance(project, instance, fields: nil, quota_user: nil, options: nil, &block)
159
+ command = make_simple_command(:get, 'v1/projects/{project}/instances/{instance}', options)
160
+ command.response_representation = Google::Apis::SqladminV1::DatabaseInstance::Representation
161
+ command.response_class = Google::Apis::SqladminV1::DatabaseInstance
162
+ command.params['project'] = project unless project.nil?
163
+ command.params['instance'] = instance unless instance.nil?
164
+ command.query['fields'] = fields unless fields.nil?
165
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
166
+ execute_or_queue_command(command, &block)
167
+ end
168
+
169
+ # Retrieves connect settings about a Cloud SQL instance.
170
+ # @param [String] project
171
+ # Project ID of the project that contains the instance.
172
+ # @param [String] instance
173
+ # Cloud SQL instance ID. This does not include the project ID.
174
+ # @param [String] read_time
175
+ # Optional. Optional snapshot read timestamp to trade freshness for performance.
176
+ # @param [String] fields
177
+ # Selector specifying which fields to include in a partial response.
178
+ # @param [String] quota_user
179
+ # Available to use for quota purposes for server-side applications. Can be any
180
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
181
+ # @param [Google::Apis::RequestOptions] options
182
+ # Request-specific options
183
+ #
184
+ # @yield [result, err] Result & error if block supplied
185
+ # @yieldparam result [Google::Apis::SqladminV1::ConnectSettings] parsed result object
186
+ # @yieldparam err [StandardError] error object if request failed
187
+ #
188
+ # @return [Google::Apis::SqladminV1::ConnectSettings]
189
+ #
190
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
191
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
192
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
193
+ def get_project_instance_connect_settings(project, instance, read_time: nil, fields: nil, quota_user: nil, options: nil, &block)
194
+ command = make_simple_command(:get, 'v1/projects/{project}/instances/{instance}/connectSettings', options)
195
+ command.response_representation = Google::Apis::SqladminV1::ConnectSettings::Representation
196
+ command.response_class = Google::Apis::SqladminV1::ConnectSettings
197
+ command.params['project'] = project unless project.nil?
198
+ command.params['instance'] = instance unless instance.nil?
199
+ command.query['readTime'] = read_time unless read_time.nil?
200
+ command.query['fields'] = fields unless fields.nil?
201
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
202
+ execute_or_queue_command(command, &block)
203
+ end
204
+
205
+ # Generates a short-lived X509 certificate containing the provided public key
206
+ # and signed by a private key specific to the target instance. Users may use the
207
+ # certificate to authenticate as themselves when connecting to the database.
208
+ # @param [String] project
209
+ # Project ID of the Cloud SQL project.
210
+ # @param [String] instance
211
+ # Cloud SQL instance ID. This does not include the project ID.
212
+ # @param [Google::Apis::SqladminV1::SslCertsCreateEphemeralRequest] ssl_certs_create_ephemeral_request_object
213
+ # @param [String] fields
214
+ # Selector specifying which fields to include in a partial response.
215
+ # @param [String] quota_user
216
+ # Available to use for quota purposes for server-side applications. Can be any
217
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
218
+ # @param [Google::Apis::RequestOptions] options
219
+ # Request-specific options
220
+ #
221
+ # @yield [result, err] Result & error if block supplied
222
+ # @yieldparam result [Google::Apis::SqladminV1::SslCert] parsed result object
223
+ # @yieldparam err [StandardError] error object if request failed
224
+ #
225
+ # @return [Google::Apis::SqladminV1::SslCert]
226
+ #
227
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
228
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
229
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
230
+ def create_project_instance_create_ephemeral(project, instance, ssl_certs_create_ephemeral_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
231
+ command = make_simple_command(:post, 'v1/projects/{project}/instances/{instance}/createEphemeral', options)
232
+ command.request_representation = Google::Apis::SqladminV1::SslCertsCreateEphemeralRequest::Representation
233
+ command.request_object = ssl_certs_create_ephemeral_request_object
234
+ command.response_representation = Google::Apis::SqladminV1::SslCert::Representation
235
+ command.response_class = Google::Apis::SqladminV1::SslCert
236
+ command.params['project'] = project unless project.nil?
237
+ command.params['instance'] = instance unless instance.nil?
238
+ command.query['fields'] = fields unless fields.nil?
239
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
240
+ execute_or_queue_command(command, &block)
241
+ end
51
242
 
52
243
  protected
53
244
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-sqladmin_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-07-05 00:00:00.000000000 Z
11
+ date: 2021-07-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-sqladmin_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-sqladmin_v1/v0.1.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-sqladmin_v1/v0.2.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-sqladmin_v1
63
63
  post_install_message:
64
64
  rdoc_options: []