Class: Google::Apis::ServicecontrolV1::Operation
- Inherits:
-
Object
- Object
- Google::Apis::ServicecontrolV1::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/servicecontrol_v1/classes.rb,
generated/google/apis/servicecontrol_v1/representations.rb,
generated/google/apis/servicecontrol_v1/representations.rb
Overview
Represents information regarding an operation.
Instance Attribute Summary collapse
-
#consumer_id ⇒ String
Identity of the consumer who is using the service.
-
#end_time ⇒ String
End time of the operation.
-
#importance ⇒ String
DO NOT USE.
-
#labels ⇒ Hash<String,String>
Labels describing the operation.
-
#log_entries ⇒ Array<Google::Apis::ServicecontrolV1::LogEntry>
Represents information to be logged.
-
#metric_value_sets ⇒ Array<Google::Apis::ServicecontrolV1::MetricValueSet>
Represents information about this operation.
-
#operation_id ⇒ String
Identity of the operation.
-
#operation_name ⇒ String
Fully qualified name of the operation.
-
#quota_properties ⇒ Google::Apis::ServicecontrolV1::QuotaProperties
Represents the properties needed for quota operations.
-
#resource_container ⇒ String
DO NOT USE.
-
#resources ⇒ Array<Google::Apis::ServicecontrolV1::ResourceInfo>
The resources that are involved in the operation.
-
#start_time ⇒ String
Required.
-
#user_labels ⇒ Hash<String,String>
User defined labels for the resource that this operation is associated with.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Operation
constructor
A new instance of Operation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation
1215 1216 1217 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1215 def initialize(**args) update!(**args) end |
Instance Attribute Details
#consumer_id ⇒ String
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:consumerId
1114 1115 1116 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1114 def consumer_id @consumer_id end |
#end_time ⇒ String
End time of the operation.
Required when the operation is used in ServiceController.Report,
but optional when the operation is used in ServiceController.Check.
Corresponds to the JSON property endTime
1121 1122 1123 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1121 def end_time @end_time end |
#importance ⇒ String
DO NOT USE. This is an experimental field.
Corresponds to the JSON property importance
1126 1127 1128 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1126 def importance @importance end |
#labels ⇒ Hash<String,String>
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. Corresponds to the JSON propertylabels
1145 1146 1147 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1145 def labels @labels end |
#log_entries ⇒ Array<Google::Apis::ServicecontrolV1::LogEntry>
Represents information to be logged.
Corresponds to the JSON property logEntries
1150 1151 1152 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1150 def log_entries @log_entries end |
#metric_value_sets ⇒ Array<Google::Apis::ServicecontrolV1::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.
Corresponds to the JSON property metricValueSets
1163 1164 1165 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1163 def metric_value_sets @metric_value_sets end |
#operation_id ⇒ String
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.
Corresponds to the JSON property operationId
1175 1176 1177 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1175 def operation_id @operation_id end |
#operation_name ⇒ String
Fully qualified name of the operation. Reserved for future use.
Corresponds to the JSON property operationName
1180 1181 1182 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1180 def operation_name @operation_name end |
#quota_properties ⇒ Google::Apis::ServicecontrolV1::QuotaProperties
Represents the properties needed for quota operations.
Corresponds to the JSON property quotaProperties
1185 1186 1187 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1185 def quota_properties @quota_properties end |
#resource_container ⇒ String
DO NOT USE. This field is deprecated, use "resources" field instead. The resource name of the parent of a resource in the resource hierarchy. This can be in one of the following formats:
- “projects/
” - “folders/
” - “organizations/
” Corresponds to the JSON property resourceContainer
1195 1196 1197 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1195 def resource_container @resource_container end |
#resources ⇒ Array<Google::Apis::ServicecontrolV1::ResourceInfo>
The resources that are involved in the operation.
The maximum supported number of entries in this field is 100.
Corresponds to the JSON property resources
1201 1202 1203 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1201 def resources @resources end |
#start_time ⇒ String
Required. Start time of the operation.
Corresponds to the JSON property startTime
1206 1207 1208 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1206 def start_time @start_time end |
#user_labels ⇒ Hash<String,String>
User defined labels for the resource that this operation is associated
with. Only a combination of 1000 user labels per consumer project are
allowed.
Corresponds to the JSON property userLabels
1213 1214 1215 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1213 def user_labels @user_labels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1220 def update!(**args) @consumer_id = args[:consumer_id] if args.key?(:consumer_id) @end_time = args[:end_time] if args.key?(:end_time) @importance = args[:importance] if args.key?(:importance) @labels = args[:labels] if args.key?(:labels) @log_entries = args[:log_entries] if args.key?(:log_entries) @metric_value_sets = args[:metric_value_sets] if args.key?(:metric_value_sets) @operation_id = args[:operation_id] if args.key?(:operation_id) @operation_name = args[:operation_name] if args.key?(:operation_name) @quota_properties = args[:quota_properties] if args.key?(:quota_properties) @resource_container = args[:resource_container] if args.key?(:resource_container) @resources = args[:resources] if args.key?(:resources) @start_time = args[:start_time] if args.key?(:start_time) @user_labels = args[:user_labels] if args.key?(:user_labels) end |