software.amazon.awssdk.services.textract.model

Class OutputConfig

java.lang.Object

software.amazon.awssdk.services.textract.model.OutputConfig

All Implemented Interfaces:

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

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

Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OutputConfig.Builder

Method Summary

Modifier and Type	Method and Description
static OutputConfig.Builder	builder()
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()
String	s3Bucket() The name of the bucket your output will go to.
String	s3Prefix() The prefix of the object key that the output will be saved to.
List<SdkField<?>>	sdkFields()
static Class<? extends OutputConfig.Builder>	serializableBuilderClass()
OutputConfig.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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

s3Bucket

public final String s3Bucket()

The name of the bucket your output will go to.

Returns:

The name of the bucket your output will go to.

s3Prefix

public final String s3Prefix()

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

Returns:

The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output".

toBuilder

public OutputConfig.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<OutputConfig.Builder,OutputConfig>

Returns:

a builder for type T

builder

public static OutputConfig.Builder builder()

serializableBuilderClass

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