google-cloud-cloud_dms-v1 0.1.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.
Files changed (30) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +201 -0
  5. data/README.md +139 -0
  6. data/lib/google-cloud-cloud_dms-v1.rb +21 -0
  7. data/lib/google/cloud/cloud_dms/v1.rb +38 -0
  8. data/lib/google/cloud/cloud_dms/v1/data_migration_service.rb +50 -0
  9. data/lib/google/cloud/cloud_dms/v1/data_migration_service/client.rb +1745 -0
  10. data/lib/google/cloud/cloud_dms/v1/data_migration_service/credentials.rb +51 -0
  11. data/lib/google/cloud/cloud_dms/v1/data_migration_service/operations.rb +655 -0
  12. data/lib/google/cloud/cloud_dms/v1/data_migration_service/paths.rb +88 -0
  13. data/lib/google/cloud/cloud_dms/v1/version.rb +28 -0
  14. data/lib/google/cloud/clouddms/v1/clouddms_pb.rb +158 -0
  15. data/lib/google/cloud/clouddms/v1/clouddms_resources_pb.rb +268 -0
  16. data/lib/google/cloud/clouddms/v1/clouddms_services_pb.rb +85 -0
  17. data/proto_docs/README.md +4 -0
  18. data/proto_docs/google/api/field_behavior.rb +65 -0
  19. data/proto_docs/google/api/resource.rb +283 -0
  20. data/proto_docs/google/cloud/clouddms/v1/clouddms.rb +427 -0
  21. data/proto_docs/google/cloud/clouddms/v1/clouddms_resources.rb +757 -0
  22. data/proto_docs/google/longrunning/operations.rb +164 -0
  23. data/proto_docs/google/protobuf/any.rb +141 -0
  24. data/proto_docs/google/protobuf/duration.rb +98 -0
  25. data/proto_docs/google/protobuf/empty.rb +36 -0
  26. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  27. data/proto_docs/google/protobuf/timestamp.rb +129 -0
  28. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  29. data/proto_docs/google/rpc/status.rb +46 -0
  30. metadata +222 -0
