xref: /aosp_15_r20/external/googleapis/google/cloud/visionai/v1alpha1/common.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2022 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.visionai.v1alpha1;
18
19import "google/api/field_behavior.proto";
20import "google/api/resource.proto";
21import "google/protobuf/timestamp.proto";
22
23option csharp_namespace = "Google.Cloud.VisionAI.V1Alpha1";
24option go_package = "cloud.google.com/go/visionai/apiv1alpha1/visionaipb;visionaipb";
25option java_multiple_files = true;
26option java_outer_classname = "CommonProto";
27option java_package = "com.google.cloud.visionai.v1alpha1";
28option php_namespace = "Google\\Cloud\\VisionAI\\V1alpha1";
29option ruby_package = "Google::Cloud::VisionAI::V1alpha1";
30
31// Message describing the Cluster object.
32message Cluster {
33  option (google.api.resource) = {
34    type: "visionai.googleapis.com/Cluster"
35    pattern: "projects/{project}/locations/{location}/clusters/{cluster}"
36  };
37
38  // The current state of the cluster.
39  enum State {
40    // Not set.
41    STATE_UNSPECIFIED = 0;
42
43    // The PROVISIONING state indicates the cluster is being created.
44    PROVISIONING = 1;
45
46    // The RUNNING state indicates the cluster has been created and is fully
47    // usable.
48    RUNNING = 2;
49
50    // The STOPPING state indicates the cluster is being deleted.
51    STOPPING = 3;
52
53    // The ERROR state indicates the cluster is unusable. It will be
54    // automatically deleted.
55    ERROR = 4;
56  }
57
58  // Output only. Name of the resource.
59  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
60
61  // Output only. The create timestamp.
62  google.protobuf.Timestamp create_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
63
64  // Output only. The update timestamp.
65  google.protobuf.Timestamp update_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
66
67  // Labels as key value pairs
68  map<string, string> labels = 4;
69
70  // Annotations to allow clients to store small amounts of arbitrary data.
71  map<string, string> annotations = 5;
72
73  // Output only. The DNS name of the data plane service
74  string dataplane_service_endpoint = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
75
76  // Output only. The current state of the cluster.
77  State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
78
79  // Output only. The private service connection service target name.
80  string psc_target = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
81}
82
83// Represents the metadata of the long-running operation.
84message OperationMetadata {
85  // Output only. The time the operation was created.
86  google.protobuf.Timestamp create_time = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
87
88  // Output only. The time the operation finished running.
89  google.protobuf.Timestamp end_time = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
90
91  // Output only. Server-defined resource path for the target of the operation.
92  string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
93
94  // Output only. Name of the verb executed by the operation.
95  string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
96
97  // Output only. Human-readable status of the operation, if any.
98  string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
99
100  // Output only. Identifies whether the user has requested cancellation
101  // of the operation. Operations that have successfully been cancelled
102  // have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1,
103  // corresponding to `Code.CANCELLED`.
104  bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
105
106  // Output only. API version used to start the operation.
107  string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
108}
109
110// The Google Cloud Storage location for the input content.
111message GcsSource {
112  // Required. References to a Google Cloud Storage paths.
113  repeated string uris = 1 [(google.api.field_behavior) = REQUIRED];
114}
115