Encoding Trait

On This Page
Fully Qualified Name

io.iguaz.v3io.spark.streaming.Encoding

Description

A trait for defining a class that returns a string character encoding.

Summary

Prototype

trait Encoding
Methods
  • encoding

    def encoding(config: Option[Properties] = None): Charset

Prototype

trait Encoding

encoding Method

Returns a character encoding.

Syntax

encoding(config: Option[Properties] = None): Charset

Parameters

config

Optional parameter for setting the returned character encoding. When provided, if the properties include the “v3io.streaming.encoding” property, the method returns a Charset instance that corresponds to the value of this property. The property value can be any StandardCharsets constant (for example, "UTF_8").

  • Type: Option[Properties]
  • Requirement: Optional
  • Default Character Encoding: When the config parameter is not provided or does not include the character-encoding configuration property, the method returns a UTF8 character encoding — UTF-8 Charset.

Return Value

Returns a character encoding (Charset).