This repository has been archived by the owner on Jul 6, 2023. It is now read-only.
/
operation.py
136 lines (121 loc) · 6.05 KB
/
operation.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto # type: ignore
from google.cloud.servicecontrol_v1.types import log_entry
from google.cloud.servicecontrol_v1.types import metric_value
from google.protobuf import any_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
__protobuf__ = proto.module(
package="google.api.servicecontrol.v1", manifest={"Operation",},
)
class Operation(proto.Message):
r"""Represents information regarding an operation.
Attributes:
operation_id (str):
Identity of the operation. This must be
unique within the scope of the service that
generated the operation. If the service calls
Check() and Report() on the same operation, the
two calls should carry the same id.
UUID version 4 is recommended, though not
required. In scenarios where an operation is
computed from existing information and an
idempotent id is desirable for deduplication
purpose, UUID version 5 is recommended. See RFC
4122 for details.
operation_name (str):
Fully qualified name of the operation.
Reserved for future use.
consumer_id (str):
Identity of the consumer who is using the service. This
field should be filled in for the operations initiated by a
consumer, but not for service-initiated operations that are
not related to a specific consumer.
- This can be in one of the following formats:
- project:PROJECT_ID,
- project\ ``_``\ number:PROJECT_NUMBER,
- projects/PROJECT_ID or PROJECT_NUMBER,
- folders/FOLDER_NUMBER,
- organizations/ORGANIZATION_NUMBER,
- api\ ``_``\ key:API_KEY.
start_time (google.protobuf.timestamp_pb2.Timestamp):
Required. Start time of the operation.
end_time (google.protobuf.timestamp_pb2.Timestamp):
End time of the operation. Required when the operation is
used in
[ServiceController.Report][google.api.servicecontrol.v1.ServiceController.Report],
but optional when the operation is used in
[ServiceController.Check][google.api.servicecontrol.v1.ServiceController.Check].
labels (Sequence[google.cloud.servicecontrol_v1.types.Operation.LabelsEntry]):
Labels describing the operation. Only the following labels
are allowed:
- Labels describing monitored resources as defined in the
service configuration.
- Default labels of metric values. When specified, labels
defined in the metric value override these default.
- The following labels defined by Google Cloud Platform:
- ``cloud.googleapis.com/location`` describing the
location where the operation happened,
- ``servicecontrol.googleapis.com/user_agent``
describing the user agent of the API request,
- ``servicecontrol.googleapis.com/service_agent``
describing the service used to handle the API request
(e.g. ESP),
- ``servicecontrol.googleapis.com/platform`` describing
the platform where the API is served, such as App
Engine, Compute Engine, or Kubernetes Engine.
metric_value_sets (Sequence[google.cloud.servicecontrol_v1.types.MetricValueSet]):
Represents information about this operation.
Each MetricValueSet corresponds to a metric
defined in the service configuration. The data
type used in the MetricValueSet must agree with
the data type specified in the metric
definition.
Within a single operation, it is not allowed to
have more than one MetricValue instances that
have the same metric names and identical label
value combinations. If a request has such
duplicated MetricValue instances, the entire
request is rejected with an invalid argument
error.
log_entries (Sequence[google.cloud.servicecontrol_v1.types.LogEntry]):
Represents information to be logged.
importance (google.cloud.servicecontrol_v1.types.Operation.Importance):
DO NOT USE. This is an experimental field.
extensions (Sequence[google.protobuf.any_pb2.Any]):
Unimplemented.
"""
class Importance(proto.Enum):
r"""Defines the importance of the data contained in the
operation.
"""
LOW = 0
HIGH = 1
operation_id = proto.Field(proto.STRING, number=1,)
operation_name = proto.Field(proto.STRING, number=2,)
consumer_id = proto.Field(proto.STRING, number=3,)
start_time = proto.Field(proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,)
end_time = proto.Field(proto.MESSAGE, number=5, message=timestamp_pb2.Timestamp,)
labels = proto.MapField(proto.STRING, proto.STRING, number=6,)
metric_value_sets = proto.RepeatedField(
proto.MESSAGE, number=7, message=metric_value.MetricValueSet,
)
log_entries = proto.RepeatedField(
proto.MESSAGE, number=8, message=log_entry.LogEntry,
)
importance = proto.Field(proto.ENUM, number=11, enum=Importance,)
extensions = proto.RepeatedField(proto.MESSAGE, number=16, message=any_pb2.Any,)
__all__ = tuple(sorted(__protobuf__.manifest))