Class: Google::Cloud::ServiceControl::V1::Operation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/servicecontrol/v1/operation.rb

Overview

Represents information regarding an operation.

Defined Under Namespace

Modules: Importance Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#consumer_id ⇒ ::String

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

Returns:

  • (::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.


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#extensions ⇒ ::Array<::Google::Protobuf::Any>

Returns Unimplemented.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#importance ⇒ ::Google::Cloud::ServiceControl::V1::Operation::Importance

Returns DO NOT USE. This is an experimental field.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

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

Returns:

  • (::Google::Protobuf::Map{::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.


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#log_entries ⇒ ::Array<::Google::Cloud::ServiceControl::V1::LogEntry>

Returns Represents information to be logged.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#metric_value_sets ⇒ ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>

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

Returns:

  • (::Array<::Google::Cloud::ServiceControl::V1::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.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#operation_id ⇒ ::String

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

Returns:

  • (::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.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#operation_name ⇒ ::String

Returns Fully qualified name of the operation. Reserved for future use.

Returns:

  • (::String) —

    Fully qualified name of the operation. Reserved for future use.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp

Returns Required. Start time of the operation.

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'proto_docs/google/api/servicecontrol/v1/operation.rb', line 102

class Operation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the importance of the data contained in the operation.
  module Importance
    # Allows data caching, batching, and aggregation. It provides
    # higher performance with higher data loss risk.
    LOW = 0

    # Disables data aggregation to minimize data loss. It is for operations
    # that contains significant monetary value or audit trail. This feature
    # only applies to the client libraries.
    HIGH = 1
  end
end