Show / Hide Table of Contents

Class WorkerMessage

WorkerMessage provides information to the backend about a worker.

Inheritance
object
WorkerMessage
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Dataflow.v1b3.Data
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class WorkerMessage : IDirectResponseSchema

Properties

DataSamplingReport

Optional. Contains metrics related to go/dataflow-data-sampling-telemetry.

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

ETag

The ETag of the item.

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

Labels

Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.

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

PerWorkerMetrics

System defined metrics for this worker.

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

StreamingScalingReport

Contains per-user worker telemetry used in streaming autoscaling.

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

Time

object representation of TimeRaw.

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

TimeDateTimeOffset

DateTimeOffset representation of TimeRaw.

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

TimeRaw

The timestamp of the worker_message.

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

WorkerHealthReport

The health of a worker.

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

WorkerLifecycleEvent

Record of worker lifecycle events.

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

WorkerMessageCode

A worker message code.

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

WorkerMetrics

Resource metrics reported by workers.

Declaration
[JsonProperty("workerMetrics")]
public virtual ResourceUtilizationReport WorkerMetrics { get; set; }
Property Value
Type Description
ResourceUtilizationReport

WorkerShutdownNotice

Shutdown notice by workers.

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

WorkerThreadScalingReport

Thread scaling information reported by workers.

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

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX