Packages

c

org.apache.spark.connect.proto

WriteOperation

final class WriteOperation extends GeneratedMessageV3 with WriteOperationOrBuilder 

As writes are not directly handled during analysis and planning, they are modeled as commands.

Protobuf type spark.connect.WriteOperation

Linear Supertypes
WriteOperationOrBuilder, GeneratedMessageV3, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteOperation
  2. WriteOperationOrBuilder
  3. GeneratedMessageV3
  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. All

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( ... ) @native()
  6. def containsOptions(key: String): Boolean 

    (Optional) A list of configuration options.


    (Optional) A list of configuration options.

    map<string, string> options = 9;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(obj: Any): Boolean
    Definition Classes
    WriteOperation → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  12. def getBucketBy(): BucketBy 

    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.


    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.

    .spark.connect.WriteOperation.BucketBy bucket_by = 8;

    returns

    The bucketBy.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  13. def getBucketByOrBuilder(): BucketByOrBuilder 

    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.


    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.

    .spark.connect.WriteOperation.BucketBy bucket_by = 8;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getDefaultInstanceForType(): WriteOperation
    Definition Classes
    WriteOperation → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  16. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  17. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  18. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  19. def getInput(): Relation 

    (Required) The output of the `input` relation will be persisted according to the options.


    (Required) The output of the `input` relation will be persisted according to the options.

    .spark.connect.Relation input = 1;

    returns

    The input.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  20. def getInputOrBuilder(): RelationOrBuilder 

    (Required) The output of the `input` relation will be persisted according to the options.


    (Required) The output of the `input` relation will be persisted according to the options.

    .spark.connect.Relation input = 1;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  21. def getMode(): SaveMode 

    (Required) the save mode.


    (Required) the save mode.

    .spark.connect.WriteOperation.SaveMode mode = 5;

    returns

    The mode.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  22. def getModeValue(): Int 

    (Required) the save mode.


    (Required) the save mode.

    .spark.connect.WriteOperation.SaveMode mode = 5;

    returns

    The enum numeric value on the wire for mode.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  23. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  24. def getOptionsCount(): Int 

    (Optional) A list of configuration options.


    (Optional) A list of configuration options.

    map<string, string> options = 9;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  25. def getOptionsMap(): Map[String, String] 

    (Optional) A list of configuration options.


    (Optional) A list of configuration options.

    map<string, string> options = 9;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  26. def getOptionsOrDefault(key: String, defaultValue: String): String 

    (Optional) A list of configuration options.


    (Optional) A list of configuration options.

    map<string, string> options = 9;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  27. def getOptionsOrThrow(key: String): String 

    (Optional) A list of configuration options.


    (Optional) A list of configuration options.

    map<string, string> options = 9;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  28. def getParserForType(): Parser[WriteOperation]
    Definition Classes
    WriteOperation → GeneratedMessageV3 → Message → MessageLite
    Annotations
    @Override()
  29. def getPartitioningColumns(index: Int): String 

    (Optional) List of columns for partitioning.


    (Optional) List of columns for partitioning.

    repeated string partitioning_columns = 7;

    index

    The index of the element to return.

    returns

    The partitioningColumns at the given index.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  30. def getPartitioningColumnsBytes(index: Int): ByteString 

    (Optional) List of columns for partitioning.


    (Optional) List of columns for partitioning.

    repeated string partitioning_columns = 7;

    index

    The index of the value to return.

    returns

    The bytes of the partitioningColumns at the given index.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  31. def getPartitioningColumnsCount(): Int 

    (Optional) List of columns for partitioning.


    (Optional) List of columns for partitioning.

    repeated string partitioning_columns = 7;

    returns

    The count of partitioningColumns.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  32. def getPartitioningColumnsList(): ProtocolStringList 

    (Optional) List of columns for partitioning.


    (Optional) List of columns for partitioning.

    repeated string partitioning_columns = 7;

    returns

    A list containing the partitioningColumns.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  33. def getPath(): String

    string path = 3;

    string path = 3;

    returns

    The path.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  34. def getPathBytes(): ByteString

    string path = 3;

    string path = 3;

    returns

    The bytes for path.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  35. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  36. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  37. def getSaveTypeCase(): SaveTypeCase
    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  38. def getSerializedSize(): Int
    Definition Classes
    WriteOperation → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  39. def getSortColumnNames(index: Int): String 

    (Optional) List of columns to sort the output by.


    (Optional) List of columns to sort the output by.

    repeated string sort_column_names = 6;

    index

    The index of the element to return.

    returns

    The sortColumnNames at the given index.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  40. def getSortColumnNamesBytes(index: Int): ByteString 

    (Optional) List of columns to sort the output by.


    (Optional) List of columns to sort the output by.

    repeated string sort_column_names = 6;

    index

    The index of the value to return.

    returns

    The bytes of the sortColumnNames at the given index.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  41. def getSortColumnNamesCount(): Int 

    (Optional) List of columns to sort the output by.


    (Optional) List of columns to sort the output by.

    repeated string sort_column_names = 6;

    returns

    The count of sortColumnNames.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  42. def getSortColumnNamesList(): ProtocolStringList 

    (Optional) List of columns to sort the output by.


    (Optional) List of columns to sort the output by.

    repeated string sort_column_names = 6;

    returns

    A list containing the sortColumnNames.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  43. def getSource(): String 

    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.


    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.

    optional string source = 2;

    returns

    The source.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  44. def getSourceBytes(): ByteString 

    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.


    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.

    optional string source = 2;

    returns

    The bytes for source.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  45. def getTable(): SaveTable

    .spark.connect.WriteOperation.SaveTable table = 4;

    .spark.connect.WriteOperation.SaveTable table = 4;

    returns

    The table.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  46. def getTableOrBuilder(): SaveTableOrBuilder

    .spark.connect.WriteOperation.SaveTable table = 4;

    .spark.connect.WriteOperation.SaveTable table = 4;

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  47. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  48. def hasBucketBy(): Boolean 

    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.


    (Optional) Bucketing specification. Bucketing must set the number of buckets and the columns
