Packages

c

org.apache.spark.connect.proto

AddArtifactsRequest

final class AddArtifactsRequest extends GeneratedMessage with AddArtifactsRequestOrBuilder

Request to transfer client-local artifacts.

Protobuf type spark.connect.AddArtifactsRequest

Linear Supertypes
AddArtifactsRequestOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AddArtifactsRequest
  2. AddArtifactsRequestOrBuilder
  3. GeneratedMessage
  4. Serializable
  5. AbstractMessage
  6. Message
  7. MessageOrBuilder
  8. AbstractMessageLite
  9. MessageLite
  10. MessageLiteOrBuilder
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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(obj: AnyRef): Boolean
    Definition Classes
    AddArtifactsRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  8. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  9. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  10. def getBatch(): Batch

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    returns

    The batch.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  11. def getBatchOrBuilder(): BatchOrBuilder

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  12. def getBeginChunk(): BeginChunkedArtifact

    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.


    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.

    .spark.connect.AddArtifactsRequest.BeginChunkedArtifact begin_chunk = 4;

    returns

    The beginChunk.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  13. def getBeginChunkOrBuilder(): BeginChunkedArtifactOrBuilder

    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.


    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.

    .spark.connect.AddArtifactsRequest.BeginChunkedArtifact begin_chunk = 4;

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  14. def getChunk(): ArtifactChunk

    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).


    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).

    .spark.connect.AddArtifactsRequest.ArtifactChunk chunk = 5;

    returns

    The chunk.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  15. def getChunkOrBuilder(): ArtifactChunkOrBuilder

    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).


    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).

    .spark.connect.AddArtifactsRequest.ArtifactChunk chunk = 5;

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. def getClientObservedServerSideSessionId(): String

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 7;

    returns

    The clientObservedServerSideSessionId.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  18. def getClientObservedServerSideSessionIdBytes(): ByteString

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 7;

    returns

    The bytes for clientObservedServerSideSessionId.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  19. def getClientType(): String

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 6;

    returns

    The clientType.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  20. def getClientTypeBytes(): ByteString

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 6;

    returns

    The bytes for clientType.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  21. def getDefaultInstanceForType(): AddArtifactsRequest
    Definition Classes
    AddArtifactsRequest → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  22. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  23. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  24. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  25. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  26. def getParserForType(): Parser[AddArtifactsRequest]
    Definition Classes
    AddArtifactsRequest → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  27. def getPayloadCase(): PayloadCase
    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
  28. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  29. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  30. def getSerializedSize(): Int
    Definition Classes
    AddArtifactsRequest → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  31. def getSessionId(): String

    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    string session_id = 1;

    returns

    The sessionId.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  32. def getSessionIdBytes(): ByteString

    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`


    (Required)

The session_id specifies a spark session for a user id (which is specified
by user_context.user_id). The session_id is set by the client to be able to
collate streaming responses from different queries within the dedicated session.
The id should be an UUID string of the format `00112233-4455-6677-8899-aabbccddeeff`

    string session_id = 1;

    returns

    The bytes for sessionId.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  33. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  34. def getUserContext(): UserContext

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    returns

    The userContext.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  35. def getUserContextOrBuilder(): UserContextOrBuilder

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  36. def hasBatch(): Boolean

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    .spark.connect.AddArtifactsRequest.Batch batch = 3;

    returns

    Whether the batch field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  37. def hasBeginChunk(): Boolean

    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.


    The metadata and the initial chunk of a large artifact chunked into multiple requests.
The server side is notified about the total size of the large artifact as well as the
number of chunks to expect.

    .spark.connect.AddArtifactsRequest.BeginChunkedArtifact begin_chunk = 4;

    returns

    Whether the beginChunk field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  38. def hasChunk(): Boolean

    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).


    A chunk of an artifact excluding metadata. This can be any chunk of a large artifact
excluding the first chunk (which is included in `BeginChunkedArtifact`).

    .spark.connect.AddArtifactsRequest.ArtifactChunk chunk = 5;

    returns

    Whether the chunk field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  39. def hasClientObservedServerSideSessionId(): Boolean

    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.


    (Optional)

Server-side generated idempotency key from the previous responses (if any). Server
can use this to validate that the server side session has not changed.

    optional string client_observed_server_side_session_id = 7;

    returns

    Whether the clientObservedServerSideSessionId field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  40. def hasClientType(): Boolean

    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.


    Provides optional information about the client sending the request. This field
can be used for language or version specific information and is only intended for
logging purposes and will not be interpreted by the server.

    optional string client_type = 6;

    returns

    Whether the clientType field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  41. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  42. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  43. def hasUserContext(): Boolean

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    returns

    Whether the userContext field is set.

    Definition Classes
    AddArtifactsRequest → AddArtifactsRequestOrBuilder
    Annotations
    @Override()
  44. def hashCode(): Int
    Definition Classes
    AddArtifactsRequest → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  45. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    AddArtifactsRequest → GeneratedMessage
    Annotations
    @Override()
  46. def internalGetMapFieldReflection(fieldNumber: Int): MapFieldReflectionAccessor
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  47. final def isInitialized(): Boolean
    Definition Classes
    AddArtifactsRequest → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    AddArtifactsRequest → AbstractMessage
    Annotations
    @Override()
  51. def newBuilderForType(): Builder
    Definition Classes
    AddArtifactsRequest → Message → MessageLite
    Annotations
    @Override()
  52. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  55. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  56. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. def toBuilder(): Builder
    Definition Classes
    AddArtifactsRequest → Message → MessageLite
    Annotations
    @Override()
  59. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  60. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  61. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  66. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  67. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    AddArtifactsRequest → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  68. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])

Deprecated Value Members

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

    (Since version 9)

  2. def internalGetMapField(fieldNumber: Int): MapField[_ <: AnyRef, _ <: AnyRef]
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @Deprecated
    Deprecated
  3. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[com.google.protobuf.InvalidProtocolBufferException]) @Deprecated
    Deprecated

Inherited from AddArtifactsRequestOrBuilder

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from AbstractMessage

Inherited from Message

Inherited from MessageOrBuilder

Inherited from AbstractMessageLite[MessageType, BuilderType]

Inherited from MessageLite

Inherited from MessageLiteOrBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped