GoogleApi.ServiceControl.V1.Model.Operation (google_api_service_control v0.36.4) View Source

Represents information regarding an operation.


  • consumerId (type: String.t, default: nil) - 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:PROJECTID, - project`number:PROJECT_NUMBER, - projects/PROJECT_ID or PROJECT_NUMBER, - folders/FOLDER_NUMBER, - organizations/ORGANIZATION_NUMBER, - api_`key:API_KEY.
  • endTime (type: DateTime.t, default: nil) - End time of the operation. Required when the operation is used in ServiceController.Report, but optional when the operation is used in ServiceController.Check.
  • extensions (type: list(map()), default: nil) - Unimplemented.
  • importance (type: String.t, default: nil) - DO NOT USE. This is an experimental field.
  • labels (type: map(), default: nil) - 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: - describing the location where the operation happened, - describing the user agent of the API request, - describing the service used to handle the API request (e.g. ESP), - describing the platform where the API is served, such as App Engine, Compute Engine, or Kubernetes Engine.
  • logEntries (type: list(GoogleApi.ServiceControl.V1.Model.LogEntry.t), default: nil) - Represents information to be logged.
  • metricValueSets (type: list(GoogleApi.ServiceControl.V1.Model.MetricValueSet.t), default: nil) - 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.
  • operationId (type: String.t, default: nil) - 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.
  • operationName (type: String.t, default: nil) - Fully qualified name of the operation. Reserved for future use.
  • quotaProperties (type: GoogleApi.ServiceControl.V1.Model.QuotaProperties.t, default: nil) - Represents the properties needed for quota check. Applicable only if this operation is for a quota check request. If this is not specified, no quota check will be performed.
  • resources (type: list(GoogleApi.ServiceControl.V1.Model.ResourceInfo.t), default: nil) - The resources that are involved in the operation. The maximum supported number of entries in this field is 100.
  • startTime (type: DateTime.t, default: nil) - Required. Start time of the operation.
  • traceSpans (type: list(GoogleApi.ServiceControl.V1.Model.TraceSpan.t), default: nil) - 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.
  • userLabels (type: map(), default: nil) - Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.ServiceControl.V1.Model.Operation{
  consumerId: String.t() | nil,
  endTime: DateTime.t() | nil,
  extensions: [map()] | nil,
  importance: String.t() | nil,
  labels: map() | nil,
  logEntries: [GoogleApi.ServiceControl.V1.Model.LogEntry.t()] | nil,
  metricValueSets: [GoogleApi.ServiceControl.V1.Model.MetricValueSet.t()] | nil,
  operationId: String.t() | nil,
  operationName: String.t() | nil,
  quotaProperties: GoogleApi.ServiceControl.V1.Model.QuotaProperties.t() | nil,
  resources: [GoogleApi.ServiceControl.V1.Model.ResourceInfo.t()] | nil,
  startTime: DateTime.t() | nil,
  traceSpans: [GoogleApi.ServiceControl.V1.Model.TraceSpan.t()] | nil,
  userLabels: map() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.