Class CSVInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CSVInput.Builder,
CSVInput>
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies that CSV field values may contain quoted record delimiters and such records should be allowed.static CSVInput.Builder
builder()
final String
comments()
A single character used to indicate that a row should be ignored when the character is present at the start of that row.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
A single character used to separate individual fields in a record.final FileHeaderInfo
Describes the first line of input.final String
Describes the first line of input.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
A single character used for escaping when the field delimiter is part of the value.final String
A single character used for escaping the quotation mark character inside an already escaped value.final String
A single character used to separate individual records in the input.static Class
<? extends CSVInput.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fileHeaderInfo
Describes the first line of input. Valid values are:
-
NONE
: First line is not a header. -
IGNORE
: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s
). -
Use
: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT
).
If the service returns an enum value that is not available in the current SDK version,
fileHeaderInfo
will returnFileHeaderInfo.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileHeaderInfoAsString()
.- Returns:
- Describes the first line of input. Valid values are:
-
NONE
: First line is not a header. -
IGNORE
: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s
). -
Use
: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT
).
-
- See Also:
-
-
fileHeaderInfoAsString
Describes the first line of input. Valid values are:
-
NONE
: First line is not a header. -
IGNORE
: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s
). -
Use
: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT
).
If the service returns an enum value that is not available in the current SDK version,
fileHeaderInfo
will returnFileHeaderInfo.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfileHeaderInfoAsString()
.- Returns:
- Describes the first line of input. Valid values are:
-
NONE
: First line is not a header. -
IGNORE
: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s
). -
Use
: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT
).
-
- See Also:
-
-
comments
A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is
#
.Default:
#
- Returns:
- A single character used to indicate that a row should be ignored when the character is present at the
start of that row. You can specify any character to indicate a comment line. The default character is
#
.Default:
#
-
quoteEscapeCharacter
A single character used for escaping the quotation mark character inside an already escaped value. For example, the value
""" a , b """
is parsed as" a , b "
.- Returns:
- A single character used for escaping the quotation mark character inside an already escaped value. For
example, the value
""" a , b """
is parsed as" a , b "
.
-
recordDelimiter
A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
- Returns:
- A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
-
fieldDelimiter
A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
- Returns:
- A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
-
quoteCharacter
A single character used for escaping when the field delimiter is part of the value. For example, if the value is
a, b
, Amazon S3 wraps this field value in quotation marks, as follows:" a , b "
.Type: String
Default:
"
Ancestors:
CSV
- Returns:
- A single character used for escaping when the field delimiter is part of the value. For example, if the
value is
a, b
, Amazon S3 wraps this field value in quotation marks, as follows:" a , b "
.Type: String
Default:
"
Ancestors:
CSV
-
allowQuotedRecordDelimiter
Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
- Returns:
- Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CSVInput.Builder,
CSVInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-