com.ibm.watson.assistant.v2.model

Class UpdateEnvironmentOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.assistant.v2.model.UpdateEnvironmentOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdateEnvironmentOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updateEnvironment options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateEnvironmentOptions.Builder Builder.

Method Summary

Modifier and Type	Method and Description
String	assistantId() Gets the assistantId.
String	description() Gets the description.
String	environmentId() Gets the environmentId.
String	name() Gets the name.
UpdateEnvironmentOptions.Builder	newBuilder() New builder.
BaseEnvironmentOrchestration	orchestration() Gets the orchestration.
Long	sessionTimeout() Gets the sessionTimeout.
List<EnvironmentSkill>	skillReferences() Gets the skillReferences.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public UpdateEnvironmentOptions.Builder newBuilder()

New builder.

Returns:

a UpdateEnvironmentOptions builder

assistantId

public String assistantId()

Gets the assistantId.

The assistant ID or the environment ID of the environment where the assistant is deployed, depending on the type of request: - For message, session, and log requests, specify the environment ID of the environment where the assistant is deployed. - For all other requests, specify the assistant ID of the assistant.

To find the environment ID or assistant ID in the watsonx Assistant user interface, open the assistant settings and scroll to the **Environments** section.

**Note:** If you are using the classic Watson Assistant experience, always use the assistant ID. To find the assistant ID in the user interface, open the assistant settings and click API Details.

Returns:

the assistantId

environmentId

public String environmentId()

Gets the environmentId.

Unique identifier of the environment. To find the environment ID in the watsonx Assistant user interface, open the environment settings and click **API Details**. **Note:** Currently, the API does not support creating environments.

Returns:

the environmentId

name

public String name()

Gets the name.

The name of the environment.

Returns:

the name

description

public String description()

Gets the description.

The description of the environment.

Returns:

the description

orchestration

public BaseEnvironmentOrchestration orchestration()

Gets the orchestration.

The search skill orchestration settings for the environment.

Returns:

the orchestration

sessionTimeout

public Long sessionTimeout()

Gets the sessionTimeout.

The session inactivity timeout setting for the environment (in seconds).

Returns:

the sessionTimeout

skillReferences

public List<EnvironmentSkill> skillReferences()

Gets the skillReferences.

An array of objects identifying the skills (such as action and dialog) that exist in the environment.

Returns:

the skillReferences