1// Copyright 2021 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.automl.v1;
18
19import "google/cloud/automl/v1/io.proto";
20import "google/protobuf/timestamp.proto";
21import "google/rpc/status.proto";
22
23option csharp_namespace = "Google.Cloud.AutoML.V1";
24option go_package = "cloud.google.com/go/automl/apiv1/automlpb;automlpb";
25option java_multiple_files = true;
26option java_package = "com.google.cloud.automl.v1";
27option php_namespace = "Google\\Cloud\\AutoMl\\V1";
28option ruby_package = "Google::Cloud::AutoML::V1";
29
30// Metadata used across all long running operations returned by AutoML API.
31message OperationMetadata {
32  // Ouptut only. Details of specific operation. Even if this field is empty,
33  // the presence allows to distinguish different types of operations.
34  oneof details {
35    // Details of a Delete operation.
36    DeleteOperationMetadata delete_details = 8;
37
38    // Details of a DeployModel operation.
39    DeployModelOperationMetadata deploy_model_details = 24;
40
41    // Details of an UndeployModel operation.
42    UndeployModelOperationMetadata undeploy_model_details = 25;
43
44    // Details of CreateModel operation.
45    CreateModelOperationMetadata create_model_details = 10;
46
47    // Details of CreateDataset operation.
48    CreateDatasetOperationMetadata create_dataset_details = 30;
49
50    // Details of ImportData operation.
51    ImportDataOperationMetadata import_data_details = 15;
52
53    // Details of BatchPredict operation.
54    BatchPredictOperationMetadata batch_predict_details = 16;
55
56    // Details of ExportData operation.
57    ExportDataOperationMetadata export_data_details = 21;
58
59    // Details of ExportModel operation.
60    ExportModelOperationMetadata export_model_details = 22;
61  }
62
63  // Output only. Progress of operation. Range: [0, 100].
64  // Not used currently.
65  int32 progress_percent = 13;
66
67  // Output only. Partial failures encountered.
68  // E.g. single files that couldn't be read.
69  // This field should never exceed 20 entries.
70  // Status details field will contain standard GCP error details.
71  repeated google.rpc.Status partial_failures = 2;
72
73  // Output only. Time when the operation was created.
74  google.protobuf.Timestamp create_time = 3;
75
76  // Output only. Time when the operation was updated for the last time.
77  google.protobuf.Timestamp update_time = 4;
78}
79
80// Details of operations that perform deletes of any entities.
81message DeleteOperationMetadata {
82
83}
84
85// Details of DeployModel operation.
86message DeployModelOperationMetadata {
87
88}
89
90// Details of UndeployModel operation.
91message UndeployModelOperationMetadata {
92
93}
94
95// Details of CreateDataset operation.
96message CreateDatasetOperationMetadata {
97
98}
99
100// Details of CreateModel operation.
101message CreateModelOperationMetadata {
102
103}
104
105// Details of ImportData operation.
106message ImportDataOperationMetadata {
107
108}
109
110// Details of ExportData operation.
111message ExportDataOperationMetadata {
112  // Further describes this export data's output.
113  // Supplements
114  // [OutputConfig][google.cloud.automl.v1.OutputConfig].
115  message ExportDataOutputInfo {
116    // The output location to which the exported data is written.
117    oneof output_location {
118      // The full path of the Google Cloud Storage directory created, into which
119      // the exported data is written.
120      string gcs_output_directory = 1;
121    }
122  }
123
124  // Output only. Information further describing this export data's output.
125  ExportDataOutputInfo output_info = 1;
126}
127
128// Details of BatchPredict operation.
129message BatchPredictOperationMetadata {
130  // Further describes this batch predict's output.
131  // Supplements
132  // [BatchPredictOutputConfig][google.cloud.automl.v1.BatchPredictOutputConfig].
133  message BatchPredictOutputInfo {
134    // The output location into which prediction output is written.
135    oneof output_location {
136      // The full path of the Google Cloud Storage directory created, into which
137      // the prediction output is written.
138      string gcs_output_directory = 1;
139    }
140  }
141
142  // Output only. The input config that was given upon starting this
143  // batch predict operation.
144  BatchPredictInputConfig input_config = 1;
145
146  // Output only. Information further describing this batch predict's output.
147  BatchPredictOutputInfo output_info = 2;
148}
149
150// Details of ExportModel operation.
151message ExportModelOperationMetadata {
152  // Further describes the output of model export.
153  // Supplements
154  // [ModelExportOutputConfig][google.cloud.automl.v1.ModelExportOutputConfig].
155  message ExportModelOutputInfo {
156    // The full path of the Google Cloud Storage directory created, into which
157    // the model will be exported.
158    string gcs_output_directory = 1;
159  }
160
161  // Output only. Information further describing the output of this model
162  // export.
163  ExportModelOutputInfo output_info = 2;
164}
165