StreamOptions (Oracle Cloud Infrastructure Java SDK - 3.75.0)

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.generativeaiinference.model.StreamOptions

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20231130")
public final class StreamOptions
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Options for streaming response.
Only set this when you set stream: true.
Note: Objects should always be created or deserialized using the StreamOptions.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the StreamOptions.Builder, which maintain a set of all explicitly set fields called StreamOptions.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class StreamOptions.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor Description

StreamOptions(Boolean isIncludeUsage)
Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StreamOptions.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`Boolean`	`getIsIncludeUsage()`	If set, an additional chunk will be streamed before the data: [DONE] message.
`int`	`hashCode()`
`StreamOptions.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

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

- Constructor Detail
  - StreamOptions
```
@Deprecated
@ConstructorProperties("isIncludeUsage")
public StreamOptions(Boolean isIncludeUsage)
```
    Deprecated.
- Method Detail
  - builder
```
public static StreamOptions.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public StreamOptions.Builder toBuilder()
```
  - getIsIncludeUsage
```
public Boolean getIsIncludeUsage()
```
    If set, an additional chunk will be streamed before the data: [DONE] message.
    The usage field on this chunk shows the token usage statistics for the entire request
    
    Returns:
    
    the value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - toString
```
public String toString(boolean includeByteArrayContents)
```
    Return a string representation of the object.
    
    Parameters:
    
    includeByteArrayContents - true to include the full contents of byte arrays
    
    Returns:
    
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel