ToolChoice.Type (Oracle Cloud Infrastructure Java SDK - 3.72.1)

java.lang.Object
- java.lang.Enum<ToolChoice.Type>
- - com.oracle.bmc.generativeaiinference.model.ToolChoice.Type

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<ToolChoice.Type>

Enclosing class:

ToolChoice
```
public static enum ToolChoice.Type
extends Enum<ToolChoice.Type>
implements BmcEnum
```
The tool choice.

Enum Constant Summary

Enum Constants
Enum Constant Description

Auto

Function

None

Required

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ToolChoice.Type`	`create(String key)`
`String`	`getValue()`
`static ToolChoice.Type`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ToolChoice.Type[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - None
```
public static final ToolChoice.Type None
```
  - Auto
```
public static final ToolChoice.Type Auto
```
  - Required
```
public static final ToolChoice.Type Required
```
  - Function
```
public static final ToolChoice.Type Function
```
- Method Detail
  - values
```
public static ToolChoice.Type[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (ToolChoice.Type c : ToolChoice.Type.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ToolChoice.Type valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getValue
```
public String getValue()
```
    Specified by:
    
    getValue in interface BmcEnum
  - create
```
public static ToolChoice.Type create(String key)
```