google-cloud-datastream-v1 1.7.0 → 1.8.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.
- checksums.yaml +4 -4
- data/README.md +1 -5
- data/lib/google/cloud/datastream/v1/bindings_override.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream/client.rb +59 -42
- data/lib/google/cloud/datastream/v1/datastream/credentials.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream/operations.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream/paths.rb +20 -1
- data/lib/google/cloud/datastream/v1/datastream/rest/client.rb +59 -42
- data/lib/google/cloud/datastream/v1/datastream/rest/operations.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream/rest/service_stub.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream/rest.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream_pb.rb +1 -1
- data/lib/google/cloud/datastream/v1/datastream_resources_pb.rb +43 -1
- data/lib/google/cloud/datastream/v1/datastream_services_pb.rb +1 -1
- data/lib/google/cloud/datastream/v1/rest.rb +1 -1
- data/lib/google/cloud/datastream/v1/version.rb +1 -1
- data/lib/google/cloud/datastream/v1.rb +1 -1
- data/lib/google-cloud-datastream-v1.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +1 -1
- data/proto_docs/google/api/field_info.rb +88 -0
- data/proto_docs/google/api/launch_stage.rb +1 -1
- data/proto_docs/google/api/resource.rb +1 -1
- data/proto_docs/google/cloud/datastream/v1/datastream.rb +77 -46
- data/proto_docs/google/cloud/datastream/v1/datastream_resources.rb +837 -89
- data/proto_docs/google/longrunning/operations.rb +1 -1
- data/proto_docs/google/protobuf/any.rb +1 -1
- data/proto_docs/google/protobuf/duration.rb +1 -1
- data/proto_docs/google/protobuf/empty.rb +1 -1
- data/proto_docs/google/protobuf/field_mask.rb +1 -1
- data/proto_docs/google/protobuf/timestamp.rb +8 -7
- data/proto_docs/google/rpc/status.rb +1 -1
- metadata +8 -8
- data/proto_docs/google/type/expr.rb +0 -75
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 6883f5d62fe2528d1e676e14b82ab0e644a5c0cb1aefceace366bc9ca19e646d
|
|
4
|
+
data.tar.gz: 771434a6aa440b24f3d24986e6a644e0b1647c27d0fe7d18f7461a01c3ae13e9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bbec55550af049d6a976f4ddddb1e518abfbcb2843bae38a5cd8d6b924ac71321467d12ecfb4eed594412a9d6189212d393fa5cf977b7724ee8f112f6dca7539
|
|
7
|
+
data.tar.gz: 8094fb60298afeb3dcb154e257fdd6c131ca578969326d6b676557ffd4bd0ead7694e1c59e22274bfe19cb479c4df5e83618a91604c367112f8fb4c810cbf962
|
data/README.md
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
# Ruby Client for the Datastream V1 API
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Datastream is a serverless and easy-to-use change data capture (CDC) and replication service that lets you synchronize data reliably, and with minimal latency.
|
|
4
4
|
|
|
5
|
-
Datastream is a serverless and easy-to-use change data capture (CDC) and replication service. It allows you to synchronize data across heterogeneous databases and applications reliably, and with minimal latency and downtime.
|
|
6
5
|
|
|
7
6
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
7
|
|
|
@@ -40,9 +39,6 @@ response = client.list_connection_profiles request
|
|
|
40
39
|
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-datastream-v1/latest)
|
|
41
40
|
for class and method documentation.
|
|
42
41
|
|
|
43
|
-
See also the [Product Documentation](https://cloud.google.com/datastream/)
|
|
44
|
-
for general usage information.
|
|
45
|
-
|
|
46
42
|
## Debug Logging
|
|
47
43
|
|
|
48
44
|
This library comes with opt-in Debug Logging that can help you troubleshoot
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -276,19 +276,19 @@ module Google
|
|
|
276
276
|
# @param parent [::String]
|
|
277
277
|
# Required. The parent that owns the collection of connection profiles.
|
|
278
278
|
# @param page_size [::Integer]
|
|
279
|
-
# Maximum number of connection profiles to return.
|
|
279
|
+
# Optional. Maximum number of connection profiles to return.
|
|
280
280
|
# If unspecified, at most 50 connection profiles will be returned.
|
|
281
281
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
282
282
|
# @param page_token [::String]
|
|
283
|
-
# Page token received from a previous `ListConnectionProfiles`
|
|
284
|
-
# Provide this to retrieve the subsequent page.
|
|
283
|
+
# Optional. Page token received from a previous `ListConnectionProfiles`
|
|
284
|
+
# call. Provide this to retrieve the subsequent page.
|
|
285
285
|
#
|
|
286
286
|
# When paginating, all other parameters provided to `ListConnectionProfiles`
|
|
287
287
|
# must match the call that provided the page token.
|
|
288
288
|
# @param filter [::String]
|
|
289
|
-
# Filter request.
|
|
289
|
+
# Optional. Filter request.
|
|
290
290
|
# @param order_by [::String]
|
|
291
|
-
# Order by fields for the result.
|
|
291
|
+
# Optional. Order by fields for the result.
|
|
292
292
|
#
|
|
293
293
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
294
294
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::ConnectionProfile>]
|
|
@@ -805,7 +805,7 @@ module Google
|
|
|
805
805
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
806
806
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
807
807
|
#
|
|
808
|
-
# @overload discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, full_hierarchy: nil, hierarchy_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil, postgresql_rdbms: nil, sql_server_rdbms: nil, salesforce_org: nil, mongodb_cluster: nil)
|
|
808
|
+
# @overload discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, full_hierarchy: nil, hierarchy_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil, postgresql_rdbms: nil, sql_server_rdbms: nil, salesforce_org: nil, mongodb_cluster: nil, spanner_database: nil, source_catalog: nil)
|
|
809
809
|
# Pass arguments to `discover_connection_profile` via keyword arguments. Note that at
|
|
810
810
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
811
811
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -814,46 +814,59 @@ module Google
|
|
|
814
814
|
# Required. The parent resource of the connection profile type. Must be in
|
|
815
815
|
# the format `projects/*/locations/*`.
|
|
816
816
|
# @param connection_profile [::Google::Cloud::Datastream::V1::ConnectionProfile, ::Hash]
|
|
817
|
-
# An ad-hoc connection profile configuration.
|
|
817
|
+
# Optional. An ad-hoc connection profile configuration.
|
|
818
818
|
#
|
|
819
819
|
# Note: The following parameters are mutually exclusive: `connection_profile`, `connection_profile_name`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
820
820
|
# @param connection_profile_name [::String]
|
|
821
|
-
# A reference to an existing connection profile.
|
|
821
|
+
# Optional. A reference to an existing connection profile.
|
|
822
822
|
#
|
|
823
823
|
# Note: The following parameters are mutually exclusive: `connection_profile_name`, `connection_profile`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
824
824
|
# @param full_hierarchy [::Boolean]
|
|
825
|
-
# Whether to retrieve the full hierarchy of data objects (TRUE)
|
|
826
|
-
# current level (FALSE).
|
|
825
|
+
# Optional. Whether to retrieve the full hierarchy of data objects (TRUE)
|
|
826
|
+
# or only the current level (FALSE).
|
|
827
827
|
#
|
|
828
828
|
# Note: The following parameters are mutually exclusive: `full_hierarchy`, `hierarchy_depth`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
829
829
|
# @param hierarchy_depth [::Integer]
|
|
830
|
-
# The number of hierarchy levels below the current level to be
|
|
830
|
+
# Optional. The number of hierarchy levels below the current level to be
|
|
831
|
+
# retrieved.
|
|
831
832
|
#
|
|
832
833
|
# Note: The following parameters are mutually exclusive: `hierarchy_depth`, `full_hierarchy`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
833
834
|
# @param oracle_rdbms [::Google::Cloud::Datastream::V1::OracleRdbms, ::Hash]
|
|
834
|
-
# Oracle RDBMS to enrich with child data objects and metadata.
|
|
835
|
+
# Optional. Oracle RDBMS to enrich with child data objects and metadata.
|
|
835
836
|
#
|
|
836
|
-
# Note: The following parameters are mutually exclusive: `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
837
|
+
# Note: The following parameters are mutually exclusive: `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
837
838
|
# @param mysql_rdbms [::Google::Cloud::Datastream::V1::MysqlRdbms, ::Hash]
|
|
838
|
-
# MySQL RDBMS to enrich with child data objects and metadata.
|
|
839
|
+
# Optional. MySQL RDBMS to enrich with child data objects and metadata.
|
|
839
840
|
#
|
|
840
|
-
# Note: The following parameters are mutually exclusive: `mysql_rdbms`, `oracle_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
841
|
+
# Note: The following parameters are mutually exclusive: `mysql_rdbms`, `oracle_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
841
842
|
# @param postgresql_rdbms [::Google::Cloud::Datastream::V1::PostgresqlRdbms, ::Hash]
|
|
842
|
-
# PostgreSQL RDBMS to enrich with child data objects and
|
|
843
|
+
# Optional. PostgreSQL RDBMS to enrich with child data objects and
|
|
844
|
+
# metadata.
|
|
843
845
|
#
|
|
844
|
-
# Note: The following parameters are mutually exclusive: `postgresql_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
846
|
+
# Note: The following parameters are mutually exclusive: `postgresql_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
845
847
|
# @param sql_server_rdbms [::Google::Cloud::Datastream::V1::SqlServerRdbms, ::Hash]
|
|
846
|
-
# SQLServer RDBMS to enrich with child data objects and metadata.
|
|
848
|
+
# Optional. SQLServer RDBMS to enrich with child data objects and metadata.
|
|
847
849
|
#
|
|
848
|
-
# Note: The following parameters are mutually exclusive: `sql_server_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
850
|
+
# Note: The following parameters are mutually exclusive: `sql_server_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
849
851
|
# @param salesforce_org [::Google::Cloud::Datastream::V1::SalesforceOrg, ::Hash]
|
|
850
|
-
# Salesforce organization to enrich with child data objects and
|
|
852
|
+
# Optional. Salesforce organization to enrich with child data objects and
|
|
853
|
+
# metadata.
|
|
851
854
|
#
|
|
852
|
-
# Note: The following parameters are mutually exclusive: `salesforce_org`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
855
|
+
# Note: The following parameters are mutually exclusive: `salesforce_org`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
853
856
|
# @param mongodb_cluster [::Google::Cloud::Datastream::V1::MongodbCluster, ::Hash]
|
|
854
|
-
# MongoDB cluster to enrich with child data objects and metadata.
|
|
857
|
+
# Optional. MongoDB cluster to enrich with child data objects and metadata.
|
|
858
|
+
#
|
|
859
|
+
# Note: The following parameters are mutually exclusive: `mongodb_cluster`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
860
|
+
# @param spanner_database [::Google::Cloud::Datastream::V1::SpannerDatabase, ::Hash]
|
|
861
|
+
# Optional. Spanner database to enrich with child data objects and
|
|
862
|
+
# metadata.
|
|
863
|
+
#
|
|
864
|
+
# Note: The following parameters are mutually exclusive: `spanner_database`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
865
|
+
# @param source_catalog [::Google::Cloud::Datastream::V1::SourceCatalog, ::Hash]
|
|
866
|
+
# Optional. Source catalog to enrich with child data objects and metadata.
|
|
867
|
+
# This is mainly used to represent SaaS sources databases.
|
|
855
868
|
#
|
|
856
|
-
# Note: The following parameters are mutually exclusive: `
|
|
869
|
+
# Note: The following parameters are mutually exclusive: `source_catalog`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
857
870
|
#
|
|
858
871
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
859
872
|
# @yieldparam response [::Google::Cloud::Datastream::V1::DiscoverConnectionProfileResponse]
|
|
@@ -940,19 +953,19 @@ module Google
|
|
|
940
953
|
# @param parent [::String]
|
|
941
954
|
# Required. The parent that owns the collection of streams.
|
|
942
955
|
# @param page_size [::Integer]
|
|
943
|
-
# Maximum number of streams to return.
|
|
956
|
+
# Optional. Maximum number of streams to return.
|
|
944
957
|
# If unspecified, at most 50 streams will be returned. The maximum
|
|
945
958
|
# value is 1000; values above 1000 will be coerced to 1000.
|
|
946
959
|
# @param page_token [::String]
|
|
947
|
-
# Page token received from a previous `ListStreams` call.
|
|
960
|
+
# Optional. Page token received from a previous `ListStreams` call.
|
|
948
961
|
# Provide this to retrieve the subsequent page.
|
|
949
962
|
#
|
|
950
963
|
# When paginating, all other parameters provided to `ListStreams`
|
|
951
964
|
# must match the call that provided the page token.
|
|
952
965
|
# @param filter [::String]
|
|
953
|
-
# Filter request.
|
|
966
|
+
# Optional. Filter request.
|
|
954
967
|
# @param order_by [::String]
|
|
955
|
-
# Order by fields for the result.
|
|
968
|
+
# Optional. Order by fields for the result.
|
|
956
969
|
#
|
|
957
970
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
958
971
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Stream>]
|
|
@@ -1747,11 +1760,11 @@ module Google
|
|
|
1747
1760
|
# @param parent [::String]
|
|
1748
1761
|
# Required. The parent stream that owns the collection of objects.
|
|
1749
1762
|
# @param page_size [::Integer]
|
|
1750
|
-
# Maximum number of objects to return. Default is 50.
|
|
1763
|
+
# Optional. Maximum number of objects to return. Default is 50.
|
|
1751
1764
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
1752
1765
|
# @param page_token [::String]
|
|
1753
|
-
# Page token received from a previous `ListStreamObjectsRequest`
|
|
1754
|
-
# Provide this to retrieve the subsequent page.
|
|
1766
|
+
# Optional. Page token received from a previous `ListStreamObjectsRequest`
|
|
1767
|
+
# call. Provide this to retrieve the subsequent page.
|
|
1755
1768
|
#
|
|
1756
1769
|
# When paginating, all other parameters provided to
|
|
1757
1770
|
# `ListStreamObjectsRequest` must match the call that provided the page
|
|
@@ -1840,7 +1853,7 @@ module Google
|
|
|
1840
1853
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1841
1854
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
1842
1855
|
#
|
|
1843
|
-
# @overload start_backfill_job(object: nil)
|
|
1856
|
+
# @overload start_backfill_job(object: nil, event_filter: nil)
|
|
1844
1857
|
# Pass arguments to `start_backfill_job` via keyword arguments. Note that at
|
|
1845
1858
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1846
1859
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1848,6 +1861,10 @@ module Google
|
|
|
1848
1861
|
# @param object [::String]
|
|
1849
1862
|
# Required. The name of the stream object resource to start a backfill job
|
|
1850
1863
|
# for.
|
|
1864
|
+
# @param event_filter [::Google::Cloud::Datastream::V1::EventFilter, ::Hash]
|
|
1865
|
+
# Optional. Optional event filter. If not set, or empty, the backfill will be
|
|
1866
|
+
# performed on the entire object. This is currently used for partial backfill
|
|
1867
|
+
# and only supported for SQL sources.
|
|
1851
1868
|
#
|
|
1852
1869
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
1853
1870
|
# @yieldparam response [::Google::Cloud::Datastream::V1::StartBackfillJobResponse]
|
|
@@ -2022,9 +2039,9 @@ module Google
|
|
|
2022
2039
|
# Required. The resource name for the location for which static IPs should be
|
|
2023
2040
|
# returned. Must be in the format `projects/*/locations/*`.
|
|
2024
2041
|
# @param page_size [::Integer]
|
|
2025
|
-
# Maximum number of Ips to return, will likely not be specified.
|
|
2042
|
+
# Optional. Maximum number of Ips to return, will likely not be specified.
|
|
2026
2043
|
# @param page_token [::String]
|
|
2027
|
-
# A page token, received from a previous `ListStaticIps` call.
|
|
2044
|
+
# Optional. A page token, received from a previous `ListStaticIps` call.
|
|
2028
2045
|
# will likely not be specified.
|
|
2029
2046
|
#
|
|
2030
2047
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
@@ -2322,16 +2339,16 @@ module Google
|
|
|
2322
2339
|
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
|
2323
2340
|
# 1000.
|
|
2324
2341
|
# @param page_token [::String]
|
|
2325
|
-
# Page token received from a previous `ListPrivateConnections`
|
|
2326
|
-
# Provide this to retrieve the subsequent page.
|
|
2342
|
+
# Optional. Page token received from a previous `ListPrivateConnections`
|
|
2343
|
+
# call. Provide this to retrieve the subsequent page.
|
|
2327
2344
|
#
|
|
2328
2345
|
# When paginating, all other parameters provided to
|
|
2329
2346
|
# `ListPrivateConnections` must match the call that provided the page
|
|
2330
2347
|
# token.
|
|
2331
2348
|
# @param filter [::String]
|
|
2332
|
-
# Filter request.
|
|
2349
|
+
# Optional. Filter request.
|
|
2333
2350
|
# @param order_by [::String]
|
|
2334
|
-
# Order by fields for the result.
|
|
2351
|
+
# Optional. Order by fields for the result.
|
|
2335
2352
|
#
|
|
2336
2353
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2337
2354
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::PrivateConnection>]
|
|
@@ -2734,21 +2751,21 @@ module Google
|
|
|
2734
2751
|
# @param parent [::String]
|
|
2735
2752
|
# Required. The parent that owns the collection of Routess.
|
|
2736
2753
|
# @param page_size [::Integer]
|
|
2737
|
-
# Maximum number of Routes to return. The service may return
|
|
2754
|
+
# Optional. Maximum number of Routes to return. The service may return
|
|
2738
2755
|
# fewer than this value. If unspecified, at most 50 Routes
|
|
2739
2756
|
# will be returned. The maximum value is 1000; values above 1000 will be
|
|
2740
2757
|
# coerced to 1000.
|
|
2741
2758
|
# @param page_token [::String]
|
|
2742
|
-
# Page token received from a previous `ListRoutes` call.
|
|
2759
|
+
# Optional. Page token received from a previous `ListRoutes` call.
|
|
2743
2760
|
# Provide this to retrieve the subsequent page.
|
|
2744
2761
|
#
|
|
2745
2762
|
# When paginating, all other parameters provided to
|
|
2746
2763
|
# `ListRoutes` must match the call that provided the page
|
|
2747
2764
|
# token.
|
|
2748
2765
|
# @param filter [::String]
|
|
2749
|
-
# Filter request.
|
|
2766
|
+
# Optional. Filter request.
|
|
2750
2767
|
# @param order_by [::String]
|
|
2751
|
-
# Order by fields for the result.
|
|
2768
|
+
# Optional. Order by fields for the result.
|
|
2752
2769
|
#
|
|
2753
2770
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
2754
2771
|
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Route>]
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -43,6 +43,25 @@ module Google
|
|
|
43
43
|
"projects/#{project}/locations/#{location}/connectionProfiles/#{connection_profile}"
|
|
44
44
|
end
|
|
45
45
|
|
|
46
|
+
##
|
|
47
|
+
# Create a fully-qualified Database resource string.
|
|
48
|
+
#
|
|
49
|
+
# The resource will be in the following format:
|
|
50
|
+
#
|
|
51
|
+
# `projects/{project}/instances/{instance}/databases/{database}`
|
|
52
|
+
#
|
|
53
|
+
# @param project [String]
|
|
54
|
+
# @param instance [String]
|
|
55
|
+
# @param database [String]
|
|
56
|
+
#
|
|
57
|
+
# @return [::String]
|
|
58
|
+
def database_path project:, instance:, database:
|
|
59
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
60
|
+
raise ::ArgumentError, "instance cannot contain /" if instance.to_s.include? "/"
|
|
61
|
+
|
|
62
|
+
"projects/#{project}/instances/#{instance}/databases/#{database}"
|
|
63
|
+
end
|
|
64
|
+
|
|
46
65
|
##
|
|
47
66
|
# Create a fully-qualified Location resource string.
|
|
48
67
|
#
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -270,19 +270,19 @@ module Google
|
|
|
270
270
|
# @param parent [::String]
|
|
271
271
|
# Required. The parent that owns the collection of connection profiles.
|
|
272
272
|
# @param page_size [::Integer]
|
|
273
|
-
# Maximum number of connection profiles to return.
|
|
273
|
+
# Optional. Maximum number of connection profiles to return.
|
|
274
274
|
# If unspecified, at most 50 connection profiles will be returned.
|
|
275
275
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
276
276
|
# @param page_token [::String]
|
|
277
|
-
# Page token received from a previous `ListConnectionProfiles`
|
|
278
|
-
# Provide this to retrieve the subsequent page.
|
|
277
|
+
# Optional. Page token received from a previous `ListConnectionProfiles`
|
|
278
|
+
# call. Provide this to retrieve the subsequent page.
|
|
279
279
|
#
|
|
280
280
|
# When paginating, all other parameters provided to `ListConnectionProfiles`
|
|
281
281
|
# must match the call that provided the page token.
|
|
282
282
|
# @param filter [::String]
|
|
283
|
-
# Filter request.
|
|
283
|
+
# Optional. Filter request.
|
|
284
284
|
# @param order_by [::String]
|
|
285
|
-
# Order by fields for the result.
|
|
285
|
+
# Optional. Order by fields for the result.
|
|
286
286
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
287
287
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastream::V1::ConnectionProfile>]
|
|
288
288
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -764,7 +764,7 @@ module Google
|
|
|
764
764
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
765
765
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
766
766
|
#
|
|
767
|
-
# @overload discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, full_hierarchy: nil, hierarchy_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil, postgresql_rdbms: nil, sql_server_rdbms: nil, salesforce_org: nil, mongodb_cluster: nil)
|
|
767
|
+
# @overload discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, full_hierarchy: nil, hierarchy_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil, postgresql_rdbms: nil, sql_server_rdbms: nil, salesforce_org: nil, mongodb_cluster: nil, spanner_database: nil, source_catalog: nil)
|
|
768
768
|
# Pass arguments to `discover_connection_profile` via keyword arguments. Note that at
|
|
769
769
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
770
770
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -773,46 +773,59 @@ module Google
|
|
|
773
773
|
# Required. The parent resource of the connection profile type. Must be in
|
|
774
774
|
# the format `projects/*/locations/*`.
|
|
775
775
|
# @param connection_profile [::Google::Cloud::Datastream::V1::ConnectionProfile, ::Hash]
|
|
776
|
-
# An ad-hoc connection profile configuration.
|
|
776
|
+
# Optional. An ad-hoc connection profile configuration.
|
|
777
777
|
#
|
|
778
778
|
# Note: The following parameters are mutually exclusive: `connection_profile`, `connection_profile_name`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
779
779
|
# @param connection_profile_name [::String]
|
|
780
|
-
# A reference to an existing connection profile.
|
|
780
|
+
# Optional. A reference to an existing connection profile.
|
|
781
781
|
#
|
|
782
782
|
# Note: The following parameters are mutually exclusive: `connection_profile_name`, `connection_profile`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
783
783
|
# @param full_hierarchy [::Boolean]
|
|
784
|
-
# Whether to retrieve the full hierarchy of data objects (TRUE)
|
|
785
|
-
# current level (FALSE).
|
|
784
|
+
# Optional. Whether to retrieve the full hierarchy of data objects (TRUE)
|
|
785
|
+
# or only the current level (FALSE).
|
|
786
786
|
#
|
|
787
787
|
# Note: The following parameters are mutually exclusive: `full_hierarchy`, `hierarchy_depth`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
788
788
|
# @param hierarchy_depth [::Integer]
|
|
789
|
-
# The number of hierarchy levels below the current level to be
|
|
789
|
+
# Optional. The number of hierarchy levels below the current level to be
|
|
790
|
+
# retrieved.
|
|
790
791
|
#
|
|
791
792
|
# Note: The following parameters are mutually exclusive: `hierarchy_depth`, `full_hierarchy`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
792
793
|
# @param oracle_rdbms [::Google::Cloud::Datastream::V1::OracleRdbms, ::Hash]
|
|
793
|
-
# Oracle RDBMS to enrich with child data objects and metadata.
|
|
794
|
+
# Optional. Oracle RDBMS to enrich with child data objects and metadata.
|
|
794
795
|
#
|
|
795
|
-
# Note: The following parameters are mutually exclusive: `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
796
|
+
# Note: The following parameters are mutually exclusive: `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
796
797
|
# @param mysql_rdbms [::Google::Cloud::Datastream::V1::MysqlRdbms, ::Hash]
|
|
797
|
-
# MySQL RDBMS to enrich with child data objects and metadata.
|
|
798
|
+
# Optional. MySQL RDBMS to enrich with child data objects and metadata.
|
|
798
799
|
#
|
|
799
|
-
# Note: The following parameters are mutually exclusive: `mysql_rdbms`, `oracle_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
800
|
+
# Note: The following parameters are mutually exclusive: `mysql_rdbms`, `oracle_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
800
801
|
# @param postgresql_rdbms [::Google::Cloud::Datastream::V1::PostgresqlRdbms, ::Hash]
|
|
801
|
-
# PostgreSQL RDBMS to enrich with child data objects and
|
|
802
|
+
# Optional. PostgreSQL RDBMS to enrich with child data objects and
|
|
803
|
+
# metadata.
|
|
802
804
|
#
|
|
803
|
-
# Note: The following parameters are mutually exclusive: `postgresql_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
805
|
+
# Note: The following parameters are mutually exclusive: `postgresql_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
804
806
|
# @param sql_server_rdbms [::Google::Cloud::Datastream::V1::SqlServerRdbms, ::Hash]
|
|
805
|
-
# SQLServer RDBMS to enrich with child data objects and metadata.
|
|
807
|
+
# Optional. SQLServer RDBMS to enrich with child data objects and metadata.
|
|
806
808
|
#
|
|
807
|
-
# Note: The following parameters are mutually exclusive: `sql_server_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `salesforce_org`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
809
|
+
# Note: The following parameters are mutually exclusive: `sql_server_rdbms`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
808
810
|
# @param salesforce_org [::Google::Cloud::Datastream::V1::SalesforceOrg, ::Hash]
|
|
809
|
-
# Salesforce organization to enrich with child data objects and
|
|
811
|
+
# Optional. Salesforce organization to enrich with child data objects and
|
|
812
|
+
# metadata.
|
|
810
813
|
#
|
|
811
|
-
# Note: The following parameters are mutually exclusive: `salesforce_org`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `mongodb_cluster`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
814
|
+
# Note: The following parameters are mutually exclusive: `salesforce_org`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `mongodb_cluster`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
812
815
|
# @param mongodb_cluster [::Google::Cloud::Datastream::V1::MongodbCluster, ::Hash]
|
|
813
|
-
# MongoDB cluster to enrich with child data objects and metadata.
|
|
816
|
+
# Optional. MongoDB cluster to enrich with child data objects and metadata.
|
|
817
|
+
#
|
|
818
|
+
# Note: The following parameters are mutually exclusive: `mongodb_cluster`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `spanner_database`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
819
|
+
# @param spanner_database [::Google::Cloud::Datastream::V1::SpannerDatabase, ::Hash]
|
|
820
|
+
# Optional. Spanner database to enrich with child data objects and
|
|
821
|
+
# metadata.
|
|
822
|
+
#
|
|
823
|
+
# Note: The following parameters are mutually exclusive: `spanner_database`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `source_catalog`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
824
|
+
# @param source_catalog [::Google::Cloud::Datastream::V1::SourceCatalog, ::Hash]
|
|
825
|
+
# Optional. Source catalog to enrich with child data objects and metadata.
|
|
826
|
+
# This is mainly used to represent SaaS sources databases.
|
|
814
827
|
#
|
|
815
|
-
# Note: The following parameters are mutually exclusive: `
|
|
828
|
+
# Note: The following parameters are mutually exclusive: `source_catalog`, `oracle_rdbms`, `mysql_rdbms`, `postgresql_rdbms`, `sql_server_rdbms`, `salesforce_org`, `mongodb_cluster`, `spanner_database`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
|
|
816
829
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
817
830
|
# @yieldparam result [::Google::Cloud::Datastream::V1::DiscoverConnectionProfileResponse]
|
|
818
831
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -892,19 +905,19 @@ module Google
|
|
|
892
905
|
# @param parent [::String]
|
|
893
906
|
# Required. The parent that owns the collection of streams.
|
|
894
907
|
# @param page_size [::Integer]
|
|
895
|
-
# Maximum number of streams to return.
|
|
908
|
+
# Optional. Maximum number of streams to return.
|
|
896
909
|
# If unspecified, at most 50 streams will be returned. The maximum
|
|
897
910
|
# value is 1000; values above 1000 will be coerced to 1000.
|
|
898
911
|
# @param page_token [::String]
|
|
899
|
-
# Page token received from a previous `ListStreams` call.
|
|
912
|
+
# Optional. Page token received from a previous `ListStreams` call.
|
|
900
913
|
# Provide this to retrieve the subsequent page.
|
|
901
914
|
#
|
|
902
915
|
# When paginating, all other parameters provided to `ListStreams`
|
|
903
916
|
# must match the call that provided the page token.
|
|
904
917
|
# @param filter [::String]
|
|
905
|
-
# Filter request.
|
|
918
|
+
# Optional. Filter request.
|
|
906
919
|
# @param order_by [::String]
|
|
907
|
-
# Order by fields for the result.
|
|
920
|
+
# Optional. Order by fields for the result.
|
|
908
921
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
909
922
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastream::V1::Stream>]
|
|
910
923
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1643,11 +1656,11 @@ module Google
|
|
|
1643
1656
|
# @param parent [::String]
|
|
1644
1657
|
# Required. The parent stream that owns the collection of objects.
|
|
1645
1658
|
# @param page_size [::Integer]
|
|
1646
|
-
# Maximum number of objects to return. Default is 50.
|
|
1659
|
+
# Optional. Maximum number of objects to return. Default is 50.
|
|
1647
1660
|
# The maximum value is 1000; values above 1000 will be coerced to 1000.
|
|
1648
1661
|
# @param page_token [::String]
|
|
1649
|
-
# Page token received from a previous `ListStreamObjectsRequest`
|
|
1650
|
-
# Provide this to retrieve the subsequent page.
|
|
1662
|
+
# Optional. Page token received from a previous `ListStreamObjectsRequest`
|
|
1663
|
+
# call. Provide this to retrieve the subsequent page.
|
|
1651
1664
|
#
|
|
1652
1665
|
# When paginating, all other parameters provided to
|
|
1653
1666
|
# `ListStreamObjectsRequest` must match the call that provided the page
|
|
@@ -1729,7 +1742,7 @@ module Google
|
|
|
1729
1742
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
1730
1743
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
1731
1744
|
#
|
|
1732
|
-
# @overload start_backfill_job(object: nil)
|
|
1745
|
+
# @overload start_backfill_job(object: nil, event_filter: nil)
|
|
1733
1746
|
# Pass arguments to `start_backfill_job` via keyword arguments. Note that at
|
|
1734
1747
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
1735
1748
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -1737,6 +1750,10 @@ module Google
|
|
|
1737
1750
|
# @param object [::String]
|
|
1738
1751
|
# Required. The name of the stream object resource to start a backfill job
|
|
1739
1752
|
# for.
|
|
1753
|
+
# @param event_filter [::Google::Cloud::Datastream::V1::EventFilter, ::Hash]
|
|
1754
|
+
# Optional. Optional event filter. If not set, or empty, the backfill will be
|
|
1755
|
+
# performed on the entire object. This is currently used for partial backfill
|
|
1756
|
+
# and only supported for SQL sources.
|
|
1740
1757
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1741
1758
|
# @yieldparam result [::Google::Cloud::Datastream::V1::StartBackfillJobResponse]
|
|
1742
1759
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1897,9 +1914,9 @@ module Google
|
|
|
1897
1914
|
# Required. The resource name for the location for which static IPs should be
|
|
1898
1915
|
# returned. Must be in the format `projects/*/locations/*`.
|
|
1899
1916
|
# @param page_size [::Integer]
|
|
1900
|
-
# Maximum number of Ips to return, will likely not be specified.
|
|
1917
|
+
# Optional. Maximum number of Ips to return, will likely not be specified.
|
|
1901
1918
|
# @param page_token [::String]
|
|
1902
|
-
# A page token, received from a previous `ListStaticIps` call.
|
|
1919
|
+
# Optional. A page token, received from a previous `ListStaticIps` call.
|
|
1903
1920
|
# will likely not be specified.
|
|
1904
1921
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1905
1922
|
# @yieldparam result [::Google::Cloud::Datastream::V1::FetchStaticIpsResponse]
|
|
@@ -2176,16 +2193,16 @@ module Google
|
|
|
2176
2193
|
# returned. The maximum value is 1000; values above 1000 will be coerced to
|
|
2177
2194
|
# 1000.
|
|
2178
2195
|
# @param page_token [::String]
|
|
2179
|
-
# Page token received from a previous `ListPrivateConnections`
|
|
2180
|
-
# Provide this to retrieve the subsequent page.
|
|
2196
|
+
# Optional. Page token received from a previous `ListPrivateConnections`
|
|
2197
|
+
# call. Provide this to retrieve the subsequent page.
|
|
2181
2198
|
#
|
|
2182
2199
|
# When paginating, all other parameters provided to
|
|
2183
2200
|
# `ListPrivateConnections` must match the call that provided the page
|
|
2184
2201
|
# token.
|
|
2185
2202
|
# @param filter [::String]
|
|
2186
|
-
# Filter request.
|
|
2203
|
+
# Optional. Filter request.
|
|
2187
2204
|
# @param order_by [::String]
|
|
2188
|
-
# Order by fields for the result.
|
|
2205
|
+
# Optional. Order by fields for the result.
|
|
2189
2206
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2190
2207
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastream::V1::PrivateConnection>]
|
|
2191
2208
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -2560,21 +2577,21 @@ module Google
|
|
|
2560
2577
|
# @param parent [::String]
|
|
2561
2578
|
# Required. The parent that owns the collection of Routess.
|
|
2562
2579
|
# @param page_size [::Integer]
|
|
2563
|
-
# Maximum number of Routes to return. The service may return
|
|
2580
|
+
# Optional. Maximum number of Routes to return. The service may return
|
|
2564
2581
|
# fewer than this value. If unspecified, at most 50 Routes
|
|
2565
2582
|
# will be returned. The maximum value is 1000; values above 1000 will be
|
|
2566
2583
|
# coerced to 1000.
|
|
2567
2584
|
# @param page_token [::String]
|
|
2568
|
-
# Page token received from a previous `ListRoutes` call.
|
|
2585
|
+
# Optional. Page token received from a previous `ListRoutes` call.
|
|
2569
2586
|
# Provide this to retrieve the subsequent page.
|
|
2570
2587
|
#
|
|
2571
2588
|
# When paginating, all other parameters provided to
|
|
2572
2589
|
# `ListRoutes` must match the call that provided the page
|
|
2573
2590
|
# token.
|
|
2574
2591
|
# @param filter [::String]
|
|
2575
|
-
# Filter request.
|
|
2592
|
+
# Optional. Filter request.
|
|
2576
2593
|
# @param order_by [::String]
|
|
2577
|
-
# Order by fields for the result.
|
|
2594
|
+
# Optional. Order by fields for the result.
|
|
2578
2595
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2579
2596
|
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Datastream::V1::Route>]
|
|
2580
2597
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|