DocumentBlock (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockruntime.model.DocumentBlock

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DocumentBlock
extends Object
implements Serializable, Cloneable, StructuredPojo

A document to include in a message.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DocumentBlock()

Constructors
Constructor and Description
`DocumentBlock()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentBlock`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFormat()` The format of a document, or its extension.
`String`	`getName()` A name for the document.
`DocumentSource`	`getSource()` Contains the content of the document.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFormat(String format)` The format of a document, or its extension.
`void`	`setName(String name)` A name for the document.
`void`	`setSource(DocumentSource source)` Contains the content of the document.
`String`	`toString()` Returns a string representation of this object.
`DocumentBlock`	`withFormat(DocumentFormat format)` The format of a document, or its extension.
`DocumentBlock`	`withFormat(String format)` The format of a document, or its extension.
`DocumentBlock`	`withName(String name)` A name for the document.
`DocumentBlock`	`withSource(DocumentSource source)` Contains the content of the document.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DocumentBlock
```
public DocumentBlock()
```
- Method Detail
  - setFormat
```
public void setFormat(String format)
```
    The format of a document, or its extension.
    
    Parameters:
    
    format - The format of a document, or its extension.
    
    See Also:
    
    DocumentFormat
  - getFormat
```
public String getFormat()
```
    The format of a document, or its extension.
    
    Returns:
    
    The format of a document, or its extension.
    
    See Also:
    
    DocumentFormat
  - withFormat
```
public DocumentBlock withFormat(String format)
```
    The format of a document, or its extension.
    
    Parameters:
    
    format - The format of a document, or its extension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - withFormat
```
public DocumentBlock withFormat(DocumentFormat format)
```
    The format of a document, or its extension.
    
    Parameters:
    
    format - The format of a document, or its extension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentFormat
  - setName
```
public void setName(String name)
```
    A name for the document. The name can only contain the following characters:
    - Alphanumeric characters
    - Whitespace characters (no more than one in a row)
    - Hyphens
    - Parentheses
    - Square brackets
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
    Parameters:
    name - A name for the document. The name can only contain the following characters:
    
    Alphanumeric characters
    
    Whitespace characters (no more than one in a row)
    
    Hyphens
    
    Parentheses
    
    Square brackets
    
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
  - getName
```
public String getName()
```
    A name for the document. The name can only contain the following characters:
    - Alphanumeric characters
    - Whitespace characters (no more than one in a row)
    - Hyphens
    - Parentheses
    - Square brackets
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
    Returns:
    A name for the document. The name can only contain the following characters:
    
    Alphanumeric characters
    
    Whitespace characters (no more than one in a row)
    
    Hyphens
    
    Parentheses
    
    Square brackets
    
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
  - withName
```
public DocumentBlock withName(String name)
```
    A name for the document. The name can only contain the following characters:
    - Alphanumeric characters
    - Whitespace characters (no more than one in a row)
    - Hyphens
    - Parentheses
    - Square brackets
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
    Parameters:
    name - A name for the document. The name can only contain the following characters:
    
    Alphanumeric characters
    
    Whitespace characters (no more than one in a row)
    
    Hyphens
    
    Parentheses
    
    Square brackets
    
    This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(DocumentSource source)
```
    Contains the content of the document.
    
    Parameters:
    
    source - Contains the content of the document.
  - getSource
```
public DocumentSource getSource()
```
    Contains the content of the document.
    
    Returns:
    
    Contains the content of the document.
  - withSource
```
public DocumentBlock withSource(DocumentSource source)
```
    Contains the content of the document.
    
    Parameters:
    
    source - Contains the content of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DocumentBlock clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class DocumentBlock

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentBlock

Method Detail

setFormat

getFormat

withFormat

withFormat

setName

getName

withName

setSource

getSource

withSource

toString

equals

hashCode

clone

marshall