Class: Google::Apis::FileV1::GoogleApiServicecontrolV1Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/file_v1/classes.rb,
generated/google/apis/file_v1/representations.rb,
generated/google/apis/file_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) ⇒ GoogleApiServicecontrolV1Operation

Returns a new instance of GoogleApiServicecontrolV1Operation.



489
490
491
# File 'generated/google/apis/file_v1/classes.rb', line 489

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#consumer_idString

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)


391
392
393
# File 'generated/google/apis/file_v1/classes.rb', line 391

def consumer_id
  @consumer_id
end

#end_timeString

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)


398
399
400
# File 'generated/google/apis/file_v1/classes.rb', line 398

def end_time
  @end_time
end

#importanceString

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

Returns:

  • (String)


403
404
405
# File 'generated/google/apis/file_v1/classes.rb', line 403

def importance
  @importance
end

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


422
423
424
# File 'generated/google/apis/file_v1/classes.rb', line 422

def labels
  @labels
end

#log_entriesArray<Google::Apis::FileV1::LogEntry>

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

Returns:



427
428
429
# File 'generated/google/apis/file_v1/classes.rb', line 427

def log_entries
  @log_entries
end

#metric_value_setsArray<Google::Apis::FileV1::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



440
441
442
# File 'generated/google/apis/file_v1/classes.rb', line 440

def metric_value_sets
  @metric_value_sets
end

#operation_idString

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)


452
453
454
# File 'generated/google/apis/file_v1/classes.rb', line 452

def operation_id
  @operation_id
end

#operation_nameString

Fully qualified name of the operation. Reserved for future use. Corresponds to the JSON property operationName

Returns:

  • (String)


457
458
459
# File 'generated/google/apis/file_v1/classes.rb', line 457

def operation_name
  @operation_name
end

#quota_propertiesGoogle::Apis::FileV1::QuotaProperties

Represents the properties needed for quota operations. Corresponds to the JSON property quotaProperties



462
463
464
# File 'generated/google/apis/file_v1/classes.rb', line 462

def quota_properties
  @quota_properties
end

#resourcesArray<Google::Apis::FileV1::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



468
469
470
# File 'generated/google/apis/file_v1/classes.rb', line 468

def resources
  @resources
end

#start_timeString

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

Returns:

  • (String)


473
474
475
# File 'generated/google/apis/file_v1/classes.rb', line 473

def start_time
  @start_time
end

#trace_spansArray<Google::Apis::FileV1::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



480
481
482
# File 'generated/google/apis/file_v1/classes.rb', line 480

def trace_spans
  @trace_spans
end

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


487
488
489
# File 'generated/google/apis/file_v1/classes.rb', line 487

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
# File 'generated/google/apis/file_v1/classes.rb', line 494

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