google-cloud-connectors-v1 0.a → 0.1.1
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 +4 -4
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +122 -0
- data/README.md +141 -8
- data/lib/google/cloud/connectors/v1/authconfig_pb.rb +52 -0
- data/lib/google/cloud/connectors/v1/bindings_override.rb +159 -0
- data/lib/google/cloud/connectors/v1/common_pb.rb +58 -0
- data/lib/google/cloud/connectors/v1/connection_pb.rb +84 -0
- data/lib/google/cloud/connectors/v1/connector_pb.rb +51 -0
- data/lib/google/cloud/connectors/v1/connector_version_pb.rb +63 -0
- data/lib/google/cloud/connectors/v1/connectors/client.rb +2189 -0
- data/lib/google/cloud/connectors/v1/connectors/credentials.rb +47 -0
- data/lib/google/cloud/connectors/v1/connectors/operations.rb +809 -0
- data/lib/google/cloud/connectors/v1/connectors/paths.rb +182 -0
- data/lib/google/cloud/connectors/v1/connectors/rest/client.rb +2049 -0
- data/lib/google/cloud/connectors/v1/connectors/rest/operations.rb +902 -0
- data/lib/google/cloud/connectors/v1/connectors/rest/service_stub.rb +1075 -0
- data/lib/google/cloud/connectors/v1/connectors/rest.rb +54 -0
- data/lib/google/cloud/connectors/v1/connectors.rb +56 -0
- data/lib/google/cloud/connectors/v1/connectors_service_pb.rb +53 -0
- data/lib/google/cloud/connectors/v1/connectors_service_services_pb.rb +80 -0
- data/lib/google/cloud/connectors/v1/destination_config_pb.rb +43 -0
- data/lib/google/cloud/connectors/v1/provider_pb.rb +51 -0
- data/lib/google/cloud/connectors/v1/rest.rb +38 -0
- data/lib/google/cloud/connectors/v1/runtime_pb.rb +47 -0
- data/lib/google/cloud/connectors/v1/settings_pb.rb +46 -0
- data/lib/google/cloud/connectors/v1/ssl_config_pb.rb +49 -0
- data/lib/google/cloud/connectors/v1/version.rb +7 -2
- data/lib/google/cloud/connectors/v1.rb +45 -0
- data/lib/google-cloud-connectors-v1.rb +21 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/client.rb +420 -0
- data/proto_docs/google/api/field_behavior.rb +85 -0
- data/proto_docs/google/api/launch_stage.rb +71 -0
- data/proto_docs/google/api/resource.rb +227 -0
- data/proto_docs/google/cloud/connectors/v1/authconfig.rb +165 -0
- data/proto_docs/google/cloud/connectors/v1/common.rb +287 -0
- data/proto_docs/google/cloud/connectors/v1/connection.rb +678 -0
- data/proto_docs/google/cloud/connectors/v1/connector.rb +119 -0
- data/proto_docs/google/cloud/connectors/v1/connector_version.rb +234 -0
- data/proto_docs/google/cloud/connectors/v1/destination_config.rb +53 -0
- data/proto_docs/google/cloud/connectors/v1/provider.rb +118 -0
- data/proto_docs/google/cloud/connectors/v1/runtime.rb +106 -0
- data/proto_docs/google/cloud/connectors/v1/settings.rb +51 -0
- data/proto_docs/google/cloud/connectors/v1/ssl_config.rb +117 -0
- data/proto_docs/google/longrunning/operations.rb +164 -0
- data/proto_docs/google/protobuf/any.rb +145 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/struct.rb +96 -0
- data/proto_docs/google/protobuf/timestamp.rb +127 -0
- data/proto_docs/google/rpc/status.rb +48 -0
- data/proto_docs/google/type/expr.rb +75 -0
- metadata +136 -10
|
@@ -0,0 +1,678 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2024 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Cloud
|
|
22
|
+
module Connectors
|
|
23
|
+
module V1
|
|
24
|
+
# Connection represents an instance of connector.
|
|
25
|
+
# @!attribute [r] name
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Output only. Resource name of the Connection.
|
|
28
|
+
# Format: projects/\\{project}/locations/\\{location}/connections/\\{connection}
|
|
29
|
+
# @!attribute [r] create_time
|
|
30
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
31
|
+
# Output only. Created time.
|
|
32
|
+
# @!attribute [r] update_time
|
|
33
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
34
|
+
# Output only. Updated time.
|
|
35
|
+
# @!attribute [rw] labels
|
|
36
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
|
37
|
+
# Optional. Resource labels to represent user-provided metadata.
|
|
38
|
+
# Refer to cloud documentation on labels for more details.
|
|
39
|
+
# https://cloud.google.com/compute/docs/labeling-resources
|
|
40
|
+
# @!attribute [rw] description
|
|
41
|
+
# @return [::String]
|
|
42
|
+
# Optional. Description of the resource.
|
|
43
|
+
# @!attribute [rw] connector_version
|
|
44
|
+
# @return [::String]
|
|
45
|
+
# Required. Connector version on which the connection is created.
|
|
46
|
+
# The format is:
|
|
47
|
+
# projects/*/locations/*/providers/*/connectors/*/versions/*
|
|
48
|
+
# Only global location is supported for ConnectorVersion resource.
|
|
49
|
+
# @!attribute [r] status
|
|
50
|
+
# @return [::Google::Cloud::Connectors::V1::ConnectionStatus]
|
|
51
|
+
# Output only. Current status of the connection.
|
|
52
|
+
# @!attribute [rw] config_variables
|
|
53
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::ConfigVariable>]
|
|
54
|
+
# Optional. Configuration for configuring the connection with an external
|
|
55
|
+
# system.
|
|
56
|
+
# @!attribute [rw] auth_config
|
|
57
|
+
# @return [::Google::Cloud::Connectors::V1::AuthConfig]
|
|
58
|
+
# Optional. Configuration for establishing the connection's authentication
|
|
59
|
+
# with an external system.
|
|
60
|
+
# @!attribute [rw] lock_config
|
|
61
|
+
# @return [::Google::Cloud::Connectors::V1::LockConfig]
|
|
62
|
+
# Optional. Configuration that indicates whether or not the Connection can be
|
|
63
|
+
# edited.
|
|
64
|
+
# @!attribute [rw] destination_configs
|
|
65
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::DestinationConfig>]
|
|
66
|
+
# Optional. Configuration of the Connector's destination. Only accepted for
|
|
67
|
+
# Connectors that accepts user defined destination(s).
|
|
68
|
+
# @!attribute [r] image_location
|
|
69
|
+
# @return [::String]
|
|
70
|
+
# Output only. GCR location where the runtime image is stored.
|
|
71
|
+
# formatted like: gcr.io/\\{bucketName}/\\{imageName}
|
|
72
|
+
# @!attribute [rw] service_account
|
|
73
|
+
# @return [::String]
|
|
74
|
+
# Optional. Service account needed for runtime plane to access GCP resources.
|
|
75
|
+
# @!attribute [r] service_directory
|
|
76
|
+
# @return [::String]
|
|
77
|
+
# Output only. The name of the Service Directory service name. Used for
|
|
78
|
+
# Private Harpoon to resolve the ILB address.
|
|
79
|
+
# e.g.
|
|
80
|
+
# "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
|
|
81
|
+
# @!attribute [r] envoy_image_location
|
|
82
|
+
# @return [::String]
|
|
83
|
+
# Output only. GCR location where the envoy image is stored.
|
|
84
|
+
# formatted like: gcr.io/\\{bucketName}/\\{imageName}
|
|
85
|
+
# @!attribute [rw] suspended
|
|
86
|
+
# @return [::Boolean]
|
|
87
|
+
# Optional. Suspended indicates if a user has suspended a connection or not.
|
|
88
|
+
# @!attribute [rw] node_config
|
|
89
|
+
# @return [::Google::Cloud::Connectors::V1::NodeConfig]
|
|
90
|
+
# Optional. Node configuration for the connection.
|
|
91
|
+
# @!attribute [rw] ssl_config
|
|
92
|
+
# @return [::Google::Cloud::Connectors::V1::SslConfig]
|
|
93
|
+
# Optional. Ssl config of a connection
|
|
94
|
+
class Connection
|
|
95
|
+
include ::Google::Protobuf::MessageExts
|
|
96
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
97
|
+
|
|
98
|
+
# @!attribute [rw] key
|
|
99
|
+
# @return [::String]
|
|
100
|
+
# @!attribute [rw] value
|
|
101
|
+
# @return [::String]
|
|
102
|
+
class LabelsEntry
|
|
103
|
+
include ::Google::Protobuf::MessageExts
|
|
104
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
105
|
+
end
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Node configuration for the connection.
|
|
109
|
+
# @!attribute [rw] min_node_count
|
|
110
|
+
# @return [::Integer]
|
|
111
|
+
# Minimum number of nodes in the runtime nodes.
|
|
112
|
+
# @!attribute [rw] max_node_count
|
|
113
|
+
# @return [::Integer]
|
|
114
|
+
# Maximum number of nodes in the runtime nodes.
|
|
115
|
+
class NodeConfig
|
|
116
|
+
include ::Google::Protobuf::MessageExts
|
|
117
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# ConnectionSchemaMetadata is the singleton resource of each connection.
|
|
121
|
+
# It includes the entity and action names of runtime resources exposed
|
|
122
|
+
# by a connection backend.
|
|
123
|
+
# @!attribute [r] entities
|
|
124
|
+
# @return [::Array<::String>]
|
|
125
|
+
# Output only. List of entity names.
|
|
126
|
+
# @!attribute [r] actions
|
|
127
|
+
# @return [::Array<::String>]
|
|
128
|
+
# Output only. List of actions.
|
|
129
|
+
# @!attribute [r] name
|
|
130
|
+
# @return [::String]
|
|
131
|
+
# Output only. Resource name.
|
|
132
|
+
# Format:
|
|
133
|
+
# projects/\\{project}/locations/\\{location}/connections/\\{connection}/connectionSchemaMetadata
|
|
134
|
+
# @!attribute [r] update_time
|
|
135
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
136
|
+
# Output only. Timestamp when the connection runtime schema was updated.
|
|
137
|
+
# @!attribute [r] refresh_time
|
|
138
|
+
# @return [::Google::Protobuf::Timestamp]
|
|
139
|
+
# Output only. Timestamp when the connection runtime schema refresh was
|
|
140
|
+
# triggered.
|
|
141
|
+
# @!attribute [r] state
|
|
142
|
+
# @return [::Google::Cloud::Connectors::V1::ConnectionSchemaMetadata::State]
|
|
143
|
+
# Output only. The current state of runtime schema.
|
|
144
|
+
class ConnectionSchemaMetadata
|
|
145
|
+
include ::Google::Protobuf::MessageExts
|
|
146
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
147
|
+
|
|
148
|
+
# State of connection runtime schema.
|
|
149
|
+
module State
|
|
150
|
+
# Default state.
|
|
151
|
+
STATE_UNSPECIFIED = 0
|
|
152
|
+
|
|
153
|
+
# Schema refresh is in progress.
|
|
154
|
+
REFRESHING = 1
|
|
155
|
+
|
|
156
|
+
# Schema has been updated.
|
|
157
|
+
UPDATED = 2
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# Schema of a runtime entity.
|
|
162
|
+
# @!attribute [r] entity
|
|
163
|
+
# @return [::String]
|
|
164
|
+
# Output only. Name of the entity.
|
|
165
|
+
# @!attribute [r] fields
|
|
166
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::RuntimeEntitySchema::Field>]
|
|
167
|
+
# Output only. List of fields in the entity.
|
|
168
|
+
class RuntimeEntitySchema
|
|
169
|
+
include ::Google::Protobuf::MessageExts
|
|
170
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
171
|
+
|
|
172
|
+
# Metadata of an entity field.
|
|
173
|
+
# @!attribute [rw] field
|
|
174
|
+
# @return [::String]
|
|
175
|
+
# Name of the Field.
|
|
176
|
+
# @!attribute [rw] description
|
|
177
|
+
# @return [::String]
|
|
178
|
+
# A brief description of the Field.
|
|
179
|
+
# @!attribute [rw] data_type
|
|
180
|
+
# @return [::Google::Cloud::Connectors::V1::DataType]
|
|
181
|
+
# The data type of the Field.
|
|
182
|
+
# @!attribute [rw] key
|
|
183
|
+
# @return [::Boolean]
|
|
184
|
+
# The following boolean field specifies if the current Field acts
|
|
185
|
+
# as a primary key or id if the parent is of type entity.
|
|
186
|
+
# @!attribute [rw] readonly
|
|
187
|
+
# @return [::Boolean]
|
|
188
|
+
# Specifies if the Field is readonly.
|
|
189
|
+
# @!attribute [rw] nullable
|
|
190
|
+
# @return [::Boolean]
|
|
191
|
+
# Specifies whether a null value is allowed.
|
|
192
|
+
# @!attribute [rw] default_value
|
|
193
|
+
# @return [::Google::Protobuf::Value]
|
|
194
|
+
# The following field specifies the default value of the Field provided
|
|
195
|
+
# by the external system if a value is not provided.
|
|
196
|
+
# @!attribute [rw] additional_details
|
|
197
|
+
# @return [::Google::Protobuf::Struct]
|
|
198
|
+
# The following map contains fields that are not explicitly mentioned
|
|
199
|
+
# above,this give connectors the flexibility to add new metadata
|
|
200
|
+
# fields.
|
|
201
|
+
class Field
|
|
202
|
+
include ::Google::Protobuf::MessageExts
|
|
203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
204
|
+
end
|
|
205
|
+
end
|
|
206
|
+
|
|
207
|
+
# Schema of a runtime action.
|
|
208
|
+
# @!attribute [r] action
|
|
209
|
+
# @return [::String]
|
|
210
|
+
# Output only. Name of the action.
|
|
211
|
+
# @!attribute [r] input_parameters
|
|
212
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::RuntimeActionSchema::InputParameter>]
|
|
213
|
+
# Output only. List of input parameter metadata for the action.
|
|
214
|
+
# @!attribute [r] result_metadata
|
|
215
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::RuntimeActionSchema::ResultMetadata>]
|
|
216
|
+
# Output only. List of result field metadata.
|
|
217
|
+
class RuntimeActionSchema
|
|
218
|
+
include ::Google::Protobuf::MessageExts
|
|
219
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
220
|
+
|
|
221
|
+
# Metadata of an input parameter.
|
|
222
|
+
# @!attribute [rw] parameter
|
|
223
|
+
# @return [::String]
|
|
224
|
+
# Name of the Parameter.
|
|
225
|
+
# @!attribute [rw] description
|
|
226
|
+
# @return [::String]
|
|
227
|
+
# A brief description of the Parameter.
|
|
228
|
+
# @!attribute [rw] data_type
|
|
229
|
+
# @return [::Google::Cloud::Connectors::V1::DataType]
|
|
230
|
+
# The data type of the Parameter.
|
|
231
|
+
# @!attribute [rw] nullable
|
|
232
|
+
# @return [::Boolean]
|
|
233
|
+
# Specifies whether a null value is allowed.
|
|
234
|
+
# @!attribute [rw] default_value
|
|
235
|
+
# @return [::Google::Protobuf::Value]
|
|
236
|
+
# The following field specifies the default value of the Parameter
|
|
237
|
+
# provided by the external system if a value is not provided.
|
|
238
|
+
class InputParameter
|
|
239
|
+
include ::Google::Protobuf::MessageExts
|
|
240
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
241
|
+
end
|
|
242
|
+
|
|
243
|
+
# Metadata of result field.
|
|
244
|
+
# @!attribute [rw] field
|
|
245
|
+
# @return [::String]
|
|
246
|
+
# Name of the result field.
|
|
247
|
+
# @!attribute [rw] description
|
|
248
|
+
# @return [::String]
|
|
249
|
+
# A brief description of the field.
|
|
250
|
+
# @!attribute [rw] data_type
|
|
251
|
+
# @return [::Google::Cloud::Connectors::V1::DataType]
|
|
252
|
+
# The data type of the field.
|
|
253
|
+
class ResultMetadata
|
|
254
|
+
include ::Google::Protobuf::MessageExts
|
|
255
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
256
|
+
end
|
|
257
|
+
end
|
|
258
|
+
|
|
259
|
+
# Determines whether or no a connection is locked. If locked, a reason must be
|
|
260
|
+
# specified.
|
|
261
|
+
# @!attribute [rw] locked
|
|
262
|
+
# @return [::Boolean]
|
|
263
|
+
# Indicates whether or not the connection is locked.
|
|
264
|
+
# @!attribute [rw] reason
|
|
265
|
+
# @return [::String]
|
|
266
|
+
# Describes why a connection is locked.
|
|
267
|
+
class LockConfig
|
|
268
|
+
include ::Google::Protobuf::MessageExts
|
|
269
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
270
|
+
end
|
|
271
|
+
|
|
272
|
+
# Request message for ConnectorsService.ListConnections
|
|
273
|
+
# @!attribute [rw] parent
|
|
274
|
+
# @return [::String]
|
|
275
|
+
# Required. Parent resource of the Connection, of the form:
|
|
276
|
+
# `projects/*/locations/*`
|
|
277
|
+
# @!attribute [rw] page_size
|
|
278
|
+
# @return [::Integer]
|
|
279
|
+
# Page size.
|
|
280
|
+
# @!attribute [rw] page_token
|
|
281
|
+
# @return [::String]
|
|
282
|
+
# Page token.
|
|
283
|
+
# @!attribute [rw] filter
|
|
284
|
+
# @return [::String]
|
|
285
|
+
# Filter.
|
|
286
|
+
# @!attribute [rw] order_by
|
|
287
|
+
# @return [::String]
|
|
288
|
+
# Order by parameters.
|
|
289
|
+
# @!attribute [rw] view
|
|
290
|
+
# @return [::Google::Cloud::Connectors::V1::ConnectionView]
|
|
291
|
+
# Specifies which fields of the Connection are returned in the response.
|
|
292
|
+
# Defaults to `BASIC` view.
|
|
293
|
+
class ListConnectionsRequest
|
|
294
|
+
include ::Google::Protobuf::MessageExts
|
|
295
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
296
|
+
end
|
|
297
|
+
|
|
298
|
+
# Response message for ConnectorsService.ListConnections
|
|
299
|
+
# @!attribute [rw] connections
|
|
300
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::Connection>]
|
|
301
|
+
# Connections.
|
|
302
|
+
# @!attribute [rw] next_page_token
|
|
303
|
+
# @return [::String]
|
|
304
|
+
# Next page token.
|
|
305
|
+
# @!attribute [rw] unreachable
|
|
306
|
+
# @return [::Array<::String>]
|
|
307
|
+
# Locations that could not be reached.
|
|
308
|
+
class ListConnectionsResponse
|
|
309
|
+
include ::Google::Protobuf::MessageExts
|
|
310
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
# Request message for ConnectorsService.GetConnection
|
|
314
|
+
# @!attribute [rw] name
|
|
315
|
+
# @return [::String]
|
|
316
|
+
# Required. Resource name of the form:
|
|
317
|
+
# `projects/*/locations/*/connections/*`
|
|
318
|
+
# @!attribute [rw] view
|
|
319
|
+
# @return [::Google::Cloud::Connectors::V1::ConnectionView]
|
|
320
|
+
# Specifies which fields of the Connection are returned in the response.
|
|
321
|
+
# Defaults to `BASIC` view.
|
|
322
|
+
class GetConnectionRequest
|
|
323
|
+
include ::Google::Protobuf::MessageExts
|
|
324
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
# Request message for ConnectorsService.CreateConnection
|
|
328
|
+
# @!attribute [rw] parent
|
|
329
|
+
# @return [::String]
|
|
330
|
+
# Required. Parent resource of the Connection, of the form:
|
|
331
|
+
# `projects/*/locations/*`
|
|
332
|
+
# @!attribute [rw] connection_id
|
|
333
|
+
# @return [::String]
|
|
334
|
+
# Required. Identifier to assign to the Connection. Must be unique within
|
|
335
|
+
# scope of the parent resource.
|
|
336
|
+
# @!attribute [rw] connection
|
|
337
|
+
# @return [::Google::Cloud::Connectors::V1::Connection]
|
|
338
|
+
# Required. Connection resource.
|
|
339
|
+
class CreateConnectionRequest
|
|
340
|
+
include ::Google::Protobuf::MessageExts
|
|
341
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
# Request message for ConnectorsService.UpdateConnection
|
|
345
|
+
# @!attribute [rw] connection
|
|
346
|
+
# @return [::Google::Cloud::Connectors::V1::Connection]
|
|
347
|
+
# Required. Connection resource.
|
|
348
|
+
# @!attribute [rw] update_mask
|
|
349
|
+
# @return [::Google::Protobuf::FieldMask]
|
|
350
|
+
# Required. You can modify only the fields listed below.
|
|
351
|
+
#
|
|
352
|
+
# To lock/unlock a connection:
|
|
353
|
+
# * `lock_config`
|
|
354
|
+
#
|
|
355
|
+
# To suspend/resume a connection:
|
|
356
|
+
# * `suspended`
|
|
357
|
+
#
|
|
358
|
+
# To update the connection details:
|
|
359
|
+
# * `description`
|
|
360
|
+
# * `labels`
|
|
361
|
+
# * `connector_version`
|
|
362
|
+
# * `config_variables`
|
|
363
|
+
# * `auth_config`
|
|
364
|
+
# * `destination_configs`
|
|
365
|
+
# * `node_config`
|
|
366
|
+
class UpdateConnectionRequest
|
|
367
|
+
include ::Google::Protobuf::MessageExts
|
|
368
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
# Request message for ConnectorsService.DeleteConnection.
|
|
372
|
+
# @!attribute [rw] name
|
|
373
|
+
# @return [::String]
|
|
374
|
+
# Required. Resource name of the form:
|
|
375
|
+
# `projects/*/locations/*/connections/*`
|
|
376
|
+
class DeleteConnectionRequest
|
|
377
|
+
include ::Google::Protobuf::MessageExts
|
|
378
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
379
|
+
end
|
|
380
|
+
|
|
381
|
+
# Request message for ConnectorsService.GetConnectionSchemaMetadata.
|
|
382
|
+
# @!attribute [rw] name
|
|
383
|
+
# @return [::String]
|
|
384
|
+
# Required. Connection name
|
|
385
|
+
# Format:
|
|
386
|
+
# projects/\\{project}/locations/\\{location}/connections/\\{connection}/connectionSchemaMetadata
|
|
387
|
+
class GetConnectionSchemaMetadataRequest
|
|
388
|
+
include ::Google::Protobuf::MessageExts
|
|
389
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
390
|
+
end
|
|
391
|
+
|
|
392
|
+
# Request message for ConnectorsService.RefreshConnectionSchemaMetadata.
|
|
393
|
+
# @!attribute [rw] name
|
|
394
|
+
# @return [::String]
|
|
395
|
+
# Required. Resource name.
|
|
396
|
+
# Format:
|
|
397
|
+
# projects/\\{project}/locations/\\{location}/connections/\\{connection}/connectionSchemaMetadata
|
|
398
|
+
class RefreshConnectionSchemaMetadataRequest
|
|
399
|
+
include ::Google::Protobuf::MessageExts
|
|
400
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
401
|
+
end
|
|
402
|
+
|
|
403
|
+
# Request message for ConnectorsService.ListRuntimeEntitySchemas.
|
|
404
|
+
# For filter, only entity field is supported with literal equality operator.
|
|
405
|
+
# Accepted filter example: entity="Order"
|
|
406
|
+
# Wildcards are not supported in the filter currently.
|
|
407
|
+
# @!attribute [rw] parent
|
|
408
|
+
# @return [::String]
|
|
409
|
+
# Required. Parent resource of RuntimeEntitySchema
|
|
410
|
+
# Format:
|
|
411
|
+
# projects/\\{project}/locations/\\{location}/connections/\\{connection}
|
|
412
|
+
# @!attribute [rw] page_size
|
|
413
|
+
# @return [::Integer]
|
|
414
|
+
# Page size.
|
|
415
|
+
# @!attribute [rw] page_token
|
|
416
|
+
# @return [::String]
|
|
417
|
+
# Page token.
|
|
418
|
+
# @!attribute [rw] filter
|
|
419
|
+
# @return [::String]
|
|
420
|
+
# Required. Filter
|
|
421
|
+
# Format:
|
|
422
|
+
# entity="\\{entityId}"
|
|
423
|
+
# Only entity field is supported with literal equality operator.
|
|
424
|
+
# Accepted filter example: entity="Order"
|
|
425
|
+
# Wildcards are not supported in the filter currently.
|
|
426
|
+
class ListRuntimeEntitySchemasRequest
|
|
427
|
+
include ::Google::Protobuf::MessageExts
|
|
428
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
429
|
+
end
|
|
430
|
+
|
|
431
|
+
# Response message for ConnectorsService.ListRuntimeEntitySchemas.
|
|
432
|
+
# @!attribute [rw] runtime_entity_schemas
|
|
433
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::RuntimeEntitySchema>]
|
|
434
|
+
# Runtime entity schemas.
|
|
435
|
+
# @!attribute [rw] next_page_token
|
|
436
|
+
# @return [::String]
|
|
437
|
+
# Next page token.
|
|
438
|
+
class ListRuntimeEntitySchemasResponse
|
|
439
|
+
include ::Google::Protobuf::MessageExts
|
|
440
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
441
|
+
end
|
|
442
|
+
|
|
443
|
+
# Request message for ConnectorsService.ListRuntimeActionSchemas.
|
|
444
|
+
# For filter, only action field is supported with literal equality operator.
|
|
445
|
+
# Accepted filter example: action="approveOrder"
|
|
446
|
+
# Wildcards are not supported in the filter currently.
|
|
447
|
+
# @!attribute [rw] parent
|
|
448
|
+
# @return [::String]
|
|
449
|
+
# Required. Parent resource of RuntimeActionSchema
|
|
450
|
+
# Format:
|
|
451
|
+
# projects/\\{project}/locations/\\{location}/connections/\\{connection}
|
|
452
|
+
# @!attribute [rw] page_size
|
|
453
|
+
# @return [::Integer]
|
|
454
|
+
# Page size.
|
|
455
|
+
# @!attribute [rw] page_token
|
|
456
|
+
# @return [::String]
|
|
457
|
+
# Page token.
|
|
458
|
+
# @!attribute [rw] filter
|
|
459
|
+
# @return [::String]
|
|
460
|
+
# Required. Filter
|
|
461
|
+
# Format:
|
|
462
|
+
# action="\\{actionId}"
|
|
463
|
+
# Only action field is supported with literal equality operator.
|
|
464
|
+
# Accepted filter example: action="CancelOrder"
|
|
465
|
+
# Wildcards are not supported in the filter currently.
|
|
466
|
+
class ListRuntimeActionSchemasRequest
|
|
467
|
+
include ::Google::Protobuf::MessageExts
|
|
468
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
# Response message for ConnectorsService.ListRuntimeActionSchemas.
|
|
472
|
+
# @!attribute [rw] runtime_action_schemas
|
|
473
|
+
# @return [::Array<::Google::Cloud::Connectors::V1::RuntimeActionSchema>]
|
|
474
|
+
# Runtime action schemas.
|
|
475
|
+
# @!attribute [rw] next_page_token
|
|
476
|
+
# @return [::String]
|
|
477
|
+
# Next page token.
|
|
478
|
+
class ListRuntimeActionSchemasResponse
|
|
479
|
+
include ::Google::Protobuf::MessageExts
|
|
480
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
# ConnectionStatus indicates the state of the connection.
|
|
484
|
+
# @!attribute [rw] state
|
|
485
|
+
# @return [::Google::Cloud::Connectors::V1::ConnectionStatus::State]
|
|
486
|
+
# State.
|
|
487
|
+
# @!attribute [rw] description
|
|
488
|
+
# @return [::String]
|
|
489
|
+
# Description.
|
|
490
|
+
# @!attribute [rw] status
|
|
491
|
+
# @return [::String]
|
|
492
|
+
# Status provides detailed information for the state.
|
|
493
|
+
class ConnectionStatus
|
|
494
|
+
include ::Google::Protobuf::MessageExts
|
|
495
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
496
|
+
|
|
497
|
+
# All the possible Connection State.
|
|
498
|
+
module State
|
|
499
|
+
# Connection does not have a state yet.
|
|
500
|
+
STATE_UNSPECIFIED = 0
|
|
501
|
+
|
|
502
|
+
# Connection is being created.
|
|
503
|
+
CREATING = 1
|
|
504
|
+
|
|
505
|
+
# Connection is running and ready for requests.
|
|
506
|
+
ACTIVE = 2
|
|
507
|
+
|
|
508
|
+
# Connection is stopped.
|
|
509
|
+
INACTIVE = 3
|
|
510
|
+
|
|
511
|
+
# Connection is being deleted.
|
|
512
|
+
DELETING = 4
|
|
513
|
+
|
|
514
|
+
# Connection is being updated.
|
|
515
|
+
UPDATING = 5
|
|
516
|
+
|
|
517
|
+
# Connection is not running due to an error.
|
|
518
|
+
ERROR = 6
|
|
519
|
+
|
|
520
|
+
# Connection is not running due to an auth error for the Oauth2 Auth Code
|
|
521
|
+
# based connector.
|
|
522
|
+
AUTHORIZATION_REQUIRED = 7
|
|
523
|
+
end
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
# All possible data types of a entity or action field.
|
|
527
|
+
module DataType
|
|
528
|
+
# Data type is not specified.
|
|
529
|
+
DATA_TYPE_UNSPECIFIED = 0
|
|
530
|
+
|
|
531
|
+
# DEPRECATED! Use DATA_TYPE_INTEGER.
|
|
532
|
+
DATA_TYPE_INT = 1
|
|
533
|
+
|
|
534
|
+
# Short integer(int16) data type.
|
|
535
|
+
DATA_TYPE_SMALLINT = 2
|
|
536
|
+
|
|
537
|
+
# Double data type.
|
|
538
|
+
DATA_TYPE_DOUBLE = 3
|
|
539
|
+
|
|
540
|
+
# Date data type.
|
|
541
|
+
DATA_TYPE_DATE = 4
|
|
542
|
+
|
|
543
|
+
# DEPRECATED! Use DATA_TYPE_TIMESTAMP.
|
|
544
|
+
DATA_TYPE_DATETIME = 5
|
|
545
|
+
|
|
546
|
+
# Time data type.
|
|
547
|
+
DATA_TYPE_TIME = 6
|
|
548
|
+
|
|
549
|
+
# DEPRECATED! Use DATA_TYPE_VARCHAR.
|
|
550
|
+
DATA_TYPE_STRING = 7
|
|
551
|
+
|
|
552
|
+
# DEPRECATED! Use DATA_TYPE_BIGINT.
|
|
553
|
+
DATA_TYPE_LONG = 8
|
|
554
|
+
|
|
555
|
+
# Boolean data type.
|
|
556
|
+
DATA_TYPE_BOOLEAN = 9
|
|
557
|
+
|
|
558
|
+
# Decimal data type.
|
|
559
|
+
DATA_TYPE_DECIMAL = 10
|
|
560
|
+
|
|
561
|
+
# DEPRECATED! Use DATA_TYPE_VARCHAR.
|
|
562
|
+
DATA_TYPE_UUID = 11
|
|
563
|
+
|
|
564
|
+
# UNSUPPORTED! Binary data type.
|
|
565
|
+
DATA_TYPE_BLOB = 12
|
|
566
|
+
|
|
567
|
+
# Bit data type.
|
|
568
|
+
DATA_TYPE_BIT = 13
|
|
569
|
+
|
|
570
|
+
# Small integer(int8) data type.
|
|
571
|
+
DATA_TYPE_TINYINT = 14
|
|
572
|
+
|
|
573
|
+
# Integer(int32) data type.
|
|
574
|
+
DATA_TYPE_INTEGER = 15
|
|
575
|
+
|
|
576
|
+
# Long integer(int64) data type.
|
|
577
|
+
DATA_TYPE_BIGINT = 16
|
|
578
|
+
|
|
579
|
+
# Float data type.
|
|
580
|
+
DATA_TYPE_FLOAT = 17
|
|
581
|
+
|
|
582
|
+
# Real data type.
|
|
583
|
+
DATA_TYPE_REAL = 18
|
|
584
|
+
|
|
585
|
+
# Numeric data type.
|
|
586
|
+
DATA_TYPE_NUMERIC = 19
|
|
587
|
+
|
|
588
|
+
# Char data type.
|
|
589
|
+
DATA_TYPE_CHAR = 20
|
|
590
|
+
|
|
591
|
+
# Varchar data type.
|
|
592
|
+
DATA_TYPE_VARCHAR = 21
|
|
593
|
+
|
|
594
|
+
# Longvarchar data type.
|
|
595
|
+
DATA_TYPE_LONGVARCHAR = 22
|
|
596
|
+
|
|
597
|
+
# Timestamp data type.
|
|
598
|
+
DATA_TYPE_TIMESTAMP = 23
|
|
599
|
+
|
|
600
|
+
# Nchar data type.
|
|
601
|
+
DATA_TYPE_NCHAR = 24
|
|
602
|
+
|
|
603
|
+
# Nvarchar data type.
|
|
604
|
+
DATA_TYPE_NVARCHAR = 25
|
|
605
|
+
|
|
606
|
+
# Longnvarchar data type.
|
|
607
|
+
DATA_TYPE_LONGNVARCHAR = 26
|
|
608
|
+
|
|
609
|
+
# Null data type.
|
|
610
|
+
DATA_TYPE_NULL = 27
|
|
611
|
+
|
|
612
|
+
# UNSUPPORTED! Binary data type.
|
|
613
|
+
DATA_TYPE_OTHER = 28
|
|
614
|
+
|
|
615
|
+
# UNSUPPORTED! Binary data type.
|
|
616
|
+
DATA_TYPE_JAVA_OBJECT = 29
|
|
617
|
+
|
|
618
|
+
# UNSUPPORTED! Binary data type.
|
|
619
|
+
DATA_TYPE_DISTINCT = 30
|
|
620
|
+
|
|
621
|
+
# UNSUPPORTED! Binary data type.
|
|
622
|
+
DATA_TYPE_STRUCT = 31
|
|
623
|
+
|
|
624
|
+
# UNSUPPORTED! Binary data type.
|
|
625
|
+
DATA_TYPE_ARRAY = 32
|
|
626
|
+
|
|
627
|
+
# UNSUPPORTED! Binary data type.
|
|
628
|
+
DATA_TYPE_CLOB = 33
|
|
629
|
+
|
|
630
|
+
# UNSUPPORTED! Binary data type.
|
|
631
|
+
DATA_TYPE_REF = 34
|
|
632
|
+
|
|
633
|
+
# UNSUPPORTED! Binary data type.
|
|
634
|
+
DATA_TYPE_DATALINK = 35
|
|
635
|
+
|
|
636
|
+
# UNSUPPORTED! Row id data type.
|
|
637
|
+
DATA_TYPE_ROWID = 36
|
|
638
|
+
|
|
639
|
+
# UNSUPPORTED! Binary data type.
|
|
640
|
+
DATA_TYPE_BINARY = 37
|
|
641
|
+
|
|
642
|
+
# UNSUPPORTED! Variable binary data type.
|
|
643
|
+
DATA_TYPE_VARBINARY = 38
|
|
644
|
+
|
|
645
|
+
# UNSUPPORTED! Long variable binary data type.
|
|
646
|
+
DATA_TYPE_LONGVARBINARY = 39
|
|
647
|
+
|
|
648
|
+
# UNSUPPORTED! NCLOB data type.
|
|
649
|
+
DATA_TYPE_NCLOB = 40
|
|
650
|
+
|
|
651
|
+
# UNSUPPORTED! SQL XML data type is not supported.
|
|
652
|
+
DATA_TYPE_SQLXML = 41
|
|
653
|
+
|
|
654
|
+
# UNSUPPORTED! Cursor reference type is not supported.
|
|
655
|
+
DATA_TYPE_REF_CURSOR = 42
|
|
656
|
+
|
|
657
|
+
# UNSUPPORTED! Use TIME or TIMESTAMP instead.
|
|
658
|
+
DATA_TYPE_TIME_WITH_TIMEZONE = 43
|
|
659
|
+
|
|
660
|
+
# UNSUPPORTED! Use TIMESTAMP instead.
|
|
661
|
+
DATA_TYPE_TIMESTAMP_WITH_TIMEZONE = 44
|
|
662
|
+
end
|
|
663
|
+
|
|
664
|
+
# Enum to control which fields should be included in the response.
|
|
665
|
+
module ConnectionView
|
|
666
|
+
# CONNECTION_UNSPECIFIED.
|
|
667
|
+
CONNECTION_VIEW_UNSPECIFIED = 0
|
|
668
|
+
|
|
669
|
+
# Do not include runtime required configs.
|
|
670
|
+
BASIC = 1
|
|
671
|
+
|
|
672
|
+
# Include runtime required configs.
|
|
673
|
+
FULL = 2
|
|
674
|
+
end
|
|
675
|
+
end
|
|
676
|
+
end
|
|
677
|
+
end
|
|
678
|
+
end
|