feat: [datastream] A new method RunStream is added to service `Data…

…stream` (#5834) * feat: A new method `RunStream` is added to service `Datastream` feat: A new field `sql_server_rdbms` is added to message `.google.cloud.datastream.v1.DiscoverConnectionProfileRequest` feat: A new field `sql_server_rdbms` is added to message `.google.cloud.datastream.v1.DiscoverConnectionProfileResponse` feat: A new message `RunStreamRequest` is added feat: A new field `oracle_ssl_config` is added to message `.google.cloud.datastream.v1.OracleProfile` feat: A new field `oracle_asm_config` is added to message `.google.cloud.datastream.v1.OracleProfile` feat: A new field `secret_manager_stored_password` is added to message `.google.cloud.datastream.v1.OracleProfile` feat: A new message `OracleAsmConfig` is added feat: A new message `SqlServerProfile` is added feat: A new message `OracleSslConfig` is added feat: A new field `sql_server_profile` is added to message `.google.cloud.datastream.v1.ConnectionProfile` feat: A new message `LogMiner` is added feat: A new message `BinaryLogParser` is added feat: A new field `log_miner` is added to message `.google.cloud.datastream.v1.OracleSourceConfig` feat: A new field `binary_log_parser` is added to message `.google.cloud.datastream.v1.OracleSourceConfig` feat: A new message `SqlServerColumn` is added feat: A new message `SqlServerTable` is added feat: A new message `SqlServerSchema` is added feat: A new message `SqlServerRdbms` is added feat: A new message `SqlServerSourceConfig` is added feat: A new message `SqlServerTransactionLogs` is added feat: A new message `SqlServerChangeTables` is added feat: A new message `BinaryLogPosition` is added feat: A new message `Gtid` is added feat: A new field `binary_log_position` is added to message `.google.cloud.datastream.v1.MysqlSourceConfig` feat: A new field `gtid` is added to message `.google.cloud.datastream.v1.MysqlSourceConfig` feat: A new field `sql_server_source_config` is added to message `.google.cloud.datastream.v1.SourceConfig` feat: A new message `AppendOnly` is added feat: A new message `Merge` is added feat: A new field `merge` is added to message `.google.cloud.datastream.v1.BigQueryDestinationConfig` feat: A new field `append_only` is added to message `.google.cloud.datastream.v1.BigQueryDestinationConfig` feat: A new field `sql_server_excluded_objects` is added to message `.google.cloud.datastream.v1.Stream` feat: A new field `last_recovery_time` is added to message `.google.cloud.datastream.v1.Stream` feat: A new message `SqlServerObjectIdentifier` is added feat: A new field `sql_server_identifier` is added to message `.google.cloud.datastream.v1.SourceObjectIdentifier` feat: A new value `WARNING` is added to enum `State` feat: A new message `CdcStrategy` is added feat: A new message `SqlServerLsnPosition` is added feat: A new message `OracleScnPosition` is added feat: A new message `MysqlLogPosition` is added docs: A comment for field `requested_cancellation` in message `.google.cloud.datastream.v1.OperationMetadata` is changed docs: A comment for message `OracleProfile` is changed docs: A comment for field `password` in message `.google.cloud.datastream.v1.OracleProfile` is changed docs: A comment for message `MysqlProfile` is changed docs: A comment for field `password` in message `.google.cloud.datastream.v1.MysqlProfile` is changed docs: A comment for field `password` in message `.google.cloud.datastream.v1.PostgresqlProfile` is changed docs: A comment for field `stream_large_objects` in message `.google.cloud.datastream.v1.OracleSourceConfig` is changed docs: A comment for field `dataset_id` in message `.google.cloud.datastream.v1.BigQueryDestinationConfig` is changed docs: A comment for field `state` in message `.google.cloud.datastream.v1.BackfillJob` is changed docs: A comment for field `state` in message `.google.cloud.datastream.v1.Validation` is changed PiperOrigin-RevId: 698715682 Source-Link: googleapis/googleapis@798a8be Source-Link: googleapis/googleapis-gen@c1fe03a Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRhdGFzdHJlYW0vLk93bEJvdC55YW1sIiwiaCI6ImMxZmUwM2E4MThjOWMxMGIyZDU4YmE3ZjM0ZWI2NmMzZjBhMDgxOWEifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Nov 21, 2024 · ca4db62 · ca4db62
1 parent 0b27dc2
commit ca4db62
Show file tree

Hide file tree

Showing 14 changed files with 22,148 additions and 10,848 deletions.
diff --git a/packages/google-cloud-datastream/README.md b/packages/google-cloud-datastream/README.md
@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
 1.  [Select or create a Cloud Platform project][projects].
 1.  [Enable billing for your project][billing].
 1.  [Enable the Datastream API][enable_api].
-1.  [Set up authentication with a service account][auth] so you can access the
+1.  [Set up authentication][auth] so you can access the
     API from your local workstation.
 
 ### Installing the client library
@@ -139,6 +139,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Datastream.list_stream_objects | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.list_stream_objects.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.list_stream_objects.js,packages/google-cloud-datastream/samples/README.md) |
 | Datastream.list_streams | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.list_streams.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.list_streams.js,packages/google-cloud-datastream/samples/README.md) |
 | Datastream.lookup_stream_object | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.lookup_stream_object.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.lookup_stream_object.js,packages/google-cloud-datastream/samples/README.md) |
