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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation



1448
1449
1450
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1448

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) 


1347
1348
1349
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1347

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) 


1354
1355
1356
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1354

def end_time
  @end_time
end

#importance ⇒ String

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

Returns:

  • (String) 


1359
1360
1361
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1359

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>) 


1378
1379
1380
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1378

def labels
  @labels
end

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

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

Returns:



1383
1384
1385
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1383

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:



1396
1397
1398
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1396

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) 


1408
1409
1410
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1408

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) 


1413
1414
1415
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1413

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:



1418
1419
1420
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1418

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

Returns:

  • (String) 


1428
1429
1430
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1428

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

Returns:



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

def resources
  @resources
end

#start_time ⇒ String

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

Returns:

  • (String) 


1439
1440
1441
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1439

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

Returns:

  • (Hash<String,String>) 


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

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1453

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