Packages

t

org.apache.spark.udf.worker

ProcessCallableOrBuilder

trait ProcessCallableOrBuilder extends MessageOrBuilder

Annotations
@Generated()
Source
ProcessCallableOrBuilder.java
Linear Supertypes
MessageOrBuilder, MessageLiteOrBuilder, AnyRef, Any
Known Subclasses
ProcessCallable
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcessCallableOrBuilder
  2. MessageOrBuilder
  3. MessageLiteOrBuilder
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def containsEnvironmentVariables(key: String): Boolean

    Environment variables for the invoked process.

(Optional)


    Environment variables for the invoked process.

(Optional)

    map<string, string> environment_variables = 3;

  2. abstract def findInitializationErrors(): List[String]
    Definition Classes
    MessageOrBuilder
  3. abstract def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    MessageOrBuilder
  4. abstract def getArguments(index: Int): String

    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)


    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)

    repeated string arguments = 2;

    index

    The index of the element to return.

    returns

    The arguments at the given index.

  5. abstract def getArgumentsBytes(index: Int): ByteString

    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)


    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)

    repeated string arguments = 2;

    index

    The index of the value to return.

    returns

    The bytes of the arguments at the given index.

  6. abstract def getArgumentsCount(): Int

    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)


    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)

    repeated string arguments = 2;

    returns

    The count of arguments.

  7. abstract def getArgumentsList(): List[String]

    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)


    Arguments passed directly to the executable.
Examples:
["udf_worker.py"]
[""]
["--max_concurrency", "5"]
["\"echo 'Test'\""]

Every executable will ALWAYS receive the following arguments,
which CANNOT be part of the below list of arguments:

--id
The value of the id argument is a string with the engine-assigned
id of this UDF Worker. This can be used in logs and other state information.

--connection
The value of the connection argument is a string with
engine-assinged connection parameters. See [[UDFWorkerProperties]]
for details.

(Optional)

    repeated string arguments = 2;

    returns

    A list containing the arguments.

  8. abstract def getCommand(index: Int): String

    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)


    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)

    repeated string command = 1;

    index

    The index of the element to return.

    returns

    The command at the given index.

  9. abstract def getCommandBytes(index: Int): ByteString

    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)


    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)

    repeated string command = 1;

    index

    The index of the value to return.

    returns

    The bytes of the command at the given index.

  10. abstract def getCommandCount(): Int

    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)


    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)

    repeated string command = 1;

    returns

    The count of command.

  11. abstract def getCommandList(): List[String]

    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)


    Executable to invoke.
Examples:
["python3", "-m"]
["worker.bin"]
["java", "worker.java"]
["/bin/bash", "-c"]
This executable should be blocking, until the task is finished.
Termination is requested via a SIGTERM signal.

Success/Failure can be indicated via exit codes:
Exit code 0    -> Success
Exit code != 0 -> Failure

(Required)

    repeated string command = 1;

    returns

    A list containing the command.

  12. abstract def getDefaultInstanceForType(): Message
    Definition Classes
    MessageOrBuilder → MessageLiteOrBuilder
  13. abstract def getDescriptorForType(): Descriptor
    Definition Classes
    MessageOrBuilder
  14. abstract def getEnvironmentVariablesCount(): Int

    Environment variables for the invoked process.

(Optional)


    Environment variables for the invoked process.

(Optional)

    map<string, string> environment_variables = 3;

  15. abstract def getEnvironmentVariablesMap(): Map[String, String]

    Environment variables for the invoked process.

(Optional)


    Environment variables for the invoked process.

(Optional)

    map<string, string> environment_variables = 3;

  16. abstract def getEnvironmentVariablesOrDefault(key: String, defaultValue: String): String

    Environment variables for the invoked process.

(Optional)


    Environment variables for the invoked process.

(Optional)

    map<string, string> environment_variables = 3;

  17. abstract def getEnvironmentVariablesOrThrow(key: String): String

    Environment variables for the invoked process.

(Optional)


    Environment variables for the invoked process.

(Optional)

    map<string, string> environment_variables = 3;

  18. abstract def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    MessageOrBuilder
  19. abstract def getInitializationErrorString(): String
    Definition Classes
    MessageOrBuilder
  20. abstract def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    MessageOrBuilder
  21. abstract def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    MessageOrBuilder
  22. abstract def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    MessageOrBuilder
  23. abstract def getUnknownFields(): UnknownFieldSet
    Definition Classes
    MessageOrBuilder
  24. abstract def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  25. abstract def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    MessageOrBuilder
  26. abstract def isInitialized(): Boolean
    Definition Classes
    MessageLiteOrBuilder
  27. abstract def getEnvironmentVariables(): Map[String, String]

    Use #getEnvironmentVariablesMap() instead.

    Use #getEnvironmentVariablesMap() instead.

    Annotations
    @Deprecated
    Deprecated

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from MessageOrBuilder

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped