com.ibm.watson.assistant.v1.model

Class MessageContextMetadata

java.lang.Object

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

com.ibm.watson.assistant.v1.model.MessageContextMetadata

All Implemented Interfaces:

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

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

Metadata related to the message.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
String	deployment() Gets the deployment.
MessageContextMetadata.Builder	newBuilder() New builder.
String	userId() Gets the userId.

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

New builder.

Returns:

a MessageContextMetadata builder

deployment

public String deployment()

Gets the deployment.

A label identifying the deployment environment, used for filtering log data. This string cannot contain carriage return, newline, or tab characters.

Returns:

the deployment

userId

public String userId()

Gets the userId.

A string value that identifies the user who is interacting with the workspace. The client must provide a unique identifier for each individual end user who accesses the application. For user-based plans, this user ID is used to identify unique users for billing purposes. This string cannot contain carriage return, newline, or tab characters. If no value is specified in the input, **user_id** is automatically set to the value of **context.conversation_id**.

**Note:** This property is the same as the **user_id** property at the root of the message body. If **user_id** is specified in both locations in a message request, the value specified at the root is used.

Returns:

the userId