Skip to content

Commit

Permalink
feat(connection): add endpoint to fetch conns by UID
Browse files Browse the repository at this point in the history
  • Loading branch information
jvallesm committed Nov 28, 2024
1 parent d1a4d29 commit abab130
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
16 changes: 16 additions & 0 deletions vdp/pipeline/v1beta/integration.proto
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,19 @@ message GetIntegrationResponse {
// The requested integration.
Integration integration = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// LookUpConnectionAdminRequest represents a request to fetch the details of a
// connection by UID.
message LookUpConnectionAdminRequest {
// Connection UID.
string namespace_id = 1 [(google.api.field_behavior) = REQUIRED];
// View allows clients to specify the desired view in the response. It
// defaults to `VIEW_BASIC`.
optional View view = 2 [(google.api.field_behavior) = OPTIONAL];
}

// LookUpConnectionAdminResponse contains the requested connection.
message LookUpConnectionAdminResponse {
// The requested connection.
Connection connection = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
}
18 changes: 12 additions & 6 deletions vdp/pipeline/v1beta/pipeline_private_service.proto
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package vdp.pipeline.v1beta;
// OpenAPI definition
import "protoc-gen-openapiv2/options/annotations.proto";
import "vdp/pipeline/v1beta/pipeline.proto";
import "vdp/pipeline/v1beta/integration.proto";

// PipelinePrivateService defines private methods to interact with Pipeline
// resources.
Expand All @@ -13,19 +14,24 @@ service PipelinePrivateService {

// List pipelines (admin only)
//
// This is a *private* method that allows admin users and internal clients to
// list *all* pipeline resources.
// This *private* method allows internal clients to list *all* pipeline
// resources.
rpc ListPipelinesAdmin(ListPipelinesAdminRequest) returns (ListPipelinesAdminResponse) {}

// Get a pipeline by UID (admin only)
//
// This is a *private* method that allows admin users to access any pipeline
// resource by its UID.
// This *private* method allows internal clients to access any pipeline
// resource by UID.
rpc LookUpPipelineAdmin(LookUpPipelineAdminRequest) returns (LookUpPipelineAdminResponse) {}

// List pipeline releases (admin only)
//
// This is a *private* method that allows admin users to list *all* pipeline
// releases.
// This *private* method allows admin users to list *all* pipeline releases.
rpc ListPipelineReleasesAdmin(ListPipelineReleasesAdminRequest) returns (ListPipelineReleasesAdminResponse) {}

// Get a connection by UID (admin only)
//
// This *private* method allows internal clients to access any connection
// resource by UID.
rpc LookUpConnectionAdmin(LookUpConnectionAdminRequest) returns (LookUpConnectionAdminResponse) {}
}

0 comments on commit abab130

Please sign in to comment.