@@ -0,0 +1,85 @@
1
+ # Generated by the protocol buffer compiler. DO NOT EDIT!
2
+ # Source: google/cloud/clouddms/v1/clouddms.proto for package 'Google.Cloud.CloudDMS.V1'
3
+ # Original file comments:
4
+ # Copyright 2021 Google LLC
5
+ #
6
+ # Licensed under the Apache License, Version 2.0 (the "License");
7
+ # you may not use this file except in compliance with the License.
8
+ # You may obtain a copy of the License at
9
+ #
10
+ # http://www.apache.org/licenses/LICENSE-2.0
11
+ #
12
+ # Unless required by applicable law or agreed to in writing, software
13
+ # distributed under the License is distributed on an "AS IS" BASIS,
14
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ # See the License for the specific language governing permissions and
16
+ # limitations under the License.
17
+ #
18
+
19
+ require 'grpc'
20
+ require 'google/cloud/clouddms/v1/clouddms_pb'
21
+
22
+ module Google
23
+ module Cloud
24
+ module CloudDMS
25
+ module V1
26
+ module DataMigrationService
27
+ # Database Migration service
28
+ class Service
29
+
30
+ include GRPC::GenericService
31
+
32
+ self.marshal_class_method = :encode
33
+ self.unmarshal_class_method = :decode
34
+ self.service_name = 'google.cloud.clouddms.v1.DataMigrationService'
35
+
36
+ # Lists migration jobs in a given project and location.
37
+ rpc :ListMigrationJobs, ::Google::Cloud::CloudDMS::V1::ListMigrationJobsRequest, ::Google::Cloud::CloudDMS::V1::ListMigrationJobsResponse
38
+ # Gets details of a single migration job.
39
+ rpc :GetMigrationJob, ::Google::Cloud::CloudDMS::V1::GetMigrationJobRequest, ::Google::Cloud::CloudDMS::V1::MigrationJob
40
+ # Creates a new migration job in a given project and location.
41
+ rpc :CreateMigrationJob, ::Google::Cloud::CloudDMS::V1::CreateMigrationJobRequest, ::Google::Longrunning::Operation
42
+ # Updates the parameters of a single migration job.
43
+ rpc :UpdateMigrationJob, ::Google::Cloud::CloudDMS::V1::UpdateMigrationJobRequest, ::Google::Longrunning::Operation
44
+ # Deletes a single migration job.
45
+ rpc :DeleteMigrationJob, ::Google::Cloud::CloudDMS::V1::DeleteMigrationJobRequest, ::Google::Longrunning::Operation
46
+ # Start an already created migration job.
47
+ rpc :StartMigrationJob, ::Google::Cloud::CloudDMS::V1::StartMigrationJobRequest, ::Google::Longrunning::Operation
48
+ # Stops a running migration job.
49
+ rpc :StopMigrationJob, ::Google::Cloud::CloudDMS::V1::StopMigrationJobRequest, ::Google::Longrunning::Operation
50
+ # Resume a migration job that is currently stopped and is resumable (was
51
+ # stopped during CDC phase).
52
+ rpc :ResumeMigrationJob, ::Google::Cloud::CloudDMS::V1::ResumeMigrationJobRequest, ::Google::Longrunning::Operation
53
+ # Promote a migration job, stopping replication to the destination and
54
+ # promoting the destination to be a standalone database.
55
+ rpc :PromoteMigrationJob, ::Google::Cloud::CloudDMS::V1::PromoteMigrationJobRequest, ::Google::Longrunning::Operation
56
+ # Verify a migration job, making sure the destination can reach the source
57
+ # and that all configuration and prerequisites are met.
58
+ rpc :VerifyMigrationJob, ::Google::Cloud::CloudDMS::V1::VerifyMigrationJobRequest, ::Google::Longrunning::Operation
59
+ # Restart a stopped or failed migration job, resetting the destination
60
+ # instance to its original state and starting the migration process from
61
+ # scratch.
62
+ rpc :RestartMigrationJob, ::Google::Cloud::CloudDMS::V1::RestartMigrationJobRequest, ::Google::Longrunning::Operation
63
+ # Generate a SSH configuration script to configure the reverse SSH
64
+ # connectivity.
65
+ rpc :GenerateSshScript, ::Google::Cloud::CloudDMS::V1::GenerateSshScriptRequest, ::Google::Cloud::CloudDMS::V1::SshScript
66
+ # Retrieve a list of all connection profiles in a given project and location.
67
+ rpc :ListConnectionProfiles, ::Google::Cloud::CloudDMS::V1::ListConnectionProfilesRequest, ::Google::Cloud::CloudDMS::V1::ListConnectionProfilesResponse
68
+ # Gets details of a single connection profile.
69
+ rpc :GetConnectionProfile, ::Google::Cloud::CloudDMS::V1::GetConnectionProfileRequest, ::Google::Cloud::CloudDMS::V1::ConnectionProfile
70
+ # Creates a new connection profile in a given project and location.
71
+ rpc :CreateConnectionProfile, ::Google::Cloud::CloudDMS::V1::CreateConnectionProfileRequest, ::Google::Longrunning::Operation
72
+ # Update the configuration of a single connection profile.
73
+ rpc :UpdateConnectionProfile, ::Google::Cloud::CloudDMS::V1::UpdateConnectionProfileRequest, ::Google::Longrunning::Operation
74
+ # Deletes a single Database Migration Service connection profile.
75
+ # A connection profile can only be deleted if it is not in use by any
76
+ # active migration jobs.
77
+ rpc :DeleteConnectionProfile, ::Google::Cloud::CloudDMS::V1::DeleteConnectionProfileRequest, ::Google::Longrunning::Operation
78
+ end
79
+
80
+ Stub = Service.rpc_stub_class
81
+ end
82
+ end
83
+ end
84
+ end
85
+ end
@@ -0,0 +1,4 @@
1
+ # Cloud Database Migration Service V1 Protocol Buffer Documentation
2
+
3
+ These files are for the YARD documentation of the generated protobuf files.
4
+ They are not intended to be required or loaded at runtime.
@@ -0,0 +1,65 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 Api
22
+ # An indicator of the behavior of a given field (for example, that a field
23
+ # is required in requests, or given as output but ignored as input).
24
+ # This **does not** change the behavior in protocol buffers itself; it only
25
+ # denotes the behavior and may affect how API tooling handles the field.
26
+ #
27
+ # Note: This enum **may** receive new values in the future.
28
+ module FieldBehavior
29
+ # Conventional default for enums. Do not use this.
30
+ FIELD_BEHAVIOR_UNSPECIFIED = 0
31
+
32
+ # Specifically denotes a field as optional.
33
+ # While all fields in protocol buffers are optional, this may be specified
34
+ # for emphasis if appropriate.
35
+ OPTIONAL = 1
36
+
37
+ # Denotes a field as required.
38
+ # This indicates that the field **must** be provided as part of the request,
39
+ # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
40
+ REQUIRED = 2
41
+
42
+ # Denotes a field as output only.
43
+ # This indicates that the field is provided in responses, but including the
44
+ # field in a request does nothing (the server *must* ignore it and
45
+ # *must not* throw an error as a result of the field's presence).
46
+ OUTPUT_ONLY = 3
47
+
48
+ # Denotes a field as input only.
49
+ # This indicates that the field is provided in requests, and the
50
+ # corresponding field is not included in output.
51
+ INPUT_ONLY = 4
52
+
53
+ # Denotes a field as immutable.
54
+ # This indicates that the field may be set once in a request to create a
55
+ # resource, but may not be changed thereafter.
56
+ IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,283 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 Api
22
+ # A simple descriptor of a resource type.
23
+ #
24
+ # ResourceDescriptor annotates a resource message (either by means of a
25
+ # protobuf annotation or use in the service config), and associates the
26
+ # resource's schema, the resource type, and the pattern of the resource name.
27
+ #
28
+ # Example:
29
+ #
30
+ # message Topic {
31
+ # // Indicates this message defines a resource schema.
32
+ # // Declares the resource type in the format of {service}/{kind}.
33
+ # // For Kubernetes resources, the format is {api group}/{kind}.
34
+ # option (google.api.resource) = {
35
+ # type: "pubsub.googleapis.com/Topic"
36
+ # name_descriptor: {
37
+ # pattern: "projects/{project}/topics/{topic}"
38
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
+ # parent_name_extractor: "projects/{project}"
40
+ # }
41
+ # };
42
+ # }
43
+ #
44
+ # The ResourceDescriptor Yaml config will look like:
45
+ #
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
+ #
53
+ # Sometimes, resources have multiple patterns, typically because they can
54
+ # live under multiple parents.
55
+ #
56
+ # Example:
57
+ #
58
+ # message LogEntry {
59
+ # option (google.api.resource) = {
60
+ # type: "logging.googleapis.com/LogEntry"
61
+ # name_descriptor: {
62
+ # pattern: "projects/{project}/logs/{log}"
63
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
+ # parent_name_extractor: "projects/{project}"
65
+ # }
66
+ # name_descriptor: {
67
+ # pattern: "folders/{folder}/logs/{log}"
68
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
+ # parent_name_extractor: "folders/{folder}"
70
+ # }
71
+ # name_descriptor: {
72
+ # pattern: "organizations/{organization}/logs/{log}"
73
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
+ # parent_name_extractor: "organizations/{organization}"
75
+ # }
76
+ # name_descriptor: {
77
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
+ # parent_type: "billing.googleapis.com/BillingAccount"
79
+ # parent_name_extractor: "billingAccounts/{billing_account}"
80
+ # }
81
+ # };
82
+ # }
83
+ #
84
+ # The ResourceDescriptor Yaml config will look like:
85
+ #
86
+ # resources:
87
+ # - type: 'logging.googleapis.com/LogEntry'
88
+ # name_descriptor:
89
+ # - pattern: "projects/{project}/logs/{log}"
90
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
+ # parent_name_extractor: "projects/{project}"
92
+ # - pattern: "folders/{folder}/logs/{log}"
93
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
+ # parent_name_extractor: "folders/{folder}"
95
+ # - pattern: "organizations/{organization}/logs/{log}"
96
+ # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
+ # parent_name_extractor: "organizations/{organization}"
98
+ # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
+ # parent_type: "billing.googleapis.com/BillingAccount"
100
+ # parent_name_extractor: "billingAccounts/{billing_account}"
101
+ #
102
+ # For flexible resources, the resource name doesn't contain parent names, but
103
+ # the resource itself has parents for policy evaluation.
104
+ #
105
+ # Example:
106
+ #
107
+ # message Shelf {
108
+ # option (google.api.resource) = {
109
+ # type: "library.googleapis.com/Shelf"
110
+ # name_descriptor: {
111
+ # pattern: "shelves/{shelf}"
112
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
+ # }
114
+ # name_descriptor: {
115
+ # pattern: "shelves/{shelf}"
116
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
+ # }
118
+ # };
119
+ # }
120
+ #
121
+ # The ResourceDescriptor Yaml config will look like:
122
+ #
123
+ # resources:
124
+ # - type: 'library.googleapis.com/Shelf'
125
+ # name_descriptor:
126
+ # - pattern: "shelves/{shelf}"
127
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
+ # - pattern: "shelves/{shelf}"
129
+ # parent_type: "cloudresourcemanager.googleapis.com/Folder"
130
+ # @!attribute [rw] type
131
+ # @return [::String]
132
+ # The resource type. It must be in the format of
133
+ # \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
134
+ # singular and must not include version numbers.
135
+ #
136
+ # Example: `storage.googleapis.com/Bucket`
137
+ #
138
+ # The value of the resource_type_kind must follow the regular expression
139
+ # /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
140
+ # should use PascalCase (UpperCamelCase). The maximum number of
141
+ # characters allowed for the `resource_type_kind` is 100.
142
+ # @!attribute [rw] pattern
143
+ # @return [::Array<::String>]
144
+ # Optional. The relative resource name pattern associated with this resource
145
+ # type. The DNS prefix of the full resource name shouldn't be specified here.
146
+ #
147
+ # The path pattern must follow the syntax, which aligns with HTTP binding
148
+ # syntax:
149
+ #
150
+ # Template = Segment { "/" Segment } ;
151
+ # Segment = LITERAL | Variable ;
152
+ # Variable = "{" LITERAL "}" ;
153
+ #
154
+ # Examples:
155
+ #
156
+ # - "projects/\\{project}/topics/\\{topic}"
157
+ # - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
158
+ #
159
+ # The components in braces correspond to the IDs for each resource in the
160
+ # hierarchy. It is expected that, if multiple patterns are provided,
161
+ # the same component name (e.g. "project") refers to IDs of the same
162
+ # type of resource.
163
+ # @!attribute [rw] name_field
164
+ # @return [::String]
165
+ # Optional. The field on the resource that designates the resource name
166
+ # field. If omitted, this is assumed to be "name".
167
+ # @!attribute [rw] history
168
+ # @return [::Google::Api::ResourceDescriptor::History]
169
+ # Optional. The historical or future-looking state of the resource pattern.
170
+ #
171
+ # Example:
172
+ #
173
+ # // The InspectTemplate message originally only supported resource
174
+ # // names with organization, and project was added later.
175
+ # message InspectTemplate {
176
+ # option (google.api.resource) = {
177
+ # type: "dlp.googleapis.com/InspectTemplate"
178
+ # pattern:
179
+ # "organizations/{organization}/inspectTemplates/{inspect_template}"
180
+ # pattern: "projects/{project}/inspectTemplates/{inspect_template}"
181
+ # history: ORIGINALLY_SINGLE_PATTERN
182
+ # };
183
+ # }
184
+ # @!attribute [rw] plural
185
+ # @return [::String]
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
190
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
194
+ # @!attribute [rw] singular
195
+ # @return [::String]
196
+ # The same concept of the `singular` field in k8s CRD spec
197
+ # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
198
+ # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
204
+ class ResourceDescriptor
205
+ include ::Google::Protobuf::MessageExts
206
+ extend ::Google::Protobuf::MessageExts::ClassMethods
207
+
208
+ # A description of the historical or future-looking state of the
209
+ # resource pattern.
210
+ module History
211
+ # The "unset" value.
212
+ HISTORY_UNSPECIFIED = 0
213
+
214
+ # The resource originally had one pattern and launched as such, and
215
+ # additional patterns were added later.
216
+ ORIGINALLY_SINGLE_PATTERN = 1
217
+
218
+ # The resource has one pattern, but the API owner expects to add more
219
+ # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
220
+ # that from being necessary once there are multiple patterns.)
221
+ FUTURE_MULTI_PATTERN = 2
222
+ end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
239
+ end
240
+
241
+ # Defines a proto annotation that describes a string field that refers to
242
+ # an API resource.
243
+ # @!attribute [rw] type
244
+ # @return [::String]
245
+ # The resource type that the annotated field references.
246
+ #
247
+ # Example:
248
+ #
249
+ # message Subscription {
250
+ # string topic = 2 [(google.api.resource_reference) = {
251
+ # type: "pubsub.googleapis.com/Topic"
252
+ # }];
253
+ # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
265
+ # @!attribute [rw] child_type
266
+ # @return [::String]
267
+ # The resource type of a child collection that the annotated field
268
+ # references. This is useful for annotating the `parent` field that
269
+ # doesn't have a fixed resource type.
270
+ #
271
+ # Example:
272
+ #
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
278
+ class ResourceReference
279
+ include ::Google::Protobuf::MessageExts
280
+ extend ::Google::Protobuf::MessageExts::ClassMethods
281
+ end
282
+ end
283
+ end
@@ -0,0 +1,427 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 CloudDMS
23
+ module V1
24
+ # Retrieve a list of all migration jobs in a given project and location.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. The parent, which owns this collection of migrationJobs.
28
+ # @!attribute [rw] page_size
29
+ # @return [::Integer]
30
+ # The maximum number of migration jobs to return. The service may return
31
+ # fewer than this value. If unspecified, at most 50 migration jobs will be
32
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
33
+ # 1000.
34
+ # @!attribute [rw] page_token
35
+ # @return [::String]
36
+ # The nextPageToken value received in the previous call to
37
+ # migrationJobs.list, used in the subsequent request to retrieve the next
38
+ # page of results. On first call this should be left blank. When paginating,
39
+ # all other parameters provided to migrationJobs.list must match the call
40
+ # that provided the page token.
41
+ # @!attribute [rw] filter
42
+ # @return [::String]
43
+ # A filter expression that filters migration jobs listed in the response.
44
+ # The expression must specify the field name, a comparison operator, and the
45
+ # value that you want to use for filtering. The value must be a string,
46
+ # a number, or a boolean. The comparison operator must be
47
+ # either =, !=, >, or <. For example, list migration jobs created this year
48
+ # by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.**
49
+ # You can also filter nested fields. For example, you could specify
50
+ # **reverseSshConnectivity.vmIp = "1.2.3.4"** to select all migration
51
+ # jobs connecting through the specific SSH tunnel bastion.
52
+ # @!attribute [rw] order_by
53
+ # @return [::String]
54
+ # Sort the results based on the migration job name.
55
+ # Valid values are: "name", "name asc", and "name desc".
56
+ class ListMigrationJobsRequest
57
+ include ::Google::Protobuf::MessageExts
58
+ extend ::Google::Protobuf::MessageExts::ClassMethods
59
+ end
60
+
61
+ # Response message for 'ListMigrationJobs' request.
62
+ # @!attribute [rw] migration_jobs
63
+ # @return [::Array<::Google::Cloud::CloudDMS::V1::MigrationJob>]
64
+ # The list of migration jobs objects.
65
+ # @!attribute [rw] next_page_token
66
+ # @return [::String]
67
+ # A token, which can be sent as `page_token` to retrieve the next page.
68
+ # If this field is omitted, there are no subsequent pages.
69
+ # @!attribute [rw] unreachable
70
+ # @return [::Array<::String>]
71
+ # Locations that could not be reached.
72
+ class ListMigrationJobsResponse
73
+ include ::Google::Protobuf::MessageExts
74
+ extend ::Google::Protobuf::MessageExts::ClassMethods
75
+ end
76
+
77
+ # Request message for 'GetMigrationJob' request.
78
+ # @!attribute [rw] name
79
+ # @return [::String]
80
+ # Required. Name of the migration job resource to get.
81
+ class GetMigrationJobRequest
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
85
+
86
+ # Request message to create a new Database Migration Service migration job
87
+ # in the specified project and region.
88
+ # @!attribute [rw] parent
89
+ # @return [::String]
90
+ # Required. The parent, which owns this collection of migration jobs.
91
+ # @!attribute [rw] migration_job_id
92
+ # @return [::String]
93
+ # Required. The ID of the instance to create.
94
+ # @!attribute [rw] migration_job
95
+ # @return [::Google::Cloud::CloudDMS::V1::MigrationJob]
96
+ # Required. Represents a [migration
97
+ # job](https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs)
98
+ # object.
99
+ # @!attribute [rw] request_id
100
+ # @return [::String]
101
+ # A unique id used to identify the request. If the server receives two
102
+ # requests with the same id, then the second request will be ignored.
103
+ #
104
+ # It is recommended to always set this value to a UUID.
105
+ #
106
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
107
+ # (_), and hyphens (-). The maximum length is 40 characters.
108
+ class CreateMigrationJobRequest
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
112
+
113
+ # Request message for 'UpdateMigrationJob' request.
114
+ # @!attribute [rw] update_mask
115
+ # @return [::Google::Protobuf::FieldMask]
116
+ # Required. Field mask is used to specify the fields to be overwritten in the
117
+ # migration job resource by the update.
118
+ # @!attribute [rw] migration_job
119
+ # @return [::Google::Cloud::CloudDMS::V1::MigrationJob]
120
+ # Required. The migration job parameters to update.
121
+ # @!attribute [rw] request_id
122
+ # @return [::String]
123
+ # A unique id used to identify the request. If the server receives two
124
+ # requests with the same id, then the second request will be ignored.
125
+ #
126
+ # It is recommended to always set this value to a UUID.
127
+ #
128
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
129
+ # (_), and hyphens (-). The maximum length is 40 characters.
130
+ class UpdateMigrationJobRequest
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+ end
134
+
135
+ # Request message for 'DeleteMigrationJob' request.
136
+ # @!attribute [rw] name
137
+ # @return [::String]
138
+ # Required. Name of the migration job resource to delete.
139
+ # @!attribute [rw] request_id
140
+ # @return [::String]
141
+ # A unique id used to identify the request. If the server receives two
142
+ # requests with the same id, then the second request will be ignored.
143
+ #
144
+ # It is recommended to always set this value to a UUID.
145
+ #
146
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
147
+ # (_), and hyphens (-). The maximum length is 40 characters.
148
+ # @!attribute [rw] force
149
+ # @return [::Boolean]
150
+ # The destination CloudSQL connection profile is always deleted with the
151
+ # migration job. In case of force delete, the destination CloudSQL replica
152
+ # database is also deleted.
153
+ class DeleteMigrationJobRequest
154
+ include ::Google::Protobuf::MessageExts
155
+ extend ::Google::Protobuf::MessageExts::ClassMethods
156
+ end
157
+
158
+ # Request message for 'StartMigrationJob' request.
159
+ # @!attribute [rw] name
160
+ # @return [::String]
161
+ # Name of the migration job resource to start.
162
+ class StartMigrationJobRequest
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # Request message for 'StopMigrationJob' request.
168
+ # @!attribute [rw] name
169
+ # @return [::String]
170
+ # Name of the migration job resource to stop.
171
+ class StopMigrationJobRequest
172
+ include ::Google::Protobuf::MessageExts
173
+ extend ::Google::Protobuf::MessageExts::ClassMethods
174
+ end
175
+
176
+ # Request message for 'ResumeMigrationJob' request.
177
+ # @!attribute [rw] name
178
+ # @return [::String]
179
+ # Name of the migration job resource to resume.
180
+ class ResumeMigrationJobRequest
181
+ include ::Google::Protobuf::MessageExts
182
+ extend ::Google::Protobuf::MessageExts::ClassMethods
183
+ end
184
+
185
+ # Request message for 'PromoteMigrationJob' request.
186
+ # @!attribute [rw] name
187
+ # @return [::String]
188
+ # Name of the migration job resource to promote.
189
+ class PromoteMigrationJobRequest
190
+ include ::Google::Protobuf::MessageExts
191
+ extend ::Google::Protobuf::MessageExts::ClassMethods
192
+ end
193
+
194
+ # Request message for 'VerifyMigrationJob' request.
195
+ # @!attribute [rw] name
196
+ # @return [::String]
197
+ # Name of the migration job resource to verify.
198
+ class VerifyMigrationJobRequest
199
+ include ::Google::Protobuf::MessageExts
200
+ extend ::Google::Protobuf::MessageExts::ClassMethods
201
+ end
202
+
203
+ # Request message for 'RestartMigrationJob' request.
204
+ # @!attribute [rw] name
205
+ # @return [::String]
206
+ # Name of the migration job resource to restart.
207
+ class RestartMigrationJobRequest
208
+ include ::Google::Protobuf::MessageExts
209
+ extend ::Google::Protobuf::MessageExts::ClassMethods
210
+ end
211
+
212
+ # Request message for 'GenerateSshScript' request.
213
+ # @!attribute [rw] migration_job
214
+ # @return [::String]
215
+ # Name of the migration job resource to generate the SSH script.
216
+ # @!attribute [rw] vm
217
+ # @return [::String]
218
+ # Required. Bastion VM Instance name to use or to create.
219
+ # @!attribute [rw] vm_creation_config
220
+ # @return [::Google::Cloud::CloudDMS::V1::VmCreationConfig]
221
+ # The VM creation configuration
222
+ # @!attribute [rw] vm_selection_config
223
+ # @return [::Google::Cloud::CloudDMS::V1::VmSelectionConfig]
224
+ # The VM selection configuration
225
+ # @!attribute [rw] vm_port
226
+ # @return [::Integer]
227
+ # The port that will be open on the bastion host
228
+ class GenerateSshScriptRequest
229
+ include ::Google::Protobuf::MessageExts
230
+ extend ::Google::Protobuf::MessageExts::ClassMethods
231
+ end
232
+
233
+ # VM creation configuration message
234
+ # @!attribute [rw] vm_machine_type
235
+ # @return [::String]
236
+ # Required. VM instance machine type to create.
237
+ # @!attribute [rw] vm_zone
238
+ # @return [::String]
239
+ # The Google Cloud Platform zone to create the VM in.
240
+ # @!attribute [rw] subnet
241
+ # @return [::String]
242
+ # The subnet name the vm needs to be created in.
243
+ class VmCreationConfig
244
+ include ::Google::Protobuf::MessageExts
245
+ extend ::Google::Protobuf::MessageExts::ClassMethods
246
+ end
247
+
248
+ # VM selection configuration message
249
+ # @!attribute [rw] vm_zone
250
+ # @return [::String]
251
+ # Required. The Google Cloud Platform zone the VM is located.
252
+ class VmSelectionConfig
253
+ include ::Google::Protobuf::MessageExts
254
+ extend ::Google::Protobuf::MessageExts::ClassMethods
255
+ end
256
+
257
+ # Response message for 'GenerateSshScript' request.
258
+ # @!attribute [rw] script
259
+ # @return [::String]
260
+ # The ssh configuration script.
261
+ class SshScript
262
+ include ::Google::Protobuf::MessageExts
263
+ extend ::Google::Protobuf::MessageExts::ClassMethods
264
+ end
265
+
266
+ # Request message for 'ListConnectionProfiles' request.
267
+ # @!attribute [rw] parent
268
+ # @return [::String]
269
+ # Required. The parent, which owns this collection of connection profiles.
270
+ # @!attribute [rw] page_size
271
+ # @return [::Integer]
272
+ # The maximum number of connection profiles to return. The service may return
273
+ # fewer than this value. If unspecified, at most 50 connection profiles will
274
+ # be returned. The maximum value is 1000; values above 1000 will be coerced
275
+ # to 1000.
276
+ # @!attribute [rw] page_token
277
+ # @return [::String]
278
+ # A page token, received from a previous `ListConnectionProfiles` call.
279
+ # Provide this to retrieve the subsequent page.
280
+ #
281
+ # When paginating, all other parameters provided to `ListConnectionProfiles`
282
+ # must match the call that provided the page token.
283
+ # @!attribute [rw] filter
284
+ # @return [::String]
285
+ # A filter expression that filters connection profiles listed in the
286
+ # response. The expression must specify the field name, a comparison
287
+ # operator, and the value that you want to use for filtering. The value must
288
+ # be a string, a number, or a boolean. The comparison operator must be either
289
+ # =, !=, >, or <. For example, list connection profiles created this year by
290
+ # specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can
291
+ # also filter nested fields. For example, you could specify **mySql.username
292
+ # = %lt;my_username%gt;** to list all connection profiles configured to
293
+ # connect with a specific username.
294
+ # @!attribute [rw] order_by
295
+ # @return [::String]
296
+ # the order by fields for the result.
297
+ class ListConnectionProfilesRequest
298
+ include ::Google::Protobuf::MessageExts
299
+ extend ::Google::Protobuf::MessageExts::ClassMethods
300
+ end
301
+
302
+ # Response message for 'ListConnectionProfiles' request.
303
+ # @!attribute [rw] connection_profiles
304
+ # @return [::Array<::Google::Cloud::CloudDMS::V1::ConnectionProfile>]
305
+ # The response list of connection profiles.
306
+ # @!attribute [rw] next_page_token
307
+ # @return [::String]
308
+ # A token, which can be sent as `page_token` to retrieve the next page.
309
+ # If this field is omitted, there are no subsequent pages.
310
+ # @!attribute [rw] unreachable
311
+ # @return [::Array<::String>]
312
+ # Locations that could not be reached.
313
+ class ListConnectionProfilesResponse
314
+ include ::Google::Protobuf::MessageExts
315
+ extend ::Google::Protobuf::MessageExts::ClassMethods
316
+ end
317
+
318
+ # Request message for 'GetConnectionProfile' request.
319
+ # @!attribute [rw] name
320
+ # @return [::String]
321
+ # Required. Name of the connection profile resource to get.
322
+ class GetConnectionProfileRequest
323
+ include ::Google::Protobuf::MessageExts
324
+ extend ::Google::Protobuf::MessageExts::ClassMethods
325
+ end
326
+
327
+ # Request message for 'CreateConnectionProfile' request.
328
+ # @!attribute [rw] parent
329
+ # @return [::String]
330
+ # Required. The parent, which owns this collection of connection profiles.
331
+ # @!attribute [rw] connection_profile_id
332
+ # @return [::String]
333
+ # Required. The connection profile identifier.
334
+ # @!attribute [rw] connection_profile
335
+ # @return [::Google::Cloud::CloudDMS::V1::ConnectionProfile]
336
+ # Required. The create request body including the connection profile data
337
+ # @!attribute [rw] request_id
338
+ # @return [::String]
339
+ # A unique id used to identify the request. If the server receives two
340
+ # requests with the same id, then the second request will be ignored.
341
+ #
342
+ # It is recommended to always set this value to a UUID.
343
+ #
344
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
345
+ # (_), and hyphens (-). The maximum length is 40 characters.
346
+ class CreateConnectionProfileRequest
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+ end
350
+
351
+ # Request message for 'UpdateConnectionProfile' request.
352
+ # @!attribute [rw] update_mask
353
+ # @return [::Google::Protobuf::FieldMask]
354
+ # Required. Field mask is used to specify the fields to be overwritten in the
355
+ # connection profile resource by the update.
356
+ # @!attribute [rw] connection_profile
357
+ # @return [::Google::Cloud::CloudDMS::V1::ConnectionProfile]
358
+ # Required. The connection profile parameters to update.
359
+ # @!attribute [rw] request_id
360
+ # @return [::String]
361
+ # A unique id used to identify the request. If the server receives two
362
+ # requests with the same id, then the second request will be ignored.
363
+ #
364
+ # It is recommended to always set this value to a UUID.
365
+ #
366
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
367
+ # (_), and hyphens (-). The maximum length is 40 characters.
368
+ class UpdateConnectionProfileRequest
369
+ include ::Google::Protobuf::MessageExts
370
+ extend ::Google::Protobuf::MessageExts::ClassMethods
371
+ end
372
+
373
+ # Request message for 'DeleteConnectionProfile' request.
374
+ # @!attribute [rw] name
375
+ # @return [::String]
376
+ # Required. Name of the connection profile resource to delete.
377
+ # @!attribute [rw] request_id
378
+ # @return [::String]
379
+ # A unique id used to identify the request. If the server receives two
380
+ # requests with the same id, then the second request will be ignored.
381
+ #
382
+ # It is recommended to always set this value to a UUID.
383
+ #
384
+ # The id must contain only letters (a-z, A-Z), numbers (0-9), underscores
385
+ # (_), and hyphens (-). The maximum length is 40 characters.
386
+ # @!attribute [rw] force
387
+ # @return [::Boolean]
388
+ # In case of force delete, the CloudSQL replica database is also deleted
389
+ # (only for CloudSQL connection profile).
390
+ class DeleteConnectionProfileRequest
391
+ include ::Google::Protobuf::MessageExts
392
+ extend ::Google::Protobuf::MessageExts::ClassMethods
393
+ end
394
+
395
+ # Represents the metadata of the long-running operation.
396
+ # @!attribute [r] create_time
397
+ # @return [::Google::Protobuf::Timestamp]
398
+ # Output only. The time the operation was created.
399
+ # @!attribute [r] end_time
400
+ # @return [::Google::Protobuf::Timestamp]
401
+ # Output only. The time the operation finished running.
402
+ # @!attribute [r] target
403
+ # @return [::String]
404
+ # Output only. Server-defined resource path for the target of the operation.
405
+ # @!attribute [r] verb
406
+ # @return [::String]
407
+ # Output only. Name of the verb executed by the operation.
408
+ # @!attribute [r] status_message
409
+ # @return [::String]
410
+ # Output only. Human-readable status of the operation, if any.
411
+ # @!attribute [r] requested_cancellation
412
+ # @return [::Boolean]
413
+ # Output only. Identifies whether the user has requested cancellation
414
+ # of the operation. Operations that have successfully been cancelled
415
+ # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
416
+ # corresponding to `Code.CANCELLED`.
417
+ # @!attribute [r] api_version
418
+ # @return [::String]
419
+ # Output only. API version used to start the operation.
420
+ class OperationMetadata
421
+ include ::Google::Protobuf::MessageExts
422
+ extend ::Google::Protobuf::MessageExts::ClassMethods
423
+ end
424
+ end
425
+ end
426
+ end
427
+ end