Class TaskRunnerSettings (0.49.0)

public final class TaskRunnerSettings extends GeneratedMessageV3 implements TaskRunnerSettingsOrBuilder

Taskrunner configuration settings.

Protobuf type google.dataflow.v1beta3.TaskRunnerSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TaskRunnerSettings

Static Fields

ALSOLOGTOSTDERR_FIELD_NUMBER

public static final int ALSOLOGTOSTDERR_FIELD_NUMBER
Field Value
Type Description
int

BASE_TASK_DIR_FIELD_NUMBER

public static final int BASE_TASK_DIR_FIELD_NUMBER
Field Value
Type Description
int

BASE_URL_FIELD_NUMBER

public static final int BASE_URL_FIELD_NUMBER
Field Value
Type Description
int

COMMANDLINES_FILE_NAME_FIELD_NUMBER

public static final int COMMANDLINES_FILE_NAME_FIELD_NUMBER
Field Value
Type Description
int

CONTINUE_ON_EXCEPTION_FIELD_NUMBER

public static final int CONTINUE_ON_EXCEPTION_FIELD_NUMBER
Field Value
Type Description
int

DATAFLOW_API_VERSION_FIELD_NUMBER

public static final int DATAFLOW_API_VERSION_FIELD_NUMBER
Field Value
Type Description
int

HARNESS_COMMAND_FIELD_NUMBER

public static final int HARNESS_COMMAND_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_HINT_FIELD_NUMBER

public static final int LANGUAGE_HINT_FIELD_NUMBER
Field Value
Type Description
int

LOG_DIR_FIELD_NUMBER

public static final int LOG_DIR_FIELD_NUMBER
Field Value
Type Description
int

LOG_TO_SERIALCONSOLE_FIELD_NUMBER

public static final int LOG_TO_SERIALCONSOLE_FIELD_NUMBER
Field Value
Type Description
int

LOG_UPLOAD_LOCATION_FIELD_NUMBER

public static final int LOG_UPLOAD_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

OAUTH_SCOPES_FIELD_NUMBER

public static final int OAUTH_SCOPES_FIELD_NUMBER
Field Value
Type Description
int

PARALLEL_WORKER_SETTINGS_FIELD_NUMBER

public static final int PARALLEL_WORKER_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

STREAMING_WORKER_MAIN_CLASS_FIELD_NUMBER

public static final int STREAMING_WORKER_MAIN_CLASS_FIELD_NUMBER
Field Value
Type Description
int

TASK_GROUP_FIELD_NUMBER

public static final int TASK_GROUP_FIELD_NUMBER
Field Value
Type Description
int

TASK_USER_FIELD_NUMBER

public static final int TASK_USER_FIELD_NUMBER
Field Value
Type Description
int

TEMP_STORAGE_PREFIX_FIELD_NUMBER

public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

VM_ID_FIELD_NUMBER

public static final int VM_ID_FIELD_NUMBER
Field Value
Type Description
int

WORKFLOW_FILE_NAME_FIELD_NUMBER

public static final int WORKFLOW_FILE_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TaskRunnerSettings getDefaultInstance()
Returns
Type Description
TaskRunnerSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TaskRunnerSettings.Builder newBuilder()
Returns
Type Description
TaskRunnerSettings.Builder

newBuilder(TaskRunnerSettings prototype)

public static TaskRunnerSettings.Builder newBuilder(TaskRunnerSettings prototype)
Parameter
Name Description
prototype TaskRunnerSettings
Returns
Type Description
TaskRunnerSettings.Builder

parseDelimitedFrom(InputStream input)

public static TaskRunnerSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TaskRunnerSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TaskRunnerSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TaskRunnerSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TaskRunnerSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TaskRunnerSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TaskRunnerSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TaskRunnerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TaskRunnerSettings> parser()
Returns
Type Description
Parser<TaskRunnerSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAlsologtostderr()

public boolean getAlsologtostderr()

Whether to also send taskrunner log info to stderr.

bool alsologtostderr = 10;

Returns
Type Description
boolean

The alsologtostderr.

getBaseTaskDir()

public String getBaseTaskDir()

