xref: /aosp_15_r20/external/googleapis/google/cloud/connectors/v1/runtime.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.connectors.v1;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21
22option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
23option java_multiple_files = true;
24option java_outer_classname = "RuntimeProto";
25option java_package = "com.google.cloud.connectors.v1";
26
27// Request message for Connectors.GetRuntimeConfig.
28message GetRuntimeConfigRequest {
29  // Required. Resource name of the form:
30  // `projects/*/locations/*/runtimeConfig`
31  string name = 1 [
32    (google.api.field_behavior) = REQUIRED,
33    (google.api.resource_reference) = {
34      type: "connectors.googleapis.com/RuntimeConfig"
35    }
36  ];
37}
38
39// RuntimeConfig is the singleton resource of each location.
40// It includes generic resource configs consumed by control plane and runtime
41// plane like: pub/sub topic/subscription resource name, Cloud Storage location
42// storing schema etc.
43message RuntimeConfig {
44  option (google.api.resource) = {
45    type: "connectors.googleapis.com/RuntimeConfig"
46    pattern: "projects/{project}/locations/{location}/runtimeConfig"
47  };
48
49  // State of the location.
50  enum State {
51    // STATE_UNSPECIFIED.
52    STATE_UNSPECIFIED = 0;
53
54    // INACTIVE.
55    INACTIVE = 1 [deprecated = true];
56
57    // ACTIVATING.
58    ACTIVATING = 2 [deprecated = true];
59
60    // ACTIVE.
61    ACTIVE = 3;
62
63    // CREATING.
64    CREATING = 4;
65
66    // DELETING.
67    DELETING = 5;
68
69    // UPDATING.
70    UPDATING = 6;
71  }
72
73  // Output only. location_id of the runtime location. E.g. "us-west1".
74  string location_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
75
76  // Output only. Pub/Sub topic for connd to send message.
77  // E.g. projects/{project-id}/topics/{topic-id}
78  string connd_topic = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
79
80  // Output only. Pub/Sub subscription for connd to receive message.
81  // E.g. projects/{project-id}/subscriptions/{topic-id}
82  string connd_subscription = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
83
84  // Output only. Pub/Sub topic for control plne to send message.
85  // communication.
86  // E.g. projects/{project-id}/topics/{topic-id}
87  string control_plane_topic = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
88
89  // Output only. Pub/Sub subscription for control plane to receive message.
90  // E.g. projects/{project-id}/subscriptions/{topic-id}
91  string control_plane_subscription = 5
92      [(google.api.field_behavior) = OUTPUT_ONLY];
93
94  // Output only. The endpoint of the connectors runtime ingress.
95  string runtime_endpoint = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
96
97  // Output only. The state of the location.
98  State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
99
100  // Output only. The Cloud Storage bucket that stores connector's schema
101  // reports.
102  string schema_gcs_bucket = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
103
104  // Output only. The name of the Service Directory service name.
105  string service_directory = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
106
107  // Output only. Name of the runtimeConfig resource.
108  // Format: projects/{project}/locations/{location}/runtimeConfig
109  string name = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
110}
111