GlcoinCore/googleapis
1
0
Fork 0
mirror of https://github.com/googleapis/googleapis.git synced 2026-08-17 13:06:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: Adding public Datastream client based on v1 API version: https://cloud.google.com/datastream/docs

Browse source 
PiperOrigin-RevId: 425538443
This commit is contained in:
Google APIs 2022-01-31 22:35:28 -08:00 • committed by Copybara-Service
parent e3bcc1ee4f
commit 07cb2ca170
5 changed files with 2337 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

365
google/cloud/datastream/v1/BUILD.bazel Normal file
View file

@ -0,0 +1,365 @@
# This file was automatically generated by BuildFileGenerator
# https://github.com/googleapis/rules_gapic/tree/master/bazel
# Most of the manual changes to this file will be overwritten.
# It's **only** allowed to change the following rule attribute values:
# - names of *_gapic_assembly_* rules
# - certain parameters of *_gapic_library rules, including but not limited to:
# * extra_protoc_parameters
# * extra_protoc_file_parameters
# The complete list of preserved parameters can be found in the source code.
# This is an API workspace, having public visibility by default makes perfect sense.
package(default_visibility = ["//visibility:public"])
##############################################################################
# Common
##############################################################################
load("@rules_proto//proto:defs.bzl", "proto_library")
load("@com_google_googleapis_imports//:imports.bzl", "proto_library_with_info")
proto_library(
name = "datastream_proto",
srcs = [
"datastream.proto",
"datastream_resources.proto",
],
deps = [
"//google/api:annotations_proto",
"//google/api:client_proto",
"//google/api:field_behavior_proto",
"//google/api:resource_proto",
"//google/longrunning:operations_proto",
"@com_google_protobuf//:duration_proto",
"@com_google_protobuf//:field_mask_proto",
"@com_google_protobuf//:timestamp_proto",
],
)
proto_library_with_info(
name = "datastream_proto_with_info",
deps = [
":datastream_proto",
"//google/cloud:common_resources_proto",
"//google/cloud/location:location_proto",
],
)
##############################################################################
# Java
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"java_gapic_assembly_gradle_pkg",
"java_gapic_library",
"java_gapic_test",
"java_grpc_library",
"java_proto_library",
)
java_proto_library(
name = "datastream_java_proto",
deps = [":datastream_proto"],
)
java_grpc_library(
name = "datastream_java_grpc",
srcs = [":datastream_proto"],
deps = [":datastream_java_proto"],
)
java_gapic_library(
name = "datastream_java_gapic",
srcs = [":datastream_proto_with_info"],
gapic_yaml = None,
grpc_service_config = "datastream_grpc_service_config.json",
service_yaml = "datastream_v1.yaml",
test_deps = [
":datastream_java_grpc",
"//google/cloud/location:location_java_grpc",
],
deps = [
":datastream_java_proto",
"//google/api:api_java_proto",
"//google/cloud/location:location_java_proto",
],
)
java_gapic_test(
name = "datastream_java_gapic_test_suite",
test_classes = [
"com.google.cloud.datastream.v1.DatastreamClientTest",
],
runtime_deps = [":datastream_java_gapic_test"],
)
# Open Source Packages
java_gapic_assembly_gradle_pkg(
name = "google-cloud-datastream-v1-java",
deps = [
":datastream_java_gapic",
":datastream_java_grpc",
":datastream_java_proto",
":datastream_proto",
],
)
##############################################################################
# Go
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"go_gapic_assembly_pkg",
"go_gapic_library",
"go_proto_library",
"go_test",
)
go_proto_library(
name = "datastream_go_proto",
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
importpath = "google.golang.org/genproto/googleapis/cloud/datastream/v1",
protos = [":datastream_proto"],
deps = [
"//google/api:annotations_go_proto",
"//google/longrunning:longrunning_go_proto",
],
)
go_gapic_library(
name = "datastream_go_gapic",
srcs = [":datastream_proto_with_info"],
grpc_service_config = "datastream_grpc_service_config.json",
importpath = "cloud.google.com/go/datastream/apiv1;datastream",
metadata = True,
service_yaml = "datastream_v1.yaml",
deps = [
":datastream_go_proto",
"//google/cloud/location:location_go_proto",
"//google/longrunning:longrunning_go_proto",
"@com_google_cloud_go//longrunning:go_default_library",
"@com_google_cloud_go//longrunning/autogen:go_default_library",
"@io_bazel_rules_go//proto/wkt:duration_go_proto",
],
)
go_test(
name = "datastream_go_gapic_test",
srcs = [":datastream_go_gapic_srcjar_test"],
embed = [":datastream_go_gapic"],
importpath = "cloud.google.com/go/datastream/apiv1",
)
# Open Source Packages
go_gapic_assembly_pkg(
name = "gapi-cloud-datastream-v1-go",
deps = [
":datastream_go_gapic",
":datastream_go_gapic_srcjar-metadata.srcjar",
":datastream_go_gapic_srcjar-test.srcjar",
":datastream_go_proto",
],
)
##############################################################################
# Python
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"py_gapic_assembly_pkg",
"py_gapic_library",
)
py_gapic_library(
name = "datastream_py_gapic",
srcs = [":datastream_proto"],
grpc_service_config = "datastream_grpc_service_config.json",
)
# Open Source Packages
py_gapic_assembly_pkg(
name = "datastream-v1-py",
deps = [
":datastream_py_gapic",
],
)
##############################################################################
# PHP
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"php_gapic_assembly_pkg",
"php_gapic_library",
"php_grpc_library",
"php_proto_library",
)
php_proto_library(
name = "datastream_php_proto",
deps = [":datastream_proto"],
)
php_grpc_library(
name = "datastream_php_grpc",
srcs = [":datastream_proto"],
deps = [":datastream_php_proto"],
)
php_gapic_library(
name = "datastream_php_gapic",
srcs = [":datastream_proto_with_info"],
grpc_service_config = "datastream_grpc_service_config.json",
service_yaml = "datastream_v1.yaml",
deps = [
":datastream_php_grpc",
":datastream_php_proto",
],
)
# Open Source Packages
php_gapic_assembly_pkg(
name = "google-cloud-datastream-v1-php",
deps = [
":datastream_php_gapic",
":datastream_php_grpc",
":datastream_php_proto",
],
)
##############################################################################
# Node.js
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"nodejs_gapic_assembly_pkg",
"nodejs_gapic_library",
)
nodejs_gapic_library(
name = "datastream_nodejs_gapic",
package_name = "@google-cloud/datastream",
src = ":datastream_proto_with_info",
extra_protoc_parameters = ["metadata"],
grpc_service_config = "datastream_grpc_service_config.json",
package = "google.cloud.datastream.v1",
service_yaml = "datastream_v1.yaml",
deps = [],
)
nodejs_gapic_assembly_pkg(
name = "datastream-v1-nodejs",
deps = [
":datastream_nodejs_gapic",
":datastream_proto",
],
)
##############################################################################
# Ruby
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"ruby_cloud_gapic_library",
"ruby_gapic_assembly_pkg",
"ruby_grpc_library",
"ruby_proto_library",
)
ruby_proto_library(
name = "datastream_ruby_proto",
deps = [":datastream_proto"],
)
ruby_grpc_library(
name = "datastream_ruby_grpc",
srcs = [":datastream_proto"],
deps = [":datastream_ruby_proto"],
)
ruby_cloud_gapic_library(
name = "datastream_ruby_gapic",
srcs = [":datastream_proto_with_info"],
extra_protoc_parameters = [
"ruby-cloud-gem-name=google-cloud-datastream-v1",
],
grpc_service_config = "datastream_grpc_service_config.json",
deps = [
":datastream_ruby_grpc",
":datastream_ruby_proto",
],
)
# Open Source Packages
ruby_gapic_assembly_pkg(
name = "google-cloud-datastream-v1-ruby",
deps = [
":datastream_ruby_gapic",
":datastream_ruby_grpc",
":datastream_ruby_proto",
],
)
##############################################################################
# C#
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"csharp_gapic_assembly_pkg",
"csharp_gapic_library",
"csharp_grpc_library",
"csharp_proto_library",
)
csharp_proto_library(
name = "datastream_csharp_proto",
deps = [":datastream_proto"],
)
csharp_grpc_library(
name = "datastream_csharp_grpc",
srcs = [":datastream_proto"],
deps = [":datastream_csharp_proto"],
)
csharp_gapic_library(
name = "datastream_csharp_gapic",
srcs = [":datastream_proto_with_info"],
common_resources_config = "@gax_dotnet//:Google.Api.Gax/ResourceNames/CommonResourcesConfig.json",
grpc_service_config = "datastream_grpc_service_config.json",
deps = [
":datastream_csharp_grpc",
":datastream_csharp_proto",
],
)
# Open Source Packages
csharp_gapic_assembly_pkg(
name = "google-cloud-datastream-v1-csharp",
deps = [
":datastream_csharp_gapic",
":datastream_csharp_grpc",
":datastream_csharp_proto",
],
)
##############################################################################
# C++
##############################################################################
load(
"@com_google_googleapis_imports//:imports.bzl",
"cc_grpc_library",
"cc_proto_library",
)
cc_proto_library(
name = "datastream_cc_proto",
deps = [":datastream_proto"],
)
cc_grpc_library(
name = "datastream_cc_grpc",
srcs = [":datastream_proto"],
grpc_only = True,
deps = [":datastream_cc_proto"],
)