to bucket by.

    .spark.connect.WriteOperation.BucketBy bucket_by = 8;

    returns

    Whether the bucketBy field is set.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  49. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → MessageOrBuilder
  50. def hasInput(): Boolean 

    (Required) The output of the `input` relation will be persisted according to the options.


    (Required) The output of the `input` relation will be persisted according to the options.

    .spark.connect.Relation input = 1;

    returns

    Whether the input field is set.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  51. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessageV3 → AbstractMessage → MessageOrBuilder
  52. def hasPath(): Boolean

    string path = 3;

    string path = 3;

    returns

    Whether the path field is set.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
  53. def hasSource(): Boolean 

    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.


    (Optional) Format value according to the Spark documentation. Examples are: text, parquet, delta.

    optional string source = 2;

    returns

    Whether the source field is set.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  54. def hasTable(): Boolean

    .spark.connect.WriteOperation.SaveTable table = 4;

    .spark.connect.WriteOperation.SaveTable table = 4;

    returns

    Whether the table field is set.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override()
  55. def hashCode(): Int
    Definition Classes
    WriteOperation → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  56. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    WriteOperation → GeneratedMessageV3
    Annotations
    @Override()
  57. def internalGetMapField(number: Int): MapField
    Attributes
    protected[proto]
    Definition Classes
    WriteOperation → GeneratedMessageV3
    Annotations
    @SuppressWarnings() @Override()
  58. final def isInitialized(): Boolean
    Definition Classes
    WriteOperation → GeneratedMessageV3 → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. def makeExtensionsImmutable(): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    WriteOperation → GeneratedMessageV3
    Annotations
    @Override()
  63. def newBuilderForType(): Builder
    Definition Classes
    WriteOperation → Message → MessageLite
    Annotations
    @Override()
  64. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3 → AbstractMessage
  65. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[proto]
    Definition Classes
    WriteOperation → GeneratedMessageV3
    Annotations
    @Override() @SuppressWarnings()
  66. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  67. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  69. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( classOf[java.io.IOException] )
  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toBuilder(): Builder
    Definition Classes
    WriteOperation → Message → MessageLite
    Annotations
    @Override()
  72. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  73. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  74. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  78. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )
  79. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... )
  80. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    WriteOperation → GeneratedMessageV3 → AbstractMessage → MessageLite
    Annotations
    @Override()
  81. def writeTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws( classOf[java.io.IOException] )

Deprecated Value Members

  1. def getOptions(): Map[String, String]

    Use #getOptionsMap() instead.

    Use #getOptionsMap() instead.

    Definition Classes
    WriteOperation → WriteOperationOrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  2. def mergeFromAndMakeImmutableInternal(input: CodedInputStream, extensionRegistry: ExtensionRegistryLite): Unit
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessageV3
    Annotations
    @throws( ... ) @Deprecated
    Deprecated

Inherited from WriteOperationOrBuilder

Inherited from GeneratedMessageV3

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