func GetAuthenticationGrantTypeEnumStringValues() []string
GetAuthenticationGrantTypeEnumStringValues Enumerates the set of values in String for AuthenticationGrantTypeEnum
func GetAuthenticationIdentityProviderEnumStringValues() []string
GetAuthenticationIdentityProviderEnumStringValues Enumerates the set of values in String for AuthenticationIdentityProviderEnum
func GetBotMultilingualModeEnumStringValues() []string
GetBotMultilingualModeEnumStringValues Enumerates the set of values in String for BotMultilingualModeEnum
func GetBotPublishStateEnumStringValues() []string
GetBotPublishStateEnumStringValues Enumerates the set of values in String for BotPublishStateEnum
func GetChannelCategoryEnumStringValues() []string
GetChannelCategoryEnumStringValues Enumerates the set of values in String for ChannelCategoryEnum
func GetChannelTypeEnumStringValues() []string
GetChannelTypeEnumStringValues Enumerates the set of values in String for ChannelTypeEnum
func GetCreateBotKindEnumStringValues() []string
GetCreateBotKindEnumStringValues Enumerates the set of values in String for CreateBotKindEnum
func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumStringValues() []string
GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumStringValues Enumerates the set of values in String for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum
func GetCreateOdaInstanceDetailsShapeNameEnumStringValues() []string
GetCreateOdaInstanceDetailsShapeNameEnumStringValues Enumerates the set of values in String for CreateOdaInstanceDetailsShapeNameEnum
func GetImportedPackageStatusEnumStringValues() []string
GetImportedPackageStatusEnumStringValues Enumerates the set of values in String for ImportedPackageStatusEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListAuthenticationProvidersIdentityProviderEnumStringValues() []string
GetListAuthenticationProvidersIdentityProviderEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersIdentityProviderEnum
func GetListAuthenticationProvidersLifecycleStateEnumStringValues() []string
GetListAuthenticationProvidersLifecycleStateEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersLifecycleStateEnum
func GetListAuthenticationProvidersSortByEnumStringValues() []string
GetListAuthenticationProvidersSortByEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersSortByEnum
func GetListAuthenticationProvidersSortOrderEnumStringValues() []string
GetListAuthenticationProvidersSortOrderEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersSortOrderEnum
func GetListChannelsCategoryEnumStringValues() []string
GetListChannelsCategoryEnumStringValues Enumerates the set of values in String for ListChannelsCategoryEnum
func GetListChannelsLifecycleStateEnumStringValues() []string
GetListChannelsLifecycleStateEnumStringValues Enumerates the set of values in String for ListChannelsLifecycleStateEnum
func GetListChannelsSortByEnumStringValues() []string
GetListChannelsSortByEnumStringValues Enumerates the set of values in String for ListChannelsSortByEnum
func GetListChannelsSortOrderEnumStringValues() []string
GetListChannelsSortOrderEnumStringValues Enumerates the set of values in String for ListChannelsSortOrderEnum
func GetListChannelsTypeEnumStringValues() []string
GetListChannelsTypeEnumStringValues Enumerates the set of values in String for ListChannelsTypeEnum
func GetListDigitalAssistantParametersLifecycleStateEnumStringValues() []string
GetListDigitalAssistantParametersLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersLifecycleStateEnum
func GetListDigitalAssistantParametersSortByEnumStringValues() []string
GetListDigitalAssistantParametersSortByEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersSortByEnum
func GetListDigitalAssistantParametersSortOrderEnumStringValues() []string
GetListDigitalAssistantParametersSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersSortOrderEnum
func GetListDigitalAssistantsLifecycleStateEnumStringValues() []string
GetListDigitalAssistantsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsLifecycleStateEnum
func GetListDigitalAssistantsSortByEnumStringValues() []string
GetListDigitalAssistantsSortByEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsSortByEnum
func GetListDigitalAssistantsSortOrderEnumStringValues() []string
GetListDigitalAssistantsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsSortOrderEnum
func GetListImportedPackagesSortByEnumStringValues() []string
GetListImportedPackagesSortByEnumStringValues Enumerates the set of values in String for ListImportedPackagesSortByEnum
func GetListImportedPackagesSortOrderEnumStringValues() []string
GetListImportedPackagesSortOrderEnumStringValues Enumerates the set of values in String for ListImportedPackagesSortOrderEnum
func GetListOdaInstanceAttachmentsLifecycleStateEnumStringValues() []string
GetListOdaInstanceAttachmentsLifecycleStateEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsLifecycleStateEnum
func GetListOdaInstanceAttachmentsSortByEnumStringValues() []string
GetListOdaInstanceAttachmentsSortByEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsSortByEnum
func GetListOdaInstanceAttachmentsSortOrderEnumStringValues() []string
GetListOdaInstanceAttachmentsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsSortOrderEnum
func GetListOdaInstancesLifecycleStateEnumStringValues() []string
GetListOdaInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListOdaInstancesLifecycleStateEnum
func GetListOdaInstancesSortByEnumStringValues() []string
GetListOdaInstancesSortByEnumStringValues Enumerates the set of values in String for ListOdaInstancesSortByEnum
func GetListOdaInstancesSortOrderEnumStringValues() []string
GetListOdaInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListOdaInstancesSortOrderEnum
func GetListOdaPrivateEndpointAttachmentsSortByEnumStringValues() []string
GetListOdaPrivateEndpointAttachmentsSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointAttachmentsSortByEnum
func GetListOdaPrivateEndpointAttachmentsSortOrderEnumStringValues() []string
GetListOdaPrivateEndpointAttachmentsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointAttachmentsSortOrderEnum
func GetListOdaPrivateEndpointScanProxiesSortByEnumStringValues() []string
GetListOdaPrivateEndpointScanProxiesSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointScanProxiesSortByEnum
func GetListOdaPrivateEndpointScanProxiesSortOrderEnumStringValues() []string
GetListOdaPrivateEndpointScanProxiesSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointScanProxiesSortOrderEnum
func GetListOdaPrivateEndpointsSortByEnumStringValues() []string
GetListOdaPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointsSortByEnum
func GetListOdaPrivateEndpointsSortOrderEnumStringValues() []string
GetListOdaPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointsSortOrderEnum
func GetListPackagesSortByEnumStringValues() []string
GetListPackagesSortByEnumStringValues Enumerates the set of values in String for ListPackagesSortByEnum
func GetListPackagesSortOrderEnumStringValues() []string
GetListPackagesSortOrderEnumStringValues Enumerates the set of values in String for ListPackagesSortOrderEnum
func GetListSkillParametersLifecycleStateEnumStringValues() []string
GetListSkillParametersLifecycleStateEnumStringValues Enumerates the set of values in String for ListSkillParametersLifecycleStateEnum
func GetListSkillParametersSortByEnumStringValues() []string
GetListSkillParametersSortByEnumStringValues Enumerates the set of values in String for ListSkillParametersSortByEnum
func GetListSkillParametersSortOrderEnumStringValues() []string
GetListSkillParametersSortOrderEnumStringValues Enumerates the set of values in String for ListSkillParametersSortOrderEnum
func GetListSkillsLifecycleStateEnumStringValues() []string
GetListSkillsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSkillsLifecycleStateEnum
func GetListSkillsSortByEnumStringValues() []string
GetListSkillsSortByEnumStringValues Enumerates the set of values in String for ListSkillsSortByEnum
func GetListSkillsSortOrderEnumStringValues() []string
GetListSkillsSortOrderEnumStringValues Enumerates the set of values in String for ListSkillsSortOrderEnum
func GetListTranslatorsLifecycleStateEnumStringValues() []string
GetListTranslatorsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTranslatorsLifecycleStateEnum
func GetListTranslatorsSortByEnumStringValues() []string
GetListTranslatorsSortByEnumStringValues Enumerates the set of values in String for ListTranslatorsSortByEnum
func GetListTranslatorsSortOrderEnumStringValues() []string
GetListTranslatorsSortOrderEnumStringValues Enumerates the set of values in String for ListTranslatorsSortOrderEnum
func GetListTranslatorsTypeEnumStringValues() []string
GetListTranslatorsTypeEnumStringValues Enumerates the set of values in String for ListTranslatorsTypeEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetOdaInstanceAttachmentAttachmentTypeEnumStringValues() []string
GetOdaInstanceAttachmentAttachmentTypeEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentAttachmentTypeEnum
func GetOdaInstanceAttachmentLifecycleStateEnumStringValues() []string
GetOdaInstanceAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentLifecycleStateEnum
func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumStringValues() []string
GetOdaInstanceAttachmentSummaryAttachmentTypeEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentSummaryAttachmentTypeEnum
func GetOdaInstanceLifecycleStateEnumStringValues() []string
GetOdaInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleStateEnum
func GetOdaInstanceLifecycleSubStateEnumStringValues() []string
GetOdaInstanceLifecycleSubStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleSubStateEnum
func GetOdaInstanceShapeNameEnumStringValues() []string
GetOdaInstanceShapeNameEnumStringValues Enumerates the set of values in String for OdaInstanceShapeNameEnum
func GetOdaInstanceSummaryLifecycleStateEnumStringValues() []string
GetOdaInstanceSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryLifecycleStateEnum
func GetOdaInstanceSummaryLifecycleSubStateEnumStringValues() []string
GetOdaInstanceSummaryLifecycleSubStateEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryLifecycleSubStateEnum
func GetOdaInstanceSummaryShapeNameEnumStringValues() []string
GetOdaInstanceSummaryShapeNameEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryShapeNameEnum
func GetOdaPrivateEndpointAttachmentLifecycleStateEnumStringValues() []string
GetOdaPrivateEndpointAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointAttachmentLifecycleStateEnum
func GetOdaPrivateEndpointLifecycleStateEnumStringValues() []string
GetOdaPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointLifecycleStateEnum
func GetOdaPrivateEndpointScanProxyLifecycleStateEnumStringValues() []string
GetOdaPrivateEndpointScanProxyLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyLifecycleStateEnum
func GetOdaPrivateEndpointScanProxyProtocolEnumStringValues() []string
GetOdaPrivateEndpointScanProxyProtocolEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyProtocolEnum
func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumStringValues() []string
GetOdaPrivateEndpointScanProxyScanListenerTypeEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyScanListenerTypeEnum
func GetOsvcServiceTypeEnumStringValues() []string
GetOsvcServiceTypeEnumStringValues Enumerates the set of values in String for OsvcServiceTypeEnum
func GetParameterDefinitionDirectionEnumStringValues() []string
GetParameterDefinitionDirectionEnumStringValues Enumerates the set of values in String for ParameterDefinitionDirectionEnum
func GetParameterDefinitionTypeEnumStringValues() []string
GetParameterDefinitionTypeEnumStringValues Enumerates the set of values in String for ParameterDefinitionTypeEnum
func GetParameterTypeEnumStringValues() []string
GetParameterTypeEnumStringValues Enumerates the set of values in String for ParameterTypeEnum
func GetServiceCloudClientTypeEnumStringValues() []string
GetServiceCloudClientTypeEnumStringValues Enumerates the set of values in String for ServiceCloudClientTypeEnum
func GetTranslationServiceEnumStringValues() []string
GetTranslationServiceEnumStringValues Enumerates the set of values in String for TranslationServiceEnum
func GetWebhookPayloadVersionEnumStringValues() []string
GetWebhookPayloadVersionEnumStringValues Enumerates the set of values in String for WebhookPayloadVersionEnum
func GetWorkRequestRequestActionEnumStringValues() []string
GetWorkRequestRequestActionEnumStringValues Enumerates the set of values in String for WorkRequestRequestActionEnum
func GetWorkRequestResourceResourceActionEnumStringValues() []string
GetWorkRequestResourceResourceActionEnumStringValues Enumerates the set of values in String for WorkRequestResourceResourceActionEnum
func GetWorkRequestResourceStatusEnumStringValues() []string
GetWorkRequestResourceStatusEnumStringValues Enumerates the set of values in String for WorkRequestResourceStatusEnum
func GetWorkRequestStatusEnumStringValues() []string
GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum
func GetWorkRequestSummaryRequestActionEnumStringValues() []string
GetWorkRequestSummaryRequestActionEnumStringValues Enumerates the set of values in String for WorkRequestSummaryRequestActionEnum
func GetWorkRequestSummaryStatusEnumStringValues() []string
GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum
AndroidChannel The configuration for an Android channel.
type AndroidChannel 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"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"true" json:"isClientAuthenticationEnabled"`
// 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// 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"`
}
func (m AndroidChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m AndroidChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AndroidChannel) GetDescription() *string
GetDescription returns Description
func (m AndroidChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AndroidChannel) GetId() *string
GetId returns Id
func (m AndroidChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AndroidChannel) GetName() *string
GetName returns Name
func (m AndroidChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m AndroidChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AndroidChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AndroidChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AndroidChannel) String() string
func (m AndroidChannel) ValidateEnumValue() (bool, error)
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
AppEventChannel The configuration for an Application Event channel.
type AppEventChannel 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 URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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 URL for sending errors and responses to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// The IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m AppEventChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m AppEventChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m AppEventChannel) GetDescription() *string
GetDescription returns Description
func (m AppEventChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m AppEventChannel) GetId() *string
GetId returns Id
func (m AppEventChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m AppEventChannel) GetName() *string
GetName returns Name
func (m AppEventChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m AppEventChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m AppEventChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m AppEventChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m AppEventChannel) String() string
func (m AppEventChannel) ValidateEnumValue() (bool, error)
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
ApplicationChannel The configuration for an Application channel.
type ApplicationChannel 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"`
// True if the user id in the AIC message should be treated as an authenticated user id.
IsAuthenticatedUserId *bool `mandatory:"true" json:"isAuthenticatedUserId"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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 URL to send response and error messages to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m ApplicationChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m ApplicationChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ApplicationChannel) GetDescription() *string
GetDescription returns Description
func (m ApplicationChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ApplicationChannel) GetId() *string
GetId returns Id
func (m ApplicationChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ApplicationChannel) GetName() *string
GetName returns Name
func (m ApplicationChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m ApplicationChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ApplicationChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ApplicationChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ApplicationChannel) String() string
func (m ApplicationChannel) ValidateEnumValue() (bool, error)
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
AuthenticationGrantTypeEnum Enum with underlying type: string
type AuthenticationGrantTypeEnum string
Set of constants representing the allowable values for AuthenticationGrantTypeEnum
const (
AuthenticationGrantTypeClientCredentials AuthenticationGrantTypeEnum = "CLIENT_CREDENTIALS"
AuthenticationGrantTypeAuthorizationCode AuthenticationGrantTypeEnum = "AUTHORIZATION_CODE"
)
func GetAuthenticationGrantTypeEnumValues() []AuthenticationGrantTypeEnum
GetAuthenticationGrantTypeEnumValues Enumerates the set of values for AuthenticationGrantTypeEnum
func GetMappingAuthenticationGrantTypeEnum(val string) (AuthenticationGrantTypeEnum, bool)
GetMappingAuthenticationGrantTypeEnum performs case Insensitive comparison on enum value and return the desired enum
AuthenticationIdentityProviderEnum Enum with underlying type: string
type AuthenticationIdentityProviderEnum string
Set of constants representing the allowable values for AuthenticationIdentityProviderEnum
const (
AuthenticationIdentityProviderGeneric AuthenticationIdentityProviderEnum = "GENERIC"
AuthenticationIdentityProviderOam AuthenticationIdentityProviderEnum = "OAM"
AuthenticationIdentityProviderGoogle AuthenticationIdentityProviderEnum = "GOOGLE"
AuthenticationIdentityProviderMicrosoft AuthenticationIdentityProviderEnum = "MICROSOFT"
)
func GetAuthenticationIdentityProviderEnumValues() []AuthenticationIdentityProviderEnum
GetAuthenticationIdentityProviderEnumValues Enumerates the set of values for AuthenticationIdentityProviderEnum
func GetMappingAuthenticationIdentityProviderEnum(val string) (AuthenticationIdentityProviderEnum, bool)
GetMappingAuthenticationIdentityProviderEnum performs case Insensitive comparison on enum value and return the desired enum
AuthenticationProvider Settings for the Authentication Provider.
type AuthenticationProvider struct {
// Unique immutable identifier that was assigned when the Authentication Provider was created.
Id *string `mandatory:"true" json:"id"`
// The grant type for the Authentication Provider.
GrantType AuthenticationGrantTypeEnum `mandatory:"true" json:"grantType"`
// Which type of Identity Provider (IDP) you are using.
IdentityProvider AuthenticationIdentityProviderEnum `mandatory:"true" json:"identityProvider"`
// A name to identify the Authentication Provider.
Name *string `mandatory:"true" json:"name"`
// The IDPs URL for requesting access tokens.
TokenEndpointUrl *string `mandatory:"true" json:"tokenEndpointUrl"`
// The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
// With Microsoft identity platform, use the application ID.
ClientId *string `mandatory:"true" json:"clientId"`
// A space-separated list of the scopes that must be included when Digital Assistant requests an access token from
// the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled,
// include the scope that’s necessary to get the refresh token (typically offline_access).
Scopes *string `mandatory:"true" json:"scopes"`
// Whether this Authentication Provider is visible in the ODA UI.
IsVisible *bool `mandatory:"true" json:"isVisible"`
// The Authentication Provider's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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 IDPs URL for the page that users authenticate with by entering the user name and password.
AuthorizationEndpointUrl *string `mandatory:"false" json:"authorizationEndpointUrl"`
// A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows
// you to send query parameters). You might need this because the generated authorization-code-request URL
// could be too long for SMS and older smart phones.
ShortAuthorizationCodeRequestUrl *string `mandatory:"false" json:"shortAuthorizationCodeRequestUrl"`
// If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then
// you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens
// component to revoke the user's tokens for this service.
RevokeTokenEndpointUrl *string `mandatory:"false" json:"revokeTokenEndpointUrl"`
// The access-token profile claim to use to identify the user.
SubjectClaim *string `mandatory:"false" json:"subjectClaim"`
// The number of days to keep the refresh token in the Digital Assistant cache.
RefreshTokenRetentionPeriodInDays *int `mandatory:"false" json:"refreshTokenRetentionPeriodInDays"`
// The OAuth Redirect URL.
RedirectUrl *string `mandatory:"false" json:"redirectUrl"`
// 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"`
}
func (m AuthenticationProvider) String() string
func (m AuthenticationProvider) ValidateEnumValue() (bool, error)
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
AuthenticationProviderCollection A collection of Authentication Provider summaries.
type AuthenticationProviderCollection struct {
// The Authentication Provider summaries.
Items []AuthenticationProviderSummary `mandatory:"true" json:"items"`
}
func (m AuthenticationProviderCollection) String() string
func (m AuthenticationProviderCollection) ValidateEnumValue() (bool, error)
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
AuthenticationProviderSummary Summary of the Authentication Provider.
type AuthenticationProviderSummary struct {
// Unique immutable identifier that was assigned when the Authentication Provider was created.
Id *string `mandatory:"true" json:"id"`
// The grant type for the Authentication Provider.
GrantType AuthenticationGrantTypeEnum `mandatory:"true" json:"grantType"`
// Which type of Identity Provider (IDP) you are using.
IdentityProvider AuthenticationIdentityProviderEnum `mandatory:"true" json:"identityProvider"`
// A name to identify the Authentication Provider.
Name *string `mandatory:"true" json:"name"`
// The Authentication Provider's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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"`
// 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"`
}
func (m AuthenticationProviderSummary) String() string
func (m AuthenticationProviderSummary) ValidateEnumValue() (bool, error)
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
Bot Metadata for a Bot resource.
type Bot struct {
// Unique immutable identifier that was assigned when the resource was created.
Id *string `mandatory:"true" json:"id"`
// The reource'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"`
// The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"true" json:"version"`
// The resource's display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The resource's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The resource's publish state.
LifecycleDetails BotPublishStateEnum `mandatory:"true" json:"lifecycleDetails"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"true" json:"platformVersion"`
// 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 resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The resource's namespace.
Namespace *string `mandatory:"false" json:"namespace"`
// The unique identifier for the base reource (when this resource extends another).
BaseId *string `mandatory:"false" json:"baseId"`
// The multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// A list of native languages supported by this resource.
NativeLanguageTags []string `mandatory:"false" json:"nativeLanguageTags"`
// 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"`
}
func (m Bot) String() string
func (m Bot) ValidateEnumValue() (bool, error)
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
BotMultilingualModeEnum Enum with underlying type: string
type BotMultilingualModeEnum string
Set of constants representing the allowable values for BotMultilingualModeEnum
const (
BotMultilingualModeNative BotMultilingualModeEnum = "NATIVE"
BotMultilingualModeTranslation BotMultilingualModeEnum = "TRANSLATION"
)
func GetBotMultilingualModeEnumValues() []BotMultilingualModeEnum
GetBotMultilingualModeEnumValues Enumerates the set of values for BotMultilingualModeEnum
func GetMappingBotMultilingualModeEnum(val string) (BotMultilingualModeEnum, bool)
GetMappingBotMultilingualModeEnum performs case Insensitive comparison on enum value and return the desired enum
BotPublishStateEnum Enum with underlying type: string
type BotPublishStateEnum string
Set of constants representing the allowable values for BotPublishStateEnum
const (
BotPublishStatePublished BotPublishStateEnum = "PUBLISHED"
BotPublishStateDraft BotPublishStateEnum = "DRAFT"
)
func GetBotPublishStateEnumValues() []BotPublishStateEnum
GetBotPublishStateEnumValues Enumerates the set of values for BotPublishStateEnum
func GetMappingBotPublishStateEnum(val string) (BotPublishStateEnum, bool)
GetMappingBotPublishStateEnum performs case Insensitive comparison on enum value and return the desired enum
ChangeOdaInstanceCompartmentDetails Properties required to move a Digital Assistant instance from one compartment to another.
type ChangeOdaInstanceCompartmentDetails struct {
// Identifier of the compartment into which the Digital Assistant instance should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOdaInstanceCompartmentDetails) String() string
func (m ChangeOdaInstanceCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeOdaInstanceCompartmentRequest wrapper for the ChangeOdaInstanceCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/ChangeOdaInstanceCompartment.go.html to see an example of how to use ChangeOdaInstanceCompartmentRequest.
type ChangeOdaInstanceCompartmentRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// The compartment to which the Digital Assistant instance should be moved.
ChangeOdaInstanceCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control in a PUT or DELETE call for
// a Digital Assistant instance, set the `if-match` query parameter
// to the value of the `ETAG` header from a previous GET or POST
// response for that instance. The service updates or deletes the
// instance only if the etag that you provide matches the instance's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeOdaInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeOdaInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOdaInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOdaInstanceCompartmentRequest) String() string
func (request ChangeOdaInstanceCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeOdaInstanceCompartmentResponse wrapper for the ChangeOdaInstanceCompartment operation
type ChangeOdaInstanceCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeOdaInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOdaInstanceCompartmentResponse) String() string
ChangeOdaPrivateEndpointCompartmentDetails Properties required to move an ODA Private Endpoint from one compartment to another.
type ChangeOdaPrivateEndpointCompartmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeOdaPrivateEndpointCompartmentDetails) String() string
func (m ChangeOdaPrivateEndpointCompartmentDetails) ValidateEnumValue() (bool, error)
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
ChangeOdaPrivateEndpointCompartmentRequest wrapper for the ChangeOdaPrivateEndpointCompartment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/ChangeOdaPrivateEndpointCompartment.go.html to see an example of how to use ChangeOdaPrivateEndpointCompartmentRequest.
type ChangeOdaPrivateEndpointCompartmentRequest struct {
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// The compartment to which the Digital Assistant instance should be moved.
ChangeOdaPrivateEndpointCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control in a PUT or DELETE call for
// a Digital Assistant instance, set the `if-match` query parameter
// to the value of the `ETAG` header from a previous GET or POST
// response for that instance. The service updates or deletes the
// instance only if the etag that you provide matches the instance's
// current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeOdaPrivateEndpointCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeOdaPrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOdaPrivateEndpointCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOdaPrivateEndpointCompartmentRequest) String() string
func (request ChangeOdaPrivateEndpointCompartmentRequest) ValidateEnumValue() (bool, error)
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
ChangeOdaPrivateEndpointCompartmentResponse wrapper for the ChangeOdaPrivateEndpointCompartment operation
type ChangeOdaPrivateEndpointCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeOdaPrivateEndpointCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOdaPrivateEndpointCompartmentResponse) String() string
Channel Properties of a Channel.
type Channel interface {
// Unique immutable identifier that was assigned when the Channel was created.
GetId() *string
// The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.
GetName() *string
// The category of the Channel.
GetCategory() ChannelCategoryEnum
// The Channel's current state.
GetLifecycleState() LifecycleStateEnum
// When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// A short description of the Channel.
GetDescription() *string
// The number of milliseconds before a session expires.
GetSessionExpiryDurationInMilliseconds() *int64
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
ChannelCategoryEnum Enum with underlying type: string
type ChannelCategoryEnum string
Set of constants representing the allowable values for ChannelCategoryEnum
const (
ChannelCategoryAgent ChannelCategoryEnum = "AGENT"
ChannelCategoryApplication ChannelCategoryEnum = "APPLICATION"
ChannelCategoryBot ChannelCategoryEnum = "BOT"
ChannelCategoryBotAsAgent ChannelCategoryEnum = "BOT_AS_AGENT"
ChannelCategorySystem ChannelCategoryEnum = "SYSTEM"
ChannelCategoryEvent ChannelCategoryEnum = "EVENT"
)
func GetChannelCategoryEnumValues() []ChannelCategoryEnum
GetChannelCategoryEnumValues Enumerates the set of values for ChannelCategoryEnum
func GetMappingChannelCategoryEnum(val string) (ChannelCategoryEnum, bool)
GetMappingChannelCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
ChannelCollection A collection of Channel summaries.
type ChannelCollection struct {
// The Channel summaries.
Items []ChannelSummary `mandatory:"true" json:"items"`
}
func (m ChannelCollection) String() string
func (m ChannelCollection) ValidateEnumValue() (bool, error)
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
ChannelSummary Summary of the Channel.
type ChannelSummary 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"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel type.
Type ChannelTypeEnum `mandatory:"true" json:"type"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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"`
// A short description of the Channel.
Description *string `mandatory:"false" json:"description"`
// 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"`
}
func (m ChannelSummary) String() string
func (m ChannelSummary) ValidateEnumValue() (bool, error)
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
ChannelTypeEnum Enum with underlying type: string
type ChannelTypeEnum string
Set of constants representing the allowable values for ChannelTypeEnum
const (
ChannelTypeAndroid ChannelTypeEnum = "ANDROID"
ChannelTypeAppevent ChannelTypeEnum = "APPEVENT"
ChannelTypeApplication ChannelTypeEnum = "APPLICATION"
ChannelTypeCortana ChannelTypeEnum = "CORTANA"
ChannelTypeFacebook ChannelTypeEnum = "FACEBOOK"
ChannelTypeIos ChannelTypeEnum = "IOS"
ChannelTypeMsteams ChannelTypeEnum = "MSTEAMS"
ChannelTypeOss ChannelTypeEnum = "OSS"
ChannelTypeOsvc ChannelTypeEnum = "OSVC"
ChannelTypeServicecloud ChannelTypeEnum = "SERVICECLOUD"
ChannelTypeSlack ChannelTypeEnum = "SLACK"
ChannelTypeTest ChannelTypeEnum = "TEST"
ChannelTypeTwilio ChannelTypeEnum = "TWILIO"
ChannelTypeWeb ChannelTypeEnum = "WEB"
ChannelTypeWebhook ChannelTypeEnum = "WEBHOOK"
)
func GetChannelTypeEnumValues() []ChannelTypeEnum
GetChannelTypeEnumValues Enumerates the set of values for ChannelTypeEnum
func GetMappingChannelTypeEnum(val string) (ChannelTypeEnum, bool)
GetMappingChannelTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CloneDigitalAssistantDetails Properties that are required to create a new Digital Assistant by cloning an existing Digital Assistant.
type CloneDigitalAssistantDetails struct {
// The unique identifier of the Digital Assistant to clone.
Id *string `mandatory:"true" json:"id"`
// The reource'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"`
// The resource's display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// 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 resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"false" json:"version"`
// The multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
}
func (m CloneDigitalAssistantDetails) GetCategory() *string
GetCategory returns Category
func (m CloneDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloneDigitalAssistantDetails) GetDescription() *string
GetDescription returns Description
func (m CloneDigitalAssistantDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloneDigitalAssistantDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CloneDigitalAssistantDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CloneDigitalAssistantDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CloneDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloneDigitalAssistantDetails) String() string
func (m CloneDigitalAssistantDetails) ValidateEnumValue() (bool, error)
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
CloneSkillDetails Properties that are required to create a new Skill by cloning an existing Skill.
type CloneSkillDetails struct {
// The unique identifier of the Skill to clone.
Id *string `mandatory:"true" json:"id"`
// The reource'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"`
// The resource's display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// 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 resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"false" json:"version"`
// The multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
}
func (m CloneSkillDetails) GetCategory() *string
GetCategory returns Category
func (m CloneSkillDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CloneSkillDetails) GetDescription() *string
GetDescription returns Description
func (m CloneSkillDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CloneSkillDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CloneSkillDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CloneSkillDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CloneSkillDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CloneSkillDetails) String() string
func (m CloneSkillDetails) ValidateEnumValue() (bool, error)
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
ConfigureDigitalAssistantParametersDetails Properties for configuring the Digital Assistant Parameters in a Digital Assistant instance.
type ConfigureDigitalAssistantParametersDetails struct {
// The values to use to configure the Digital Assistant Parameters.
Parameters []DigitalAssistantParameterValue `mandatory:"true" json:"parameters"`
}
func (m ConfigureDigitalAssistantParametersDetails) String() string
func (m ConfigureDigitalAssistantParametersDetails) ValidateEnumValue() (bool, error)
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
ConfigureDigitalAssistantParametersRequest wrapper for the ConfigureDigitalAssistantParameters operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/ConfigureDigitalAssistantParameters.go.html to see an example of how to use ConfigureDigitalAssistantParametersRequest.
type ConfigureDigitalAssistantParametersRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// The parameter values to use.
ConfigureDigitalAssistantParametersDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ConfigureDigitalAssistantParametersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ConfigureDigitalAssistantParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ConfigureDigitalAssistantParametersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ConfigureDigitalAssistantParametersRequest) String() string
func (request ConfigureDigitalAssistantParametersRequest) ValidateEnumValue() (bool, error)
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
ConfigureDigitalAssistantParametersResponse wrapper for the ConfigureDigitalAssistantParameters operation
type ConfigureDigitalAssistantParametersResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ConfigureDigitalAssistantParametersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ConfigureDigitalAssistantParametersResponse) String() string
CortanaChannel The configuration for a Cortana channel.
type CortanaChannel 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 Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"true" json:"msaAppId"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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"`
}
func (m CortanaChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CortanaChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CortanaChannel) GetDescription() *string
GetDescription returns Description
func (m CortanaChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CortanaChannel) GetId() *string
GetId returns Id
func (m CortanaChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CortanaChannel) GetName() *string
GetName returns Name
func (m CortanaChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CortanaChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CortanaChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CortanaChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CortanaChannel) String() string
func (m CortanaChannel) ValidateEnumValue() (bool, error)
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
CreateAndroidChannelDetails Properties required to create an Android channel.
type CreateAndroidChannelDetails struct {
// 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"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"true" json:"isClientAuthenticationEnabled"`
// 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m CreateAndroidChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAndroidChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAndroidChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAndroidChannelDetails) GetName() *string
GetName returns Name
func (m CreateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateAndroidChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAndroidChannelDetails) String() string
func (m CreateAndroidChannelDetails) ValidateEnumValue() (bool, error)
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
CreateAndroidChannelResult The configuration for an Android channel.
type CreateAndroidChannelResult 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 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.
SecretKey *string `mandatory:"true" json:"secretKey"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"true" json:"isClientAuthenticationEnabled"`
// 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// 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"`
}
func (m CreateAndroidChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateAndroidChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAndroidChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateAndroidChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAndroidChannelResult) GetId() *string
GetId returns Id
func (m CreateAndroidChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateAndroidChannelResult) GetName() *string
GetName returns Name
func (m CreateAndroidChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateAndroidChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateAndroidChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateAndroidChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAndroidChannelResult) String() string
func (m CreateAndroidChannelResult) ValidateEnumValue() (bool, error)
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
CreateAppEventChannelDetails Properties required to create an Application Event channel.
type CreateAppEventChannelDetails struct {
// 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"`
// 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 URL for sending errors and responses to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// The IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
}
func (m CreateAppEventChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAppEventChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateAppEventChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAppEventChannelDetails) GetName() *string
GetName returns Name
func (m CreateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateAppEventChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAppEventChannelDetails) String() string
func (m CreateAppEventChannelDetails) ValidateEnumValue() (bool, error)
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
CreateAppEventChannelResult The configuration for an Application Event channel.
type CreateAppEventChannelResult 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 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.
SecretKey *string `mandatory:"true" json:"secretKey"`
// The URL for sending errors and responses to.
OutboundUrl *string `mandatory:"true" json:"outboundUrl"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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 IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CreateAppEventChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateAppEventChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateAppEventChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateAppEventChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateAppEventChannelResult) GetId() *string
GetId returns Id
func (m CreateAppEventChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateAppEventChannelResult) GetName() *string
GetName returns Name
func (m CreateAppEventChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateAppEventChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateAppEventChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateAppEventChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateAppEventChannelResult) String() string
func (m CreateAppEventChannelResult) ValidateEnumValue() (bool, error)
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
CreateApplicationChannelDetails Properties required to create an Application channel.
type CreateApplicationChannelDetails struct {
// 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"`
// True if the user id in the AIC message should be treated as an authenticated user id.
IsAuthenticatedUserId *bool `mandatory:"true" json:"isAuthenticatedUserId"`
// 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 URL to send response and error messages to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
}
func (m CreateApplicationChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateApplicationChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateApplicationChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateApplicationChannelDetails) GetName() *string
GetName returns Name
func (m CreateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateApplicationChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateApplicationChannelDetails) String() string
func (m CreateApplicationChannelDetails) ValidateEnumValue() (bool, error)
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
CreateApplicationChannelResult The configuration for an Application channel.
type CreateApplicationChannelResult 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 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.
SecretKey *string `mandatory:"true" json:"secretKey"`
// True if the user id in the AIC message should be treated as an authenticated user id.
IsAuthenticatedUserId *bool `mandatory:"true" json:"isAuthenticatedUserId"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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 URL to send response and error messages to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CreateApplicationChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateApplicationChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateApplicationChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateApplicationChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateApplicationChannelResult) GetId() *string
GetId returns Id
func (m CreateApplicationChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateApplicationChannelResult) GetName() *string
GetName returns Name
func (m CreateApplicationChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateApplicationChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateApplicationChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateApplicationChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateApplicationChannelResult) String() string
func (m CreateApplicationChannelResult) ValidateEnumValue() (bool, error)
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
CreateAuthenticationProviderDetails Properties required to create a new Authentication Provider.
type CreateAuthenticationProviderDetails struct {
// The grant type for the Authentication Provider.
GrantType AuthenticationGrantTypeEnum `mandatory:"true" json:"grantType"`
// Which type of Identity Provider (IDP) you are using.
IdentityProvider AuthenticationIdentityProviderEnum `mandatory:"true" json:"identityProvider"`
// A name to identify the Authentication Provider.
Name *string `mandatory:"true" json:"name"`
// The IDPs URL for requesting access tokens.
TokenEndpointUrl *string `mandatory:"true" json:"tokenEndpointUrl"`
// The client ID for the IDP application (OAuth Client) that was registered as described in Identity Provider Registration.
// With Microsoft identity platform, use the application ID.
ClientId *string `mandatory:"true" json:"clientId"`
// The client secret for the IDP application (OAuth Client) that was registered as described in Identity Provider
// Registration. With Microsoft identity platform, use the application secret.
ClientSecret *string `mandatory:"true" json:"clientSecret"`
// A space-separated list of the scopes that must be included when Digital Assistant requests an access token from
// the provider. Include all the scopes that are required to access the resources. If refresh tokens are enabled,
// include the scope that’s necessary to get the refresh token (typically offline_access).
Scopes *string `mandatory:"true" json:"scopes"`
// The IDPs URL for the page that users authenticate with by entering the user name and password.
AuthorizationEndpointUrl *string `mandatory:"false" json:"authorizationEndpointUrl"`
// A shortened version of the authorization URL, which you can get from a URL shortener service (one that allows
// you to send query parameters). You might need this because the generated authorization-code-request URL
// could be too long for SMS and older smart phones.
ShortAuthorizationCodeRequestUrl *string `mandatory:"false" json:"shortAuthorizationCodeRequestUrl"`
// If you want to revoke all the refresh tokens and access tokens of the logged-in user from a dialog flow, then
// you need the IDP's revoke refresh token URL. If you provide this URL, then you can use the System.OAuth2ResetTokens
// component to revoke the user's tokens for this service.
RevokeTokenEndpointUrl *string `mandatory:"false" json:"revokeTokenEndpointUrl"`
// The access-token profile claim to use to identify the user.
SubjectClaim *string `mandatory:"false" json:"subjectClaim"`
// The number of days to keep the refresh token in the Digital Assistant cache.
RefreshTokenRetentionPeriodInDays *int `mandatory:"false" json:"refreshTokenRetentionPeriodInDays"`
// The OAuth Redirect URL.
RedirectUrl *string `mandatory:"false" json:"redirectUrl"`
// Whether this Authentication Provider is visible in the ODA UI.
IsVisible *bool `mandatory:"false" json:"isVisible"`
// 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"`
}
func (m CreateAuthenticationProviderDetails) String() string
func (m CreateAuthenticationProviderDetails) ValidateEnumValue() (bool, error)
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
CreateAuthenticationProviderRequest wrapper for the CreateAuthenticationProvider operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateAuthenticationProvider.go.html to see an example of how to use CreateAuthenticationProviderRequest.
type CreateAuthenticationProviderRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Property values required to create the new Authentication Provider.
CreateAuthenticationProviderDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateAuthenticationProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateAuthenticationProviderRequest) String() string
func (request CreateAuthenticationProviderRequest) ValidateEnumValue() (bool, error)
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
CreateAuthenticationProviderResponse wrapper for the CreateAuthenticationProvider operation
type CreateAuthenticationProviderResponse struct {
// The underlying http response
RawResponse *http.Response
// The AuthenticationProvider instance
AuthenticationProvider `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateAuthenticationProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateAuthenticationProviderResponse) String() string
CreateBotKindEnum Enum with underlying type: string
type CreateBotKindEnum string
Set of constants representing the allowable values for CreateBotKindEnum
const (
CreateBotKindNew CreateBotKindEnum = "NEW"
CreateBotKindClone CreateBotKindEnum = "CLONE"
CreateBotKindVersion CreateBotKindEnum = "VERSION"
CreateBotKindExtend CreateBotKindEnum = "EXTEND"
)
func GetCreateBotKindEnumValues() []CreateBotKindEnum
GetCreateBotKindEnumValues Enumerates the set of values for CreateBotKindEnum
func GetMappingCreateBotKindEnum(val string) (CreateBotKindEnum, bool)
GetMappingCreateBotKindEnum performs case Insensitive comparison on enum value and return the desired enum
CreateChannelDetails Properties that are required to create a Channel.
type CreateChannelDetails interface {
// The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.
GetName() *string
// A short description of the Channel.
GetDescription() *string
// The number of milliseconds before a session expires.
GetSessionExpiryDurationInMilliseconds() *int64
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateChannelRequest wrapper for the CreateChannel operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateChannel.go.html to see an example of how to use CreateChannelRequest.
type CreateChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Property values for creating the new Channel.
CreateChannelDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateChannelRequest) String() string
func (request CreateChannelRequest) ValidateEnumValue() (bool, error)
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
CreateChannelResponse wrapper for the CreateChannel operation
type CreateChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The CreateChannelResult instance
CreateChannelResult `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateChannelResponse) String() string
CreateChannelResult Properties of a Channel.
type CreateChannelResult interface {
// Unique immutable identifier that was assigned when the Channel was created.
GetId() *string
// The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.
GetName() *string
// The category of the Channel.
GetCategory() ChannelCategoryEnum
// The Channel's current state.
GetLifecycleState() LifecycleStateEnum
// When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeCreated() *common.SDKTime
// When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
GetTimeUpdated() *common.SDKTime
// A short description of the Channel.
GetDescription() *string
// The number of milliseconds before a session expires.
GetSessionExpiryDurationInMilliseconds() *int64
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateCortanaChannelDetails Properties required to create a Cortana channel.
type CreateCortanaChannelDetails struct {
// 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"`
// The Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"true" json:"msaAppId"`
// The client secret that you obtained from your bot registration.
MsaAppPassword *string `mandatory:"true" json:"msaAppPassword"`
// 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"`
}
func (m CreateCortanaChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateCortanaChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateCortanaChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateCortanaChannelDetails) GetName() *string
GetName returns Name
func (m CreateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateCortanaChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateCortanaChannelDetails) String() string
func (m CreateCortanaChannelDetails) ValidateEnumValue() (bool, error)
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
CreateCortanaChannelResult The configuration for a Cortana channel.
type CreateCortanaChannelResult 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 Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"true" json:"msaAppId"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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"`
}
func (m CreateCortanaChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateCortanaChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateCortanaChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateCortanaChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateCortanaChannelResult) GetId() *string
GetId returns Id
func (m CreateCortanaChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateCortanaChannelResult) GetName() *string
GetName returns Name
func (m CreateCortanaChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateCortanaChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateCortanaChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateCortanaChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateCortanaChannelResult) String() string
func (m CreateCortanaChannelResult) ValidateEnumValue() (bool, error)
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
CreateDigitalAssistantDetails Properties that are required to create a Digital Assistant.
type CreateDigitalAssistantDetails interface {
// The resource's category. This is used to group resource's together.
GetCategory() *string
// A short description of the resource.
GetDescription() *string
// The ODA Platform Version for this resource.
GetPlatformVersion() *string
// The multilingual mode for the resource.
GetMultilingualMode() BotMultilingualModeEnum
// The primary language for the resource.
GetPrimaryLanguageTag() *string
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateDigitalAssistantRequest wrapper for the CreateDigitalAssistant operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateDigitalAssistant.go.html to see an example of how to use CreateDigitalAssistantRequest.
type CreateDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Property values for creating the new Digital Assistant.
CreateDigitalAssistantDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDigitalAssistantRequest) String() string
func (request CreateDigitalAssistantRequest) ValidateEnumValue() (bool, error)
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
CreateDigitalAssistantResponse wrapper for the CreateDigitalAssistant operation
type CreateDigitalAssistantResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDigitalAssistantResponse) String() string
CreateDigitalAssistantVersionDetails Properties that are required to create a new version of an existing Digital Assistant.
type CreateDigitalAssistantVersionDetails struct {
// The unique identifier of the Digital Assistant to create a new version of.
Id *string `mandatory:"true" json:"id"`
// The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"true" json:"version"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// 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 multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
}
func (m CreateDigitalAssistantVersionDetails) GetCategory() *string
GetCategory returns Category
func (m CreateDigitalAssistantVersionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateDigitalAssistantVersionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateDigitalAssistantVersionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateDigitalAssistantVersionDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CreateDigitalAssistantVersionDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CreateDigitalAssistantVersionDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CreateDigitalAssistantVersionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDigitalAssistantVersionDetails) String() string
func (m CreateDigitalAssistantVersionDetails) ValidateEnumValue() (bool, error)
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
CreateFacebookChannelDetails Properties required to create a Facebook channel.
type CreateFacebookChannelDetails struct {
// 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"`
// The app secret for your Facebook app.
AppSecret *string `mandatory:"true" json:"appSecret"`
// The page access token that you generated for your Facebook page.
PageAccessToken *string `mandatory:"true" json:"pageAccessToken"`
// 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"`
}
func (m CreateFacebookChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateFacebookChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateFacebookChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateFacebookChannelDetails) GetName() *string
GetName returns Name
func (m CreateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateFacebookChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateFacebookChannelDetails) String() string
func (m CreateFacebookChannelDetails) ValidateEnumValue() (bool, error)
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
CreateFacebookChannelResult The configuration for a Facebook channel.
type CreateFacebookChannelResult 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 Facebook verify token.
// This is used by Facebook when verifying the webhook channel.
// This is only returned this once. If it is lost the keys will need to be rotated to generate a new verify token.
VerifyToken *string `mandatory:"true" json:"verifyToken"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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"`
}
func (m CreateFacebookChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateFacebookChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateFacebookChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateFacebookChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateFacebookChannelResult) GetId() *string
GetId returns Id
func (m CreateFacebookChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateFacebookChannelResult) GetName() *string
GetName returns Name
func (m CreateFacebookChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateFacebookChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateFacebookChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateFacebookChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateFacebookChannelResult) String() string
func (m CreateFacebookChannelResult) ValidateEnumValue() (bool, error)
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
CreateImportedPackageDetails Payload for creating an imported package
type CreateImportedPackageDetails struct {
// ID of the package to import.
CurrentPackageId *string `mandatory:"true" json:"currentPackageId"`
// A list of parameter values to use when importing the given package. Must match those defined in the import contract.
ParameterValues map[string]string `mandatory:"false" json:"parameterValues"`
// 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"`
}
func (m CreateImportedPackageDetails) String() string
func (m CreateImportedPackageDetails) ValidateEnumValue() (bool, error)
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
CreateImportedPackageRequest wrapper for the CreateImportedPackage operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateImportedPackage.go.html to see an example of how to use CreateImportedPackageRequest.
type CreateImportedPackageRequest struct {
// Parameter values required to import the package.
CreateImportedPackageDetails `contributesTo:"body"`
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateImportedPackageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateImportedPackageRequest) String() string
func (request CreateImportedPackageRequest) ValidateEnumValue() (bool, error)
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
CreateImportedPackageResponse wrapper for the CreateImportedPackage operation
type CreateImportedPackageResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportedPackage instance
ImportedPackage `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateImportedPackageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateImportedPackageResponse) String() string
CreateIosChannelDetails Properties required to create an iOS channel.
type CreateIosChannelDetails struct {
// 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"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"true" json:"isClientAuthenticationEnabled"`
// 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m CreateIosChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateIosChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateIosChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateIosChannelDetails) GetName() *string
GetName returns Name
func (m CreateIosChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateIosChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateIosChannelDetails) String() string
func (m CreateIosChannelDetails) ValidateEnumValue() (bool, error)
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
CreateIosChannelResult The configuration for an iOS channel.
type CreateIosChannelResult 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 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.
SecretKey *string `mandatory:"true" json:"secretKey"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"true" json:"isClientAuthenticationEnabled"`
// 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// 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"`
}
func (m CreateIosChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateIosChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateIosChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateIosChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateIosChannelResult) GetId() *string
GetId returns Id
func (m CreateIosChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateIosChannelResult) GetName() *string
GetName returns Name
func (m CreateIosChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateIosChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateIosChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateIosChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateIosChannelResult) String() string
func (m CreateIosChannelResult) ValidateEnumValue() (bool, error)
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
CreateMsTeamsChannelDetails Properties required to create an MS Teams channel.
type CreateMsTeamsChannelDetails struct {
// 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"`
// The Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"true" json:"msaAppId"`
// The client secret that you obtained from your bot registration.
MsaAppPassword *string `mandatory:"true" json:"msaAppPassword"`
// 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"`
}
func (m CreateMsTeamsChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMsTeamsChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateMsTeamsChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMsTeamsChannelDetails) GetName() *string
GetName returns Name
func (m CreateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateMsTeamsChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMsTeamsChannelDetails) String() string
func (m CreateMsTeamsChannelDetails) ValidateEnumValue() (bool, error)
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
CreateMsTeamsChannelResult The configuration for an MS Teams channel.
type CreateMsTeamsChannelResult 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 Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"true" json:"msaAppId"`
// The URL to use to send messages to this channel.
// This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
WebhookUrl *string `mandatory:"true" json:"webhookUrl"`
// 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"`
}
func (m CreateMsTeamsChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateMsTeamsChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateMsTeamsChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateMsTeamsChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateMsTeamsChannelResult) GetId() *string
GetId returns Id
func (m CreateMsTeamsChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateMsTeamsChannelResult) GetName() *string
GetName returns Name
func (m CreateMsTeamsChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateMsTeamsChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateMsTeamsChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateMsTeamsChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateMsTeamsChannelResult) String() string
func (m CreateMsTeamsChannelResult) ValidateEnumValue() (bool, error)
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
CreateNewDigitalAssistantDetails Properties that are required to create a Digital Assistant from scratch.
type CreateNewDigitalAssistantDetails struct {
// The reource'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"`
// The resource's display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// 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 resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"false" json:"version"`
// A list of native languages supported by this resource.
NativeLanguageTags []string `mandatory:"false" json:"nativeLanguageTags"`
// The multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
}
func (m CreateNewDigitalAssistantDetails) GetCategory() *string
GetCategory returns Category
func (m CreateNewDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateNewDigitalAssistantDetails) GetDescription() *string
GetDescription returns Description
func (m CreateNewDigitalAssistantDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateNewDigitalAssistantDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CreateNewDigitalAssistantDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CreateNewDigitalAssistantDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CreateNewDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateNewDigitalAssistantDetails) String() string
func (m CreateNewDigitalAssistantDetails) ValidateEnumValue() (bool, error)
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
CreateNewSkillDetails Properties that are required to create a Skill from scratch.
type CreateNewSkillDetails struct {
// The reource'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"`
// The resource's display name.
DisplayName *string `mandatory:"true" json:"displayName"`
// The resource's version. The version can only contain numbers, letters, periods, underscores, dashes or spaces. The version must begin with a letter or a number.
Version *string `mandatory:"true" json:"version"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"false" json:"category"`
// A short description of the resource.
Description *string `mandatory:"false" json:"description"`
// The ODA Platform Version for this resource.
PlatformVersion *string `mandatory:"false" json:"platformVersion"`
// The primary language for the resource.
PrimaryLanguageTag *string `mandatory:"false" json:"primaryLanguageTag"`
// 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"`
// A list of native languages supported by this resource.
NativeLanguageTags []string `mandatory:"false" json:"nativeLanguageTags"`
// The multilingual mode for the resource.
MultilingualMode BotMultilingualModeEnum `mandatory:"false" json:"multilingualMode,omitempty"`
}
func (m CreateNewSkillDetails) GetCategory() *string
GetCategory returns Category
func (m CreateNewSkillDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateNewSkillDetails) GetDescription() *string
GetDescription returns Description
func (m CreateNewSkillDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateNewSkillDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CreateNewSkillDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CreateNewSkillDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CreateNewSkillDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateNewSkillDetails) String() string
func (m CreateNewSkillDetails) ValidateEnumValue() (bool, error)
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
CreateOdaInstanceAttachmentDetails Properties required to create an ODA instance attachment.
type CreateOdaInstanceAttachmentDetails struct {
// The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this ODA instance is being attached.
AttachToId *string `mandatory:"true" json:"attachToId"`
// The type of target instance which this ODA instance is being attached.
AttachmentType CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum `mandatory:"true" json:"attachmentType"`
Owner *OdaInstanceAttachmentOwner `mandatory:"true" json:"owner"`
// Attachment specific metadata. Defined by the target service.
AttachmentMetadata *string `mandatory:"false" json:"attachmentMetadata"`
// List of operations that are restricted while this instance is attached.
RestrictedOperations []string `mandatory:"false" json:"restrictedOperations"`
// 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"`
}
func (m CreateOdaInstanceAttachmentDetails) String() string
func (m CreateOdaInstanceAttachmentDetails) ValidateEnumValue() (bool, error)
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
CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum Enum with underlying type: string
type CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum string
Set of constants representing the allowable values for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum
const (
CreateOdaInstanceAttachmentDetailsAttachmentTypeFusion CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum = "FUSION"
)
func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumValues() []CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum
GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumValues Enumerates the set of values for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum
func GetMappingCreateOdaInstanceAttachmentDetailsAttachmentTypeEnum(val string) (CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum, bool)
GetMappingCreateOdaInstanceAttachmentDetailsAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateOdaInstanceAttachmentRequest wrapper for the CreateOdaInstanceAttachment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateOdaInstanceAttachment.go.html to see an example of how to use CreateOdaInstanceAttachmentRequest.
type CreateOdaInstanceAttachmentRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Details for the new Digital Assistant instance attachment.
CreateOdaInstanceAttachmentDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaInstanceAttachmentRequest) String() string
func (request CreateOdaInstanceAttachmentRequest) ValidateEnumValue() (bool, error)
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
CreateOdaInstanceAttachmentResponse wrapper for the CreateOdaInstanceAttachment operation
type CreateOdaInstanceAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateOdaInstanceAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaInstanceAttachmentResponse) String() string
CreateOdaInstanceDetails Properties that are required to create a Digital Assistant instance.
type CreateOdaInstanceDetails struct {
// Identifier of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Shape or size of the instance.
ShapeName CreateOdaInstanceDetailsShapeNameEnum `mandatory:"true" json:"shapeName"`
// User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the Digital Assistant instance.
Description *string `mandatory:"false" json:"description"`
// 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"`
}
func (m CreateOdaInstanceDetails) String() string
func (m CreateOdaInstanceDetails) ValidateEnumValue() (bool, error)
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
CreateOdaInstanceDetailsShapeNameEnum Enum with underlying type: string
type CreateOdaInstanceDetailsShapeNameEnum string
Set of constants representing the allowable values for CreateOdaInstanceDetailsShapeNameEnum
const (
CreateOdaInstanceDetailsShapeNameDevelopment CreateOdaInstanceDetailsShapeNameEnum = "DEVELOPMENT"
CreateOdaInstanceDetailsShapeNameProduction CreateOdaInstanceDetailsShapeNameEnum = "PRODUCTION"
)
func GetCreateOdaInstanceDetailsShapeNameEnumValues() []CreateOdaInstanceDetailsShapeNameEnum
GetCreateOdaInstanceDetailsShapeNameEnumValues Enumerates the set of values for CreateOdaInstanceDetailsShapeNameEnum
func GetMappingCreateOdaInstanceDetailsShapeNameEnum(val string) (CreateOdaInstanceDetailsShapeNameEnum, bool)
GetMappingCreateOdaInstanceDetailsShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum
CreateOdaInstanceRequest wrapper for the CreateOdaInstance operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateOdaInstance.go.html to see an example of how to use CreateOdaInstanceRequest.
type CreateOdaInstanceRequest struct {
// Details for the new Digital Assistant instance.
CreateOdaInstanceDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaInstanceRequest) String() string
func (request CreateOdaInstanceRequest) ValidateEnumValue() (bool, error)
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
CreateOdaInstanceResponse wrapper for the CreateOdaInstance operation
type CreateOdaInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaInstance instance
OdaInstance `presentIn:"body"`
// Fully qualified URL for the newly created instance.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaInstanceResponse) String() string
CreateOdaPrivateEndpointAttachmentDetails Properties that are required to create an ODA private endpoint attachment.
type CreateOdaPrivateEndpointAttachmentDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`
}
func (m CreateOdaPrivateEndpointAttachmentDetails) String() string
func (m CreateOdaPrivateEndpointAttachmentDetails) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointAttachmentRequest wrapper for the CreateOdaPrivateEndpointAttachment operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateOdaPrivateEndpointAttachment.go.html to see an example of how to use CreateOdaPrivateEndpointAttachmentRequest.
type CreateOdaPrivateEndpointAttachmentRequest struct {
// Details for the new ODA Private Endpoint Attachment.
CreateOdaPrivateEndpointAttachmentDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOdaPrivateEndpointAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaPrivateEndpointAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaPrivateEndpointAttachmentRequest) String() string
func (request CreateOdaPrivateEndpointAttachmentRequest) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointAttachmentResponse wrapper for the CreateOdaPrivateEndpointAttachment operation
type CreateOdaPrivateEndpointAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpointAttachment instance
OdaPrivateEndpointAttachment `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaPrivateEndpointAttachmentResponse) String() string
CreateOdaPrivateEndpointDetails Properties that can be specified to create an ODA private endpoint.
type CreateOdaPrivateEndpointDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
SubnetId *string `mandatory:"true" json:"subnetId"`
// User-defined name for the ODA private endpoint. Avoid entering confidential information.
// You can change this value.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the ODA private endpoint.
Description *string `mandatory:"false" json:"description"`
// List of OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm)
NsgIds []string `mandatory:"false" json:"nsgIds"`
// 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"`
}
func (m CreateOdaPrivateEndpointDetails) String() string
func (m CreateOdaPrivateEndpointDetails) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointRequest wrapper for the CreateOdaPrivateEndpoint operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateOdaPrivateEndpoint.go.html to see an example of how to use CreateOdaPrivateEndpointRequest.
type CreateOdaPrivateEndpointRequest struct {
// Details for the new ODA Private Endpoint.
CreateOdaPrivateEndpointDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaPrivateEndpointRequest) String() string
func (request CreateOdaPrivateEndpointRequest) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointResponse wrapper for the CreateOdaPrivateEndpoint operation
type CreateOdaPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpoint instance
OdaPrivateEndpoint `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CreateOdaPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaPrivateEndpointResponse) String() string
CreateOdaPrivateEndpointScanProxyDetails Properties that are required to create an ODA Private Endpoint Scan Proxy.
type CreateOdaPrivateEndpointScanProxyDetails struct {
// Type indicating whether Scan listener is specified by its FQDN or list of IPs
ScanListenerType OdaPrivateEndpointScanProxyScanListenerTypeEnum `mandatory:"true" json:"scanListenerType"`
// The protocol used for communication between client, scanProxy and RAC's scan listeners
Protocol OdaPrivateEndpointScanProxyProtocolEnum `mandatory:"true" json:"protocol"`
// The FQDN/IPs and port information of customer's Real Application Cluster (RAC)'s SCAN listeners.
ScanListenerInfos []ScanListenerInfo `mandatory:"true" json:"scanListenerInfos"`
}
func (m CreateOdaPrivateEndpointScanProxyDetails) String() string
func (m CreateOdaPrivateEndpointScanProxyDetails) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointScanProxyRequest wrapper for the CreateOdaPrivateEndpointScanProxy operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateOdaPrivateEndpointScanProxy.go.html to see an example of how to use CreateOdaPrivateEndpointScanProxyRequest.
type CreateOdaPrivateEndpointScanProxyRequest struct {
// Details for the new ODA Private Endpoint Scan Proxy.
CreateOdaPrivateEndpointScanProxyDetails `contributesTo:"body"`
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateOdaPrivateEndpointScanProxyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaPrivateEndpointScanProxyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaPrivateEndpointScanProxyRequest) String() string
func (request CreateOdaPrivateEndpointScanProxyRequest) ValidateEnumValue() (bool, error)
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
CreateOdaPrivateEndpointScanProxyResponse wrapper for the CreateOdaPrivateEndpointScanProxy operation
type CreateOdaPrivateEndpointScanProxyResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpointScanProxy instance
OdaPrivateEndpointScanProxy `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status
// of the operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response CreateOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaPrivateEndpointScanProxyResponse) String() string
CreateOssChannelDetails Properties required to create an Oracle Streaming Service (OSS) channel.
type CreateOssChannelDetails struct {
// 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"`
// The topic inbound messages are received on.
InboundMessageTopic *string `mandatory:"true" json:"inboundMessageTopic"`
// The topic outbound messages are sent on.
OutboundMessageTopic *string `mandatory:"true" json:"outboundMessageTopic"`
// The Oracle Streaming Service bootstrap servers.
BootstrapServers *string `mandatory:"true" json:"bootstrapServers"`
// The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.
SecurityProtocol *string `mandatory:"true" json:"securityProtocol"`
// The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.
SaslMechanism *string `mandatory:"true" json:"saslMechanism"`
// The tenancy to use when connecting to the Oracle Streaming Service.
TenancyName *string `mandatory:"true" json:"tenancyName"`
// The user name to use when connecting to the Oracle Streaming Service.
UserName *string `mandatory:"true" json:"userName"`
// The stream pool OCI to use when connecting to the Oracle Streaming Service.
StreamPoolId *string `mandatory:"true" json:"streamPoolId"`
// The authentication token to use when connecting to the Oracle Streaming Service.
AuthToken *string `mandatory:"true" json:"authToken"`
// 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 IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
}
func (m CreateOssChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOssChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateOssChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOssChannelDetails) GetName() *string
GetName returns Name
func (m CreateOssChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateOssChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOssChannelDetails) String() string
func (m CreateOssChannelDetails) ValidateEnumValue() (bool, error)
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
CreateOssChannelResult The configuration for an Oracle Streaming Service (OSS) channel.
type CreateOssChannelResult 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 topic inbound messages are received on.
InboundMessageTopic *string `mandatory:"true" json:"inboundMessageTopic"`
// The topic outbound messages are sent on.
OutboundMessageTopic *string `mandatory:"true" json:"outboundMessageTopic"`
// The Oracle Streaming Service bootstrap servers.
BootstrapServers *string `mandatory:"true" json:"bootstrapServers"`
// The security protocol to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.
SecurityProtocol *string `mandatory:"true" json:"securityProtocol"`
// The SASL mechanmism to use when conecting to the Oracle Streaming Service. See Oracle Streaming Service documentation for a list of valid values.
SaslMechanism *string `mandatory:"true" json:"saslMechanism"`
// The tenancy to use when connecting to the Oracle Streaming Service.
TenancyName *string `mandatory:"true" json:"tenancyName"`
// The user name to use when connecting to the Oracle Streaming Service.
UserName *string `mandatory:"true" json:"userName"`
// The stream pool OCI to use when connecting to the Oracle Streaming Service.
StreamPoolId *string `mandatory:"true" json:"streamPoolId"`
// 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 IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CreateOssChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateOssChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOssChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateOssChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOssChannelResult) GetId() *string
GetId returns Id
func (m CreateOssChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateOssChannelResult) GetName() *string
GetName returns Name
func (m CreateOssChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateOssChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateOssChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateOssChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOssChannelResult) String() string
func (m CreateOssChannelResult) ValidateEnumValue() (bool, error)
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
CreateOsvcChannelDetails Properties required to create an OSVC channel.
type CreateOsvcChannelDetails struct {
// 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"`
// 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 password for the digital-assistant agent.
Password *string `mandatory:"true" json:"password"`
// 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 type of OSVC service.
ChannelService OsvcServiceTypeEnum `mandatory:"false" json:"channelService,omitempty"`
}
func (m CreateOsvcChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOsvcChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateOsvcChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOsvcChannelDetails) GetName() *string
GetName returns Name
func (m CreateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateOsvcChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOsvcChannelDetails) String() string
func (m CreateOsvcChannelDetails) ValidateEnumValue() (bool, error)
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
CreateOsvcChannelResult The configuration for an OSVC channel.
type CreateOsvcChannelResult 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"`
}
func (m CreateOsvcChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateOsvcChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateOsvcChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateOsvcChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateOsvcChannelResult) GetId() *string
GetId returns Id
func (m CreateOsvcChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateOsvcChannelResult) GetName() *string
GetName returns Name
func (m CreateOsvcChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateOsvcChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateOsvcChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateOsvcChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateOsvcChannelResult) String() string
func (m CreateOsvcChannelResult) ValidateEnumValue() (bool, error)
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
CreateServiceCloudChannelDetails Properties required to create an Service Cloud channel.
type CreateServiceCloudChannelDetails struct {
// 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"`
// The domain name.
//
// If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the
// Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix
// is sitename and the domain name is exampledomain.com.
//
// If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces,
// then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.
DomainName *string `mandatory:"true" json:"domainName"`
// The host prefix.
//
// If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the
// Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix
// is sitename and the domain name is exampledomain.com.
//
// If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces,
// then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.
HostNamePrefix *string `mandatory:"true" json:"hostNamePrefix"`
// The user name for an Oracle B2C Service staff member who has the necessary profile permissions.
UserName *string `mandatory:"true" json:"userName"`
// The password for the Oracle B2C Service staff member who has the necessary profile permissions.
Password *string `mandatory:"true" json:"password"`
// 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 type of Service Cloud client.
ClientType ServiceCloudClientTypeEnum `mandatory:"true" json:"clientType"`
}
func (m CreateServiceCloudChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateServiceCloudChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateServiceCloudChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateServiceCloudChannelDetails) GetName() *string
GetName returns Name
func (m CreateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateServiceCloudChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateServiceCloudChannelDetails) String() string
func (m CreateServiceCloudChannelDetails) ValidateEnumValue() (bool, error)
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
CreateServiceCloudChannelResult The configuration for a Service Cloud agent channel.
type CreateServiceCloudChannelResult 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 domain name.
//
// If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the
// Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix
// is sitename and the domain name is exampledomain.com.
//
// If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces,
// then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.
DomainName *string `mandatory:"true" json:"domainName"`
// The host prefix.
//
// If you have access to Oracle B2C Service, you can derive this value from the URL that you use to launch the
// Agent Browser User Interface. For example, if the URL is sitename.exampledomain.com, then the host name prefix
// is sitename and the domain name is exampledomain.com.
//
// If the channel is connecting to Oracle B2C Service version 19A or later, and you have multiple interfaces,
// then you must include the interface ID in the host (site) name . For example, for the interface that has an ID of 2, you would use something like sitename-2.exampledomain.com.
HostNamePrefix *string `mandatory:"true" json:"hostNamePrefix"`
// The user name for an Oracle B2C Service staff member who has the necessary profile permissions.
UserName *string `mandatory:"true" json:"userName"`
// 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 category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of Service Cloud client.
ClientType ServiceCloudClientTypeEnum `mandatory:"true" json:"clientType"`
}
func (m CreateServiceCloudChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateServiceCloudChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateServiceCloudChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateServiceCloudChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateServiceCloudChannelResult) GetId() *string
GetId returns Id
func (m CreateServiceCloudChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateServiceCloudChannelResult) GetName() *string
GetName returns Name
func (m CreateServiceCloudChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateServiceCloudChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateServiceCloudChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateServiceCloudChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateServiceCloudChannelResult) String() string
func (m CreateServiceCloudChannelResult) ValidateEnumValue() (bool, error)
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
CreateSkillDetails Properties that are required to create a Skill.
type CreateSkillDetails interface {
// The resource's category. This is used to group resource's together.
GetCategory() *string
// A short description of the resource.
GetDescription() *string
// The ODA Platform Version for this resource.
GetPlatformVersion() *string
// The multilingual mode for the resource.
GetMultilingualMode() BotMultilingualModeEnum
// The primary language for the resource.
GetPrimaryLanguageTag() *string
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
GetFreeformTags() map[string]string
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
GetDefinedTags() map[string]map[string]interface{}
}
CreateSkillParameterDetails Properties that are required to create a Skill Parameter.
type CreateSkillParameterDetails struct {
// The Parameter name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// The display name for the Parameter.
DisplayName *string `mandatory:"true" json:"displayName"`
// The value type.
Type ParameterTypeEnum `mandatory:"true" json:"type"`
// The current value. The value will be interpreted based on the `type`.
Value *string `mandatory:"true" json:"value"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
}
func (m CreateSkillParameterDetails) String() string
func (m CreateSkillParameterDetails) ValidateEnumValue() (bool, error)
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
CreateSkillParameterRequest wrapper for the CreateSkillParameter operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateSkillParameter.go.html to see an example of how to use CreateSkillParameterRequest.
type CreateSkillParameterRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Skill identifier.
SkillId *string `mandatory:"true" contributesTo:"path" name:"skillId"`
// Property values for creating the new Skill Parameter.
CreateSkillParameterDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSkillParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSkillParameterRequest) String() string
func (request CreateSkillParameterRequest) ValidateEnumValue() (bool, error)
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
CreateSkillParameterResponse wrapper for the CreateSkillParameter operation
type CreateSkillParameterResponse struct {
// The underlying http response
RawResponse *http.Response
// The SkillParameter instance
SkillParameter `presentIn:"body"`
// Fully qualified URL for the newly created resource.
Location *string `presentIn:"header" name:"location"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateSkillParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSkillParameterResponse) String() string
CreateSkillRequest wrapper for the CreateSkill operation
# See also
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.54.0/oda/CreateSkill.go.html to see an example of how to use CreateSkillRequest.
type CreateSkillRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Property values for creating the Skill.
CreateSkillDetails `contributesTo:"body"`
// The client request ID for tracing. This value is included in the opc-request-id response header.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so that you can retry the request if there's
// a timeout or server error without the risk of executing that same action again.
// Retry tokens expire after 24 hours, but they can become invalid before then if there are
// conflicting operations. For example, if an instance was deleted and purged from the system,
// then the service might reject a retry of the original creation request.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSkillRequest) String() string