Packages

c

org.apache.spark.connect.proto

ArtifactStatusesRequest

final class ArtifactStatusesRequest extends GeneratedMessage with ArtifactStatusesRequestOrBuilder

Request to get current statuses of artifacts at the server side.

Protobuf type spark.connect.ArtifactStatusesRequest

Linear Supertypes
ArtifactStatusesRequestOrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArtifactStatusesRequest
  2. ArtifactStatusesRequestOrBuilder
  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
    ArtifactStatusesRequest → 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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. 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 = 5;

    returns

    The clientObservedServerSideSessionId.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  12. 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 = 5;

    returns

    The bytes for clientObservedServerSideSessionId.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  13. 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 = 3;

    returns

    The clientType.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  14. 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 = 3;

    returns

    The bytes for clientType.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  15. def getDefaultInstanceForType(): ArtifactStatusesRequest
    Definition Classes
    ArtifactStatusesRequest → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  16. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  17. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getNames(index: Int): String

    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)


    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)

    repeated string names = 4;

    index

    The index of the element to return.

    returns

    The names at the given index.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
  20. def getNamesBytes(index: Int): ByteString

    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)


    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)

    repeated string names = 4;

    index

    The index of the value to return.

    returns

    The bytes of the names at the given index.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
  21. def getNamesCount(): Int

    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)


    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)

    repeated string names = 4;

    returns

    The count of names.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
  22. def getNamesList(): ProtocolStringList

    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)


    The name of the artifact is expected in the form of a "Relative Path" that is made up of a
sequence of directories and the final file element.
Examples of "Relative Path"s: "jars/test.jar", "classes/xyz.class", "abc.xyz", "a/b/X.jar".
The server is expected to maintain the hierarchy of files as defined by their name. (i.e
The relative path of the file on the server's filesystem will be the same as the name of
the provided artifact)

    repeated string names = 4;

    returns

    A list containing the names.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
  23. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  24. def getParserForType(): Parser[ArtifactStatusesRequest]
    Definition Classes
    ArtifactStatusesRequest → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  25. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  26. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  27. def getSerializedSize(): Int
    Definition Classes
    ArtifactStatusesRequest → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  28. 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
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  29. 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
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  30. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  31. def getUserContext(): UserContext

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    returns

    The userContext.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  32. def getUserContextOrBuilder(): UserContextOrBuilder

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  33. 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 = 5;

    returns

    Whether the clientObservedServerSideSessionId field is set.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  34. 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 = 3;

    returns

    Whether the clientType field is set.

    Definition Classes
    ArtifactStatusesRequest → ArtifactStatusesRequestOrBuilder
    Annotations
    @Override()
  35. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  36. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  37. def hasUserContext(): Boolean

    User context


    User context

    .spark.connect.UserContext user_context = 2;

    returns

    Whether the userContext field is set.

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

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