xref: /aosp_15_r20/external/googleapis/google/cloud/common/operation_metadata.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
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.common;
18
19import "google/api/field_behavior.proto";
20import "google/protobuf/timestamp.proto";
21
22option go_package = "google.golang.org/genproto/googleapis/cloud/common;common";
23option java_multiple_files = true;
24option java_package = "com.google.cloud.common";
25
26// Represents the metadata of the long-running operation.
27message OperationMetadata {
28  // Output only. The time the operation was created.
29  google.protobuf.Timestamp create_time = 1
30      [(google.api.field_behavior) = OUTPUT_ONLY];
31
32  // Output only. The time the operation finished running.
33  google.protobuf.Timestamp end_time = 2
34      [(google.api.field_behavior) = OUTPUT_ONLY];
35
36  // Output only. Server-defined resource path for the target of the operation.
37  string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
38
39  // Output only. Name of the verb executed by the operation.
40  string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
41
42  // Output only. Human-readable status of the operation, if any.
43  string status_detail = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
44
45  // Output only. Identifies whether the user has requested cancellation
46  // of the operation. Operations that have successfully been cancelled
47  // have [Operation.error][] value with a [google.rpc.Status.code][] of 1,
48  // corresponding to `Code.CANCELLED`.
49  bool cancel_requested = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
50
51  // Output only. API version used to start the operation.
52  string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
53}
54