xref: /aosp_15_r20/external/googleapis/google/cloud/connectors/v1/connector.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";
21import "google/cloud/connectors/v1/common.proto";
22import "google/protobuf/timestamp.proto";
23
24option go_package = "cloud.google.com/go/connectors/apiv1/connectorspb;connectorspb";
25option java_multiple_files = true;
26option java_outer_classname = "ConnectorProto";
27option java_package = "com.google.cloud.connectors.v1";
28
29// Connectors indicates a specific connector type, e.x. Salesforce, SAP etc.
30message Connector {
31  option (google.api.resource) = {
32    type: "connectors.googleapis.com/Connector"
33    pattern: "projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}"
34  };
35
36  // Output only. Resource name of the Connector.
37  // Format:
38  // projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}
39  // Only global location is supported for Connector resource.
40  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
41
42  // Output only. Created time.
43  google.protobuf.Timestamp create_time = 2
44      [(google.api.field_behavior) = OUTPUT_ONLY];
45
46  // Output only. Updated time.
47  google.protobuf.Timestamp update_time = 3
48      [(google.api.field_behavior) = OUTPUT_ONLY];
49
50  // Output only. Resource labels to represent user-provided metadata.
51  // Refer to cloud documentation on labels for more details.
52  // https://cloud.google.com/compute/docs/labeling-resources
53  map<string, string> labels = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
54
55  // Output only. Link to documentation page.
56  string documentation_uri = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
57
58  // Output only. Link to external page.
59  string external_uri = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
60
61  // Output only. Description of the resource.
62  string description = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
63
64  // Output only. Cloud storage location of icons etc consumed by UI.
65  string web_assets_location = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
66
67  // Output only. Display name.
68  string display_name = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
69
70  // Output only. Flag to mark the version indicating the launch stage.
71  LaunchStage launch_stage = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
72}
73
74// Request message for Connectors.GetConnector.
75message GetConnectorRequest {
76  // Required. Resource name of the form:
77  // `projects/*/locations/*/providers/*/connectors/*`
78  // Only global location is supported for Connector resource.
79  string name = 1 [
80    (google.api.field_behavior) = REQUIRED,
81    (google.api.resource_reference) = {
82      type: "connectors.googleapis.com/Connector"
83    }
84  ];
85}
86
87// Request message for Connectors.ListConnectors.
88message ListConnectorsRequest {
89  // Required. Parent resource of the connectors, of the form:
90  // `projects/*/locations/*/providers/*`
91  // Only global location is supported for Connector resource.
92  string parent = 1 [
93    (google.api.field_behavior) = REQUIRED,
94    (google.api.resource_reference) = {
95      type: "connectors.googleapis.com/Provider"
96    }
97  ];
98
99  // Page size.
100  int32 page_size = 2;
101
102  // Page token.
103  string page_token = 3;
104}
105
106// Response message for Connectors.ListConnectors.
107message ListConnectorsResponse {
108  // A list of connectors.
109  repeated Connector connectors = 1;
110
111  // Next page token.
112  string next_page_token = 2;
113
114  // Locations that could not be reached.
115  repeated string unreachable = 3;
116}
117