Class TaskRunnerSettings.Builder (0.10.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class TaskRunnerSettings.Builder extends GeneratedMessageV3.Builder<TaskRunnerSettings.Builder> implements TaskRunnerSettingsOrBuilder

Taskrunner configuration settings.

Protobuf type google.dataflow.v1beta3.TaskRunnerSettings

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllOauthScopes(Iterable<String> values)

public TaskRunnerSettings.Builder addAllOauthScopes(Iterable<String> values)

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

repeated string oauth_scopes = 3;

Parameter
NameDescription
valuesIterable<String>

The oauthScopes to add.

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

addOauthScopes(String value)

public TaskRunnerSettings.Builder addOauthScopes(String value)

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

repeated string oauth_scopes = 3;

Parameter
NameDescription
valueString

The oauthScopes to add.

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

addOauthScopesBytes(ByteString value)

public TaskRunnerSettings.Builder addOauthScopesBytes(ByteString value)

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

repeated string oauth_scopes = 3;

Parameter
NameDescription
valueByteString

The bytes of the oauthScopes to add.

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TaskRunnerSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TaskRunnerSettings.Builder
Overrides

build()

public TaskRunnerSettings build()
Returns
TypeDescription
TaskRunnerSettings

buildPartial()

public TaskRunnerSettings buildPartial()
Returns
TypeDescription
TaskRunnerSettings

clear()

public TaskRunnerSettings.Builder clear()
Returns
TypeDescription
TaskRunnerSettings.Builder
Overrides

clearAlsologtostderr()

public TaskRunnerSettings.Builder clearAlsologtostderr()

Whether to also send taskrunner log info to stderr.

bool alsologtostderr = 10;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearBaseTaskDir()

public TaskRunnerSettings.Builder clearBaseTaskDir()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearBaseUrl()

public TaskRunnerSettings.Builder clearBaseUrl()

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". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 4;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearCommandlinesFileName()

public TaskRunnerSettings.Builder clearCommandlinesFileName()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearContinueOnException()

public TaskRunnerSettings.Builder clearContinueOnException()

Whether to continue taskrunner if an exception is hit.

bool continue_on_exception = 8;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearDataflowApiVersion()

public TaskRunnerSettings.Builder clearDataflowApiVersion()

The API version of endpoint, e.g. "v1b3"

string dataflow_api_version = 5;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TaskRunnerSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TaskRunnerSettings.Builder
Overrides

clearHarnessCommand()

public TaskRunnerSettings.Builder clearHarnessCommand()

The command to launch the worker harness.

string harness_command = 14;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearLanguageHint()

public TaskRunnerSettings.Builder clearLanguageHint()

The suggested backend language.

string language_hint = 18;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearLogDir()

public TaskRunnerSettings.Builder clearLogDir()

The directory on the VM to store logs.

string log_dir = 12;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearLogToSerialconsole()

public TaskRunnerSettings.Builder clearLogToSerialconsole()

Whether to send taskrunner log info to Google Compute Engine VM serial console.

bool log_to_serialconsole = 9;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearLogUploadLocation()

public TaskRunnerSettings.Builder clearLogUploadLocation()

Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string log_upload_location = 11;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearOauthScopes()

public TaskRunnerSettings.Builder clearOauthScopes()

The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

repeated string oauth_scopes = 3;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TaskRunnerSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TaskRunnerSettings.Builder
Overrides

clearParallelWorkerSettings()

public TaskRunnerSettings.Builder clearParallelWorkerSettings()

The settings to pass to the parallel worker harness.

.google.dataflow.v1beta3.WorkerSettings parallel_worker_settings = 6;

Returns
TypeDescription
TaskRunnerSettings.Builder

clearStreamingWorkerMainClass()

public TaskRunnerSettings.Builder clearStreamingWorkerMainClass()

The streaming worker main class name.

string streaming_worker_main_class = 19;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearTaskGroup()

public TaskRunnerSettings.Builder clearTaskGroup()

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

string task_group = 2;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearTaskUser()

public TaskRunnerSettings.Builder clearTaskUser()

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

string task_user = 1;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearTempStoragePrefix()

public TaskRunnerSettings.Builder clearTempStoragePrefix()

The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

string temp_storage_prefix = 13;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearVmId()

public TaskRunnerSettings.Builder clearVmId()

The ID string of the VM.

string vm_id = 17;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clearWorkflowFileName()

public TaskRunnerSettings.Builder clearWorkflowFileName()

The file to store the workflow in.

string workflow_file_name = 15;

Returns
TypeDescription
TaskRunnerSettings.Builder

This builder for chaining.

clone()

public TaskRunnerSettings.Builder clone()
Returns
TypeDescription
TaskRunnerSettings.Builder
Overrides

getAlsologtostderr()

public boolean getAlsologtostderr()

Whether to also send taskrunner log info to stderr.

bool alsologtostderr = 10;

Returns
TypeDescription
boolean

The alsologtostderr.

getBaseTaskDir()

public String getBaseTaskDir()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
TypeDescription
String

The baseTaskDir.

getBaseTaskDirBytes()

public ByteString getBaseTaskDirBytes()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
TypeDescription
ByteString

The bytes for baseTaskDir.

getBaseUrl()

public String getBaseUrl()

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". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 4;

Returns
TypeDescription
String

The baseUrl.

getBaseUrlBytes()

public ByteString getBaseUrlBytes()

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". If not specified, the default value is "http://www.googleapis.com/"

string base_url = 4;

Returns
TypeDescription
ByteString

The bytes for baseUrl.

getCommandlinesFileName()

public String getCommandlinesFileName()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
TypeDescription
String

The commandlinesFileName.

getCommandlinesFileNameBytes()

public ByteString getCommandlinesFileNameBytes()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
TypeDescription
ByteString

The bytes for commandlinesFileName.

getContinueOnException()