Package com.oracle.bmc.oda.model

Class OsvcChannel

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.oda.model.Channel

com.oracle.bmc.oda.model.OsvcChannel

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public final class OsvcChannel
extends Channel

The configuration for an OSVC channel.
Note: Objects should always be created or deserialized using the OsvcChannel.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 OsvcChannel.Builder, which maintain a set of all explicitly set fields called OsvcChannel.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	OsvcChannel.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

OsvcChannel(String id, String name, String description, ChannelCategory category, Long sessionExpiryDurationInMilliseconds, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String host, String port, String userName, Integer totalSessionCount, OsvcServiceType channelService, String authenticationProviderName, String botId)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static OsvcChannel.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAuthenticationProviderName()	The name of the Authentication Provider to use to authenticate the user.
String	getBotId()	The ID of the Skill or Digital Assistant that the Channel is routed to.
OsvcServiceType	getChannelService()	The type of OSVC service.
String	getHost()	The host.
String	getPort()	The port.
Integer	getTotalSessionCount()	The total session count.
String	getUserName()	The user name for the digital-assistant agent.
int	hashCode()
OsvcChannel.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.oda.model.Channel

getCategory, getDefinedTags, getDescription, getFreeformTags, getId, getLifecycleState, getName, getSessionExpiryDurationInMilliseconds, getTimeCreated, getTimeUpdated

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

OsvcChannel

@Deprecated
public OsvcChannel(String id,
                   String name,
                   String description,
                   ChannelCategory category,
                   Long sessionExpiryDurationInMilliseconds,
                   LifecycleState lifecycleState,
                   Date timeCreated,
                   Date timeUpdated,
                   Map<String,String> freeformTags,
                   Map<String,Map<String,Object>> definedTags,
                   String host,
                   String port,
                   String userName,
                   Integer totalSessionCount,
                   OsvcServiceType channelService,
                   String authenticationProviderName,
                   String botId)

Deprecated.

Method Detail

builder

public static OsvcChannel.Builder builder()

Create a new builder.

toBuilder

public OsvcChannel.Builder toBuilder()

getHost

public String getHost()

The host.

For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch, then the host is sitename.exampledomain.com.

For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL. For example: sitename.exampledomain.com.

Returns:

the value

getPort

public String getPort()

The port.

Returns:

the value

getUserName

public String getUserName()

The user name for the digital-assistant agent.

Returns:

the value

getTotalSessionCount

public Integer getTotalSessionCount()

The total session count.

Returns:

the value

getChannelService

public OsvcServiceType getChannelService()

The type of OSVC service.

Returns:

the value

getAuthenticationProviderName

public String getAuthenticationProviderName()

The name of the Authentication Provider to use to authenticate the user.

Returns:

the value

getBotId

public String getBotId()

The ID of the Skill or Digital Assistant that the Channel is routed to.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Channel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Channel

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Channel

hashCode

public int hashCode()

Overrides:

hashCode in class Channel