xref: /aosp_15_r20/external/googleapis/google/spanner/admin/instance/v1/common.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.spanner.admin.instance.v1;
18
19import "google/protobuf/timestamp.proto";
20
21option csharp_namespace = "Google.Cloud.Spanner.Admin.Instance.V1";
22option go_package = "cloud.google.com/go/spanner/admin/instance/apiv1/instancepb;instancepb";
23option java_multiple_files = true;
24option java_outer_classname = "CommonProto";
25option java_package = "com.google.spanner.admin.instance.v1";
26option php_namespace = "Google\\Cloud\\Spanner\\Admin\\Instance\\V1";
27option ruby_package = "Google::Cloud::Spanner::Admin::Instance::V1";
28
29// Encapsulates progress related information for a Cloud Spanner long
30// running instance operations.
31message OperationProgress {
32  // Percent completion of the operation.
33  // Values are between 0 and 100 inclusive.
34  int32 progress_percent = 1;
35
36  // Time the request was received.
37  google.protobuf.Timestamp start_time = 2;
38
39  // If set, the time at which this operation failed or was completed
40  // successfully.
41  google.protobuf.Timestamp end_time = 3;
42}
43
44// Indicates the expected fulfillment period of an operation.
45enum FulfillmentPeriod {
46  // Not specified.
47  FULFILLMENT_PERIOD_UNSPECIFIED = 0;
48
49  // Normal fulfillment period. The operation is expected to complete within
50  // minutes.
51  FULFILLMENT_PERIOD_NORMAL = 1;
52
53  // Extended fulfillment period. It can take up to an hour for the operation
54  // to complete.
55  FULFILLMENT_PERIOD_EXTENDED = 2;
56}
57