Package software.amazon.awssdk.services.s3control.model

Class JobManifestSpec

java.lang.Object

software.amazon.awssdk.services.s3control.model.JobManifestSpec

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class JobManifestSpec
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobManifestSpec.Builder,JobManifestSpec>

Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobManifestSpec.Builder

Method Summary

Modifier and Type	Method	Description
static JobManifestSpec.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<JobManifestFieldName>	fields()	If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
List<String>	fieldsAsStrings()	If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.
JobManifestFormat	format()	Indicates which of the available formats the specified manifest uses.
String	formatAsString()	Indicates which of the available formats the specified manifest uses.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends JobManifestSpec.Builder>	serializableBuilderClass()
JobManifestSpec.Builder	toBuilder()
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 software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

format

public final JobManifestFormat format()

Indicates which of the available formats the specified manifest uses.

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

Returns:

Indicates which of the available formats the specified manifest uses.

See Also:

JobManifestFormat

formatAsString

public final String formatAsString()

Indicates which of the available formats the specified manifest uses.

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

Returns:

Indicates which of the available formats the specified manifest uses.

See Also:

JobManifestFormat

fields

public final List<JobManifestFieldName> fields()

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFields() method.

Returns:

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

hasFields

public final boolean hasFields()

For responses, this returns true if the service returned a value for the Fields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fieldsAsStrings

public final List<String> fieldsAsStrings()

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFields() method.

Returns:

If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

toBuilder

public JobManifestSpec.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobManifestSpec.Builder,JobManifestSpec>

builder

public static JobManifestSpec.Builder builder()

serializableBuilderClass

public static Class<? extends JobManifestSpec.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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