/
oda_instance.go
308 lines (257 loc) · 15.9 KB
/
oda_instance.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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
// 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 (
"fmt"
"github.com/oracle/oci-go-sdk/v65/common"
"strings"
)
// OdaInstance Description of `OdaServiceInstance` object.
type OdaInstance struct {
// Unique immutable identifier that was assigned when the instance was created.
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment that the instance belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Shape or size of the instance.
ShapeName OdaInstanceShapeNameEnum `mandatory:"true" json:"shapeName"`
// User-defined name for the Digital Assistant instance. Avoid entering confidential information.
// You can change this value.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the Digital Assistant instance.
Description *string `mandatory:"false" json:"description"`
// URL for the Digital Assistant web application that's associated with the instance.
WebAppUrl *string `mandatory:"false" json:"webAppUrl"`
// URL for the connector's endpoint.
ConnectorUrl *string `mandatory:"false" json:"connectorUrl"`
// When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the Digital Assistance instance 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:"false" json:"timeUpdated"`
// The current state of the Digital Assistant instance.
LifecycleState OdaInstanceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The current sub-state of the Digital Assistant instance.
LifecycleSubState OdaInstanceLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// A message that describes the current state in more detail.
// For example, actionable information about an instance that's in the `FAILED` state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
// 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"`
// Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
IsRoleBasedAccess *bool `mandatory:"false" json:"isRoleBasedAccess"`
// If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
IdentityDomain *string `mandatory:"false" json:"identityDomain"`
// If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
IdentityAppGuid *string `mandatory:"false" json:"identityAppGuid"`
// If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
IdentityAppConsoleUrl *string `mandatory:"false" json:"identityAppConsoleUrl"`
// A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
ImportedPackageNames []string `mandatory:"false" json:"importedPackageNames"`
// A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
ImportedPackageIds []string `mandatory:"false" json:"importedPackageIds"`
// A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
AttachmentTypes []string `mandatory:"false" json:"attachmentTypes"`
// A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
AttachmentIds []string `mandatory:"false" json:"attachmentIds"`
// A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
RestrictedOperations []RestrictedOperation `mandatory:"false" json:"restrictedOperations"`
}
func (m OdaInstance) 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 OdaInstance) ValidateEnumValue() (bool, error) {
errMessage := []string{}
if _, ok := GetMappingOdaInstanceShapeNameEnum(string(m.ShapeName)); !ok && m.ShapeName != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for ShapeName: %s. Supported values are: %s.", m.ShapeName, strings.Join(GetOdaInstanceShapeNameEnumStringValues(), ",")))
}
if _, ok := GetMappingOdaInstanceLifecycleStateEnum(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(GetOdaInstanceLifecycleStateEnumStringValues(), ",")))
}
if _, ok := GetMappingOdaInstanceLifecycleSubStateEnum(string(m.LifecycleSubState)); !ok && m.LifecycleSubState != "" {
errMessage = append(errMessage, fmt.Sprintf("unsupported enum value for LifecycleSubState: %s. Supported values are: %s.", m.LifecycleSubState, strings.Join(GetOdaInstanceLifecycleSubStateEnumStringValues(), ",")))
}
if len(errMessage) > 0 {
return true, fmt.Errorf(strings.Join(errMessage, "\n"))
}
return false, nil
}
// OdaInstanceShapeNameEnum Enum with underlying type: string
type OdaInstanceShapeNameEnum string
// Set of constants representing the allowable values for OdaInstanceShapeNameEnum
const (
OdaInstanceShapeNameDevelopment OdaInstanceShapeNameEnum = "DEVELOPMENT"
OdaInstanceShapeNameProduction OdaInstanceShapeNameEnum = "PRODUCTION"
)
var mappingOdaInstanceShapeNameEnum = map[string]OdaInstanceShapeNameEnum{
"DEVELOPMENT": OdaInstanceShapeNameDevelopment,
"PRODUCTION": OdaInstanceShapeNameProduction,
}
var mappingOdaInstanceShapeNameEnumLowerCase = map[string]OdaInstanceShapeNameEnum{
"development": OdaInstanceShapeNameDevelopment,
"production": OdaInstanceShapeNameProduction,
}
// GetOdaInstanceShapeNameEnumValues Enumerates the set of values for OdaInstanceShapeNameEnum
func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum {
values := make([]OdaInstanceShapeNameEnum, 0)
for _, v := range mappingOdaInstanceShapeNameEnum {
values = append(values, v)
}
return values
}
// GetOdaInstanceShapeNameEnumStringValues Enumerates the set of values in String for OdaInstanceShapeNameEnum
func GetOdaInstanceShapeNameEnumStringValues() []string {
return []string{
"DEVELOPMENT",
"PRODUCTION",
}
}
// GetMappingOdaInstanceShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingOdaInstanceShapeNameEnum(val string) (OdaInstanceShapeNameEnum, bool) {
enum, ok := mappingOdaInstanceShapeNameEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// OdaInstanceLifecycleStateEnum Enum with underlying type: string
type OdaInstanceLifecycleStateEnum string
// Set of constants representing the allowable values for OdaInstanceLifecycleStateEnum
const (
OdaInstanceLifecycleStateCreating OdaInstanceLifecycleStateEnum = "CREATING"
OdaInstanceLifecycleStateUpdating OdaInstanceLifecycleStateEnum = "UPDATING"
OdaInstanceLifecycleStateActive OdaInstanceLifecycleStateEnum = "ACTIVE"
OdaInstanceLifecycleStateInactive OdaInstanceLifecycleStateEnum = "INACTIVE"
OdaInstanceLifecycleStateDeleting OdaInstanceLifecycleStateEnum = "DELETING"
OdaInstanceLifecycleStateDeleted OdaInstanceLifecycleStateEnum = "DELETED"
OdaInstanceLifecycleStateFailed OdaInstanceLifecycleStateEnum = "FAILED"
)
var mappingOdaInstanceLifecycleStateEnum = map[string]OdaInstanceLifecycleStateEnum{
"CREATING": OdaInstanceLifecycleStateCreating,
"UPDATING": OdaInstanceLifecycleStateUpdating,
"ACTIVE": OdaInstanceLifecycleStateActive,
"INACTIVE": OdaInstanceLifecycleStateInactive,
"DELETING": OdaInstanceLifecycleStateDeleting,
"DELETED": OdaInstanceLifecycleStateDeleted,
"FAILED": OdaInstanceLifecycleStateFailed,
}
var mappingOdaInstanceLifecycleStateEnumLowerCase = map[string]OdaInstanceLifecycleStateEnum{
"creating": OdaInstanceLifecycleStateCreating,
"updating": OdaInstanceLifecycleStateUpdating,
"active": OdaInstanceLifecycleStateActive,
"inactive": OdaInstanceLifecycleStateInactive,
"deleting": OdaInstanceLifecycleStateDeleting,
"deleted": OdaInstanceLifecycleStateDeleted,
"failed": OdaInstanceLifecycleStateFailed,
}
// GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum
func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum {
values := make([]OdaInstanceLifecycleStateEnum, 0)
for _, v := range mappingOdaInstanceLifecycleStateEnum {
values = append(values, v)
}
return values
}
// GetOdaInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleStateEnum
func GetOdaInstanceLifecycleStateEnumStringValues() []string {
return []string{
"CREATING",
"UPDATING",
"ACTIVE",
"INACTIVE",
"DELETING",
"DELETED",
"FAILED",
}
}
// GetMappingOdaInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingOdaInstanceLifecycleStateEnum(val string) (OdaInstanceLifecycleStateEnum, bool) {
enum, ok := mappingOdaInstanceLifecycleStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}
// OdaInstanceLifecycleSubStateEnum Enum with underlying type: string
type OdaInstanceLifecycleSubStateEnum string
// Set of constants representing the allowable values for OdaInstanceLifecycleSubStateEnum
const (
OdaInstanceLifecycleSubStateCreating OdaInstanceLifecycleSubStateEnum = "CREATING"
OdaInstanceLifecycleSubStateStarting OdaInstanceLifecycleSubStateEnum = "STARTING"
OdaInstanceLifecycleSubStateStopping OdaInstanceLifecycleSubStateEnum = "STOPPING"
OdaInstanceLifecycleSubStateChangingCompartment OdaInstanceLifecycleSubStateEnum = "CHANGING_COMPARTMENT"
OdaInstanceLifecycleSubStateActivatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "ACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateUpdatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "UPDATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateDeactivatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "DEACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateDeleting OdaInstanceLifecycleSubStateEnum = "DELETING"
OdaInstanceLifecycleSubStateDeletePending OdaInstanceLifecycleSubStateEnum = "DELETE_PENDING"
OdaInstanceLifecycleSubStateRecovering OdaInstanceLifecycleSubStateEnum = "RECOVERING"
OdaInstanceLifecycleSubStateUpdating OdaInstanceLifecycleSubStateEnum = "UPDATING"
OdaInstanceLifecycleSubStatePurging OdaInstanceLifecycleSubStateEnum = "PURGING"
OdaInstanceLifecycleSubStateQueued OdaInstanceLifecycleSubStateEnum = "QUEUED"
)
var mappingOdaInstanceLifecycleSubStateEnum = map[string]OdaInstanceLifecycleSubStateEnum{
"CREATING": OdaInstanceLifecycleSubStateCreating,
"STARTING": OdaInstanceLifecycleSubStateStarting,
"STOPPING": OdaInstanceLifecycleSubStateStopping,
"CHANGING_COMPARTMENT": OdaInstanceLifecycleSubStateChangingCompartment,
"ACTIVATING_CUSTOMER_ENCRYPTION_KEY": OdaInstanceLifecycleSubStateActivatingCustomerEncryptionKey,
"UPDATING_CUSTOMER_ENCRYPTION_KEY": OdaInstanceLifecycleSubStateUpdatingCustomerEncryptionKey,
"DEACTIVATING_CUSTOMER_ENCRYPTION_KEY": OdaInstanceLifecycleSubStateDeactivatingCustomerEncryptionKey,
"DELETING": OdaInstanceLifecycleSubStateDeleting,
"DELETE_PENDING": OdaInstanceLifecycleSubStateDeletePending,
"RECOVERING": OdaInstanceLifecycleSubStateRecovering,
"UPDATING": OdaInstanceLifecycleSubStateUpdating,
"PURGING": OdaInstanceLifecycleSubStatePurging,
"QUEUED": OdaInstanceLifecycleSubStateQueued,
}
var mappingOdaInstanceLifecycleSubStateEnumLowerCase = map[string]OdaInstanceLifecycleSubStateEnum{
"creating": OdaInstanceLifecycleSubStateCreating,
"starting": OdaInstanceLifecycleSubStateStarting,
"stopping": OdaInstanceLifecycleSubStateStopping,
"changing_compartment": OdaInstanceLifecycleSubStateChangingCompartment,
"activating_customer_encryption_key": OdaInstanceLifecycleSubStateActivatingCustomerEncryptionKey,
"updating_customer_encryption_key": OdaInstanceLifecycleSubStateUpdatingCustomerEncryptionKey,
"deactivating_customer_encryption_key": OdaInstanceLifecycleSubStateDeactivatingCustomerEncryptionKey,
"deleting": OdaInstanceLifecycleSubStateDeleting,
"delete_pending": OdaInstanceLifecycleSubStateDeletePending,
"recovering": OdaInstanceLifecycleSubStateRecovering,
"updating": OdaInstanceLifecycleSubStateUpdating,
"purging": OdaInstanceLifecycleSubStatePurging,
"queued": OdaInstanceLifecycleSubStateQueued,
}
// GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum
func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum {
values := make([]OdaInstanceLifecycleSubStateEnum, 0)
for _, v := range mappingOdaInstanceLifecycleSubStateEnum {
values = append(values, v)
}
return values
}
// GetOdaInstanceLifecycleSubStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleSubStateEnum
func GetOdaInstanceLifecycleSubStateEnumStringValues() []string {
return []string{
"CREATING",
"STARTING",
"STOPPING",
"CHANGING_COMPARTMENT",
"ACTIVATING_CUSTOMER_ENCRYPTION_KEY",
"UPDATING_CUSTOMER_ENCRYPTION_KEY",
"DEACTIVATING_CUSTOMER_ENCRYPTION_KEY",
"DELETING",
"DELETE_PENDING",
"RECOVERING",
"UPDATING",
"PURGING",
"QUEUED",
}
}
// GetMappingOdaInstanceLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetMappingOdaInstanceLifecycleSubStateEnum(val string) (OdaInstanceLifecycleSubStateEnum, bool) {
enum, ok := mappingOdaInstanceLifecycleSubStateEnumLowerCase[strings.ToLower(val)]
return enum, ok
}