-
Notifications
You must be signed in to change notification settings - Fork 80
/
osvc_channel.go
170 lines (134 loc) · 6.16 KB
/
osvc_channel.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
// Copyright (c) 2016, 2018, 2024, Oracle and/or its affiliates. All rights reserved.
// This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
// Code generated. DO NOT EDIT.
// Digital Assistant Service Instance API
//
// API to create and maintain Oracle Digital Assistant service instances.
//
package oda
import (
"encoding/json"
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// OsvcChannel The configuration for an OSVC channel.
type OsvcChannel struct {
// Unique immutable identifier that was assigned when the Channel was created.
Id *string `mandatory:"true" json:"id"`
// The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.
Name *string `mandatory:"true" json:"name"`
// When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// 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.
Host *string `mandatory:"true" json:"host"`
// The port.
Port *string `mandatory:"true" json:"port"`
// The user name for the digital-assistant agent.
UserName *string `mandatory:"true" json:"userName"`
// The total session count.
TotalSessionCount *int `mandatory:"true" json:"totalSessionCount"`
// The name of the Authentication Provider to use to authenticate the user.
AuthenticationProviderName *string `mandatory:"true" json:"authenticationProviderName"`
// A short description of the Channel.
Description *string `mandatory:"false" json:"description"`
// The number of milliseconds before a session expires.
SessionExpiryDurationInMilliseconds *int64 `mandatory:"false" json:"sessionExpiryDurationInMilliseconds"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of OSVC service.
ChannelService OsvcServiceTypeEnum `mandatory:"true" json:"channelService"`
}
// GetId returns Id
func (m OsvcChannel) GetId() *string {
return m.Id
}
// GetName returns Name
func (m OsvcChannel) GetName() *string {
return m.Name
}
// GetDescription returns Description
func (m OsvcChannel) GetDescription() *string {
return m.Description
}
// GetCategory returns Category
func (m OsvcChannel) GetCategory() ChannelCategoryEnum {
return m.Category
}
// GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m OsvcChannel) GetSessionExpiryDurationInMilliseconds() *int64 {
return m.SessionExpiryDurationInMilliseconds
}
// GetLifecycleState returns LifecycleState
func (m OsvcChannel) GetLifecycleState() LifecycleStateEnum {
return m.LifecycleState
}
// GetTimeCreated returns TimeCreated
func (m OsvcChannel) GetTimeCreated() *common.SDKTime {
return m.TimeCreated
}
// GetTimeUpdated returns TimeUpdated
func (m OsvcChannel) GetTimeUpdated() *common.SDKTime {
return m.TimeUpdated
}
// GetFreeformTags returns FreeformTags
func (m OsvcChannel) GetFreeformTags() map[string]string {
return m.FreeformTags
}
// GetDefinedTags returns DefinedTags
func (m OsvcChannel) GetDefinedTags() map[string]map[string]interface{} {
return m.DefinedTags
}
func (m OsvcChannel) String() string {
return common.PointerString(m)
}
// ValidateEnumValue returns an error when providing an unsupported enum value
// This function is being called during constructing API request process
// Not recommended for calling this function directly
func (m OsvcChannel) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingChannelCategoryEnum(string(m.Category)); !ok && m.Category != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for Category: %s. Supported values are: %s.", m.Category, strings.Join(GetChannelCategoryEnumStringValues(), ",")))
}
if _, ok := GetMappingLifecycleStateEnum(string(m.LifecycleState)); !ok && m.LifecycleState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleState: %s. Supported values are: %s.", m.LifecycleState, strings.Join(GetLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingOsvcServiceTypeEnum(string(m.ChannelService)); !ok && m.ChannelService != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ChannelService: %s. Supported values are: %s.", m.ChannelService, strings.Join(GetOsvcServiceTypeEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// MarshalJSON marshals to json representation
func (m OsvcChannel) MarshalJSON() (buff []byte, e error) {
type MarshalTypeOsvcChannel OsvcChannel
s := struct {
DiscriminatorParam string `json:"type"`
MarshalTypeOsvcChannel
}{
"OSVC",
(MarshalTypeOsvcChannel)(m),
}
return json.Marshal(&s)
}