com.ibm.cos.v2.services.s3.model

Class InputSerialization

java.lang.Object

com.ibm.cos.v2.services.s3.model.InputSerialization

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<InputSerialization.Builder,InputSerialization>, Serializable

@Generated(value="com.ibm.cos.v2:codegen")
public final class InputSerialization
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InputSerialization.Builder,InputSerialization>

Describes the serialization format of the object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputSerialization.Builder

Method Summary

Modifier and Type	Method and Description
static InputSerialization.Builder	builder()
CompressionType	compressionType() Specifies object's compression format.
String	compressionTypeAsString() Specifies object's compression format.
CSVInput	csv() Describes the serialization of a CSV-encoded object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
JSONInput	json() Specifies JSON as object's input serialization format.
ParquetInput	parquet() Specifies Parquet as object's input serialization format.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends InputSerialization.Builder>	serializableBuilderClass()
InputSerialization.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

csv

public final CSVInput csv()

Describes the serialization of a CSV-encoded object.

Returns:

Describes the serialization of a CSV-encoded object.

compressionType

public final CompressionType compressionType()

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

Returns:

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

See Also:

CompressionType

compressionTypeAsString

public final String compressionTypeAsString()

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

If the service returns an enum value that is not available in the current SDK version, compressionType will return CompressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionTypeAsString().

Returns:

Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

See Also:

CompressionType

json

public final JSONInput json()

Specifies JSON as object's input serialization format.

Returns:

Specifies JSON as object's input serialization format.

parquet

public final ParquetInput parquet()

Specifies Parquet as object's input serialization format.

Returns:

Specifies Parquet as object's input serialization format.

toBuilder

public InputSerialization.Builder 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 interface ToCopyableBuilder<InputSerialization.Builder,InputSerialization>

Returns:

a builder for type T

builder

public static InputSerialization.Builder builder()

serializableBuilderClass

public static Class<? extends InputSerialization.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.