Package software.amazon.awssdk.services.b2bi.model

Class GetTransformerJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.b2bi.model.B2BiResponse

software.amazon.awssdk.services.b2bi.model.GetTransformerJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTransformerJobResponse.Builder,GetTransformerJobResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetTransformerJobResponse
extends B2BiResponse
implements ToCopyableBuilder<GetTransformerJobResponse.Builder,GetTransformerJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetTransformerJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetTransformerJobResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOutputFiles()	For responses, this returns true if the service returned a value for the OutputFiles property.
String	message()	Returns an optional error message, which gets populated when the job is not run successfully.
List<S3Location>	outputFiles()	Returns the location for the output files.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTransformerJobResponse.Builder>	serializableBuilderClass()
TransformerJobStatus	status()	Returns the current state of the transformer job, either running, succeeded, or failed.
String	statusAsString()	Returns the current state of the transformer job, either running, succeeded, or failed.
GetTransformerJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.b2bi.model.B2BiResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

status

public final TransformerJobStatus status()

Returns the current state of the transformer job, either running, succeeded, or failed.

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

Returns:

Returns the current state of the transformer job, either running, succeeded, or failed.

See Also:

TransformerJobStatus

statusAsString

public final String statusAsString()

Returns the current state of the transformer job, either running, succeeded, or failed.

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

Returns:

Returns the current state of the transformer job, either running, succeeded, or failed.

See Also:

TransformerJobStatus

hasOutputFiles

public final boolean hasOutputFiles()

For responses, this returns true if the service returned a value for the OutputFiles 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.

outputFiles

public final List<S3Location> outputFiles()

Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.

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 hasOutputFiles() method.

Returns:

Returns the location for the output files. If the caller specified a directory for the output, then this contains the full path to the output file, including the file name generated by the service.

message

public final String message()

Returns an optional error message, which gets populated when the job is not run successfully.

Returns:

Returns an optional error message, which gets populated when the job is not run successfully.

toBuilder

public GetTransformerJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTransformerJobResponse.Builder,GetTransformerJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetTransformerJobResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo