Dataflow v1beta3 API - Class WorkerSettings (2.0.0-beta06)

public sealed class WorkerSettings : IMessage<WorkerSettings>, IEquatable<WorkerSettings>, IDeepCloneable<WorkerSettings>, IBufferMessage, IMessage

Reference documentation and code samples for the Dataflow v1beta3 API class WorkerSettings.

Provides data to pass through to the worker harness.

Inheritance

object > WorkerSettings

Implements

IMessage WorkerSettings, IEquatable WorkerSettings, IDeepCloneable WorkerSettings, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Constructors

WorkerSettings()

public WorkerSettings()

WorkerSettings(WorkerSettings)

public WorkerSettings(WorkerSettings other)

Parameter
Name	Description
`other`	`WorkerSettings`

Properties

BaseUrl

public string BaseUrl { get; set; }

The base URL for accessing Google Cloud APIs.

When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators".

If not specified, the default value is "http://www.googleapis.com/"

Property Value
Type	Description
`string`

ReportingEnabled

public bool ReportingEnabled { get; set; }

Whether to send work progress updates to the service.

Property Value
Type	Description
`bool`

ServicePath

public string ServicePath { get; set; }

The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

Property Value
Type	Description
`string`

ShuffleServicePath

public string ShuffleServicePath { get; set; }

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

Property Value
Type	Description
`string`

TempStoragePrefix

public string TempStoragePrefix { get; set; }

The prefix of the resources the system should use for temporary storage.

The supported resource type is:

Google Cloud Storage:

storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

Property Value
Type	Description
`string`

WorkerId

public string WorkerId { get; set; }

The ID of the worker running this pipeline.

Property Value
Type	Description
`string`