Package com.oracle.bmc.oda.model

Class CreateWebChannelResult

java.lang.Object

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

com.oracle.bmc.oda.model.CreateChannelResult

com.oracle.bmc.oda.model.CreateWebChannelResult

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

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

CreateWebChannelResult(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 secretKey, Long maxTokenExpirationTimeInMinutes, Boolean isClientAuthenticationEnabled, String allowedDomains, String botId)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateWebChannelResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAllowedDomains()	A comma-delimited whitelist of allowed domains.
String	getBotId()	The ID of the Skill or Digital Assistant that the Channel is routed to.
Boolean	getIsClientAuthenticationEnabled()	Whether client authentication is enabled or not.
Long	getMaxTokenExpirationTimeInMinutes()	The maximum time until the token expires (in minutes).
String	getSecretKey()	The secret key used to verify the authenticity of received messages.
int	hashCode()
CreateWebChannelResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

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

CreateWebChannelResult

@Deprecated
public CreateWebChannelResult(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 secretKey,
                              Long maxTokenExpirationTimeInMinutes,
                              Boolean isClientAuthenticationEnabled,
                              String allowedDomains,
                              String botId)

Deprecated.

Method Detail

builder

public static CreateWebChannelResult.Builder builder()

Create a new builder.

toBuilder

public CreateWebChannelResult.Builder toBuilder()

getSecretKey

public String getSecretKey()

The secret key used to verify the authenticity of received messages.

This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.

Returns:

the value

getMaxTokenExpirationTimeInMinutes

public Long getMaxTokenExpirationTimeInMinutes()

The maximum time until the token expires (in minutes).

Returns:

the value

getIsClientAuthenticationEnabled

public Boolean getIsClientAuthenticationEnabled()

Whether client authentication is enabled or not.

Returns:

the value

getAllowedDomains

public String getAllowedDomains()

A comma-delimited whitelist of allowed domains.

The channel will only communicate with the sites from the domains that you add to this list. For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access to the channel from any domain.

Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.

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 CreateChannelResult

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class CreateChannelResult

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class CreateChannelResult

hashCode

public int hashCode()

Overrides:

hashCode in class CreateChannelResult