Class: Google::Apis::ServicecontrolV1::Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/servicecontrol_v1/classes.rb,
lib/google/apis/servicecontrol_v1/representations.rb,
lib/google/apis/servicecontrol_v1/representations.rb

Overview

Represents information regarding an operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation.



1522
1523
1524
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1522

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 property consumerId

Returns:

  • (String) 


1434
1435
1436
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1434

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

Returns:

  • (String) 


1441
1442
1443
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1441

def end_time
  @end_time
end

#importance ⇒ String

DO NOT USE. This is an experimental field. Corresponds to the JSON property importance

Returns:

  • (String) 


1446
1447
1448
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1446

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 property labels

Returns:

  • (Hash<String,String>) 


1460
1461
1462
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1460

def labels
  @labels
end

#log_entries ⇒ Array<Google::Apis::ServicecontrolV1::LogEntry>

Represents information to be logged. Corresponds to the JSON property logEntries

Returns:



1465
1466
1467
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1465

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

Returns:



1476
1477
1478
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1476

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

Returns:

  • (String) 


1486
1487
1488
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1486

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

Returns:

  • (String) 


1491
1492
1493
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1491

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

Returns:



1496
1497
1498
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1496

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

Returns:



1502
1503
1504
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1502

def resources
  @resources
end

#start_time ⇒ String

Required. Start time of the operation. Corresponds to the JSON property startTime

Returns:

  • (String) 


1507
1508
1509
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1507

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

Returns:



1514
1515
1516
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1514

def trace_spans
  @trace_spans
end

#user_labels ⇒ Hash<String,String>

Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


1520
1521
1522
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1520

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/google/apis/servicecontrol_v1/classes.rb', line 1527

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