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.
-
#resources ⇒ Array<Google::Apis::ServicecontrolV1::ResourceInfo>
The resources that are involved in the operation.
-
#start_time ⇒ String
Required.
-
#trace_spans ⇒ Array<Google::Apis::ServicecontrolV1::TraceSpan>
Unimplemented.
-
#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.
1554 1555 1556 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1554 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:PROJECT_ID,
- project
_
number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER,
- folders/FOLDER_NUMBER,
- organizations/ORGANIZATION_NUMBER,
- api
_
key:API_KEY. Corresponds to the JSON propertyconsumerId
1456 1457 1458 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1456 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
1463 1464 1465 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1463 def end_time @end_time end |
#importance ⇒ String
DO NOT USE. This is an experimental field.
Corresponds to the JSON property importance
1468 1469 1470 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1468 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
1487 1488 1489 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1487 def labels @labels end |
#log_entries ⇒ Array<Google::Apis::ServicecontrolV1::LogEntry>
Represents information to be logged.
Corresponds to the JSON property logEntries
1492 1493 1494 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1492 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
1505 1506 1507 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1505 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
1517 1518 1519 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1517 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
1522 1523 1524 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1522 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
1527 1528 1529 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1527 def quota_properties @quota_properties 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
1533 1534 1535 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1533 def resources @resources end |
#start_time ⇒ String
Required. Start time of the operation.
Corresponds to the JSON property startTime
1538 1539 1540 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1538 def start_time @start_time end |
#trace_spans ⇒ Array<Google::Apis::ServicecontrolV1::TraceSpan>
Unimplemented. A list of Cloud Trace spans. The span names shall contain
the id of the destination project which can be either the produce or the
consumer project.
Corresponds to the JSON property traceSpans
1545 1546 1547 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1545 def trace_spans @trace_spans 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
1552 1553 1554 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1552 def user_labels @user_labels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 |
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1559 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) @resources = args[:resources] if args.key?(:resources) @start_time = args[:start_time] if args.key?(:start_time) @trace_spans = args[:trace_spans] if args.key?(:trace_spans) @user_labels = args[:user_labels] if args.key?(:user_labels) end |