Class Operation

Represents information regarding an operation.

Inheritance
object
Operation
Implements
Inherited Members
Namespace: Google.Apis.ServiceControl.v1.Data
Assembly: Google.Apis.ServiceControl.v1.dll
Syntax
public class Operation : IDirectResponseSchema

Properties

ConsumerId

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.

Declaration
[JsonProperty("consumerId")]
public virtual string ConsumerId { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Importance

DO NOT USE. This is an experimental field.

Declaration
[JsonProperty("importance")]
public virtual string Importance { get; set; }
Property Value
Type Description
string

Labels

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.
Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LogEntries

Represents information to be logged.

Declaration
[JsonProperty("logEntries")]
public virtual IList<LogEntry> LogEntries { get; set; }
Property Value
Type Description
IList<LogEntry>

MetricValueSets

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.

Declaration
[JsonProperty("metricValueSets")]
public virtual IList<MetricValueSet> MetricValueSets { get; set; }
Property Value
Type Description
IList<MetricValueSet>

OperationId

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.

Declaration
[JsonProperty("operationId")]
public virtual string OperationId { get; set; }
Property Value
Type Description
string

OperationName

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

Declaration
[JsonProperty("operationName")]
public virtual string OperationName { get; set; }
Property Value
Type Description
string

QuotaProperties

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.

Declaration
[JsonProperty("quotaProperties")]
public virtual QuotaProperties QuotaProperties { get; set; }
Property Value
Type Description
QuotaProperties

Resources

The resources that are involved in the operation. The maximum supported number of entries in this field is 100.

Declaration
[JsonProperty("resources")]
public virtual IList<ResourceInfo> Resources { get; set; }
Property Value
Type Description
IList<ResourceInfo>

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

Required. Start time of the operation.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

TraceSpans

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.

Declaration
[JsonProperty("traceSpans")]
public virtual IList<TraceSpan> TraceSpans { get; set; }
Property Value
Type Description
IList<TraceSpan>

UserLabels

Private Preview. This feature is only available for approved services. User defined labels for the resource that this operation is associated with.

Declaration
[JsonProperty("userLabels")]
public virtual IDictionary<string, string> UserLabels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements