|
|
|
@ -1,4 +1,4 @@ |
|
|
|
|
// Copyright 2022 Google LLC |
|
|
|
|
// Copyright 2023 Google LLC |
|
|
|
|
// |
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); |
|
|
|
|
// you may not use this file except in compliance with the License. |
|
|
|
@ -22,6 +22,7 @@ import "google/api/field_behavior.proto"; |
|
|
|
|
import "google/api/resource.proto"; |
|
|
|
|
import "google/cloud/datastream/v1/datastream_resources.proto"; |
|
|
|
|
import "google/longrunning/operations.proto"; |
|
|
|
|
import "google/protobuf/empty.proto"; |
|
|
|
|
import "google/protobuf/field_mask.proto"; |
|
|
|
|
import "google/protobuf/timestamp.proto"; |
|
|
|
|
|
|
|
|
@ -36,11 +37,13 @@ option ruby_package = "Google::Cloud::Datastream::V1"; |
|
|
|
|
// Datastream service |
|
|
|
|
service Datastream { |
|
|
|
|
option (google.api.default_host) = "datastream.googleapis.com"; |
|
|
|
|
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform"; |
|
|
|
|
option (google.api.oauth_scopes) = |
|
|
|
|
"https://www.googleapis.com/auth/cloud-platform"; |
|
|
|
|
|
|
|
|
|
// Use this method to list connection profiles created in a project and |
|
|
|
|
// location. |
|
|
|
|
rpc ListConnectionProfiles(ListConnectionProfilesRequest) returns (ListConnectionProfilesResponse) { |
|
|
|
|
rpc ListConnectionProfiles(ListConnectionProfilesRequest) |
|
|
|
|
returns (ListConnectionProfilesResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{parent=projects/*/locations/*}/connectionProfiles" |
|
|
|
|
}; |
|
|
|
@ -48,7 +51,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to get details about a connection profile. |
|
|
|
|
rpc GetConnectionProfile(GetConnectionProfileRequest) returns (ConnectionProfile) { |
|
|
|
|
rpc GetConnectionProfile(GetConnectionProfileRequest) |
|
|
|
|
returns (ConnectionProfile) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{name=projects/*/locations/*/connectionProfiles/*}" |
|
|
|
|
}; |
|
|
|
@ -56,12 +60,14 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to create a connection profile in a project and location. |
|
|
|
|
rpc CreateConnectionProfile(CreateConnectionProfileRequest) returns (google.longrunning.Operation) { |
|
|
|
|
rpc CreateConnectionProfile(CreateConnectionProfileRequest) |
|
|
|
|
returns (google.longrunning.Operation) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{parent=projects/*/locations/*}/connectionProfiles" |
|
|
|
|
body: "connection_profile" |
|
|
|
|
}; |
|
|
|
|
option (google.api.method_signature) = "parent,connection_profile,connection_profile_id"; |
|
|
|
|
option (google.api.method_signature) = |
|
|
|
|
"parent,connection_profile,connection_profile_id"; |
|
|
|
|
option (google.longrunning.operation_info) = { |
|
|
|
|
response_type: "ConnectionProfile" |
|
|
|
|
metadata_type: "OperationMetadata" |
|
|
|
@ -69,7 +75,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to update the parameters of a connection profile. |
|
|
|
|
rpc UpdateConnectionProfile(UpdateConnectionProfileRequest) returns (google.longrunning.Operation) { |
|
|
|
|
rpc UpdateConnectionProfile(UpdateConnectionProfileRequest) |
|
|
|
|
returns (google.longrunning.Operation) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
patch: "/v1/{connection_profile.name=projects/*/locations/*/connectionProfiles/*}" |
|
|
|
|
body: "connection_profile" |
|
|
|
@ -82,7 +89,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to delete a connection profile. |
|
|
|
|
rpc DeleteConnectionProfile(DeleteConnectionProfileRequest) returns (google.longrunning.Operation) { |
|
|
|
|
rpc DeleteConnectionProfile(DeleteConnectionProfileRequest) |
|
|
|
|
returns (google.longrunning.Operation) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
delete: "/v1/{name=projects/*/locations/*/connectionProfiles/*}" |
|
|
|
|
}; |
|
|
|
@ -97,7 +105,8 @@ service Datastream { |
|
|
|
|
// The discover API call exposes the data objects and metadata belonging to |
|
|
|
|
// the profile. Typically, a request returns children data objects of a |
|
|
|
|
// parent data object that's optionally supplied in the request. |
|
|
|
|
rpc DiscoverConnectionProfile(DiscoverConnectionProfileRequest) returns (DiscoverConnectionProfileResponse) { |
|
|
|
|
rpc DiscoverConnectionProfile(DiscoverConnectionProfileRequest) |
|
|
|
|
returns (DiscoverConnectionProfileResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{parent=projects/*/locations/*}/connectionProfiles:discover" |
|
|
|
|
body: "*" |
|
|
|
@ -175,7 +184,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to list the objects of a specific stream. |
|
|
|
|
rpc ListStreamObjects(ListStreamObjectsRequest) returns (ListStreamObjectsResponse) { |
|
|
|
|
rpc ListStreamObjects(ListStreamObjectsRequest) |
|
|
|
|
returns (ListStreamObjectsResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{parent=projects/*/locations/*/streams/*}/objects" |
|
|
|
|
}; |
|
|
|
@ -183,7 +193,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to start a backfill job for the specified stream object. |
|
|
|
|
rpc StartBackfillJob(StartBackfillJobRequest) returns (StartBackfillJobResponse) { |
|
|
|
|
rpc StartBackfillJob(StartBackfillJobRequest) |
|
|
|
|
returns (StartBackfillJobResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{object=projects/*/locations/*/streams/*/objects/*}:startBackfillJob" |
|
|
|
|
body: "*" |
|
|
|
@ -192,7 +203,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to stop a backfill job for the specified stream object. |
|
|
|
|
rpc StopBackfillJob(StopBackfillJobRequest) returns (StopBackfillJobResponse) { |
|
|
|
|
rpc StopBackfillJob(StopBackfillJobRequest) |
|
|
|
|
returns (StopBackfillJobResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{object=projects/*/locations/*/streams/*/objects/*}:stopBackfillJob" |
|
|
|
|
body: "*" |
|
|
|
@ -210,12 +222,14 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to create a private connectivity configuration. |
|
|
|
|
rpc CreatePrivateConnection(CreatePrivateConnectionRequest) returns (google.longrunning.Operation) { |
|
|
|
|
rpc CreatePrivateConnection(CreatePrivateConnectionRequest) |
|
|
|
|
returns (google.longrunning.Operation) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
post: "/v1/{parent=projects/*/locations/*}/privateConnections" |
|
|
|
|
body: "private_connection" |
|
|
|
|
}; |
|
|
|
|
option (google.api.method_signature) = "parent,private_connection,private_connection_id"; |
|
|
|
|
option (google.api.method_signature) = |
|
|
|
|
"parent,private_connection,private_connection_id"; |
|
|
|
|
option (google.longrunning.operation_info) = { |
|
|
|
|
response_type: "PrivateConnection" |
|
|
|
|
metadata_type: "OperationMetadata" |
|
|
|
@ -223,7 +237,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to get details about a private connectivity configuration. |
|
|
|
|
rpc GetPrivateConnection(GetPrivateConnectionRequest) returns (PrivateConnection) { |
|
|
|
|
rpc GetPrivateConnection(GetPrivateConnectionRequest) |
|
|
|
|
returns (PrivateConnection) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{name=projects/*/locations/*/privateConnections/*}" |
|
|
|
|
}; |
|
|
|
@ -232,7 +247,8 @@ service Datastream { |
|
|
|
|
|
|
|
|
|
// Use this method to list private connectivity configurations in a project |
|
|
|
|
// and location. |
|
|
|
|
rpc ListPrivateConnections(ListPrivateConnectionsRequest) returns (ListPrivateConnectionsResponse) { |
|
|
|
|
rpc ListPrivateConnections(ListPrivateConnectionsRequest) |
|
|
|
|
returns (ListPrivateConnectionsResponse) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
get: "/v1/{parent=projects/*/locations/*}/privateConnections" |
|
|
|
|
}; |
|
|
|
@ -240,7 +256,8 @@ service Datastream { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Use this method to delete a private connectivity configuration. |
|
|
|
|
rpc DeletePrivateConnection(DeletePrivateConnectionRequest) returns (google.longrunning.Operation) { |
|
|
|
|
rpc DeletePrivateConnection(DeletePrivateConnectionRequest) |
|
|
|
|
returns (google.longrunning.Operation) { |
|
|
|
|
option (google.api.http) = { |
|
|
|
|
delete: "/v1/{name=projects/*/locations/*/privateConnections/*}" |
|
|
|
|
}; |
|
|
|
@ -297,8 +314,8 @@ service Datastream { |
|
|
|
|
|
|
|
|
|
// Request message for 'discover' ConnectionProfile request. |
|
|
|
|
message DiscoverConnectionProfileRequest { |
|
|
|
|
// Required. The parent resource of the connection profile type. Must be in the |
|
|
|
|
// format `projects/*/locations/*`. |
|
|
|
|
// Required. The parent resource of the connection profile type. Must be in |
|
|
|
|
// the format `projects/*/locations/*`. |
|
|
|
|
string parent = 1 [ |
|
|
|
|
(google.api.field_behavior) = REQUIRED, |
|
|
|
|
(google.api.resource_reference) = { |
|
|
|
@ -355,8 +372,8 @@ message DiscoverConnectionProfileResponse { |
|
|
|
|
|
|
|
|
|
// Request message for 'FetchStaticIps' request. |
|
|
|
|
message FetchStaticIpsRequest { |
|
|
|
|
// Required. The resource name for the location for which static IPs should be returned. |
|
|
|
|
// Must be in the format `projects/*/locations/*`. |
|
|
|
|
// Required. The resource name for the location for which static IPs should be |
|
|
|
|
// returned. Must be in the format `projects/*/locations/*`. |
|
|
|
|
string name = 1 [ |
|
|
|
|
(google.api.field_behavior) = REQUIRED, |
|
|
|
|
(google.api.resource_reference) = { |
|
|
|
@ -449,7 +466,8 @@ message CreateConnectionProfileRequest { |
|
|
|
|
string connection_profile_id = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// Required. The connection profile resource to create. |
|
|
|
|
ConnectionProfile connection_profile = 3 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
ConnectionProfile connection_profile = 3 |
|
|
|
|
[(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// Optional. A request ID to identify requests. Specify a unique request ID |
|
|
|
|
// so that if you must retry your request, the server will know to ignore |
|
|
|
@ -466,8 +484,8 @@ message CreateConnectionProfileRequest { |
|
|
|
|
// not supported (00000000-0000-0000-0000-000000000000). |
|
|
|
|
string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Only validate the connection profile, but don't create any resources. |
|
|
|
|
// The default is false. |
|
|
|
|
// Optional. Only validate the connection profile, but don't create any |
|
|
|
|
// resources. The default is false. |
|
|
|
|
bool validate_only = 5 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Create the connection profile without validating it. |
|
|
|
@ -481,10 +499,12 @@ message UpdateConnectionProfileRequest { |
|
|
|
|
// The fields specified in the update_mask are relative to the resource, not |
|
|
|
|
// the full request. A field will be overwritten if it is in the mask. If the |
|
|
|
|
// user does not provide a mask then all fields will be overwritten. |
|
|
|
|
google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
google.protobuf.FieldMask update_mask = 1 |
|
|
|
|
[(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Required. The connection profile to update. |
|
|
|
|
ConnectionProfile connection_profile = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
ConnectionProfile connection_profile = 2 |
|
|
|
|
[(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// Optional. A request ID to identify requests. Specify a unique request ID |
|
|
|
|
// so that if you must retry your request, the server will know to ignore |
|
|
|
@ -501,8 +521,8 @@ message UpdateConnectionProfileRequest { |
|
|
|
|
// not supported (00000000-0000-0000-0000-000000000000). |
|
|
|
|
string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Only validate the connection profile, but don't update any resources. |
|
|
|
|
// The default is false. |
|
|
|
|
// Optional. Only validate the connection profile, but don't update any |
|
|
|
|
// resources. The default is false. |
|
|
|
|
bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Update the connection profile without validating it. |
|
|
|
@ -634,7 +654,8 @@ message UpdateStreamRequest { |
|
|
|
|
// The fields specified in the update_mask are relative to the resource, not |
|
|
|
|
// the full request. A field will be overwritten if it is in the mask. If the |
|
|
|
|
// user does not provide a mask then all fields will be overwritten. |
|
|
|
|
google.protobuf.FieldMask update_mask = 1 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
google.protobuf.FieldMask update_mask = 1 |
|
|
|
|
[(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Required. The stream resource to update. |
|
|
|
|
Stream stream = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
@ -654,8 +675,8 @@ message UpdateStreamRequest { |
|
|
|
|
// not supported (00000000-0000-0000-0000-000000000000). |
|
|
|
|
string request_id = 3 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Only validate the stream with the changes, without actually updating it. |
|
|
|
|
// The default is false. |
|
|
|
|
// Optional. Only validate the stream with the changes, without actually |
|
|
|
|
// updating it. The default is false. |
|
|
|
|
bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. Update the stream without validating it. |
|
|
|
@ -711,12 +732,14 @@ message LookupStreamObjectRequest { |
|
|
|
|
]; |
|
|
|
|
|
|
|
|
|
// Required. The source object identifier which maps to the stream object. |
|
|
|
|
SourceObjectIdentifier source_object_identifier = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
SourceObjectIdentifier source_object_identifier = 2 |
|
|
|
|
[(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request for manually initiating a backfill job for a specific stream object. |
|
|
|
|
message StartBackfillJobRequest { |
|
|
|
|
// Required. The name of the stream object resource to start a backfill job for. |
|
|
|
|
// Required. The name of the stream object resource to start a backfill job |
|
|
|
|
// for. |
|
|
|
|
string object = 1 [ |
|
|
|
|
(google.api.field_behavior) = REQUIRED, |
|
|
|
|
(google.api.resource_reference) = { |
|
|
|
@ -734,7 +757,8 @@ message StartBackfillJobResponse { |
|
|
|
|
// Request for manually stopping a running backfill job for a specific stream |
|
|
|
|
// object. |
|
|
|
|
message StopBackfillJobRequest { |
|
|
|
|
// Required. The name of the stream object resource to stop the backfill job for. |
|
|
|
|
// Required. The name of the stream object resource to stop the backfill job |
|
|
|
|
// for. |
|
|
|
|
string object = 1 [ |
|
|
|
|
(google.api.field_behavior) = REQUIRED, |
|
|
|
|
(google.api.resource_reference) = { |
|
|
|
@ -784,10 +808,12 @@ message ListStreamObjectsResponse { |
|
|
|
|
// Represents the metadata of the long-running operation. |
|
|
|
|
message OperationMetadata { |
|
|
|
|
// Output only. The time the operation was created. |
|
|
|
|
google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
google.protobuf.Timestamp create_time = 1 |
|
|
|
|
[(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
|
|
|
|
|
// Output only. The time the operation finished running. |
|
|
|
|
google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
google.protobuf.Timestamp end_time = 2 |
|
|
|
|
[(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
|
|
|
|
|
// Output only. Server-defined resource path for the target of the operation. |
|
|
|
|
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
@ -800,15 +826,17 @@ 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 [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. |
|
|
|
|
string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
|
|
|
|
|
// Output only. Results of executed validations if there are any. |
|
|
|
|
ValidationResult validation_result = 8 [(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
ValidationResult validation_result = 8 |
|
|
|
|
[(google.api.field_behavior) = OUTPUT_ONLY]; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request for creating a private connection. |
|
|
|
@ -825,7 +853,8 @@ message CreatePrivateConnectionRequest { |
|
|
|
|
string private_connection_id = 2 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// Required. The Private Connectivity resource to create. |
|
|
|
|
PrivateConnection private_connection = 3 [(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
PrivateConnection private_connection = 3 |
|
|
|
|
[(google.api.field_behavior) = REQUIRED]; |
|
|
|
|
|
|
|
|
|
// Optional. A request ID to identify requests. Specify a unique request ID |
|
|
|
|
// so that if you must retry your request, the server will know to ignore |
|
|
|
@ -841,11 +870,15 @@ message CreatePrivateConnectionRequest { |
|
|
|
|
// The request ID must be a valid UUID with the exception that zero UUID is |
|
|
|
|
// not supported (00000000-0000-0000-0000-000000000000). |
|
|
|
|
string request_id = 4 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. If set to true, will skip validations. |
|
|
|
|
bool force = 6 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Request for listing private connections. |
|
|
|
|
message ListPrivateConnectionsRequest { |
|
|
|
|
// Required. The parent that owns the collection of private connectivity configurations. |
|
|
|
|
// Required. The parent that owns the collection of private connectivity |
|
|
|
|
// configurations. |
|
|
|
|
string parent = 1 [ |
|
|
|
|
(google.api.field_behavior) = REQUIRED, |
|
|
|
|
(google.api.resource_reference) = { |
|
|
|
@ -912,8 +945,8 @@ message DeletePrivateConnectionRequest { |
|
|
|
|
// not supported (00000000-0000-0000-0000-000000000000). |
|
|
|
|
string request_id = 2 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
|
|
|
|
|
// Optional. If set to true, any child routes that belong to this PrivateConnection will |
|
|
|
|
// also be deleted. |
|
|
|
|
// Optional. If set to true, any child routes that belong to this |
|
|
|
|
// PrivateConnection will also be deleted. |
|
|
|
|
bool force = 3 [(google.api.field_behavior) = OPTIONAL]; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|