1036
google/cloud/datastream/v1/datastream.proto Normal file
View file

File diff suppressed because it is too large Load diff

29
google/cloud/datastream/v1/datastream_grpc_service_config.json Normal file
View file

@ -0,0 +1,29 @@
{
"methodConfig": [{
"name": [{ "service": "google.cloud.datastream.v1.Datastream" }],
"timeout": "60s",
"retryPolicy": {
"maxAttempts": 5,
"initialBackoff": "1s",
"maxBackoff": "10s",
"backoffMultiplier": 1.3,
"retryableStatusCodes": ["UNAVAILABLE"]
}
},
{
"name": [
{ "service": "google.cloud.datastream.v1.Datastream", "method": "CreateConnectionProfile" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "UpdateConnectionProfile" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "GenerateConnectionProfileReport" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "DeleteConnectionProfile" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "CreateStream" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "UpdateStream" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "DeleteStream" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "CreatePrivateConnection" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "DeletePrivateConnection" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "CreateRoute" },
{ "service": "google.cloud.datastream.v1.Datastream", "method": "DeleteRoute" }
],
"timeout": "60s"
}]
}

836
google/cloud/datastream/v1/datastream_resources.proto Normal file
View file

@ -0,0 +1,836 @@
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.datastream.v1;
import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Datastream.V1";
option go_package = "google.golang.org/genproto/googleapis/cloud/datastream/v1;datastream";
option java_multiple_files = true;
option java_outer_classname = "DatastreamResourcesProto";
option java_package = "com.google.cloud.datastream.v1";
option php_namespace = "Google\\Cloud\\Datastream\\V1";
option ruby_package = "Google::Cloud::Datastream::V1";
option (google.api.resource_definition) = {
type: "compute.googleapis.com/Networks"
pattern: "projects/{project}/global/networks/{network}"
};
// Oracle database profile.
message OracleProfile {
// Required. Hostname for the Oracle connection.
string hostname = 1 [(google.api.field_behavior) = REQUIRED];
// Port for the Oracle connection, default value is 1521.
int32 port = 2;
// Required. Username for the Oracle connection.
string username = 3 [(google.api.field_behavior) = REQUIRED];
// Required. Password for the Oracle connection.
string password = 4 [(google.api.field_behavior) = REQUIRED];
// Required. Database for the Oracle connection.
string database_service = 5 [(google.api.field_behavior) = REQUIRED];
// Connection string attributes
map<string, string> connection_attributes = 6;
}
// MySQL database profile.
message MysqlProfile {
// Required. Hostname for the MySQL connection.
string hostname = 1 [(google.api.field_behavior) = REQUIRED];
// Port for the MySQL connection, default value is 3306.
int32 port = 2;
// Required. Username for the MySQL connection.
string username = 3 [(google.api.field_behavior) = REQUIRED];
// Required. Input only. Password for the MySQL connection.
string password = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = INPUT_ONLY
];
// SSL configuration for the MySQL connection.
MysqlSslConfig ssl_config = 5;
}
// Cloud Storage bucket profile.
message GcsProfile {
// Required. The Cloud Storage bucket name.
string bucket = 1 [(google.api.field_behavior) = REQUIRED];
// The root path inside the Cloud Storage bucket.
string root_path = 2;
}
// Static IP address connectivity.
message StaticServiceIpConnectivity {}
// Forward SSH Tunnel connectivity.
message ForwardSshTunnelConnectivity {
// Required. Hostname for the SSH tunnel.
string hostname = 1 [(google.api.field_behavior) = REQUIRED];
// Required. Username for the SSH tunnel.
string username = 2 [(google.api.field_behavior) = REQUIRED];
// Port for the SSH tunnel, default value is 22.
int32 port = 3;
oneof authentication_method {
// Input only. SSH password.
string password = 100 [(google.api.field_behavior) = INPUT_ONLY];
// Input only. SSH private key.
string private_key = 101 [(google.api.field_behavior) = INPUT_ONLY];
}
}
// The VPC Peering configuration is used to create VPC peering between
// Datastream and the consumer's VPC.
message VpcPeeringConfig {
// Required. Fully qualified name of the VPC that Datastream will peer to.
// Format: `projects/{project}/global/{networks}/{name}`
string vpc = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "compute.googleapis.com/Networks"
}
];
// Required. A free subnet for peering. (CIDR of /29)
string subnet = 2 [(google.api.field_behavior) = REQUIRED];
}
// The PrivateConnection resource is used to establish private connectivity
// between Datastream and a customer's network.
message PrivateConnection {
option (google.api.resource) = {
type: "datastream.googleapis.com/PrivateConnection"
pattern: "projects/{project}/locations/{location}/privateConnections/{private_connection}"
};
// Private Connection state.
enum State {
// Unspecified state.
STATE_UNSPECIFIED = 0;
// The private connection is in creation state - creating resources.
CREATING = 1;
// The private connection has been created with all of its resources.
CREATED = 2;
// The private connection creation has failed.
FAILED = 3;
// The private connection is being deleted.
DELETING = 4;
// Delete request has failed, resource is in invalid state.
FAILED_TO_DELETE = 5;
}
// Output only. The resource's name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The create time of the resource.
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The update time of the resource.
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Labels.
map<string, string> labels = 4;
// Required. Display name.
string display_name = 5 [(google.api.field_behavior) = REQUIRED];
// Output only. The state of the Private Connection.
State state = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. In case of error, the details of the error in a user-friendly
// format.
Error error = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
// VPC Peering Config.
VpcPeeringConfig vpc_peering_config = 100;
}
// Private Connectivity
message PrivateConnectivity {
// Required. A reference to a private connection resource.
// Format: `projects/{project}/locations/{location}/privateConnections/{name}`
string private_connection = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datastream.googleapis.com/PrivateConnection"
}
];
}
// The route resource is the child of the private connection resource,
// used for defining a route for a private connection.
message Route {
option (google.api.resource) = {
type: "datastream.googleapis.com/Route"
pattern: "projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}"
};
// Output only. The resource's name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The create time of the resource.
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The update time of the resource.
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Labels.
map<string, string> labels = 4;
// Required. Display name.
string display_name = 5 [(google.api.field_behavior) = REQUIRED];
// Required. Destination address for connection
string destination_address = 6 [(google.api.field_behavior) = REQUIRED];
// Destination port for connection
int32 destination_port = 7;
}
// MySQL SSL configuration information.
message MysqlSslConfig {
// Input only. PEM-encoded private key associated with the Client Certificate.
// If this field is used then the 'client_certificate' and the
// 'ca_certificate' fields are mandatory.
string client_key = 1 [(google.api.field_behavior) = INPUT_ONLY];
// Output only. Indicates whether the client_key field is set.
bool client_key_set = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Input only. PEM-encoded certificate that will be used by the replica to
// authenticate against the source database server. If this field is used
// then the 'client_key' and the 'ca_certificate' fields are mandatory.
string client_certificate = 3 [(google.api.field_behavior) = INPUT_ONLY];
// Output only. Indicates whether the client_certificate field is set.
bool client_certificate_set = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Input only. PEM-encoded certificate of the CA that signed the source
// database server's certificate.
string ca_certificate = 5 [(google.api.field_behavior) = INPUT_ONLY];
// Output only. Indicates whether the ca_certificate field is set.
bool ca_certificate_set = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// A set of reusable connection configurations to be used as a source or
// destination for a stream.
message ConnectionProfile {
option (google.api.resource) = {
type: "datastream.googleapis.com/ConnectionProfile"
pattern: "projects/{project}/locations/{location}/connectionProfiles/{connection_profile}"
};
// Output only. The resource's name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The create time of the resource.
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The update time of the resource.
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Labels.
map<string, string> labels = 4;
// Required. Display name.
string display_name = 5 [(google.api.field_behavior) = REQUIRED];
// Connection configuration for the ConnectionProfile.
oneof profile {
// Oracle ConnectionProfile configuration.
OracleProfile oracle_profile = 100;
// Cloud Storage ConnectionProfile configuration.
GcsProfile gcs_profile = 101;
// MySQL ConnectionProfile configuration.
MysqlProfile mysql_profile = 102;
}
// Connectivity options used to establish a connection to the profile.
oneof connectivity {
// Static Service IP connectivity.
StaticServiceIpConnectivity static_service_ip_connectivity = 200;
// Forward SSH tunnel connectivity.
ForwardSshTunnelConnectivity forward_ssh_connectivity = 201;
// Private connectivity.
PrivateConnectivity private_connectivity = 202;
}
}
// Oracle Column.
message OracleColumn {
// Column name.
string column = 1;
// The Oracle data type.
string data_type = 2;
// Column length.
int32 length = 3;
// Column precision.
int32 precision = 4;
// Column scale.
int32 scale = 5;
// Column encoding.
string encoding = 6;
// Whether or not the column represents a primary key.
bool primary_key = 7;
// Whether or not the column can accept a null value.
bool nullable = 8;
// The ordinal position of the column in the table.
int32 ordinal_position = 9;
}
// Oracle table.
message OracleTable {
// Table name.
string table = 1;
// Oracle columns in the schema.
// When unspecified as part of inclue/exclude lists, includes/excludes
// everything.
repeated OracleColumn oracle_columns = 2;
}
// Oracle schema.
message OracleSchema {
// Schema name.
string schema = 1;
// Tables in the schema.
repeated OracleTable oracle_tables = 2;
}
// Oracle database structure.
message OracleRdbms {
// Oracle schemas/databases in the database server.
repeated OracleSchema oracle_schemas = 1;
}
// Oracle data source configuration
message OracleSourceConfig {
// Oracle objects to include in the stream.
OracleRdbms include_objects = 1;
// Oracle objects to exclude from the stream.
OracleRdbms exclude_objects = 2;
}
// MySQL Column.
message MysqlColumn {
// Column name.
string column = 1;
// The MySQL data type. Full data types list can be found here:
// https://dev.mysql.com/doc/refman/8.0/en/data-types.html
string data_type = 2;
// Column length.
int32 length = 3;
// Column collation.
string collation = 4;
// Whether or not the column represents a primary key.
bool primary_key = 5;
// Whether or not the column can accept a null value.
bool nullable = 6;
// The ordinal position of the column in the table.
int32 ordinal_position = 7;
}
// MySQL table.
message MysqlTable {
// Table name.
string table = 1;
// MySQL columns in the database.
// When unspecified as part of include/exclude lists, includes/excludes
// everything.
repeated MysqlColumn mysql_columns = 2;
}
// MySQL database.
message MysqlDatabase {
// Database name.
string database = 1;
// Tables in the database.
repeated MysqlTable mysql_tables = 2;
}
// MySQL database structure
message MysqlRdbms {
// Mysql databases on the server
repeated MysqlDatabase mysql_databases = 1;
}
// MySQL source configuration
message MysqlSourceConfig {
// MySQL objects to retrieve from the source.
MysqlRdbms include_objects = 1;
// MySQL objects to exclude from the stream.
MysqlRdbms exclude_objects = 2;
}
// The configuration of the stream source.
message SourceConfig {
// Required. Source connection profile resoource.
// Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
string source_connection_profile = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datastream.googleapis.com/ConnectionProfile"
}
];
// Stream configuration that is specific to the data source type.
oneof source_stream_config {
// Oracle data source configuration
OracleSourceConfig oracle_source_config = 100;
// MySQL data source configuration
MysqlSourceConfig mysql_source_config = 101;
}
}
// AVRO file format configuration.
message AvroFileFormat {}
// JSON file format configuration.
message JsonFileFormat {
// Schema file format.
enum SchemaFileFormat {
// Unspecified schema file format.
SCHEMA_FILE_FORMAT_UNSPECIFIED = 0;
// Do not attach schema file.
NO_SCHEMA_FILE = 1;
// Avro schema format.
AVRO_SCHEMA_FILE = 2;
}
// Json file compression.
enum JsonCompression {
// Unspecified json file compression.
JSON_COMPRESSION_UNSPECIFIED = 0;
// Do not compress JSON file.
NO_COMPRESSION = 1;
// Gzip compression.
GZIP = 2;
}
// The schema file format along JSON data files.
SchemaFileFormat schema_file_format = 1;
// Compression of the loaded JSON file.
JsonCompression compression = 2;
}
// Google Cloud Storage destination configuration
message GcsDestinationConfig {
// Path inside the Cloud Storage bucket to write data to.
string path = 1;
// The maximum file size to be saved in the bucket.
int32 file_rotation_mb = 2;
// The maximum duration for which new events are added before a file is
// closed and a new file is created.
google.protobuf.Duration file_rotation_interval = 3;
// File Format that the data should be written in.
oneof file_format {
// AVRO file format configuration.
AvroFileFormat avro_file_format = 100;
// JSON file format configuration.
JsonFileFormat json_file_format = 101;
}
}
// The configuration of the stream destination.
message DestinationConfig {
// Required. Destination connection profile resource.
// Format: `projects/{project}/locations/{location}/connectionProfiles/{name}`
string destination_connection_profile = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "datastream.googleapis.com/ConnectionProfile"
}
];
// Stream configuration that is specific to the data destination type.
oneof destination_stream_config {
// A configuration for how data should be loaded to Cloud Storage.
GcsDestinationConfig gcs_destination_config = 100;
}
}
// A resource representing streaming data from a source to a destination.
message Stream {
option (google.api.resource) = {
type: "datastream.googleapis.com/Stream"
pattern: "projects/{project}/locations/{location}/streams/{stream}"
};
// Stream state.
enum State {
// Unspecified stream state.
STATE_UNSPECIFIED = 0;
// The stream has been created but has not yet started streaming data.
NOT_STARTED = 1;
// The stream is running.
RUNNING = 2;
// The stream is paused.
PAUSED = 3;
// The stream is in maintenance mode.
//
// Updates are rejected on the resource in this state.
MAINTENANCE = 4;
// The stream is experiencing an error that is preventing data from being
// streamed.
FAILED = 5;
// The stream has experienced a terminal failure.
FAILED_PERMANENTLY = 6;
// The stream is starting, but not yet running.
STARTING = 7;
// The Stream is no longer reading new events, but still writing events in
// the buffer.
DRAINING = 8;
}
// Backfill strategy to automatically backfill the Stream's objects.
// Specific objects can be excluded.
message BackfillAllStrategy {
// List of objects to exclude.
oneof excluded_objects {
// Oracle data source objects to avoid backfilling.
OracleRdbms oracle_excluded_objects = 1;
// MySQL data source objects to avoid backfilling.
MysqlRdbms mysql_excluded_objects = 2;
}
}
// Backfill strategy to disable automatic backfill for the Stream's objects.
message BackfillNoneStrategy {}
// Output only. The stream's name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The creation time of the stream.
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last update time of the stream.
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Labels.
map<string, string> labels = 4;
// Required. Display name.
string display_name = 5 [(google.api.field_behavior) = REQUIRED];
// Required. Source connection profile configuration.
SourceConfig source_config = 6 [(google.api.field_behavior) = REQUIRED];
// Required. Destination connection profile configuration.
DestinationConfig destination_config = 7
[(google.api.field_behavior) = REQUIRED];
// The state of the stream.
State state = 8;
// Stream backfill strategy.
oneof backfill_strategy {
// Automatically backfill objects included in the stream source
// configuration. Specific objects can be excluded.
BackfillAllStrategy backfill_all = 101;
// Do not automatically backfill any objects.
BackfillNoneStrategy backfill_none = 102;
}
// Output only. Errors on the Stream.
repeated Error errors = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
// Immutable. A reference to a KMS encryption key.
// If provided, it will be used to encrypt the data.
// If left blank, data will be encrypted using an internal Stream-specific
// encryption key provisioned through KMS.
optional string customer_managed_encryption_key = 10
[(google.api.field_behavior) = IMMUTABLE];
}
// A specific stream object (e.g a specific DB table).
message StreamObject {
option (google.api.resource) = {
type: "datastream.googleapis.com/StreamObject"
pattern: "projects/{project}/locations/{location}/streams/{stream}/objects/{object}"
};
// Output only. The object resource's name.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The creation time of the object.
google.protobuf.Timestamp create_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The last update time of the object.
google.protobuf.Timestamp update_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Required. Display name.
string display_name = 5 [(google.api.field_behavior) = REQUIRED];
// Output only. Active errors on the object.
repeated Error errors = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
// The latest backfill job that was initiated for the stream object.
BackfillJob backfill_job = 7;
// The object identifier in the data source.
SourceObjectIdentifier source_object = 8;
}
// Represents an identifier of an object in the data source.
message SourceObjectIdentifier {
// Oracle data source object identifier.
message OracleObjectIdentifier {
// Required. The schema name.
string schema = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The table name.
string table = 2 [(google.api.field_behavior) = REQUIRED];
}
// Mysql data source object identifier.
message MysqlObjectIdentifier {
// Required. The database name.
string database = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The table name.
string table = 2 [(google.api.field_behavior) = REQUIRED];
}
// The identifier for an object in the data source.
oneof source_identifier {
// Oracle data source object identifier.
OracleObjectIdentifier oracle_identifier = 1;
// Mysql data source object identifier.
MysqlObjectIdentifier mysql_identifier = 2;
}
}
// Represents a backfill job on a specific stream object.
message BackfillJob {
// State of the stream object's backfill job.
enum State {
// Default value.
STATE_UNSPECIFIED = 0;
// Backfill job was never started for the stream object (stream has backfill
// strategy defined as manual or object was explicitly excluded from
// automatic backfill).
NOT_STARTED = 1;
// Backfill job will start pending available resources.
PENDING = 2;
// Backfill job is running.
ACTIVE = 3;
// Backfill job stopped (next job run will start from beginning).
STOPPED = 4;
// Backfill job failed (due to an error).
FAILED = 5;
// Backfill completed successfully.
COMPLETED = 6;
// Backfill job failed since the table structure is currently unsupported
// for backfill.
UNSUPPORTED = 7;
}
// Triggering reason for a backfill job.
enum Trigger {
// Default value.
TRIGGER_UNSPECIFIED = 0;
// Object backfill job was triggered automatically according to the stream's
// backfill strategy.
AUTOMATIC = 1;
// Object backfill job was triggered manually using the dedicated API.
MANUAL = 2;
}
// Backfill job state.
State state = 1;
// Backfill job's triggering reason.
Trigger trigger = 2;
// Output only. Backfill job's start time.
google.protobuf.Timestamp last_start_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Backfill job's end time.
google.protobuf.Timestamp last_end_time = 4
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Errors which caused the backfill job to fail.
repeated Error errors = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
// Represent a user-facing Error.
message Error {
// A title that explains the reason for the error.
string reason = 1;
// A unique identifier for this specific error,
// allowing it to be traced throughout the system in logs and API responses.
string error_uuid = 2;
// A message containing more information about the error that occurred.
string message = 3;
// The time when the error occurred.
google.protobuf.Timestamp error_time = 4;
// Additional information about the error.
map<string, string> details = 5;
}
// Contains the current validation results.
message ValidationResult {
// A list of validations (includes both executed as well as not executed
// validations).
repeated Validation validations = 1;
}
// A validation to perform on a stream.
message Validation {
// Validation execution state.
enum State {
// Unspecified state.
STATE_UNSPECIFIED = 0;
// Validation did not execute.
NOT_EXECUTED = 1;
// Validation failed.
FAILED = 2;
// Validation passed.
PASSED = 3;
}
// A short description of the validation.
string description = 1;
// Validation execution status.
State state = 2;
// Messages reflecting the validation results.
repeated ValidationMessage message = 3;
// A custom code identifying this validation.
string code = 4;
}
// Represent user-facing validation result message.
message ValidationMessage {
// Validation message level.
enum Level {
// Unspecified level.
LEVEL_UNSPECIFIED = 0;
// Potentially cause issues with the Stream.
WARNING = 1;
// Definitely cause issues with the Stream.
ERROR = 2;
}
// The result of the validation.
string message = 1;
// Message severity level (warning or error).
Level level = 2;
// Additional metadata related to the result.
map<string, string> metadata = 3;
// A custom code identifying this specific message.
string code = 4;
}

71
google/cloud/datastream/v1/datastream_v1.yaml Normal file
View file

@ -0,0 +1,71 @@
type: google.api.Service
config_version: 3
name: datastream.googleapis.com
title: Datastream API
apis:
- name: google.cloud.datastream.v1.Datastream
- name: google.cloud.location.Locations
types:
- name: google.cloud.datastream.v1.Error
- name: google.cloud.datastream.v1.OperationMetadata
- name: google.cloud.datastream.v1.ValidationResult
documentation:
rules:
- selector: google.cloud.location.Locations.GetLocation
description: Gets information about a location.
- selector: google.cloud.location.Locations.ListLocations
description: Lists information about the supported locations for this service.
backend:
rules:
- selector: 'google.cloud.datastream.v1.Datastream.*'
deadline: 60.0
- selector: google.cloud.datastream.v1.Datastream.DiscoverConnectionProfile
deadline: 120.0
- selector: google.cloud.datastream.v1.Datastream.StartBackfillJob
deadline: 120.0
- selector: google.cloud.location.Locations.GetLocation
deadline: 60.0
- selector: google.cloud.location.Locations.ListLocations
deadline: 60.0
- selector: 'google.longrunning.Operations.*'
deadline: 60.0
http:
rules:
- selector: google.cloud.location.Locations.GetLocation
get: '/v1/{name=projects/*/locations/*}'
- selector: google.cloud.location.Locations.ListLocations
get: '/v1/{name=projects/*}/locations'
- selector: google.longrunning.Operations.CancelOperation
post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
body: '*'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.GetOperation
get: '/v1/{name=projects/*/locations/*/operations/*}'
- selector: google.longrunning.Operations.ListOperations
get: '/v1/{name=projects/*/locations/*}/operations'
authentication:
rules:
- selector: 'google.cloud.datastream.v1.Datastream.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.location.Locations.GetLocation
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: google.cloud.location.Locations.ListLocations
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform
- selector: 'google.longrunning.Operations.*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform