Package com.oracle.bmc.aispeech.model

Class RealtimeSessionToken

java.lang.Object

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

com.oracle.bmc.aispeech.model.RealtimeSessionToken

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220101")
public final class RealtimeSessionToken
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The response from the realtime session token endpoint that creates the auth token to be used with the realtime speech service.
Note: Objects should always be created or deserialized using the RealtimeSessionToken.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 RealtimeSessionToken.Builder, which maintain a set of all explicitly set fields called RealtimeSessionToken.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	RealtimeSessionToken.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
RealtimeSessionToken(String token, String sessionId, String compartmentId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RealtimeSessionToken.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	Compartment ID that was used to create the token.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getSessionId()	The session ID this token corresponds to.
String	getToken()	The session token (JWT) to be consumed by the websocket server.
int	hashCode()
RealtimeSessionToken.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

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

RealtimeSessionToken

@Deprecated
@ConstructorProperties({"token","sessionId","compartmentId","freeformTags","definedTags"})
public RealtimeSessionToken(String token,
                            String sessionId,
                            String compartmentId,
                            Map<String,String> freeformTags,
                            Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static RealtimeSessionToken.Builder builder()

Create a new builder.

toBuilder

public RealtimeSessionToken.Builder toBuilder()

getToken

public String getToken()

The session token (JWT) to be consumed by the websocket server.

The token contains the session/tenant ID, as well as the expiry time.

Returns:

the value

getSessionId

public String getSessionId()

The session ID this token corresponds to.

Provided for convenience, the session ID is already present in the JWT token.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment ID that was used to create the token.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“foo-namespace-1”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}, “foo-namespace-2”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}}.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel