Class ContentBlockStartEvent

java.lang.Object

software.amazon.awssdk.services.bedrockruntime.model.ContentBlockStartEvent

All Implemented Interfaces:

Serializable, SdkPojo, ConverseStreamOutput, ToCopyableBuilder<ContentBlockStartEvent.Builder,ContentBlockStartEvent>

Direct Known Subclasses:

DefaultContentBlockStart

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

Content block start event.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ContentBlockStartEvent.Builder

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

ConverseStreamOutput.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockruntime.model.ConverseStreamOutput

UNKNOWN

Method Summary

Modifier and Type	Method	Description
void	accept(ConverseStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of ContentBlockStartEvent.
static ContentBlockStartEvent.Builder	builder()
final Integer	contentBlockIndex()	The index for a content block start event.
final ContentBlockStartEvent	copy(Consumer<? super ContentBlockStartEvent.Builder> modifier)	A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends ContentBlockStartEvent.Builder>	serializableBuilderClass()
final ContentBlockStart	start()	Start information about a content block start event.
ContentBlockStartEvent.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final 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.services.bedrockruntime.model.ConverseStreamOutput

sdkEventType

Method Details

start

public final ContentBlockStart start()

Start information about a content block start event.

Returns:

Start information about a content block start event.

contentBlockIndex

public final Integer contentBlockIndex()

The index for a content block start event.

Returns:

The index for a content block start event.

toBuilder

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

Returns:

a builder for type T

builder

public static ContentBlockStartEvent.Builder builder()

serializableBuilderClass

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

copy

public final ContentBlockStartEvent copy(Consumer<? super ContentBlockStartEvent.Builder> modifier)

Description copied from interface: ToCopyableBuilder

A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.

Specified by:

copy in interface ToCopyableBuilder<ContentBlockStartEvent.Builder,ContentBlockStartEvent>

Parameters:

modifier - A function that mutates this immutable object using the provided builder.

Returns:

A new copy of this object with the requested modifications.

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.

accept

public void accept(ConverseStreamResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of ContentBlockStartEvent.

Specified by:

accept in interface ConverseStreamOutput

Parameters:

visitor - Visitor to invoke.