Interface TaskRunnerSettingsOrBuilder (0.31.0)

Version 0.31.0

• 0.59.0 (latest)
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.5.0

public interface TaskRunnerSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlsologtostderr()

public abstract boolean getAlsologtostderr()

Whether to also send taskrunner log info to stderr.

bool alsologtostderr = 10;

Returns
Type	Description
boolean	The alsologtostderr.

getBaseTaskDir()

public abstract String getBaseTaskDir()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
Type	Description
String	The baseTaskDir.

getBaseTaskDirBytes()

public abstract ByteString getBaseTaskDirBytes()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
Type	Description
ByteString	The bytes for baseTaskDir.

getBaseUrl()

public abstract 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
Type	Description
String	The baseUrl.

getBaseUrlBytes()

public abstract 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
Type	Description
ByteString	The bytes for baseUrl.

getCommandlinesFileName()

public abstract String getCommandlinesFileName()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
Type	Description
String	The commandlinesFileName.

getCommandlinesFileNameBytes()

public abstract ByteString getCommandlinesFileNameBytes()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
Type	Description
ByteString	The bytes for commandlinesFileName.

getContinueOnException()

public abstract boolean getContinueOnException()

Whether to continue taskrunner if an exception is hit.

bool continue_on_exception = 8;

Returns
Type	Description
boolean	The continueOnException.

getDataflowApiVersion()

public abstract String getDataflowApiVersion()

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

string dataflow_api_version = 5;

Returns
Type	Description
String	The dataflowApiVersion.

getDataflowApiVersionBytes()

public abstract ByteString getDataflowApiVersionBytes()

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

string dataflow_api_version = 5;

Returns
Type	Description
ByteString	The bytes for dataflowApiVersion.

getHarnessCommand()

public abstract String getHarnessCommand()

The command to launch the worker harness.

string harness_command = 14;

Returns
Type	Description
String	The harnessCommand.

getHarnessCommandBytes()

public abstract ByteString getHarnessCommandBytes()

The command to launch the worker harness.

string harness_command = 14;

Returns
Type	Description
ByteString	The bytes for harnessCommand.

getLanguageHint()

public abstract String getLanguageHint()

The suggested backend language.

string language_hint = 18;

Returns
Type	Description
String	The languageHint.

getLanguageHintBytes()

public abstract ByteString getLanguageHintBytes()

The suggested backend language.

string language_hint = 18;

Returns
Type	Description
ByteString	The bytes for languageHint.

getLogDir()

public abstract String getLogDir()

The directory on the VM to store logs.

string log_dir = 12;

Returns
Type	Description
String	The logDir.

getLogDirBytes()

public abstract ByteString getLogDirBytes()

The directory on the VM to store logs.

string log_dir = 12;

Returns
Type	Description
ByteString	The bytes for logDir.

getLogToSerialconsole()

public abstract boolean getLogToSerialconsole()

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

bool log_to_serialconsole = 9;

Returns
Type	Description
boolean	The logToSerialconsole.

getLogUploadLocation()

public abstract String getLogUploadLocation()

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
Type	Description
String	The logUploadLocation.

getLogUploadLocationBytes()

public abstract ByteString getLogUploadLocationBytes()

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
Type	Description
ByteString	The bytes for logUploadLocation.

getOauthScopes(int index)

public abstract String getOauthScopes(int index)

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

repeated string oauth_scopes = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The oauthScopes at the given index.

getOauthScopesBytes(int index)

public abstract ByteString getOauthScopesBytes(int index)

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

repeated string oauth_scopes = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the oauthScopes at the given index.

getOauthScopesCount()

public abstract int getOauthScopesCount()

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

repeated string oauth_scopes = 3;

Returns
Type	Description
int	The count of oauthScopes.

getOauthScopesList()

public abstract List<String> getOauthScopesList()

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

repeated string oauth_scopes = 3;

Returns
Type	Description
List<String>	A list containing the oauthScopes.

getParallelWorkerSettings()

public abstract WorkerSettings getParallelWorkerSettings()

The settings to pass to the parallel worker harness.

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

Returns
Type	Description
WorkerSettings	The parallelWorkerSettings.

getParallelWorkerSettingsOrBuilder()

public abstract WorkerSettingsOrBuilder getParallelWorkerSettingsOrBuilder()

The settings to pass to the parallel worker harness.

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

Returns
Type	Description
WorkerSettingsOrBuilder

getStreamingWorkerMainClass()

public abstract String getStreamingWorkerMainClass()

The streaming worker main class name.

string streaming_worker_main_class = 19;

Returns
Type	Description
String	The streamingWorkerMainClass.

getStreamingWorkerMainClassBytes()

public abstract ByteString getStreamingWorkerMainClassBytes()

The streaming worker main class name.

string streaming_worker_main_class = 19;

Returns
Type	Description
ByteString	The bytes for streamingWorkerMainClass.

getTaskGroup()

public abstract String getTaskGroup()

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

string task_group = 2;

Returns
Type	Description
String	The taskGroup.

getTaskGroupBytes()

public abstract ByteString getTaskGroupBytes()

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

string task_group = 2;

Returns
Type	Description
ByteString	The bytes for taskGroup.

getTaskUser()

public abstract String getTaskUser()

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

string task_user = 1;

Returns
Type	Description
String	The taskUser.

getTaskUserBytes()

public abstract ByteString getTaskUserBytes()

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

string task_user = 1;

Returns
Type	Description
ByteString	The bytes for taskUser.

getTempStoragePrefix()

public abstract String getTempStoragePrefix()

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
Type	Description
String	The tempStoragePrefix.

getTempStoragePrefixBytes()

public abstract ByteString getTempStoragePrefixBytes()

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
Type	Description
ByteString	The bytes for tempStoragePrefix.

getVmId()

public abstract String getVmId()

The ID string of the VM.

string vm_id = 17;

Returns
Type	Description
String	The vmId.

getVmIdBytes()

public abstract ByteString getVmIdBytes()

The ID string of the VM.

string vm_id = 17;

Returns
Type	Description
ByteString	The bytes for vmId.

getWorkflowFileName()

public abstract String getWorkflowFileName()

The file to store the workflow in.

string workflow_file_name = 15;

Returns
Type	Description
String	The workflowFileName.

getWorkflowFileNameBytes()

public abstract ByteString getWorkflowFileNameBytes()

The file to store the workflow in.

string workflow_file_name = 15;

Returns
Type	Description
ByteString	The bytes for workflowFileName.

hasParallelWorkerSettings()

public abstract boolean hasParallelWorkerSettings()

The settings to pass to the parallel worker harness.

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

Returns
Type	Description
boolean	Whether the parallelWorkerSettings field is set.