RealtimeMessageAuthenticationCredentials

class oci.ai_speech.models.RealtimeMessageAuthenticationCredentials(**kwargs)

Bases: oci.ai_speech.models.realtime_message_authentication.RealtimeMessageAuthentication

The payload for credential-based authentication.

Attributes

AUTHENTICATION_TYPE_CREDENTIALS str(object=’’) -> str
AUTHENTICATION_TYPE_TOKEN str(object=’’) -> str
authentication_type [Required] Gets the authentication_type of this RealtimeMessageAuthentication.
compartment_id [Required] Gets the compartment_id of this RealtimeMessageAuthentication.
headers [Required] Gets the headers of this RealtimeMessageAuthenticationCredentials.

Methods

__init__(**kwargs) Initializes a new RealtimeMessageAuthenticationCredentials object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
AUTHENTICATION_TYPE_CREDENTIALS = 'CREDENTIALS'
AUTHENTICATION_TYPE_TOKEN = 'TOKEN'
__init__(**kwargs)

Initializes a new RealtimeMessageAuthenticationCredentials object with values from keyword arguments. The default value of the authentication_type attribute of this class is CREDENTIALS and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • authentication_type (str) – The value to assign to the authentication_type property of this RealtimeMessageAuthenticationCredentials. Allowed values for this property are: “CREDENTIALS”, “TOKEN”
  • compartment_id (str) – The value to assign to the compartment_id property of this RealtimeMessageAuthenticationCredentials.
  • headers (dict(str, str)) – The value to assign to the headers property of this RealtimeMessageAuthenticationCredentials.
authentication_type

[Required] Gets the authentication_type of this RealtimeMessageAuthentication. Type of authentication method to be used.

Allowed values for this property are: “CREDENTIALS”, “TOKEN”

Returns:The authentication_type of this RealtimeMessageAuthentication.
Return type:str
compartment_id

[Required] Gets the compartment_id of this RealtimeMessageAuthentication. Compartment ID to be used for authentication/authorization.

Returns:The compartment_id of this RealtimeMessageAuthentication.
Return type:str
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

headers

[Required] Gets the headers of this RealtimeMessageAuthenticationCredentials. The signed request header object.

Returns:The headers of this RealtimeMessageAuthenticationCredentials.
Return type:dict(str, str)