Package com.google.dataflow.v1beta3

Class TaskRunnerSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.dataflow.v1beta3.TaskRunnerSettings
All Implemented Interfaces:
TaskRunnerSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TaskRunnerSettings extends com.google.protobuf.GeneratedMessage implements TaskRunnerSettingsOrBuilder
 Taskrunner configuration settings.
Protobuf type google.dataflow.v1beta3.TaskRunnerSettings
See Also:

  • Field Details

    • TASK_USER_FIELD_NUMBER

      public static final int TASK_USER_FIELD_NUMBER
      See Also:

    • TASK_GROUP_FIELD_NUMBER

      public static final int TASK_GROUP_FIELD_NUMBER
      See Also:

    • OAUTH_SCOPES_FIELD_NUMBER

      public static final int OAUTH_SCOPES_FIELD_NUMBER
      See Also:

    • BASE_URL_FIELD_NUMBER

      public static final int BASE_URL_FIELD_NUMBER
      See Also:

    • DATAFLOW_API_VERSION_FIELD_NUMBER

      public static final int DATAFLOW_API_VERSION_FIELD_NUMBER
      See Also:

    • PARALLEL_WORKER_SETTINGS_FIELD_NUMBER

      public static final int PARALLEL_WORKER_SETTINGS_FIELD_NUMBER
      See Also:

    • BASE_TASK_DIR_FIELD_NUMBER

      public static final int BASE_TASK_DIR_FIELD_NUMBER
      See Also:

    • CONTINUE_ON_EXCEPTION_FIELD_NUMBER

      public static final int CONTINUE_ON_EXCEPTION_FIELD_NUMBER
      See Also:

    • LOG_TO_SERIALCONSOLE_FIELD_NUMBER

      public static final int LOG_TO_SERIALCONSOLE_FIELD_NUMBER
      See Also:

    • ALSOLOGTOSTDERR_FIELD_NUMBER

      public static final int ALSOLOGTOSTDERR_FIELD_NUMBER
      See Also:

    • LOG_UPLOAD_LOCATION_FIELD_NUMBER

      public static final int LOG_UPLOAD_LOCATION_FIELD_NUMBER
      See Also:

    • LOG_DIR_FIELD_NUMBER

      public static final int LOG_DIR_FIELD_NUMBER
      See Also:

    • TEMP_STORAGE_PREFIX_FIELD_NUMBER

      public static final int TEMP_STORAGE_PREFIX_FIELD_NUMBER
      See Also:

    • HARNESS_COMMAND_FIELD_NUMBER

      public static final int HARNESS_COMMAND_FIELD_NUMBER
      See Also:

    • WORKFLOW_FILE_NAME_FIELD_NUMBER

      public static final int WORKFLOW_FILE_NAME_FIELD_NUMBER
      See Also:

    • COMMANDLINES_FILE_NAME_FIELD_NUMBER

      public static final int COMMANDLINES_FILE_NAME_FIELD_NUMBER
      See Also:

    • VM_ID_FIELD_NUMBER

      public static final int VM_ID_FIELD_NUMBER
      See Also:

    • LANGUAGE_HINT_FIELD_NUMBER

      public static final int LANGUAGE_HINT_FIELD_NUMBER
      See Also:

    • STREAMING_WORKER_MAIN_CLASS_FIELD_NUMBER

      public static final int STREAMING_WORKER_MAIN_CLASS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      getTaskUser in interface TaskRunnerSettingsOrBuilder
      Returns:
      The taskUser.

    • getTaskUserBytes

      public com.google.protobuf.ByteString getTaskUserBytes()
       The UNIX user ID on the worker VM to use for tasks launched by
 taskrunner; e.g. "root".
      string task_user = 1;
      Specified by:
      getTaskUserBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for taskUser.

    • 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;
      Specified by:
      getTaskGroup in interface TaskRunnerSettingsOrBuilder
      Returns:
      The taskGroup.

    • getTaskGroupBytes

      public com.google.protobuf.ByteString getTaskGroupBytes()
       The UNIX group ID on the worker VM to use for tasks launched by
 taskrunner; e.g. "wheel".
      string task_group = 2;
      Specified by:
      getTaskGroupBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for taskGroup.

    • getOauthScopesList

      public com.google.protobuf.ProtocolStringList getOauthScopesList()
       The OAuth2 scopes to be requested by the taskrunner in order to
 access the Cloud Dataflow API.
      repeated string oauth_scopes = 3;
      Specified by:
      getOauthScopesList in interface TaskRunnerSettingsOrBuilder
      Returns:
      A list containing the oauthScopes.

    • 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;
      Specified by:
      getOauthScopesCount in interface TaskRunnerSettingsOrBuilder
      Returns:
      The count of oauthScopes.

    • getOauthScopes

      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;
      Specified by:
      getOauthScopes in interface TaskRunnerSettingsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The oauthScopes at the given index.

    • getOauthScopesBytes

      public com.google.protobuf.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;
      Specified by:
      getOauthScopesBytes in interface TaskRunnerSettingsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the oauthScopes at the given index.

    • 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;
      Specified by:
      getBaseUrl in interface TaskRunnerSettingsOrBuilder
      Returns:
      The baseUrl.

    • getBaseUrlBytes

      public com.google.protobuf.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;
      Specified by:
      getBaseUrlBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for baseUrl.

    • getDataflowApiVersion

      public String getDataflowApiVersion()
       The API version of endpoint, e.g. "v1b3"
      string dataflow_api_version = 5;
      Specified by:
      getDataflowApiVersion in interface TaskRunnerSettingsOrBuilder
      Returns:
      The dataflowApiVersion.

    • getDataflowApiVersionBytes

      public com.google.protobuf.ByteString getDataflowApiVersionBytes()
       The API version of endpoint, e.g. "v1b3"
      string dataflow_api_version = 5;
      Specified by:
      getDataflowApiVersionBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for dataflowApiVersion.

    • hasParallelWorkerSettings

      public boolean hasParallelWorkerSettings()
       The settings to pass to the parallel worker harness.
      .google.dataflow.v1beta3.WorkerSettings parallel_worker_settings = 6;
      Specified by:
      hasParallelWorkerSettings in interface TaskRunnerSettingsOrBuilder
      Returns:
      Whether the parallelWorkerSettings field is set.

    • getParallelWorkerSettings

      public WorkerSettings getParallelWorkerSettings()
       The settings to pass to the parallel worker harness.
      .google.dataflow.v1beta3.WorkerSettings parallel_worker_settings = 6;
      Specified by:
      getParallelWorkerSettings in interface TaskRunnerSettingsOrBuilder
      Returns:
      The parallelWorkerSettings.

    • getParallelWorkerSettingsOrBuilder

      public WorkerSettingsOrBuilder getParallelWorkerSettingsOrBuilder()
       The settings to pass to the parallel worker harness.
      .google.dataflow.v1beta3.WorkerSettings parallel_worker_settings = 6;
      Specified by:
      getParallelWorkerSettingsOrBuilder in interface TaskRunnerSettingsOrBuilder

    • getBaseTaskDir

      public String getBaseTaskDir()
       The location on the worker for task-specific subdirectories.
      string base_task_dir = 7;
      Specified by:
      getBaseTaskDir in interface TaskRunnerSettingsOrBuilder
      Returns:
      The baseTaskDir.

    • getBaseTaskDirBytes

      public com.google.protobuf.ByteString getBaseTaskDirBytes()
       The location on the worker for task-specific subdirectories.
      string base_task_dir = 7;
      Specified by:
      getBaseTaskDirBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for baseTaskDir.

    • getContinueOnException

      public boolean getContinueOnException()
       Whether to continue taskrunner if an exception is hit.
      bool continue_on_exception = 8;
      Specified by:
      getContinueOnException in interface TaskRunnerSettingsOrBuilder
      Returns:
      The continueOnException.

    • getLogToSerialconsole

      public boolean getLogToSerialconsole()
       Whether to send taskrunner log info to Google Compute Engine VM serial
 console.
      bool log_to_serialconsole = 9;
      Specified by:
      getLogToSerialconsole in interface TaskRunnerSettingsOrBuilder
      Returns:
      The logToSerialconsole.

    • getAlsologtostderr

      public boolean getAlsologtostderr()
       Whether to also send taskrunner log info to stderr.
      bool alsologtostderr = 10;
      Specified by:
      getAlsologtostderr in interface TaskRunnerSettingsOrBuilder
      Returns:
      The alsologtostderr.

    • 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;
      Specified by:
      getLogUploadLocation in interface TaskRunnerSettingsOrBuilder
      Returns:
      The logUploadLocation.

    • getLogUploadLocationBytes

      public com.google.protobuf.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;
      Specified by:
      getLogUploadLocationBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for logUploadLocation.

    • getLogDir

      public String getLogDir()
       The directory on the VM to store logs.
      string log_dir = 12;
      Specified by:
      getLogDir in interface TaskRunnerSettingsOrBuilder
      Returns:
      The logDir.

    • getLogDirBytes

      public com.google.protobuf.ByteString getLogDirBytes()
       The directory on the VM to store logs.
      string log_dir = 12;
      Specified by:
      getLogDirBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for logDir.

    • 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;
      Specified by:
      getTempStoragePrefix in interface TaskRunnerSettingsOrBuilder
      Returns:
      The tempStoragePrefix.

    • getTempStoragePrefixBytes

      public com.google.protobuf.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;
      Specified by:
      getTempStoragePrefixBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for tempStoragePrefix.

    • getHarnessCommand

      public String getHarnessCommand()
       The command to launch the worker harness.
      string harness_command = 14;
      Specified by:
      getHarnessCommand in interface TaskRunnerSettingsOrBuilder
      Returns:
      The harnessCommand.

    • getHarnessCommandBytes

      public com.google.protobuf.ByteString getHarnessCommandBytes()
       The command to launch the worker harness.
      string harness_command = 14;
      Specified by:
      getHarnessCommandBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for harnessCommand.

    • getWorkflowFileName

      public String getWorkflowFileName()
       The file to store the workflow in.
      string workflow_file_name = 15;
      Specified by:
      getWorkflowFileName in interface TaskRunnerSettingsOrBuilder
      Returns:
      The workflowFileName.

    • getWorkflowFileNameBytes

      public com.google.protobuf.ByteString getWorkflowFileNameBytes()
       The file to store the workflow in.
      string workflow_file_name = 15;
      Specified by:
      getWorkflowFileNameBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for workflowFileName.

    • getCommandlinesFileName

      public String getCommandlinesFileName()
       The file to store preprocessing commands in.
      string commandlines_file_name = 16;
      Specified by:
      getCommandlinesFileName in interface TaskRunnerSettingsOrBuilder
      Returns:
      The commandlinesFileName.

    • getCommandlinesFileNameBytes

      public com.google.protobuf.ByteString getCommandlinesFileNameBytes()
       The file to store preprocessing commands in.
      string commandlines_file_name = 16;
      Specified by:
      getCommandlinesFileNameBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for commandlinesFileName.

    • getVmId

      public String getVmId()
       The ID string of the VM.
      string vm_id = 17;
      Specified by:
      getVmId in interface TaskRunnerSettingsOrBuilder
      Returns:
      The vmId.

    • getVmIdBytes

      public com.google.protobuf.ByteString getVmIdBytes()
       The ID string of the VM.
      string vm_id = 17;
      Specified by:
      getVmIdBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for vmId.

    • getLanguageHint

      public String getLanguageHint()
       The suggested backend language.
      string language_hint = 18;
      Specified by:
      getLanguageHint in interface TaskRunnerSettingsOrBuilder
      Returns:
      The languageHint.

    • getLanguageHintBytes

      public com.google.protobuf.ByteString getLanguageHintBytes()
       The suggested backend language.
      string language_hint = 18;
      Specified by:
      getLanguageHintBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for languageHint.

    • getStreamingWorkerMainClass

      public String getStreamingWorkerMainClass()
       The streaming worker main class name.
      string streaming_worker_main_class = 19;
      Specified by:
      getStreamingWorkerMainClass in interface TaskRunnerSettingsOrBuilder
      Returns:
      The streamingWorkerMainClass.

    • getStreamingWorkerMainClassBytes

      public com.google.protobuf.ByteString getStreamingWorkerMainClassBytes()
       The streaming worker main class name.
      string streaming_worker_main_class = 19;
      Specified by:
      getStreamingWorkerMainClassBytes in interface TaskRunnerSettingsOrBuilder
      Returns:
      The bytes for streamingWorkerMainClass.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TaskRunnerSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TaskRunnerSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskRunnerSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TaskRunnerSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TaskRunnerSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskRunnerSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TaskRunnerSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TaskRunnerSettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TaskRunnerSettings.Builder newBuilder()

    • newBuilder

      public static TaskRunnerSettings.Builder newBuilder(TaskRunnerSettings prototype)

    • toBuilder

      public TaskRunnerSettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TaskRunnerSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TaskRunnerSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TaskRunnerSettings> parser()

    • getParserForType

      public com.google.protobuf.Parser<TaskRunnerSettings> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TaskRunnerSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder