Class CSVOutput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CSVOutput.Builder,
CSVOutput>
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic CSVOutput.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The value used to separate individual fields in a record.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
The single character used for escaping the quote character inside an already escaped value.final QuoteFields
Indicates whether to use quotation marks around output fields.final String
Indicates whether to use quotation marks around output fields.final String
A single character used to separate individual records in the output.static Class
<? extends CSVOutput.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
-
quoteFields
Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
If the service returns an enum value that is not available in the current SDK version,
quoteFields
will returnQuoteFields.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromquoteFieldsAsString()
.- Returns:
- Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
-
- See Also:
-
-
quoteFieldsAsString
Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
If the service returns an enum value that is not available in the current SDK version,
quoteFields
will returnQuoteFields.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromquoteFieldsAsString()
.- Returns:
- Indicates whether to use quotation marks around output fields.
-
ALWAYS
: Always use quotation marks for output fields. -
ASNEEDED
: Use quotation marks for output fields when needed.
-
- See Also:
-
-
quoteEscapeCharacter
The single character used for escaping the quote character inside an already escaped value.
- Returns:
- The single character used for escaping the quote character inside an already escaped value.
-
recordDelimiter
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
- Returns:
- A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
-
fieldDelimiter
The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
- Returns:
- The value 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 "
.- 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 "
.
-
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<CSVOutput.Builder,
CSVOutput> - 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
-