The location on the worker for task-specific subdirectories.

string base_task_dir = 7;

Returns
Type Description
String

The baseTaskDir.

getBaseTaskDirBytes()

public 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 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 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 String getCommandlinesFileName()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
Type Description
String

The commandlinesFileName.

getCommandlinesFileNameBytes()

public ByteString getCommandlinesFileNameBytes()

The file to store preprocessing commands in.

string commandlines_file_name = 16;

Returns
Type Description
ByteString

The bytes for commandlinesFileName.

getContinueOnException()

public boolean getContinueOnException()

Whether to continue taskrunner if an exception is hit.

bool continue_on_exception = 8;

Returns
Type Description
boolean

The continueOnException.

getDataflowApiVersion()

public String getDataflowApiVersion()

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

string dataflow_api_version = 5;

Returns
Type Description
String

The dataflowApiVersion.

getDataflowApiVersionBytes()

public ByteString getDataflowApiVersionBytes()

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

string dataflow_api_version = 5;

Returns
Type Description
ByteString

The bytes for dataflowApiVersion.

getDefaultInstanceForType()

public TaskRunnerSettings getDefaultInstanceForType()
Returns
Type Description
TaskRunnerSettings

getHarnessCommand()

public String getHarnessCommand()

The command to launch the worker harness.

string harness_command = 14;

Returns
Type Description
String

The harnessCommand.

getHarnessCommandBytes()

public ByteString getHarnessCommandBytes()

The command to launch the worker harness.

string harness_command = 14;

Returns
Type Description
ByteString

The bytes for harnessCommand.

getLanguageHint()

public String getLanguageHint()

The suggested backend language.

string language_hint = 18;

Returns
Type Description
String

The languageHint.

getLanguageHintBytes()

public ByteString getLanguageHintBytes()

The suggested backend language.

string language_hint = 18;

Returns
Type Description
ByteString

The bytes for languageHint.

getLogDir()

public String getLogDir()

The directory on the VM to store logs.

string log_dir = 12;

Returns
Type Description
String

The logDir.

getLogDirBytes()

public ByteString getLogDirBytes()

The directory on the VM to store logs.

string log_dir = 12;

Returns
Type Description
ByteString

The bytes for logDir.

getLogToSerialconsole()

public 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 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 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 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the oauthScopes.

getParallelWorkerSettings()

public 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 WorkerSettingsOrBuilder getParallelWorkerSettingsOrBuilder()

The settings to pass to the parallel worker harness.

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

Returns
Type Description
WorkerSettingsOrBuilder

getParserForType()

public Parser<TaskRunnerSettings> getParserForType()
Returns
Type Description
Parser<TaskRunnerSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStreamingWorkerMainClass()

public String getStreamingWorkerMainClass()

The streaming worker main class name.

string streaming_worker_main_class = 19;

Returns
Type Description
String

The streamingWorkerMainClass.

getStreamingWorkerMainClassBytes()

public ByteString getStreamingWorkerMainClassBytes()

The streaming worker main class name.

string streaming_worker_main_class = 19;

Returns
Type Description
ByteString

The bytes for streamingWorkerMainClass.

getTaskGroup()

public 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 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 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 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 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 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 String getVmId()

The ID string of the VM.

string vm_id = 17;

Returns
Type Description
String

The vmId.

getVmIdBytes()

public ByteString getVmIdBytes()

The ID string of the VM.

string vm_id = 17;

Returns
Type Description
ByteString

The bytes for vmId.

getWorkflowFileName()

public String getWorkflowFileName()

The file to store the workflow in.

string workflow_file_name = 15;

Returns
Type Description
String

The workflowFileName.

getWorkflowFileNameBytes()

public ByteString getWorkflowFileNameBytes()

The file to store the workflow in.

string workflow_file_name = 15;

Returns
Type Description
ByteString

The bytes for workflowFileName.

hasParallelWorkerSettings()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TaskRunnerSettings.Builder newBuilderForType()
Returns
Type Description
TaskRunnerSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TaskRunnerSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TaskRunnerSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TaskRunnerSettings.Builder toBuilder()
Returns
Type Description
TaskRunnerSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException