Package software.amazon.awssdk.services.comprehend.model

Class BlockReference

java.lang.Object

software.amazon.awssdk.services.comprehend.model.BlockReference

All Implemented Interfaces:

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

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

A reference to a block.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BlockReference.Builder

Method Summary

Modifier and Type	Method	Description
Integer	beginOffset()	Offset of the start of the block within its parent block.
String	blockId()	Unique identifier for the block.
static BlockReference.Builder	builder()
List<ChildBlock>	childBlocks()	List of child blocks within this block.
Integer	endOffset()	Offset of the end of the block within its parent block.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChildBlocks()	For responses, this returns true if the service returned a value for the ChildBlocks property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends BlockReference.Builder>	serializableBuilderClass()
BlockReference.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

blockId

public final String blockId()

Unique identifier for the block.

Returns:

Unique identifier for the block.

beginOffset

public final Integer beginOffset()

Offset of the start of the block within its parent block.

Returns:

Offset of the start of the block within its parent block.

endOffset

public final Integer endOffset()

Offset of the end of the block within its parent block.

Returns:

Offset of the end of the block within its parent block.

hasChildBlocks

public final boolean hasChildBlocks()

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

childBlocks

public final List<ChildBlock> childBlocks()

List of child blocks within this block.

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

Returns:

List of child blocks within this block.

toBuilder

public BlockReference.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BlockReference.Builder,BlockReference>

builder

public static BlockReference.Builder builder()

serializableBuilderClass

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