+| Datastream.run_stream | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.run_stream.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.run_stream.js,packages/google-cloud-datastream/samples/README.md) |
 | Datastream.start_backfill_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.start_backfill_job.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.start_backfill_job.js,packages/google-cloud-datastream/samples/README.md) |
 | Datastream.stop_backfill_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.stop_backfill_job.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.stop_backfill_job.js,packages/google-cloud-datastream/samples/README.md) |
 | Datastream.update_connection_profile | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-datastream/samples/generated/v1/datastream.update_connection_profile.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-datastream/samples/generated/v1/datastream.update_connection_profile.js,packages/google-cloud-datastream/samples/README.md) |
@@ -234,4 +235,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
 [projects]: https://console.cloud.google.com/project
 [billing]: https://support.google.com/cloud/answer/6293499#enable-billing
 [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=datastream.googleapis.com
-[auth]: https://cloud.google.com/docs/authentication/getting-started
+[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
diff --git a/packages/google-cloud-datastream/protos/google/cloud/datastream/v1/datastream.proto b/packages/google-cloud-datastream/protos/google/cloud/datastream/v1/datastream.proto
@@ -167,6 +167,19 @@ service Datastream {
     };
   }
 
+  // Use this method to start, resume or recover a stream with a non default CDC
+  // strategy.
+  rpc RunStream(RunStreamRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{name=projects/*/locations/*/streams/*}:run"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "Stream"
+      metadata_type: "OperationMetadata"
+    };
+  }
+
   // Use this method to get details about a stream object.
   rpc GetStreamObject(GetStreamObjectRequest) returns (StreamObject) {
     option (google.api.http) = {
@@ -352,6 +365,9 @@ message DiscoverConnectionProfileRequest {
 
     // PostgreSQL RDBMS to enrich with child data objects and metadata.
     PostgresqlRdbms postgresql_rdbms = 102;
+
+    // SQLServer RDBMS to enrich with child data objects and metadata.
+    SqlServerRdbms sql_server_rdbms = 103;
   }
 }
 
@@ -367,6 +383,9 @@ message DiscoverConnectionProfileResponse {
 
     // Enriched PostgreSQL RDBMS object.
     PostgresqlRdbms postgresql_rdbms = 102;
+
+    // Enriched SQLServer RDBMS object.
+    SqlServerRdbms sql_server_rdbms = 103;
   }
 }
 
@@ -709,6 +728,25 @@ message DeleteStreamRequest {
   string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
+// Request message for running a stream.
+message RunStreamRequest {
+  // Required. Name of the stream resource to start, in the format:
+  // projects/{project_id}/locations/{location}/streams/{stream_name}
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "datastream.googleapis.com/Stream"
+    }
+  ];
+
+  // Optional. The CDC strategy of the stream. If not set, the system's default
+  // value will be used.
+  CdcStrategy cdc_strategy = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Update the stream without validating it.
+  bool force = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
 // Request for fetching a specific stream object.
 message GetStreamObjectRequest {
   // Required. The name of the stream object resource to get.
@@ -826,9 +864,10 @@ message OperationMetadata {
 
   // Output only. Identifies whether the user has requested cancellation
   // of the operation. Operations that have successfully been cancelled
-  // have [Operation.error][] value with a
-  // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
-  // `Code.CANCELLED`.
+  // have
+  // [google.longrunning.Operation.error][google.longrunning.Operation.error]
+  // value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
+  // corresponding to `Code.CANCELLED`.
   bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. API version used to start the operation.