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 more...

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

[View source]

1364
1365
1366
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1364

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_number:, api_key:. Corresponds to the JSON property consumerId

Returns:

  • (String) 

1263
1264
1265
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1263

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) 

1270
1271
1272
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1270

def end_time
  @end_time
end

#importance ⇒ String

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

Returns:

  • (String) 

1275
1276
1277
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1275

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

1294
1295
1296
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1294

def labels
  @labels
end

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

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

Returns:


1299
1300
1301
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1299

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:


1312
1313
1314
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1312

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) 

1324
1325
1326
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1324

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) 

1329
1330
1331
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1329

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:


1334
1335
1336
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1334

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) 

1344
1345
1346
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1344

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:


1350
1351
1352
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1350

def resources
  @resources
end

#start_time ⇒ String

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

Returns:

  • (String) 

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

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

1362
1363
1364
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1362

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 1369

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