public sealed class TaskRunnerSettings : IMessage<TaskRunnerSettings>, IEquatable<TaskRunnerSettings>, IDeepCloneable<TaskRunnerSettings>, IBufferMessage, IMessage
Reference documentation and code samples for the Dataflow v1beta3 API class TaskRunnerSettings.
The base URL for the taskrunner to use when 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".
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis documentation details the \u003ccode\u003eTaskRunnerSettings\u003c/code\u003e class within the Google Cloud Dataflow v1beta3 API, which is used for configuring settings for taskrunners in Dataflow jobs.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eTaskRunnerSettings\u003c/code\u003e class implements several interfaces including \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, and inherits from the base \u003ccode\u003eobject\u003c/code\u003e class.\u003c/p\u003e\n"],["\u003cp\u003eIt has multiple properties, such as \u003ccode\u003eAlsologtostderr\u003c/code\u003e, \u003ccode\u003eBaseTaskDir\u003c/code\u003e, \u003ccode\u003eBaseUrl\u003c/code\u003e, \u003ccode\u003eCommandlinesFileName\u003c/code\u003e, and others, allowing configuration of various taskrunner behaviors and settings, such as logging, API access, and resource locations.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides constructors for default initialization and for creating an instance from an existing \u003ccode\u003eTaskRunnerSettings\u003c/code\u003e object, in addition to containing a list of properties for configuration, and inherited members.\u003c/p\u003e\n"],["\u003cp\u003eThere are 3 available versions for this class, with \u003ccode\u003e2.0.0-beta07\u003c/code\u003e being the latest.\u003c/p\u003e\n"]]],[],null,["# Dataflow v1beta3 API - Class TaskRunnerSettings (2.0.0-beta07)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.0-beta07 (latest)](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings)\n- [2.0.0-beta06](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/2.0.0-beta06/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings)\n- [1.0.0-beta03](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/1.0.0-beta03/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings) \n\n public sealed class TaskRunnerSettings : IMessage\u003cTaskRunnerSettings\u003e, IEquatable\u003cTaskRunnerSettings\u003e, IDeepCloneable\u003cTaskRunnerSettings\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Dataflow v1beta3 API class TaskRunnerSettings.\n\nTaskrunner configuration settings. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e TaskRunnerSettings \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[TaskRunnerSettings](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[TaskRunnerSettings](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[TaskRunnerSettings](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3.TaskRunnerSettings), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.Dataflow.V1Beta3](/dotnet/docs/reference/Google.Cloud.Dataflow.V1Beta3/latest/Google.Cloud.Dataflow.V1Beta3)\n\nAssembly\n--------\n\nGoogle.Cloud.Dataflow.V1Beta3.dll\n\nConstructors\n------------\n\n### TaskRunnerSettings()\n\n public TaskRunnerSettings()\n\n### TaskRunnerSettings(TaskRunnerSettings)\n\n public TaskRunnerSettings(TaskRunnerSettings other)\n\nProperties\n----------\n\n### Alsologtostderr\n\n public bool Alsologtostderr { get; set; }\n\nWhether to also send taskrunner log info to stderr.\n\n### BaseTaskDir\n\n public string BaseTaskDir { get; set; }\n\nThe location on the worker for task-specific subdirectories.\n\n### BaseUrl\n\n public string BaseUrl { get; set; }\n\nThe base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"\u003chttp://www.googleapis.com/\u003e\"\n\n### CommandlinesFileName\n\n public string CommandlinesFileName { get; set; }\n\nThe file to store preprocessing commands in.\n\n### ContinueOnException\n\n public bool ContinueOnException { get; set; }\n\nWhether to continue taskrunner if an exception is hit.\n\n### DataflowApiVersion\n\n public string DataflowApiVersion { get; set; }\n\nThe API version of endpoint, e.g. \"v1b3\"\n\n### HarnessCommand\n\n public string HarnessCommand { get; set; }\n\nThe command to launch the worker harness.\n\n### LanguageHint\n\n public string LanguageHint { get; set; }\n\nThe suggested backend language.\n\n### LogDir\n\n public string LogDir { get; set; }\n\nThe directory on the VM to store logs.\n\n### LogToSerialconsole\n\n public bool LogToSerialconsole { get; set; }\n\nWhether to send taskrunner log info to Google Compute Engine VM serial\nconsole.\n\n### LogUploadLocation\n\n public string LogUploadLocation { get; set; }\n\nIndicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\nstorage.googleapis.com/{bucket}/{object}\nbucket.storage.googleapis.com/{object}\n\n### OauthScopes\n\n public RepeatedField\u003cstring\u003e OauthScopes { get; }\n\nThe OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.\n\n### ParallelWorkerSettings\n\n public WorkerSettings ParallelWorkerSettings { get; set; }\n\nThe settings to pass to the parallel worker harness.\n\n### StreamingWorkerMainClass\n\n public string StreamingWorkerMainClass { get; set; }\n\nThe streaming worker main class name.\n\n### TaskGroup\n\n public string TaskGroup { get; set; }\n\nThe UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".\n\n### TaskUser\n\n public string TaskUser { get; set; }\n\nThe UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\".\n\n### TempStoragePrefix\n\n public string TempStoragePrefix { get; set; }\n\nThe prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\nstorage.googleapis.com/{bucket}/{object}\nbucket.storage.googleapis.com/{object}\n\n### VmId\n\n public string VmId { get; set; }\n\nThe ID string of the VM.\n\n### WorkflowFileName\n\n public string WorkflowFileName { get; set; }\n\nThe file to store the workflow in."]]
