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



955
956
957
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 955

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) 


868
869
870
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 868

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) 


887
888
889
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 887

def end_time
  @end_time
end

#importance ⇒ String

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

Returns:

  • (String) 


902
903
904
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 902

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 (e.g. GAE, GCE, GKE). Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


929
930
931
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 929

def labels
  @labels
end

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

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

Returns:



934
935
936
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 934

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:



953
954
955
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 953

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) 


880
881
882
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 880

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) 


892
893
894
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 892

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:



856
857
858
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 856

def quota_properties
  @quota_properties
end

#resource_container ⇒ String

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) 


911
912
913
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 911

def resource_container
  @resource_container
end

#start_time ⇒ String

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

Returns:

  • (String) 


897
898
899
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 897

def start_time
  @start_time
end

#user_labels ⇒ Hash<String,String>

User defined labels for the resource that this operation is associated with. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


940
941
942
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 940

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'generated/google/apis/servicecontrol_v1/classes.rb', line 960

def update!(**args)
  @quota_properties = args[:quota_properties] if args.key?(:quota_properties)
  @consumer_id = args[:consumer_id] if args.key?(:consumer_id)
  @operation_id = args[:operation_id] if args.key?(:operation_id)
  @end_time = args[:end_time] if args.key?(:end_time)
  @operation_name = args[:operation_name] if args.key?(:operation_name)
  @start_time = args[:start_time] if args.key?(:start_time)
  @importance = args[:importance] if args.key?(:importance)
  @resource_container = args[:resource_container] if args.key?(:resource_container)
  @labels = args[:labels] if args.key?(:labels)
  @log_entries = args[:log_entries] if args.key?(:log_entries)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
  @metric_value_sets = args[:metric_value_sets] if args.key?(:metric_value_sets)
end