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