Packages

c

org.apache.spark.connect.proto

WriteOperationV2

final class WriteOperationV2 extends GeneratedMessage with WriteOperationV2OrBuilder

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

Protobuf type spark.connect.WriteOperationV2

Linear Supertypes
WriteOperationV2OrBuilder, GeneratedMessage, Serializable, AbstractMessage, Message, MessageOrBuilder, AbstractMessageLite[MessageType, BuilderType], MessageLite, MessageLiteOrBuilder, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteOperationV2
  2. WriteOperationV2OrBuilder
  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. def containsOptions(key: String): Boolean

    (Optional) A list of configuration options.
    

    (Optional) A list of configuration options.
    

    map<string, string> options = 5;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  7. def containsTableProperties(key: String): Boolean

    (Optional) A list of table properties.
    

    (Optional) A list of table properties.
    

    map<string, string> table_properties = 6;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(obj: AnyRef): Boolean
    Definition Classes
    WriteOperationV2 → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  10. def findInitializationErrors(): List[String]
    Definition Classes
    AbstractMessage → MessageOrBuilder
  11. def getAllFields(): Map[FieldDescriptor, AnyRef]
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def getClusteringColumns(index: Int): String

    (Optional) Columns used for clustering the table.
    

    (Optional) Columns used for clustering the table.
    

    repeated string clustering_columns = 9;

    index

    The index of the element to return.

    returns

    The clusteringColumns at the given index.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  14. def getClusteringColumnsBytes(index: Int): ByteString

    (Optional) Columns used for clustering the table.
    

    (Optional) Columns used for clustering the table.
    

    repeated string clustering_columns = 9;

    index

    The index of the value to return.

    returns

    The bytes of the clusteringColumns at the given index.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  15. def getClusteringColumnsCount(): Int

    (Optional) Columns used for clustering the table.
    

    (Optional) Columns used for clustering the table.
    

    repeated string clustering_columns = 9;

    returns

    The count of clusteringColumns.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  16. def getClusteringColumnsList(): ProtocolStringList

    (Optional) Columns used for clustering the table.
    

    (Optional) Columns used for clustering the table.
    

    repeated string clustering_columns = 9;

    returns

    A list containing the clusteringColumns.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  17. def getDefaultInstanceForType(): WriteOperationV2
    Definition Classes
    WriteOperationV2 → MessageOrBuilder → MessageLiteOrBuilder
    Annotations
    @Override()
  18. def getDescriptorForType(): Descriptor
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  19. def getField(field: FieldDescriptor): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  20. def getInitializationErrorString(): String
    Definition Classes
    AbstractMessage → MessageOrBuilder
  21. 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
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  22. 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
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  23. def getMode(): Mode

    (Required) Write mode.
    

    (Required) Write mode.
    

    .spark.connect.WriteOperationV2.Mode mode = 7;

    returns

    The mode.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  24. def getModeValue(): Int

    (Required) Write mode.
    

    (Required) Write mode.
    

    .spark.connect.WriteOperationV2.Mode mode = 7;

    returns

    The enum numeric value on the wire for mode.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  25. def getOneofFieldDescriptor(oneof: OneofDescriptor): FieldDescriptor
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  26. def getOptionsCount(): Int

    (Optional) A list of configuration options.
    

    (Optional) A list of configuration options.
    

    map<string, string> options = 5;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  27. def getOptionsMap(): Map[String, String]

    (Optional) A list of configuration options.
    

    (Optional) A list of configuration options.
    

    map<string, string> options = 5;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  28. def getOptionsOrDefault(key: String, defaultValue: String): String

    (Optional) A list of configuration options.
    

    (Optional) A list of configuration options.
    

    map<string, string> options = 5;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  29. def getOptionsOrThrow(key: String): String

    (Optional) A list of configuration options.
    

    (Optional) A list of configuration options.
    

    map<string, string> options = 5;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  30. def getOverwriteCondition(): Expression

    (Optional) A condition for overwrite saving mode
    

    (Optional) A condition for overwrite saving mode
    

    .spark.connect.Expression overwrite_condition = 8;

    returns

    The overwriteCondition.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  31. def getOverwriteConditionOrBuilder(): ExpressionOrBuilder

    (Optional) A condition for overwrite saving mode
    

    (Optional) A condition for overwrite saving mode
    

    .spark.connect.Expression overwrite_condition = 8;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  32. def getParserForType(): Parser[WriteOperationV2]
    Definition Classes
    WriteOperationV2 → GeneratedMessage → Message → MessageLite
    Annotations
    @Override()
  33. def getPartitioningColumns(index: Int): Expression

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    repeated .spark.connect.Expression partitioning_columns = 4;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  34. def getPartitioningColumnsCount(): Int

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    repeated .spark.connect.Expression partitioning_columns = 4;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  35. def getPartitioningColumnsList(): List[Expression]

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    repeated .spark.connect.Expression partitioning_columns = 4;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  36. def getPartitioningColumnsOrBuilder(index: Int): ExpressionOrBuilder

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    repeated .spark.connect.Expression partitioning_columns = 4;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  37. def getPartitioningColumnsOrBuilderList(): List[_ <: ExpressionOrBuilder]

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    (Optional) List of columns for partitioning for output table created by `create`,
    `createOrReplace`, or `replace`
    

    repeated .spark.connect.Expression partitioning_columns = 4;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  38. def getProvider(): String

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    optional string provider = 3;

    returns

    The provider.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  39. def getProviderBytes(): ByteString

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    optional string provider = 3;

    returns

    The bytes for provider.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  40. def getRepeatedField(field: FieldDescriptor, index: Int): AnyRef
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  41. def getRepeatedFieldCount(field: FieldDescriptor): Int
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  42. def getSerializedSize(): Int
    Definition Classes
    WriteOperationV2 → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  43. def getTableName(): String

    (Required) The destination of the write operation must be either a path or a table.
    

    (Required) The destination of the write operation must be either a path or a table.
    

    string table_name = 2;

    returns

    The tableName.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  44. def getTableNameBytes(): ByteString

    (Required) The destination of the write operation must be either a path or a table.
    

    (Required) The destination of the write operation must be either a path or a table.
    

    string table_name = 2;

    returns

    The bytes for tableName.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  45. def getTablePropertiesCount(): Int

    (Optional) A list of table properties.
    

    (Optional) A list of table properties.
    

    map<string, string> table_properties = 6;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
  46. def getTablePropertiesMap(): Map[String, String]

    (Optional) A list of table properties.
    

    (Optional) A list of table properties.
    

    map<string, string> table_properties = 6;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  47. def getTablePropertiesOrDefault(key: String, defaultValue: String): String

    (Optional) A list of table properties.
    

    (Optional) A list of table properties.
    

    map<string, string> table_properties = 6;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  48. def getTablePropertiesOrThrow(key: String): String

    (Optional) A list of table properties.
    

    (Optional) A list of table properties.
    

    map<string, string> table_properties = 6;

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  49. def getUnknownFields(): UnknownFieldSet
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  50. def hasField(field: FieldDescriptor): Boolean
    Definition Classes
    GeneratedMessage → MessageOrBuilder
  51. 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
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  52. def hasOneof(oneof: OneofDescriptor): Boolean
    Definition Classes
    GeneratedMessage → AbstractMessage → MessageOrBuilder
  53. def hasOverwriteCondition(): Boolean

    (Optional) A condition for overwrite saving mode
    

    (Optional) A condition for overwrite saving mode
    

    .spark.connect.Expression overwrite_condition = 8;

    returns

    Whether the overwriteCondition field is set.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  54. def hasProvider(): Boolean

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    (Optional) A provider for the underlying output data source. Spark's default catalog supports
    "parquet", "json", etc.
    

    optional string provider = 3;

    returns

    Whether the provider field is set.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override()
  55. def hashCode(): Int
    Definition Classes
    WriteOperationV2 → AbstractMessage → Message → AnyRef → Any
    Annotations
    @Override()
  56. def internalGetFieldAccessorTable(): FieldAccessorTable
    Attributes
    protected[proto]
    Definition Classes
    WriteOperationV2 → GeneratedMessage
    Annotations
    @Override()
  57. def internalGetMapFieldReflection(number: Int): MapFieldReflectionAccessor
    Attributes
    protected[proto]
    Definition Classes
    WriteOperationV2 → GeneratedMessage
    Annotations
    @SuppressWarnings() @Override()
  58. final def isInitialized(): Boolean
    Definition Classes
    WriteOperationV2 → GeneratedMessage → AbstractMessage → MessageLiteOrBuilder
    Annotations
    @Override()
  59. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. def newBuilderForType(parent: BuilderParent): Builder
    Attributes
    protected[proto]
    Definition Classes
    WriteOperationV2 → AbstractMessage
    Annotations
    @Override()
  62. def newBuilderForType(): Builder
    Definition Classes
    WriteOperationV2 → Message → MessageLite
    Annotations
    @Override()
  63. def newInstance(unused: UnusedPrivateParameter): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  66. def parseUnknownField(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  67. def parseUnknownFieldProto3(input: CodedInputStream, unknownFields: Builder, extensionRegistry: ExtensionRegistryLite, tag: Int): Boolean
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.IOException])
  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. def toBuilder(): Builder
    Definition Classes
    WriteOperationV2 → Message → MessageLite
    Annotations
    @Override()
  70. def toByteArray(): Array[Byte]
    Definition Classes
    AbstractMessageLite → MessageLite
  71. def toByteString(): ByteString
    Definition Classes
    AbstractMessageLite → MessageLite
  72. final def toString(): String
    Definition Classes
    AbstractMessage → Message → AnyRef → Any
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    AbstractMessageLite → MessageLite
    Annotations
    @throws(classOf[java.io.IOException])
  77. def writeReplace(): AnyRef
    Attributes
    protected[protobuf]
    Definition Classes
    GeneratedMessage
    Annotations
    @throws(classOf[java.io.ObjectStreamException])
  78. def writeTo(output: CodedOutputStream): Unit
    Definition Classes
    WriteOperationV2 → GeneratedMessage → AbstractMessage → MessageLite
    Annotations
    @Override()
  79. 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 getOptions(): Map[String, String]

    Use #getOptionsMap() instead.

    Use #getOptionsMap() instead.

    Definition Classes
    WriteOperationV2WriteOperationV2OrBuilder
    Annotations
    @Override() @Deprecated
    Deprecated
  3. def getTableProperties(): Map[String, String]

    Use #getTablePropertiesMap() instead.

    Use #getTablePropertiesMap() instead.

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

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