com.ibm.watson.assistant.v2.model

Class GetEnvironmentOptions

java.lang.Object

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

com.ibm.watson.assistant.v2.model.GetEnvironmentOptions

All Implemented Interfaces:

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

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

The getEnvironment options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	assistantId() Gets the assistantId.
String	environmentId() Gets the environmentId.
Boolean	includeAudit() Gets the includeAudit.
GetEnvironmentOptions.Builder	newBuilder() New builder.

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 GetEnvironmentOptions.Builder newBuilder()

New builder.

Returns:

a GetEnvironmentOptions 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

includeAudit

public Boolean includeAudit()

Gets the includeAudit.

Whether to include the audit properties (`created` and `updated` timestamps) in the response.

Returns:

the includeAudit