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 GetEntityAttributeTypeEnumStringValues() []string
GetEntityAttributeTypeEnumStringValues Enumerates the set of values in String for EntityAttributeTypeEnum
func GetEntityTypeEnumStringValues() []string
GetEntityTypeEnumStringValues Enumerates the set of values in String for EntityTypeEnum
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 GetTemporalPreferenceEnumStringValues() []string
GetTemporalPreferenceEnumStringValues Enumerates the set of values in String for TemporalPreferenceEnum
func GetTrainSkillParameterTypeEnumStringValues() []string
GetTrainSkillParameterTypeEnumStringValues Enumerates the set of values in String for TrainSkillParameterTypeEnum
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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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
BulkCreateSkillEntitiesDetails A collection of skill entities to create.
type BulkCreateSkillEntitiesDetails struct {
// List of the skill entity objects to create.
Items []CreateSkillEntityDetails `mandatory:"true" json:"items"`
}
func (m BulkCreateSkillEntitiesDetails) String() string
func (m *BulkCreateSkillEntitiesDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m BulkCreateSkillEntitiesDetails) 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
BulkCreateSkillEntitiesRequest wrapper for the BulkCreateSkillEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/BulkCreateSkillEntities.go.html to see an example of how to use BulkCreateSkillEntitiesRequest.
type BulkCreateSkillEntitiesRequest 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 bulk creating a list of skill entities.
BulkCreateSkillEntitiesDetails `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 BulkCreateSkillEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request BulkCreateSkillEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request BulkCreateSkillEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request BulkCreateSkillEntitiesRequest) String() string
func (request BulkCreateSkillEntitiesRequest) 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
BulkCreateSkillEntitiesResponse wrapper for the BulkCreateSkillEntities operation
type BulkCreateSkillEntitiesResponse 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 BulkCreateSkillEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response BulkCreateSkillEntitiesResponse) String() string
CascadingDeleteSkillCustomEntitiesRequest wrapper for the CascadingDeleteSkillCustomEntities operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CascadingDeleteSkillCustomEntities.go.html to see an example of how to use CascadingDeleteSkillCustomEntitiesRequest.
type CascadingDeleteSkillCustomEntitiesRequest 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"`
// 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 CascadingDeleteSkillCustomEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CascadingDeleteSkillCustomEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CascadingDeleteSkillCustomEntitiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CascadingDeleteSkillCustomEntitiesRequest) String() string
func (request CascadingDeleteSkillCustomEntitiesRequest) 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
CascadingDeleteSkillCustomEntitiesResponse wrapper for the CascadingDeleteSkillCustomEntities operation
type CascadingDeleteSkillCustomEntitiesResponse 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 CascadingDeleteSkillCustomEntitiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CascadingDeleteSkillCustomEntitiesResponse) String() string
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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.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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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.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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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) GetDialogVersion() *string
GetDialogVersion returns DialogVersion
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
CompositeEntity Metadata for a composite entity.
type CompositeEntity struct {
// Unique immutable identifier that was assigned when the resource was created.
Id *string `mandatory:"true" json:"id"`
// The entity name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// List of entity attributes.
Attributes []EntityAttribute `mandatory:"true" json:"attributes"`
// List of entity actions.
Actions []EntityAction `mandatory:"false" json:"actions"`
NaturalLanguageMapping *EntityNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
}
func (m CompositeEntity) GetId() *string
GetId returns Id
func (m CompositeEntity) GetName() *string
GetName returns Name
func (m CompositeEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CompositeEntity) String() string
func (m CompositeEntity) 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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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) GetDialogVersion() *string
GetDialogVersion returns DialogVersion
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"
CreateOdaInstanceAttachmentDetailsAttachmentTypeMax CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum = "MAX"
)
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The OCID (https://docs.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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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.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.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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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.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
CreateSkillCompositeEntityDetails Properties that are required to create a skill composite entity.
type CreateSkillCompositeEntityDetails struct {
// The entity name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// List of entity attributes.
Attributes []EntityAttribute `mandatory:"true" json:"attributes"`
// List of entity actions.
Actions []EntityAction `mandatory:"false" json:"actions"`
NaturalLanguageMapping *EntityNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
}
func (m CreateSkillCompositeEntityDetails) GetName() *string
GetName returns Name
func (m CreateSkillCompositeEntityDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSkillCompositeEntityDetails) String() string
func (m CreateSkillCompositeEntityDetails) 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 resource's dialog version.
GetDialogVersion() *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{}
}
CreateSkillEntityDetails Properties that are required to create a skill entity.
type CreateSkillEntityDetails interface {
// The entity name. This must be unique within the parent resource.
GetName() *string
}
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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/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
func (request CreateSkillRequest) 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
CreateSkillResponse wrapper for the CreateSkill operation
type CreateSkillResponse 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 CreateSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSkillResponse) String() string
CreateSkillValueListEntityDetails Properties that are required to create a value list entity.
type CreateSkillValueListEntityDetails struct {
// The entity name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// List of values for a value list entity.
Values []StaticEntityValue `mandatory:"true" json:"values"`
}
func (m CreateSkillValueListEntityDetails) GetName() *string
GetName returns Name
func (m CreateSkillValueListEntityDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSkillValueListEntityDetails) String() string
func (m CreateSkillValueListEntityDetails) 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
CreateSkillVersionDetails Properties that are required to create a new version of an existing Skill.
type CreateSkillVersionDetails struct {
// The unique identifier of the Skill 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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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 CreateSkillVersionDetails) GetCategory() *string
GetCategory returns Category
func (m CreateSkillVersionDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSkillVersionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateSkillVersionDetails) GetDialogVersion() *string
GetDialogVersion returns DialogVersion
func (m CreateSkillVersionDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSkillVersionDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m CreateSkillVersionDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m CreateSkillVersionDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m CreateSkillVersionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSkillVersionDetails) String() string
func (m CreateSkillVersionDetails) 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
CreateSlackChannelDetails Properties required to create a Slack channel.
type CreateSlackChannelDetails 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 Slack Client Id for the Slack app.
ClientId *string `mandatory:"true" json:"clientId"`
// The Signing Secret for the Slack App.
SigningSecret *string `mandatory:"true" json:"signingSecret"`
// The Client Secret for the Slack App.
ClientSecret *string `mandatory:"true" json:"clientSecret"`
// 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 redirect to when authentication is successful.
AuthSuccessUrl *string `mandatory:"false" json:"authSuccessUrl"`
// The URL to redirect to when authentication is unsuccessful.
AuthErrorUrl *string `mandatory:"false" json:"authErrorUrl"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m CreateSlackChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSlackChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateSlackChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSlackChannelDetails) GetName() *string
GetName returns Name
func (m CreateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateSlackChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSlackChannelDetails) String() string
func (m CreateSlackChannelDetails) 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
CreateSlackChannelResult The configuration for a Slack channel.
type CreateSlackChannelResult 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 Slack Client Id for the Slack app.
ClientId *string `mandatory:"true" json:"clientId"`
// 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 redirect to when authentication is successful.
AuthSuccessUrl *string `mandatory:"false" json:"authSuccessUrl"`
// The URL to redirect to when authentication is unsuccessful.
AuthErrorUrl *string `mandatory:"false" json:"authErrorUrl"`
// 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 CreateSlackChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateSlackChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateSlackChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateSlackChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateSlackChannelResult) GetId() *string
GetId returns Id
func (m CreateSlackChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateSlackChannelResult) GetName() *string
GetName returns Name
func (m CreateSlackChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateSlackChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateSlackChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateSlackChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateSlackChannelResult) String() string
func (m CreateSlackChannelResult) 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
CreateTestChannelResult The configuration for the Test channel.
type CreateTestChannelResult 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 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:"false" json:"secretKey"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m CreateTestChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateTestChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateTestChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateTestChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateTestChannelResult) GetId() *string
GetId returns Id
func (m CreateTestChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateTestChannelResult) GetName() *string
GetName returns Name
func (m CreateTestChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateTestChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateTestChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateTestChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateTestChannelResult) String() string
func (m CreateTestChannelResult) 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
CreateTranslatorDetails Properties that are required to create a Translator.
type CreateTranslatorDetails struct {
// The Translation Service to use for this Translator.
Type TranslationServiceEnum `mandatory:"true" json:"type"`
// The base URL for invoking the Translation Service.
BaseUrl *string `mandatory:"true" json:"baseUrl"`
// The authentication token to use when invoking the Translation Service
AuthToken *string `mandatory:"true" json:"authToken"`
// Properties used when invoking the translation service.
// Each property is a simple key-value pair.
Properties map[string]string `mandatory:"false" json:"properties"`
// 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 CreateTranslatorDetails) String() string
func (m CreateTranslatorDetails) 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
CreateTranslatorRequest wrapper for the CreateTranslator operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateTranslator.go.html to see an example of how to use CreateTranslatorRequest.
type CreateTranslatorRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Property values to create the new Translator.
CreateTranslatorDetails `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 CreateTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateTranslatorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateTranslatorRequest) String() string
func (request CreateTranslatorRequest) 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
CreateTranslatorResponse wrapper for the CreateTranslator operation
type CreateTranslatorResponse struct {
// The underlying http response
RawResponse *http.Response
// The Translator instance
Translator `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 CreateTranslatorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateTranslatorResponse) String() string
CreateTwilioChannelDetails Properties required to create a Twilio channel.
type CreateTwilioChannelDetails 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 Account SID for the Twilio number.
AccountSID *string `mandatory:"true" json:"accountSID"`
// The Twilio phone number.
PhoneNumber *string `mandatory:"true" json:"phoneNumber"`
// The Auth Token for the Twilio number.
AuthToken *string `mandatory:"true" json:"authToken"`
// Whether MMS is enabled for this channel or not.
IsMmsEnabled *bool `mandatory:"true" json:"isMmsEnabled"`
// 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 original connectors URL (used for backward compatibility).
OriginalConnectorsUrl *string `mandatory:"false" json:"originalConnectorsUrl"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m CreateTwilioChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateTwilioChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateTwilioChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateTwilioChannelDetails) GetName() *string
GetName returns Name
func (m CreateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateTwilioChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateTwilioChannelDetails) String() string
func (m CreateTwilioChannelDetails) 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
CreateTwilioChannelResult The configuration for a Twilio channel.
type CreateTwilioChannelResult 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 Account SID for the Twilio number.
AccountSID *string `mandatory:"true" json:"accountSID"`
// The Twilio phone number.
PhoneNumber *string `mandatory:"true" json:"phoneNumber"`
// Whether MMS is enabled for this channel or not.
IsMmsEnabled *bool `mandatory:"true" json:"isMmsEnabled"`
// 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 original connectors URL (used for backward compatibility).
OriginalConnectorsUrl *string `mandatory:"false" json:"originalConnectorsUrl"`
// 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 CreateTwilioChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateTwilioChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateTwilioChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateTwilioChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateTwilioChannelResult) GetId() *string
GetId returns Id
func (m CreateTwilioChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateTwilioChannelResult) GetName() *string
GetName returns Name
func (m CreateTwilioChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateTwilioChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateTwilioChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateTwilioChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateTwilioChannelResult) String() string
func (m CreateTwilioChannelResult) 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
CreateWebChannelDetails Properties required to create a Web channel.
type CreateWebChannelDetails 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"`
// A comma-delimited whitelist of allowed domains.
//
// The channel will only communicate with the sites from the domains that you add to this list.
// For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access
// to the channel from any domain.
//
// Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.
AllowedDomains *string `mandatory:"false" json:"allowedDomains"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m CreateWebChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateWebChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateWebChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateWebChannelDetails) GetName() *string
GetName returns Name
func (m CreateWebChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateWebChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateWebChannelDetails) String() string
func (m CreateWebChannelDetails) 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
CreateWebChannelResult The configuration for a Web channel.
type CreateWebChannelResult 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"`
// A comma-delimited whitelist of allowed domains.
//
// The channel will only communicate with the sites from the domains that you add to this list.
// For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access
// to the channel from any domain.
//
// Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.
AllowedDomains *string `mandatory:"false" json:"allowedDomains"`
// 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 CreateWebChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateWebChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateWebChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateWebChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateWebChannelResult) GetId() *string
GetId returns Id
func (m CreateWebChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateWebChannelResult) GetName() *string
GetName returns Name
func (m CreateWebChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateWebChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateWebChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateWebChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateWebChannelResult) String() string
func (m CreateWebChannelResult) 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
CreateWebhookChannelDetails Properties required to create a Webhook channel.
type CreateWebhookChannelDetails 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 URL to send responses to.
OutboundUrl *string `mandatory:"true" json:"outboundUrl"`
// 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 version for payloads.
PayloadVersion WebhookPayloadVersionEnum `mandatory:"true" json:"payloadVersion"`
}
func (m CreateWebhookChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateWebhookChannelDetails) GetDescription() *string
GetDescription returns Description
func (m CreateWebhookChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateWebhookChannelDetails) GetName() *string
GetName returns Name
func (m CreateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateWebhookChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateWebhookChannelDetails) String() string
func (m CreateWebhookChannelDetails) 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
CreateWebhookChannelResult The configuration for a Webhook channel.
type CreateWebhookChannelResult 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 to send 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 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 version for payloads.
PayloadVersion WebhookPayloadVersionEnum `mandatory:"true" json:"payloadVersion"`
}
func (m CreateWebhookChannelResult) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m CreateWebhookChannelResult) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m CreateWebhookChannelResult) GetDescription() *string
GetDescription returns Description
func (m CreateWebhookChannelResult) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m CreateWebhookChannelResult) GetId() *string
GetId returns Id
func (m CreateWebhookChannelResult) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m CreateWebhookChannelResult) GetName() *string
GetName returns Name
func (m CreateWebhookChannelResult) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m CreateWebhookChannelResult) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m CreateWebhookChannelResult) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m CreateWebhookChannelResult) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateWebhookChannelResult) String() string
func (m CreateWebhookChannelResult) 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
DefaultParameterValues Default values for parameters required to import a package
type DefaultParameterValues struct {
// A list of resource type specific default parameter values, one set for each resource type listed in the package definition.
ResourceTypesDefaultParameterValues []ResourceTypeDefaultParameterValues `mandatory:"false" json:"resourceTypesDefaultParameterValues"`
}
func (m DefaultParameterValues) String() string
func (m DefaultParameterValues) 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
DeleteAuthenticationProviderRequest wrapper for the DeleteAuthenticationProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteAuthenticationProvider.go.html to see an example of how to use DeleteAuthenticationProviderRequest.
type DeleteAuthenticationProviderRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Authentication Provider identifier.
AuthenticationProviderId *string `mandatory:"true" contributesTo:"path" name:"authenticationProviderId"`
// 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"`
// 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 DeleteAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteAuthenticationProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteAuthenticationProviderRequest) String() string
func (request DeleteAuthenticationProviderRequest) 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
DeleteAuthenticationProviderResponse wrapper for the DeleteAuthenticationProvider operation
type DeleteAuthenticationProviderResponse 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 DeleteAuthenticationProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteAuthenticationProviderResponse) String() string
DeleteChannelRequest wrapper for the DeleteChannel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteChannel.go.html to see an example of how to use DeleteChannelRequest.
type DeleteChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// 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"`
// 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 DeleteChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteChannelRequest) String() string
func (request DeleteChannelRequest) 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
DeleteChannelResponse wrapper for the DeleteChannel operation
type DeleteChannelResponse 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 DeleteChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteChannelResponse) String() string
DeleteDigitalAssistantRequest wrapper for the DeleteDigitalAssistant operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteDigitalAssistant.go.html to see an example of how to use DeleteDigitalAssistantRequest.
type DeleteDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// 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"`
// 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 DeleteDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDigitalAssistantRequest) String() string
func (request DeleteDigitalAssistantRequest) 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
DeleteDigitalAssistantResponse wrapper for the DeleteDigitalAssistant operation
type DeleteDigitalAssistantResponse 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 DeleteDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDigitalAssistantResponse) String() string
DeleteImportedPackageRequest wrapper for the DeleteImportedPackage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteImportedPackage.go.html to see an example of how to use DeleteImportedPackageRequest.
type DeleteImportedPackageRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant package identifier.
PackageId *string `mandatory:"true" contributesTo:"path" name:"packageId"`
// 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"`
// 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"`
// 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 DeleteImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteImportedPackageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteImportedPackageRequest) String() string
func (request DeleteImportedPackageRequest) 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
DeleteImportedPackageResponse wrapper for the DeleteImportedPackage operation
type DeleteImportedPackageResponse 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 DeleteImportedPackageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteImportedPackageResponse) String() string
DeleteOdaInstanceAttachmentRequest wrapper for the DeleteOdaInstanceAttachment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstanceAttachment.go.html to see an example of how to use DeleteOdaInstanceAttachmentRequest.
type DeleteOdaInstanceAttachmentRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant instance attachment identifier.
AttachmentId *string `mandatory:"true" contributesTo:"path" name:"attachmentId"`
// 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"`
// 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 DeleteOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaInstanceAttachmentRequest) String() string
func (request DeleteOdaInstanceAttachmentRequest) 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
DeleteOdaInstanceAttachmentResponse wrapper for the DeleteOdaInstanceAttachment operation
type DeleteOdaInstanceAttachmentResponse 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 DeleteOdaInstanceAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaInstanceAttachmentResponse) String() string
DeleteOdaInstanceRequest wrapper for the DeleteOdaInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstance.go.html to see an example of how to use DeleteOdaInstanceRequest.
type DeleteOdaInstanceRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Retain the ODA instance being deleted for the given number of days before hard-delete/purge.
RetentionTime *int `mandatory:"false" contributesTo:"query" name:"retentionTime"`
// 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"`
// 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 DeleteOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaInstanceRequest) String() string
func (request DeleteOdaInstanceRequest) 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
DeleteOdaInstanceResponse wrapper for the DeleteOdaInstance operation
type DeleteOdaInstanceResponse 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 DeleteOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaInstanceResponse) String() string
DeleteOdaPrivateEndpointAttachmentRequest wrapper for the DeleteOdaPrivateEndpointAttachment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointAttachment.go.html to see an example of how to use DeleteOdaPrivateEndpointAttachmentRequest.
type DeleteOdaPrivateEndpointAttachmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of ODA Private Endpoint Attachment.
OdaPrivateEndpointAttachmentId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointAttachmentId"`
// 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"`
// 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 DeleteOdaPrivateEndpointAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaPrivateEndpointAttachmentRequest) String() string
func (request DeleteOdaPrivateEndpointAttachmentRequest) 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
DeleteOdaPrivateEndpointAttachmentResponse wrapper for the DeleteOdaPrivateEndpointAttachment operation
type DeleteOdaPrivateEndpointAttachmentResponse 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 DeleteOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaPrivateEndpointAttachmentResponse) String() string
DeleteOdaPrivateEndpointRequest wrapper for the DeleteOdaPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpoint.go.html to see an example of how to use DeleteOdaPrivateEndpointRequest.
type DeleteOdaPrivateEndpointRequest struct {
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// 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"`
// 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 DeleteOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaPrivateEndpointRequest) String() string
func (request DeleteOdaPrivateEndpointRequest) 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
DeleteOdaPrivateEndpointResponse wrapper for the DeleteOdaPrivateEndpoint operation
type DeleteOdaPrivateEndpointResponse 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 DeleteOdaPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaPrivateEndpointResponse) String() string
DeleteOdaPrivateEndpointScanProxyRequest wrapper for the DeleteOdaPrivateEndpointScanProxy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointScanProxy.go.html to see an example of how to use DeleteOdaPrivateEndpointScanProxyRequest.
type DeleteOdaPrivateEndpointScanProxyRequest struct {
// Unique ODA Private Endpoint Scan Proxy identifier.
OdaPrivateEndpointScanProxyId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointScanProxyId"`
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// 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"`
// 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 DeleteOdaPrivateEndpointScanProxyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaPrivateEndpointScanProxyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaPrivateEndpointScanProxyRequest) String() string
func (request DeleteOdaPrivateEndpointScanProxyRequest) 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
DeleteOdaPrivateEndpointScanProxyResponse wrapper for the DeleteOdaPrivateEndpointScanProxy operation
type DeleteOdaPrivateEndpointScanProxyResponse 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 DeleteOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaPrivateEndpointScanProxyResponse) String() string
DeleteSkillParameterRequest wrapper for the DeleteSkillParameter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkillParameter.go.html to see an example of how to use DeleteSkillParameterRequest.
type DeleteSkillParameterRequest 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"`
// The name of a Skill Parameter.
ParameterName *string `mandatory:"true" contributesTo:"path" name:"parameterName"`
// 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"`
// 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 DeleteSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSkillParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSkillParameterRequest) String() string
func (request DeleteSkillParameterRequest) 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
DeleteSkillParameterResponse wrapper for the DeleteSkillParameter operation
type DeleteSkillParameterResponse 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 DeleteSkillParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSkillParameterResponse) String() string
DeleteSkillRequest wrapper for the DeleteSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkill.go.html to see an example of how to use DeleteSkillRequest.
type DeleteSkillRequest 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"`
// 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"`
// 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 DeleteSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSkillRequest) String() string
func (request DeleteSkillRequest) 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
DeleteSkillResponse wrapper for the DeleteSkill operation
type DeleteSkillResponse 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 DeleteSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSkillResponse) String() string
DeleteTranslatorRequest wrapper for the DeleteTranslator operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteTranslator.go.html to see an example of how to use DeleteTranslatorRequest.
type DeleteTranslatorRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Translator identifier.
TranslatorId *string `mandatory:"true" contributesTo:"path" name:"translatorId"`
// 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"`
// 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 DeleteTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteTranslatorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteTranslatorRequest) String() string
func (request DeleteTranslatorRequest) 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
DeleteTranslatorResponse wrapper for the DeleteTranslator operation
type DeleteTranslatorResponse 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 DeleteTranslatorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteTranslatorResponse) String() string
DigitalAssistant Digital Assistant metadata.
type DigitalAssistant 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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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 DigitalAssistant) String() string
func (m DigitalAssistant) 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
DigitalAssistantCollection A collection of Digital Assistant summaries.
type DigitalAssistantCollection struct {
// The Digital Assistant summaries.
Items []DigitalAssistantSummary `mandatory:"true" json:"items"`
}
func (m DigitalAssistantCollection) String() string
func (m DigitalAssistantCollection) 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
DigitalAssistantParameter Metadata for a Digital Assistant Parameter.
type DigitalAssistantParameter 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"`
// The Parameter's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
}
func (m DigitalAssistantParameter) String() string
func (m DigitalAssistantParameter) 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
DigitalAssistantParameterCollection A collection of Digital Assistant Parameter summaries.
type DigitalAssistantParameterCollection struct {
// The Digital Assistant Parameter summaries.
Items []DigitalAssistantParameterSummary `mandatory:"true" json:"items"`
}
func (m DigitalAssistantParameterCollection) String() string
func (m DigitalAssistantParameterCollection) 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
DigitalAssistantParameterSummary Metadata for a Digital Assistant Parameter property.
type DigitalAssistantParameterSummary 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 Parameter's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
// The current value. The value will be interpreted based on the `type`.
Value *string `mandatory:"false" json:"value"`
}
func (m DigitalAssistantParameterSummary) String() string
func (m DigitalAssistantParameterSummary) 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
DigitalAssistantParameterValue Properties for configuring a Parameter in a Digital Assistant instance.
type DigitalAssistantParameterValue struct {
// The Parameter name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// 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"`
}
func (m DigitalAssistantParameterValue) String() string
func (m DigitalAssistantParameterValue) 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
DigitalAssistantSummary Summary of a Digital Assistant.
type DigitalAssistantSummary 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 namespace.
Namespace *string `mandatory:"true" json:"namespace"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"true" json:"category"`
// 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"`
// 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 DigitalAssistantSummary) String() string
func (m DigitalAssistantSummary) 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
Entity Metadata for an entity.
type Entity interface {
// Unique immutable identifier that was assigned when the resource was created.
GetId() *string
// The entity name. This must be unique within the parent resource.
GetName() *string
}
EntityAction Action of an entity
type EntityAction struct {
// Name of an entity action
Name *string `mandatory:"true" json:"name"`
// List of entity action arguments
Arguments []EntityActionArgument `mandatory:"true" json:"arguments"`
// Type of CRUD operation for entity action
CrudType *string `mandatory:"false" json:"crudType"`
NaturalLanguageMapping *EntityActionNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
}
func (m EntityAction) String() string
func (m EntityAction) 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
EntityActionArgument Argument of an entity action
type EntityActionArgument struct {
// Name of an entity action argument
Name *string `mandatory:"true" json:"name"`
// Type of an entity action argument
Type EntityAttributeTypeEnum `mandatory:"true" json:"type"`
// Metatype of an entity action argument
MetaType *string `mandatory:"false" json:"metaType"`
NaturalLanguageMapping *EntityActionArgumentNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
// Is the entity action argument multi-value
IsMultiValue *bool `mandatory:"false" json:"isMultiValue"`
// Name of referenced entity.
EntityName *string `mandatory:"false" json:"entityName"`
}
func (m EntityActionArgument) String() string
func (m EntityActionArgument) 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
EntityActionArgumentNaturalLanguageMapping Natural language mapping of an entity action argument.
type EntityActionArgumentNaturalLanguageMapping struct {
// List of natural language mapped values.
Languages []LanguageMapping `mandatory:"true" json:"languages"`
}
func (m EntityActionArgumentNaturalLanguageMapping) String() string
func (m EntityActionArgumentNaturalLanguageMapping) 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
EntityActionNaturalLanguageMapping Natural language mapping of an entity action.
type EntityActionNaturalLanguageMapping struct {
// List of natural language mapped values.
Languages []LanguageMapping `mandatory:"true" json:"languages"`
}
func (m EntityActionNaturalLanguageMapping) String() string
func (m EntityActionNaturalLanguageMapping) 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
EntityAttribute Attribute of an entity
type EntityAttribute struct {
// The name of an entity attribute
Name *string `mandatory:"true" json:"name"`
// The type of an entity attribute
Type EntityAttributeTypeEnum `mandatory:"true" json:"type"`
NaturalLanguageMapping *EntityAttributeNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
// Is the entity attribute multi-value
IsMultiValue *bool `mandatory:"false" json:"isMultiValue"`
// Is the entity attribute a fuzzy match
IsFuzzyMatch *bool `mandatory:"false" json:"isFuzzyMatch"`
// Are comparisons inverted in the entity attribute
IsInvertComparisons *bool `mandatory:"false" json:"isInvertComparisons"`
// Temporal preference of an attribute
TemporalPreference TemporalPreferenceEnum `mandatory:"false" json:"temporalPreference,omitempty"`
// Name of referenced entity.
EntityName *string `mandatory:"false" json:"entityName"`
}
func (m EntityAttribute) String() string
func (m EntityAttribute) 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
EntityAttributeNaturalLanguageMapping Natural language mapping of an entity attribute
type EntityAttributeNaturalLanguageMapping struct {
// List of natural language mapped values.
Languages []LanguageMapping `mandatory:"true" json:"languages"`
}
func (m EntityAttributeNaturalLanguageMapping) String() string
func (m EntityAttributeNaturalLanguageMapping) 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
EntityAttributeTypeEnum Enum with underlying type: string
type EntityAttributeTypeEnum string
Set of constants representing the allowable values for EntityAttributeTypeEnum
const (
EntityAttributeTypeText EntityAttributeTypeEnum = "TEXT"
EntityAttributeTypeNumber EntityAttributeTypeEnum = "NUMBER"
EntityAttributeTypeDateTime EntityAttributeTypeEnum = "DATE_TIME"
EntityAttributeTypeDate EntityAttributeTypeEnum = "DATE"
EntityAttributeTypeEntity EntityAttributeTypeEnum = "ENTITY"
EntityAttributeTypeCompositeEntity EntityAttributeTypeEnum = "COMPOSITE_ENTITY"
EntityAttributeTypeAttributeReference EntityAttributeTypeEnum = "ATTRIBUTE_REFERENCE"
EntityAttributeTypeBoolean EntityAttributeTypeEnum = "BOOLEAN"
)
func GetEntityAttributeTypeEnumValues() []EntityAttributeTypeEnum
GetEntityAttributeTypeEnumValues Enumerates the set of values for EntityAttributeTypeEnum
func GetMappingEntityAttributeTypeEnum(val string) (EntityAttributeTypeEnum, bool)
GetMappingEntityAttributeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
EntityNaturalLanguageMapping Natural language mapping of an entity attribute.
type EntityNaturalLanguageMapping struct {
// List of natural language mapped values.
Languages []LanguageMapping `mandatory:"true" json:"languages"`
}
func (m EntityNaturalLanguageMapping) String() string
func (m EntityNaturalLanguageMapping) 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
EntityTypeEnum Enum with underlying type: string
type EntityTypeEnum string
Set of constants representing the allowable values for EntityTypeEnum
const (
EntityTypeComposite EntityTypeEnum = "COMPOSITE"
EntityTypeEnumValues EntityTypeEnum = "ENUM_VALUES"
)
func GetEntityTypeEnumValues() []EntityTypeEnum
GetEntityTypeEnumValues Enumerates the set of values for EntityTypeEnum
func GetMappingEntityTypeEnum(val string) (EntityTypeEnum, bool)
GetMappingEntityTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ErrorBody Error Information.
type ErrorBody struct {
// A short error code that defines the error, which is useful for programmatic parsing.
Code *string `mandatory:"true" json:"code"`
// A human-readable error string.
Message *string `mandatory:"true" json:"message"`
}
func (m ErrorBody) String() string
func (m ErrorBody) 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
ExportBotDetails Properties to export a Bot to Object Storage.
type ExportBotDetails struct {
Target *StorageLocation `mandatory:"true" json:"target"`
}
func (m ExportBotDetails) String() string
func (m ExportBotDetails) 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
ExportDigitalAssistantDetails Properties that specify where in Object Storage to export the Digital Assistant to.
type ExportDigitalAssistantDetails struct {
Target *StorageLocation `mandatory:"true" json:"target"`
}
func (m ExportDigitalAssistantDetails) String() string
func (m ExportDigitalAssistantDetails) 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
ExportDigitalAssistantRequest wrapper for the ExportDigitalAssistant operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportDigitalAssistant.go.html to see an example of how to use ExportDigitalAssistantRequest.
type ExportDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// Where in Object Storage to export the Digital Assistant to.
ExportDigitalAssistantDetails `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 ExportDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportDigitalAssistantRequest) String() string
func (request ExportDigitalAssistantRequest) 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
ExportDigitalAssistantResponse wrapper for the ExportDigitalAssistant operation
type ExportDigitalAssistantResponse 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"`
// 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 ExportDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportDigitalAssistantResponse) String() string
ExportSkillDetails Properties that specify where in Object Storage to export the Skill to.
type ExportSkillDetails struct {
Target *StorageLocation `mandatory:"true" json:"target"`
}
func (m ExportSkillDetails) String() string
func (m ExportSkillDetails) 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
ExportSkillRequest wrapper for the ExportSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportSkill.go.html to see an example of how to use ExportSkillRequest.
type ExportSkillRequest 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"`
// Where in Object Storage to export the Skill to.
ExportSkillDetails `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 ExportSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ExportSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ExportSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ExportSkillRequest) String() string
func (request ExportSkillRequest) 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
ExportSkillResponse wrapper for the ExportSkill operation
type ExportSkillResponse 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"`
// 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 ExportSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ExportSkillResponse) String() string
ExtendDigitalAssistantDetails Properties that are required to create a new Digital Assistant by extending an existing Digital Assistant.
type ExtendDigitalAssistantDetails struct {
// The unique identifier of the Digital Assistant to extend.
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 ExtendDigitalAssistantDetails) GetCategory() *string
GetCategory returns Category
func (m ExtendDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ExtendDigitalAssistantDetails) GetDescription() *string
GetDescription returns Description
func (m ExtendDigitalAssistantDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ExtendDigitalAssistantDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m ExtendDigitalAssistantDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m ExtendDigitalAssistantDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m ExtendDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtendDigitalAssistantDetails) String() string
func (m ExtendDigitalAssistantDetails) 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
ExtendSkillDetails Properties that are required to create a new Skill by extending an existing Skill.
type ExtendSkillDetails struct {
// The unique identifier of the Skill to extend.
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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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 ExtendSkillDetails) GetCategory() *string
GetCategory returns Category
func (m ExtendSkillDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ExtendSkillDetails) GetDescription() *string
GetDescription returns Description
func (m ExtendSkillDetails) GetDialogVersion() *string
GetDialogVersion returns DialogVersion
func (m ExtendSkillDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ExtendSkillDetails) GetMultilingualMode() BotMultilingualModeEnum
GetMultilingualMode returns MultilingualMode
func (m ExtendSkillDetails) GetPlatformVersion() *string
GetPlatformVersion returns PlatformVersion
func (m ExtendSkillDetails) GetPrimaryLanguageTag() *string
GetPrimaryLanguageTag returns PrimaryLanguageTag
func (m ExtendSkillDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ExtendSkillDetails) String() string
func (m ExtendSkillDetails) 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
FacebookChannel The configuration for a Facebook channel.
type FacebookChannel 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 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 FacebookChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m FacebookChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m FacebookChannel) GetDescription() *string
GetDescription returns Description
func (m FacebookChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m FacebookChannel) GetId() *string
GetId returns Id
func (m FacebookChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m FacebookChannel) GetName() *string
GetName returns Name
func (m FacebookChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m FacebookChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m FacebookChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m FacebookChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FacebookChannel) String() string
func (m FacebookChannel) 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
GetAuthenticationProviderRequest wrapper for the GetAuthenticationProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetAuthenticationProvider.go.html to see an example of how to use GetAuthenticationProviderRequest.
type GetAuthenticationProviderRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Authentication Provider identifier.
AuthenticationProviderId *string `mandatory:"true" contributesTo:"path" name:"authenticationProviderId"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetAuthenticationProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetAuthenticationProviderRequest) String() string
func (request GetAuthenticationProviderRequest) 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
GetAuthenticationProviderResponse wrapper for the GetAuthenticationProvider operation
type GetAuthenticationProviderResponse struct {
// The underlying http response
RawResponse *http.Response
// The AuthenticationProvider instance
AuthenticationProvider `presentIn:"body"`
// 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 GetAuthenticationProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetAuthenticationProviderResponse) String() string
GetChannelRequest wrapper for the GetChannel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetChannel.go.html to see an example of how to use GetChannelRequest.
type GetChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetChannelRequest) String() string
func (request GetChannelRequest) 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
GetChannelResponse wrapper for the GetChannel operation
type GetChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// 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 GetChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetChannelResponse) String() string
GetDigitalAssistantParameterRequest wrapper for the GetDigitalAssistantParameter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistantParameter.go.html to see an example of how to use GetDigitalAssistantParameterRequest.
type GetDigitalAssistantParameterRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.
ParameterName *string `mandatory:"true" contributesTo:"path" name:"parameterName"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetDigitalAssistantParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalAssistantParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalAssistantParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalAssistantParameterRequest) String() string
func (request GetDigitalAssistantParameterRequest) 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
GetDigitalAssistantParameterResponse wrapper for the GetDigitalAssistantParameter operation
type GetDigitalAssistantParameterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalAssistantParameter instance
DigitalAssistantParameter `presentIn:"body"`
// 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 GetDigitalAssistantParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalAssistantParameterResponse) String() string
GetDigitalAssistantRequest wrapper for the GetDigitalAssistant operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistant.go.html to see an example of how to use GetDigitalAssistantRequest.
type GetDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDigitalAssistantRequest) String() string
func (request GetDigitalAssistantRequest) 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
GetDigitalAssistantResponse wrapper for the GetDigitalAssistant operation
type GetDigitalAssistantResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalAssistant instance
DigitalAssistant `presentIn:"body"`
// 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 GetDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDigitalAssistantResponse) String() string
GetImportedPackageRequest wrapper for the GetImportedPackage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetImportedPackage.go.html to see an example of how to use GetImportedPackageRequest.
type GetImportedPackageRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant package identifier.
PackageId *string `mandatory:"true" contributesTo:"path" name:"packageId"`
// 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 GetImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetImportedPackageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetImportedPackageRequest) String() string
func (request GetImportedPackageRequest) 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
GetImportedPackageResponse wrapper for the GetImportedPackage operation
type GetImportedPackageResponse struct {
// The underlying http response
RawResponse *http.Response
// The ImportedPackage instance
ImportedPackage `presentIn:"body"`
// 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 GetImportedPackageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetImportedPackageResponse) String() string
GetOdaInstanceAttachmentRequest wrapper for the GetOdaInstanceAttachment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstanceAttachment.go.html to see an example of how to use GetOdaInstanceAttachmentRequest.
type GetOdaInstanceAttachmentRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant instance attachment identifier.
AttachmentId *string `mandatory:"true" contributesTo:"path" name:"attachmentId"`
// Whether to send attachment owner info during get/list call.
IncludeOwnerMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeOwnerMetadata"`
// 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 GetOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaInstanceAttachmentRequest) String() string
func (request GetOdaInstanceAttachmentRequest) 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
GetOdaInstanceAttachmentResponse wrapper for the GetOdaInstanceAttachment operation
type GetOdaInstanceAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaInstanceAttachment instance
OdaInstanceAttachment `presentIn:"body"`
// 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 GetOdaInstanceAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaInstanceAttachmentResponse) String() string
GetOdaInstanceRequest wrapper for the GetOdaInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstance.go.html to see an example of how to use GetOdaInstanceRequest.
type GetOdaInstanceRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// 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 GetOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaInstanceRequest) String() string
func (request GetOdaInstanceRequest) 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
GetOdaInstanceResponse wrapper for the GetOdaInstance operation
type GetOdaInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaInstance instance
OdaInstance `presentIn:"body"`
// 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 GetOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaInstanceResponse) String() string
GetOdaPrivateEndpointAttachmentRequest wrapper for the GetOdaPrivateEndpointAttachment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointAttachment.go.html to see an example of how to use GetOdaPrivateEndpointAttachmentRequest.
type GetOdaPrivateEndpointAttachmentRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of ODA Private Endpoint Attachment.
OdaPrivateEndpointAttachmentId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointAttachmentId"`
// 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 GetOdaPrivateEndpointAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaPrivateEndpointAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaPrivateEndpointAttachmentRequest) String() string
func (request GetOdaPrivateEndpointAttachmentRequest) 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
GetOdaPrivateEndpointAttachmentResponse wrapper for the GetOdaPrivateEndpointAttachment operation
type GetOdaPrivateEndpointAttachmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpointAttachment instance
OdaPrivateEndpointAttachment `presentIn:"body"`
// 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 GetOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaPrivateEndpointAttachmentResponse) String() string
GetOdaPrivateEndpointRequest wrapper for the GetOdaPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpoint.go.html to see an example of how to use GetOdaPrivateEndpointRequest.
type GetOdaPrivateEndpointRequest struct {
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.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"`
// 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 GetOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaPrivateEndpointRequest) String() string
func (request GetOdaPrivateEndpointRequest) 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
GetOdaPrivateEndpointResponse wrapper for the GetOdaPrivateEndpoint operation
type GetOdaPrivateEndpointResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpoint instance
OdaPrivateEndpoint `presentIn:"body"`
// 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 GetOdaPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaPrivateEndpointResponse) String() string
GetOdaPrivateEndpointScanProxyRequest wrapper for the GetOdaPrivateEndpointScanProxy operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointScanProxy.go.html to see an example of how to use GetOdaPrivateEndpointScanProxyRequest.
type GetOdaPrivateEndpointScanProxyRequest struct {
// Unique ODA Private Endpoint Scan Proxy identifier.
OdaPrivateEndpointScanProxyId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointScanProxyId"`
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.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"`
// 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 GetOdaPrivateEndpointScanProxyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaPrivateEndpointScanProxyRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaPrivateEndpointScanProxyRequest) String() string
func (request GetOdaPrivateEndpointScanProxyRequest) 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
GetOdaPrivateEndpointScanProxyResponse wrapper for the GetOdaPrivateEndpointScanProxy operation
type GetOdaPrivateEndpointScanProxyResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaPrivateEndpointScanProxy instance
OdaPrivateEndpointScanProxy `presentIn:"body"`
// 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 GetOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaPrivateEndpointScanProxyResponse) String() string
GetPackageRequest wrapper for the GetPackage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetPackage.go.html to see an example of how to use GetPackageRequest.
type GetPackageRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant package identifier.
PackageId *string `mandatory:"true" contributesTo:"path" name:"packageId"`
// 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 GetPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetPackageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetPackageRequest) String() string
func (request GetPackageRequest) 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
GetPackageResponse wrapper for the GetPackage operation
type GetPackageResponse struct {
// The underlying http response
RawResponse *http.Response
// The ModelPackage instance
ModelPackage `presentIn:"body"`
// 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 GetPackageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetPackageResponse) String() string
GetSkillParameterRequest wrapper for the GetSkillParameter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkillParameter.go.html to see an example of how to use GetSkillParameterRequest.
type GetSkillParameterRequest 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"`
// The name of a Skill Parameter.
ParameterName *string `mandatory:"true" contributesTo:"path" name:"parameterName"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSkillParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSkillParameterRequest) String() string
func (request GetSkillParameterRequest) 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
GetSkillParameterResponse wrapper for the GetSkillParameter operation
type GetSkillParameterResponse struct {
// The underlying http response
RawResponse *http.Response
// The SkillParameter instance
SkillParameter `presentIn:"body"`
// 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 GetSkillParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSkillParameterResponse) String() string
GetSkillRequest wrapper for the GetSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkill.go.html to see an example of how to use GetSkillRequest.
type GetSkillRequest 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"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSkillRequest) String() string
func (request GetSkillRequest) 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
GetSkillResponse wrapper for the GetSkill operation
type GetSkillResponse struct {
// The underlying http response
RawResponse *http.Response
// The Skill instance
Skill `presentIn:"body"`
// 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 GetSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSkillResponse) String() string
GetTranslatorRequest wrapper for the GetTranslator operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetTranslator.go.html to see an example of how to use GetTranslatorRequest.
type GetTranslatorRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Translator identifier.
TranslatorId *string `mandatory:"true" contributesTo:"path" name:"translatorId"`
// The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the
// requested resource, with a 200 status, only if it doesn't have an ETag matching the given ones.
// When the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).
IfNoneMatch *string `mandatory:"false" contributesTo:"header" name:"if-none-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"`
// 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 GetTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetTranslatorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetTranslatorRequest) String() string
func (request GetTranslatorRequest) 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
GetTranslatorResponse wrapper for the GetTranslator operation
type GetTranslatorResponse struct {
// The underlying http response
RawResponse *http.Response
// The Translator instance
Translator `presentIn:"body"`
// 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 GetTranslatorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetTranslatorResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The identifier of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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 GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) 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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// 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"`
// A non-negative integer representing the number of seconds the client should
// wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ImportBotDetails Properties to import a Bot resource from Object Storage.
type ImportBotDetails struct {
Source *StorageLocation `mandatory:"true" json:"source"`
}
func (m ImportBotDetails) String() string
func (m ImportBotDetails) 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
ImportBotRequest wrapper for the ImportBot operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ImportBot.go.html to see an example of how to use ImportBotRequest.
type ImportBotRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Properties for where in Object Storage to import the Bot archive from.
ImportBotDetails `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 ImportBotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportBotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportBotRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportBotRequest) String() string
func (request ImportBotRequest) 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
ImportBotResponse wrapper for the ImportBot operation
type ImportBotResponse 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 ImportBotResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportBotResponse) String() string
ImportContract The contract guiding the import experience for the consumer and behavior of the resource providers for all resource types in a package.
type ImportContract struct {
// A list of resource type specific import contracts, one for each resource type listed in the package definition.
ImportContract []ResourceTypeImportContract `mandatory:"false" json:"importContract"`
}
func (m ImportContract) String() string
func (m ImportContract) 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
ImportedPackage An imported/instantiated package within an instance.
type ImportedPackage struct {
// ID of the host instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// ID of the package.
CurrentPackageId *string `mandatory:"true" json:"currentPackageId"`
// Stable name of the package (the same across versions).
Name *string `mandatory:"true" json:"name"`
// Display name of the package (can change across versions).
DisplayName *string `mandatory:"true" json:"displayName"`
// version of the package.
Version *string `mandatory:"true" json:"version"`
// Status of the imported package.
Status ImportedPackageStatusEnum `mandatory:"true" json:"status"`
// When the imported package 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 imported package 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"`
// Short message explaining the status of this imported package.
StatusMessage *string `mandatory:"true" json:"statusMessage"`
// A list of parameter values used to import the package.
ParameterValues map[string]string `mandatory:"true" 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 ImportedPackage) String() string
func (m ImportedPackage) 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
ImportedPackageStatusEnum Enum with underlying type: string
type ImportedPackageStatusEnum string
Set of constants representing the allowable values for ImportedPackageStatusEnum
const (
ImportedPackageStatusReady ImportedPackageStatusEnum = "READY"
ImportedPackageStatusOperationPending ImportedPackageStatusEnum = "OPERATION_PENDING"
ImportedPackageStatusFailed ImportedPackageStatusEnum = "FAILED"
)
func GetImportedPackageStatusEnumValues() []ImportedPackageStatusEnum
GetImportedPackageStatusEnumValues Enumerates the set of values for ImportedPackageStatusEnum
func GetMappingImportedPackageStatusEnum(val string) (ImportedPackageStatusEnum, bool)
GetMappingImportedPackageStatusEnum performs case Insensitive comparison on enum value and return the desired enum
ImportedPackageSummary A summary of an imported/instantiated package within an instance.
type ImportedPackageSummary struct {
// ID of the host instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// ID of the package.
CurrentPackageId *string `mandatory:"true" json:"currentPackageId"`
// Stable name of the package (the same across versions).
Name *string `mandatory:"true" json:"name"`
// Display name of the package (can change across versions).
DisplayName *string `mandatory:"true" json:"displayName"`
// version of the package.
Version *string `mandatory:"true" json:"version"`
// Status of the imported package.
Status ImportedPackageStatusEnum `mandatory:"true" json:"status"`
// When the imported package 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 imported package 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 ImportedPackageSummary) String() string
func (m ImportedPackageSummary) 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
IosChannel The configuration for an iOS channel.
type IosChannel 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 IosChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m IosChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m IosChannel) GetDescription() *string
GetDescription returns Description
func (m IosChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m IosChannel) GetId() *string
GetId returns Id
func (m IosChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m IosChannel) GetName() *string
GetName returns Name
func (m IosChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m IosChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m IosChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m IosChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m IosChannel) String() string
func (m IosChannel) 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
LanguageMapping A natural language mapping.
type LanguageMapping struct {
// Language tag of mapping.
LanguageTag *string `mandatory:"true" json:"languageTag"`
// Primary name of mapping.
PrimaryName *string `mandatory:"true" json:"primaryName"`
// List of named values for mapping.
Names []NameMapping `mandatory:"true" json:"names"`
}
func (m LanguageMapping) String() string
func (m LanguageMapping) 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
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateCreating LifecycleStateEnum = "CREATING"
LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
LifecycleStateActive LifecycleStateEnum = "ACTIVE"
LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
LifecycleStateDeleting LifecycleStateEnum = "DELETING"
LifecycleStateDeleted LifecycleStateEnum = "DELETED"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAuthenticationProvidersIdentityProviderEnum Enum with underlying type: string
type ListAuthenticationProvidersIdentityProviderEnum string
Set of constants representing the allowable values for ListAuthenticationProvidersIdentityProviderEnum
const (
ListAuthenticationProvidersIdentityProviderGeneric ListAuthenticationProvidersIdentityProviderEnum = "GENERIC"
ListAuthenticationProvidersIdentityProviderOam ListAuthenticationProvidersIdentityProviderEnum = "OAM"
ListAuthenticationProvidersIdentityProviderGoogle ListAuthenticationProvidersIdentityProviderEnum = "GOOGLE"
ListAuthenticationProvidersIdentityProviderMicrosoft ListAuthenticationProvidersIdentityProviderEnum = "MICROSOFT"
)
func GetListAuthenticationProvidersIdentityProviderEnumValues() []ListAuthenticationProvidersIdentityProviderEnum
GetListAuthenticationProvidersIdentityProviderEnumValues Enumerates the set of values for ListAuthenticationProvidersIdentityProviderEnum
func GetMappingListAuthenticationProvidersIdentityProviderEnum(val string) (ListAuthenticationProvidersIdentityProviderEnum, bool)
GetMappingListAuthenticationProvidersIdentityProviderEnum performs case Insensitive comparison on enum value and return the desired enum
ListAuthenticationProvidersLifecycleStateEnum Enum with underlying type: string
type ListAuthenticationProvidersLifecycleStateEnum string
Set of constants representing the allowable values for ListAuthenticationProvidersLifecycleStateEnum
const (
ListAuthenticationProvidersLifecycleStateCreating ListAuthenticationProvidersLifecycleStateEnum = "CREATING"
ListAuthenticationProvidersLifecycleStateUpdating ListAuthenticationProvidersLifecycleStateEnum = "UPDATING"
ListAuthenticationProvidersLifecycleStateActive ListAuthenticationProvidersLifecycleStateEnum = "ACTIVE"
ListAuthenticationProvidersLifecycleStateInactive ListAuthenticationProvidersLifecycleStateEnum = "INACTIVE"
ListAuthenticationProvidersLifecycleStateDeleting ListAuthenticationProvidersLifecycleStateEnum = "DELETING"
ListAuthenticationProvidersLifecycleStateDeleted ListAuthenticationProvidersLifecycleStateEnum = "DELETED"
ListAuthenticationProvidersLifecycleStateFailed ListAuthenticationProvidersLifecycleStateEnum = "FAILED"
)
func GetListAuthenticationProvidersLifecycleStateEnumValues() []ListAuthenticationProvidersLifecycleStateEnum
GetListAuthenticationProvidersLifecycleStateEnumValues Enumerates the set of values for ListAuthenticationProvidersLifecycleStateEnum
func GetMappingListAuthenticationProvidersLifecycleStateEnum(val string) (ListAuthenticationProvidersLifecycleStateEnum, bool)
GetMappingListAuthenticationProvidersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListAuthenticationProvidersRequest wrapper for the ListAuthenticationProviders operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListAuthenticationProviders.go.html to see an example of how to use ListAuthenticationProvidersRequest.
type ListAuthenticationProvidersRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Authentication Provider identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only Authentication Providers for this Identity Provider.
IdentityProvider ListAuthenticationProvidersIdentityProviderEnum `mandatory:"false" contributesTo:"query" name:"identityProvider" omitEmpty:"true"`
// List only the information for Authentication Providers with this name. Authentication Provider names are unique and may not change.
// Example: `MyProvider`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only the resources that are in this lifecycle state.
LifecycleState ListAuthenticationProvidersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListAuthenticationProvidersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending.
// For all other sort fields the default sort order is ascending.
SortBy ListAuthenticationProvidersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListAuthenticationProvidersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAuthenticationProvidersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAuthenticationProvidersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAuthenticationProvidersRequest) String() string
func (request ListAuthenticationProvidersRequest) 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
ListAuthenticationProvidersResponse wrapper for the ListAuthenticationProviders operation
type ListAuthenticationProvidersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AuthenticationProviderCollection instances
AuthenticationProviderCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListAuthenticationProvidersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAuthenticationProvidersResponse) String() string
ListAuthenticationProvidersSortByEnum Enum with underlying type: string
type ListAuthenticationProvidersSortByEnum string
Set of constants representing the allowable values for ListAuthenticationProvidersSortByEnum
const (
ListAuthenticationProvidersSortByTimecreated ListAuthenticationProvidersSortByEnum = "timeCreated"
ListAuthenticationProvidersSortByTimeupdated ListAuthenticationProvidersSortByEnum = "timeUpdated"
ListAuthenticationProvidersSortByName ListAuthenticationProvidersSortByEnum = "name"
ListAuthenticationProvidersSortByIdentityprovider ListAuthenticationProvidersSortByEnum = "identityProvider"
)
func GetListAuthenticationProvidersSortByEnumValues() []ListAuthenticationProvidersSortByEnum
GetListAuthenticationProvidersSortByEnumValues Enumerates the set of values for ListAuthenticationProvidersSortByEnum
func GetMappingListAuthenticationProvidersSortByEnum(val string) (ListAuthenticationProvidersSortByEnum, bool)
GetMappingListAuthenticationProvidersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListAuthenticationProvidersSortOrderEnum Enum with underlying type: string
type ListAuthenticationProvidersSortOrderEnum string
Set of constants representing the allowable values for ListAuthenticationProvidersSortOrderEnum
const (
ListAuthenticationProvidersSortOrderAsc ListAuthenticationProvidersSortOrderEnum = "ASC"
ListAuthenticationProvidersSortOrderDesc ListAuthenticationProvidersSortOrderEnum = "DESC"
)
func GetListAuthenticationProvidersSortOrderEnumValues() []ListAuthenticationProvidersSortOrderEnum
GetListAuthenticationProvidersSortOrderEnumValues Enumerates the set of values for ListAuthenticationProvidersSortOrderEnum
func GetMappingListAuthenticationProvidersSortOrderEnum(val string) (ListAuthenticationProvidersSortOrderEnum, bool)
GetMappingListAuthenticationProvidersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsCategoryEnum Enum with underlying type: string
type ListChannelsCategoryEnum string
Set of constants representing the allowable values for ListChannelsCategoryEnum
const (
ListChannelsCategoryAgent ListChannelsCategoryEnum = "AGENT"
ListChannelsCategoryApplication ListChannelsCategoryEnum = "APPLICATION"
ListChannelsCategoryBot ListChannelsCategoryEnum = "BOT"
ListChannelsCategoryBotAsAgent ListChannelsCategoryEnum = "BOT_AS_AGENT"
ListChannelsCategorySystem ListChannelsCategoryEnum = "SYSTEM"
ListChannelsCategoryEvent ListChannelsCategoryEnum = "EVENT"
)
func GetListChannelsCategoryEnumValues() []ListChannelsCategoryEnum
GetListChannelsCategoryEnumValues Enumerates the set of values for ListChannelsCategoryEnum
func GetMappingListChannelsCategoryEnum(val string) (ListChannelsCategoryEnum, bool)
GetMappingListChannelsCategoryEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsLifecycleStateEnum Enum with underlying type: string
type ListChannelsLifecycleStateEnum string
Set of constants representing the allowable values for ListChannelsLifecycleStateEnum
const (
ListChannelsLifecycleStateCreating ListChannelsLifecycleStateEnum = "CREATING"
ListChannelsLifecycleStateUpdating ListChannelsLifecycleStateEnum = "UPDATING"
ListChannelsLifecycleStateActive ListChannelsLifecycleStateEnum = "ACTIVE"
ListChannelsLifecycleStateInactive ListChannelsLifecycleStateEnum = "INACTIVE"
ListChannelsLifecycleStateDeleting ListChannelsLifecycleStateEnum = "DELETING"
ListChannelsLifecycleStateDeleted ListChannelsLifecycleStateEnum = "DELETED"
ListChannelsLifecycleStateFailed ListChannelsLifecycleStateEnum = "FAILED"
)
func GetListChannelsLifecycleStateEnumValues() []ListChannelsLifecycleStateEnum
GetListChannelsLifecycleStateEnumValues Enumerates the set of values for ListChannelsLifecycleStateEnum
func GetMappingListChannelsLifecycleStateEnum(val string) (ListChannelsLifecycleStateEnum, bool)
GetMappingListChannelsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsRequest wrapper for the ListChannels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListChannels.go.html to see an example of how to use ListChannelsRequest.
type ListChannelsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only the information for Channels with this name. Channels names are unique and may not change.
// Example: `MyChannel`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only Channels with this category.
Category ListChannelsCategoryEnum `mandatory:"false" contributesTo:"query" name:"category" omitEmpty:"true"`
// List only Channels of this type.
Type ListChannelsTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`
// List only the resources that are in this lifecycle state.
LifecycleState ListChannelsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListChannelsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending, and the default sort order for `name` is ascending.
SortBy ListChannelsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListChannelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListChannelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListChannelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListChannelsRequest) String() string
func (request ListChannelsRequest) 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
ListChannelsResponse wrapper for the ListChannels operation
type ListChannelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ChannelCollection instances
ChannelCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListChannelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListChannelsResponse) String() string
ListChannelsSortByEnum Enum with underlying type: string
type ListChannelsSortByEnum string
Set of constants representing the allowable values for ListChannelsSortByEnum
const (
ListChannelsSortByTimecreated ListChannelsSortByEnum = "timeCreated"
ListChannelsSortByTimeupdated ListChannelsSortByEnum = "timeUpdated"
ListChannelsSortByName ListChannelsSortByEnum = "name"
)
func GetListChannelsSortByEnumValues() []ListChannelsSortByEnum
GetListChannelsSortByEnumValues Enumerates the set of values for ListChannelsSortByEnum
func GetMappingListChannelsSortByEnum(val string) (ListChannelsSortByEnum, bool)
GetMappingListChannelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsSortOrderEnum Enum with underlying type: string
type ListChannelsSortOrderEnum string
Set of constants representing the allowable values for ListChannelsSortOrderEnum
const (
ListChannelsSortOrderAsc ListChannelsSortOrderEnum = "ASC"
ListChannelsSortOrderDesc ListChannelsSortOrderEnum = "DESC"
)
func GetListChannelsSortOrderEnumValues() []ListChannelsSortOrderEnum
GetListChannelsSortOrderEnumValues Enumerates the set of values for ListChannelsSortOrderEnum
func GetMappingListChannelsSortOrderEnum(val string) (ListChannelsSortOrderEnum, bool)
GetMappingListChannelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListChannelsTypeEnum Enum with underlying type: string
type ListChannelsTypeEnum string
Set of constants representing the allowable values for ListChannelsTypeEnum
const (
ListChannelsTypeAndroid ListChannelsTypeEnum = "ANDROID"
ListChannelsTypeAppevent ListChannelsTypeEnum = "APPEVENT"
ListChannelsTypeApplication ListChannelsTypeEnum = "APPLICATION"
ListChannelsTypeCortana ListChannelsTypeEnum = "CORTANA"
ListChannelsTypeFacebook ListChannelsTypeEnum = "FACEBOOK"
ListChannelsTypeIos ListChannelsTypeEnum = "IOS"
ListChannelsTypeMsteams ListChannelsTypeEnum = "MSTEAMS"
ListChannelsTypeOss ListChannelsTypeEnum = "OSS"
ListChannelsTypeOsvc ListChannelsTypeEnum = "OSVC"
ListChannelsTypeServicecloud ListChannelsTypeEnum = "SERVICECLOUD"
ListChannelsTypeSlack ListChannelsTypeEnum = "SLACK"
ListChannelsTypeTest ListChannelsTypeEnum = "TEST"
ListChannelsTypeTwilio ListChannelsTypeEnum = "TWILIO"
ListChannelsTypeWeb ListChannelsTypeEnum = "WEB"
ListChannelsTypeWebhook ListChannelsTypeEnum = "WEBHOOK"
)
func GetListChannelsTypeEnumValues() []ListChannelsTypeEnum
GetListChannelsTypeEnumValues Enumerates the set of values for ListChannelsTypeEnum
func GetMappingListChannelsTypeEnum(val string) (ListChannelsTypeEnum, bool)
GetMappingListChannelsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantParametersLifecycleStateEnum Enum with underlying type: string
type ListDigitalAssistantParametersLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalAssistantParametersLifecycleStateEnum
const (
ListDigitalAssistantParametersLifecycleStateCreating ListDigitalAssistantParametersLifecycleStateEnum = "CREATING"
ListDigitalAssistantParametersLifecycleStateUpdating ListDigitalAssistantParametersLifecycleStateEnum = "UPDATING"
ListDigitalAssistantParametersLifecycleStateActive ListDigitalAssistantParametersLifecycleStateEnum = "ACTIVE"
ListDigitalAssistantParametersLifecycleStateInactive ListDigitalAssistantParametersLifecycleStateEnum = "INACTIVE"
ListDigitalAssistantParametersLifecycleStateDeleting ListDigitalAssistantParametersLifecycleStateEnum = "DELETING"
ListDigitalAssistantParametersLifecycleStateDeleted ListDigitalAssistantParametersLifecycleStateEnum = "DELETED"
ListDigitalAssistantParametersLifecycleStateFailed ListDigitalAssistantParametersLifecycleStateEnum = "FAILED"
)
func GetListDigitalAssistantParametersLifecycleStateEnumValues() []ListDigitalAssistantParametersLifecycleStateEnum
GetListDigitalAssistantParametersLifecycleStateEnumValues Enumerates the set of values for ListDigitalAssistantParametersLifecycleStateEnum
func GetMappingListDigitalAssistantParametersLifecycleStateEnum(val string) (ListDigitalAssistantParametersLifecycleStateEnum, bool)
GetMappingListDigitalAssistantParametersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantParametersRequest wrapper for the ListDigitalAssistantParameters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistantParameters.go.html to see an example of how to use ListDigitalAssistantParametersRequest.
type ListDigitalAssistantParametersRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// List only Parameters with this name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only the resources that are in this lifecycle state.
LifecycleState ListDigitalAssistantParametersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListDigitalAssistantParametersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `name`.
// The default sort order is ascending.
SortBy ListDigitalAssistantParametersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListDigitalAssistantParametersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalAssistantParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalAssistantParametersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalAssistantParametersRequest) String() string
func (request ListDigitalAssistantParametersRequest) 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
ListDigitalAssistantParametersResponse wrapper for the ListDigitalAssistantParameters operation
type ListDigitalAssistantParametersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalAssistantParameterCollection instances
DigitalAssistantParameterCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListDigitalAssistantParametersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalAssistantParametersResponse) String() string
ListDigitalAssistantParametersSortByEnum Enum with underlying type: string
type ListDigitalAssistantParametersSortByEnum string
Set of constants representing the allowable values for ListDigitalAssistantParametersSortByEnum
const (
ListDigitalAssistantParametersSortByName ListDigitalAssistantParametersSortByEnum = "name"
ListDigitalAssistantParametersSortByDisplayname ListDigitalAssistantParametersSortByEnum = "displayName"
ListDigitalAssistantParametersSortByType ListDigitalAssistantParametersSortByEnum = "type"
)
func GetListDigitalAssistantParametersSortByEnumValues() []ListDigitalAssistantParametersSortByEnum
GetListDigitalAssistantParametersSortByEnumValues Enumerates the set of values for ListDigitalAssistantParametersSortByEnum
func GetMappingListDigitalAssistantParametersSortByEnum(val string) (ListDigitalAssistantParametersSortByEnum, bool)
GetMappingListDigitalAssistantParametersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantParametersSortOrderEnum Enum with underlying type: string
type ListDigitalAssistantParametersSortOrderEnum string
Set of constants representing the allowable values for ListDigitalAssistantParametersSortOrderEnum
const (
ListDigitalAssistantParametersSortOrderAsc ListDigitalAssistantParametersSortOrderEnum = "ASC"
ListDigitalAssistantParametersSortOrderDesc ListDigitalAssistantParametersSortOrderEnum = "DESC"
)
func GetListDigitalAssistantParametersSortOrderEnumValues() []ListDigitalAssistantParametersSortOrderEnum
GetListDigitalAssistantParametersSortOrderEnumValues Enumerates the set of values for ListDigitalAssistantParametersSortOrderEnum
func GetMappingListDigitalAssistantParametersSortOrderEnum(val string) (ListDigitalAssistantParametersSortOrderEnum, bool)
GetMappingListDigitalAssistantParametersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantsLifecycleStateEnum Enum with underlying type: string
type ListDigitalAssistantsLifecycleStateEnum string
Set of constants representing the allowable values for ListDigitalAssistantsLifecycleStateEnum
const (
ListDigitalAssistantsLifecycleStateCreating ListDigitalAssistantsLifecycleStateEnum = "CREATING"
ListDigitalAssistantsLifecycleStateUpdating ListDigitalAssistantsLifecycleStateEnum = "UPDATING"
ListDigitalAssistantsLifecycleStateActive ListDigitalAssistantsLifecycleStateEnum = "ACTIVE"
ListDigitalAssistantsLifecycleStateInactive ListDigitalAssistantsLifecycleStateEnum = "INACTIVE"
ListDigitalAssistantsLifecycleStateDeleting ListDigitalAssistantsLifecycleStateEnum = "DELETING"
ListDigitalAssistantsLifecycleStateDeleted ListDigitalAssistantsLifecycleStateEnum = "DELETED"
ListDigitalAssistantsLifecycleStateFailed ListDigitalAssistantsLifecycleStateEnum = "FAILED"
)
func GetListDigitalAssistantsLifecycleStateEnumValues() []ListDigitalAssistantsLifecycleStateEnum
GetListDigitalAssistantsLifecycleStateEnumValues Enumerates the set of values for ListDigitalAssistantsLifecycleStateEnum
func GetMappingListDigitalAssistantsLifecycleStateEnum(val string) (ListDigitalAssistantsLifecycleStateEnum, bool)
GetMappingListDigitalAssistantsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantsRequest wrapper for the ListDigitalAssistants operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistants.go.html to see an example of how to use ListDigitalAssistantsRequest.
type ListDigitalAssistantsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only Bot resources with this category.
Category *string `mandatory:"false" contributesTo:"query" name:"category"`
// List only Bot resources with this name. Names are unique and may not change.
// Example: `MySkill`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only Bot resources with this version. Versions are unique and may not change.
// Example: `1.0`
Version *string `mandatory:"false" contributesTo:"query" name:"version"`
// List only Bot resources with this namespace. Namespaces may not change.
// Example: `MyNamespace`
Namespace *string `mandatory:"false" contributesTo:"query" name:"namespace"`
// List only Bot resources with this platform version.
PlatformVersion *string `mandatory:"false" contributesTo:"query" name:"platformVersion"`
// List only the resources that are in this lifecycle state.
LifecycleState ListDigitalAssistantsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// List only Bot resources with this lifecycle details.
LifecycleDetails *string `mandatory:"false" contributesTo:"query" name:"lifecycleDetails"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListDigitalAssistantsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending.
// For all other sort fields the default sort order is ascending.
SortBy ListDigitalAssistantsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListDigitalAssistantsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDigitalAssistantsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDigitalAssistantsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDigitalAssistantsRequest) String() string
func (request ListDigitalAssistantsRequest) 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
ListDigitalAssistantsResponse wrapper for the ListDigitalAssistants operation
type ListDigitalAssistantsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DigitalAssistantCollection instances
DigitalAssistantCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListDigitalAssistantsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDigitalAssistantsResponse) String() string
ListDigitalAssistantsSortByEnum Enum with underlying type: string
type ListDigitalAssistantsSortByEnum string
Set of constants representing the allowable values for ListDigitalAssistantsSortByEnum
const (
ListDigitalAssistantsSortByTimecreated ListDigitalAssistantsSortByEnum = "timeCreated"
ListDigitalAssistantsSortByTimeupdated ListDigitalAssistantsSortByEnum = "timeUpdated"
ListDigitalAssistantsSortByName ListDigitalAssistantsSortByEnum = "name"
)
func GetListDigitalAssistantsSortByEnumValues() []ListDigitalAssistantsSortByEnum
GetListDigitalAssistantsSortByEnumValues Enumerates the set of values for ListDigitalAssistantsSortByEnum
func GetMappingListDigitalAssistantsSortByEnum(val string) (ListDigitalAssistantsSortByEnum, bool)
GetMappingListDigitalAssistantsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDigitalAssistantsSortOrderEnum Enum with underlying type: string
type ListDigitalAssistantsSortOrderEnum string
Set of constants representing the allowable values for ListDigitalAssistantsSortOrderEnum
const (
ListDigitalAssistantsSortOrderAsc ListDigitalAssistantsSortOrderEnum = "ASC"
ListDigitalAssistantsSortOrderDesc ListDigitalAssistantsSortOrderEnum = "DESC"
)
func GetListDigitalAssistantsSortOrderEnumValues() []ListDigitalAssistantsSortOrderEnum
GetListDigitalAssistantsSortOrderEnumValues Enumerates the set of values for ListDigitalAssistantsSortOrderEnum
func GetMappingListDigitalAssistantsSortOrderEnum(val string) (ListDigitalAssistantsSortOrderEnum, bool)
GetMappingListDigitalAssistantsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListImportedPackagesRequest wrapper for the ListImportedPackages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListImportedPackages.go.html to see an example of how to use ListImportedPackagesRequest.
type ListImportedPackagesRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// List only the information for the package with this name. Package names are unique to a publisher and may not change.
// Example: `My Package`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListImportedPackagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListImportedPackagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListImportedPackagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListImportedPackagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListImportedPackagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListImportedPackagesRequest) String() string
func (request ListImportedPackagesRequest) 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
ListImportedPackagesResponse wrapper for the ListImportedPackages operation
type ListImportedPackagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ImportedPackageSummary instances
Items []ImportedPackageSummary `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListImportedPackagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListImportedPackagesResponse) String() string
ListImportedPackagesSortByEnum Enum with underlying type: string
type ListImportedPackagesSortByEnum string
Set of constants representing the allowable values for ListImportedPackagesSortByEnum
const (
ListImportedPackagesSortByTimecreated ListImportedPackagesSortByEnum = "TIMECREATED"
ListImportedPackagesSortByDisplayname ListImportedPackagesSortByEnum = "DISPLAYNAME"
)
func GetListImportedPackagesSortByEnumValues() []ListImportedPackagesSortByEnum
GetListImportedPackagesSortByEnumValues Enumerates the set of values for ListImportedPackagesSortByEnum
func GetMappingListImportedPackagesSortByEnum(val string) (ListImportedPackagesSortByEnum, bool)
GetMappingListImportedPackagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListImportedPackagesSortOrderEnum Enum with underlying type: string
type ListImportedPackagesSortOrderEnum string
Set of constants representing the allowable values for ListImportedPackagesSortOrderEnum
const (
ListImportedPackagesSortOrderAsc ListImportedPackagesSortOrderEnum = "ASC"
ListImportedPackagesSortOrderDesc ListImportedPackagesSortOrderEnum = "DESC"
)
func GetListImportedPackagesSortOrderEnumValues() []ListImportedPackagesSortOrderEnum
GetListImportedPackagesSortOrderEnumValues Enumerates the set of values for ListImportedPackagesSortOrderEnum
func GetMappingListImportedPackagesSortOrderEnum(val string) (ListImportedPackagesSortOrderEnum, bool)
GetMappingListImportedPackagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstanceAttachmentsLifecycleStateEnum Enum with underlying type: string
type ListOdaInstanceAttachmentsLifecycleStateEnum string
Set of constants representing the allowable values for ListOdaInstanceAttachmentsLifecycleStateEnum
const (
ListOdaInstanceAttachmentsLifecycleStateAttaching ListOdaInstanceAttachmentsLifecycleStateEnum = "ATTACHING"
ListOdaInstanceAttachmentsLifecycleStateActive ListOdaInstanceAttachmentsLifecycleStateEnum = "ACTIVE"
ListOdaInstanceAttachmentsLifecycleStateDetaching ListOdaInstanceAttachmentsLifecycleStateEnum = "DETACHING"
ListOdaInstanceAttachmentsLifecycleStateInactive ListOdaInstanceAttachmentsLifecycleStateEnum = "INACTIVE"
ListOdaInstanceAttachmentsLifecycleStateFailed ListOdaInstanceAttachmentsLifecycleStateEnum = "FAILED"
)
func GetListOdaInstanceAttachmentsLifecycleStateEnumValues() []ListOdaInstanceAttachmentsLifecycleStateEnum
GetListOdaInstanceAttachmentsLifecycleStateEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsLifecycleStateEnum
func GetMappingListOdaInstanceAttachmentsLifecycleStateEnum(val string) (ListOdaInstanceAttachmentsLifecycleStateEnum, bool)
GetMappingListOdaInstanceAttachmentsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstanceAttachmentsRequest wrapper for the ListOdaInstanceAttachments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstanceAttachments.go.html to see an example of how to use ListOdaInstanceAttachmentsRequest.
type ListOdaInstanceAttachmentsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Whether to send attachment owner info during get/list call.
IncludeOwnerMetadata *bool `mandatory:"false" contributesTo:"query" name:"includeOwnerMetadata"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// List only the ODA instance attachments that are in this lifecycle state.
LifecycleState ListOdaInstanceAttachmentsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListOdaInstanceAttachmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending.
SortBy ListOdaInstanceAttachmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListOdaInstanceAttachmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOdaInstanceAttachmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaInstanceAttachmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaInstanceAttachmentsRequest) String() string
func (request ListOdaInstanceAttachmentsRequest) 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
ListOdaInstanceAttachmentsResponse wrapper for the ListOdaInstanceAttachments operation
type ListOdaInstanceAttachmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OdaInstanceAttachmentCollection instances
OdaInstanceAttachmentCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListOdaInstanceAttachmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaInstanceAttachmentsResponse) String() string
ListOdaInstanceAttachmentsSortByEnum Enum with underlying type: string
type ListOdaInstanceAttachmentsSortByEnum string
Set of constants representing the allowable values for ListOdaInstanceAttachmentsSortByEnum
const (
ListOdaInstanceAttachmentsSortByTimecreated ListOdaInstanceAttachmentsSortByEnum = "TIMECREATED"
)
func GetListOdaInstanceAttachmentsSortByEnumValues() []ListOdaInstanceAttachmentsSortByEnum
GetListOdaInstanceAttachmentsSortByEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsSortByEnum
func GetMappingListOdaInstanceAttachmentsSortByEnum(val string) (ListOdaInstanceAttachmentsSortByEnum, bool)
GetMappingListOdaInstanceAttachmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstanceAttachmentsSortOrderEnum Enum with underlying type: string
type ListOdaInstanceAttachmentsSortOrderEnum string
Set of constants representing the allowable values for ListOdaInstanceAttachmentsSortOrderEnum
const (
ListOdaInstanceAttachmentsSortOrderAsc ListOdaInstanceAttachmentsSortOrderEnum = "ASC"
ListOdaInstanceAttachmentsSortOrderDesc ListOdaInstanceAttachmentsSortOrderEnum = "DESC"
)
func GetListOdaInstanceAttachmentsSortOrderEnumValues() []ListOdaInstanceAttachmentsSortOrderEnum
GetListOdaInstanceAttachmentsSortOrderEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsSortOrderEnum
func GetMappingListOdaInstanceAttachmentsSortOrderEnum(val string) (ListOdaInstanceAttachmentsSortOrderEnum, bool)
GetMappingListOdaInstanceAttachmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstancesLifecycleStateEnum Enum with underlying type: string
type ListOdaInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListOdaInstancesLifecycleStateEnum
const (
ListOdaInstancesLifecycleStateCreating ListOdaInstancesLifecycleStateEnum = "CREATING"
ListOdaInstancesLifecycleStateUpdating ListOdaInstancesLifecycleStateEnum = "UPDATING"
ListOdaInstancesLifecycleStateActive ListOdaInstancesLifecycleStateEnum = "ACTIVE"
ListOdaInstancesLifecycleStateInactive ListOdaInstancesLifecycleStateEnum = "INACTIVE"
ListOdaInstancesLifecycleStateDeleting ListOdaInstancesLifecycleStateEnum = "DELETING"
ListOdaInstancesLifecycleStateDeleted ListOdaInstancesLifecycleStateEnum = "DELETED"
ListOdaInstancesLifecycleStateFailed ListOdaInstancesLifecycleStateEnum = "FAILED"
)
func GetListOdaInstancesLifecycleStateEnumValues() []ListOdaInstancesLifecycleStateEnum
GetListOdaInstancesLifecycleStateEnumValues Enumerates the set of values for ListOdaInstancesLifecycleStateEnum
func GetMappingListOdaInstancesLifecycleStateEnum(val string) (ListOdaInstancesLifecycleStateEnum, bool)
GetMappingListOdaInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstancesRequest wrapper for the ListOdaInstances operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstances.go.html to see an example of how to use ListOdaInstancesRequest.
type ListOdaInstancesRequest struct {
// List the Digital Assistant instances that belong to this compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// List only the Digital Assistant instances that are in this lifecycle state.
LifecycleState ListOdaInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListOdaInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListOdaInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListOdaInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOdaInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaInstancesRequest) String() string
func (request ListOdaInstancesRequest) 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
ListOdaInstancesResponse wrapper for the ListOdaInstances operation
type ListOdaInstancesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []OdaInstanceSummary instances
Items []OdaInstanceSummary `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListOdaInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaInstancesResponse) String() string
ListOdaInstancesSortByEnum Enum with underlying type: string
type ListOdaInstancesSortByEnum string
Set of constants representing the allowable values for ListOdaInstancesSortByEnum
const (
ListOdaInstancesSortByTimecreated ListOdaInstancesSortByEnum = "TIMECREATED"
ListOdaInstancesSortByDisplayname ListOdaInstancesSortByEnum = "DISPLAYNAME"
)
func GetListOdaInstancesSortByEnumValues() []ListOdaInstancesSortByEnum
GetListOdaInstancesSortByEnumValues Enumerates the set of values for ListOdaInstancesSortByEnum
func GetMappingListOdaInstancesSortByEnum(val string) (ListOdaInstancesSortByEnum, bool)
GetMappingListOdaInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaInstancesSortOrderEnum Enum with underlying type: string
type ListOdaInstancesSortOrderEnum string
Set of constants representing the allowable values for ListOdaInstancesSortOrderEnum
const (
ListOdaInstancesSortOrderAsc ListOdaInstancesSortOrderEnum = "ASC"
ListOdaInstancesSortOrderDesc ListOdaInstancesSortOrderEnum = "DESC"
)
func GetListOdaInstancesSortOrderEnumValues() []ListOdaInstancesSortOrderEnum
GetListOdaInstancesSortOrderEnumValues Enumerates the set of values for ListOdaInstancesSortOrderEnum
func GetMappingListOdaInstancesSortOrderEnum(val string) (ListOdaInstancesSortOrderEnum, bool)
GetMappingListOdaInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointAttachmentsRequest wrapper for the ListOdaPrivateEndpointAttachments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointAttachments.go.html to see an example of how to use ListOdaPrivateEndpointAttachmentsRequest.
type ListOdaPrivateEndpointAttachmentsRequest struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of ODA Private Endpoint.
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"query" name:"odaPrivateEndpointId"`
// List the ODA Private Endpoint Attachments that belong to this compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// List only the ODA Private Endpoint Attachments that are in this lifecycle state.
LifecycleState OdaPrivateEndpointAttachmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListOdaPrivateEndpointAttachmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListOdaPrivateEndpointAttachmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListOdaPrivateEndpointAttachmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOdaPrivateEndpointAttachmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaPrivateEndpointAttachmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaPrivateEndpointAttachmentsRequest) String() string
func (request ListOdaPrivateEndpointAttachmentsRequest) 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
ListOdaPrivateEndpointAttachmentsResponse wrapper for the ListOdaPrivateEndpointAttachments operation
type ListOdaPrivateEndpointAttachmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OdaPrivateEndpointAttachmentCollection instances
OdaPrivateEndpointAttachmentCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListOdaPrivateEndpointAttachmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaPrivateEndpointAttachmentsResponse) String() string
ListOdaPrivateEndpointAttachmentsSortByEnum Enum with underlying type: string
type ListOdaPrivateEndpointAttachmentsSortByEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointAttachmentsSortByEnum
const (
ListOdaPrivateEndpointAttachmentsSortByTimecreated ListOdaPrivateEndpointAttachmentsSortByEnum = "TIMECREATED"
ListOdaPrivateEndpointAttachmentsSortByDisplayname ListOdaPrivateEndpointAttachmentsSortByEnum = "DISPLAYNAME"
)
func GetListOdaPrivateEndpointAttachmentsSortByEnumValues() []ListOdaPrivateEndpointAttachmentsSortByEnum
GetListOdaPrivateEndpointAttachmentsSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointAttachmentsSortByEnum
func GetMappingListOdaPrivateEndpointAttachmentsSortByEnum(val string) (ListOdaPrivateEndpointAttachmentsSortByEnum, bool)
GetMappingListOdaPrivateEndpointAttachmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointAttachmentsSortOrderEnum Enum with underlying type: string
type ListOdaPrivateEndpointAttachmentsSortOrderEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointAttachmentsSortOrderEnum
const (
ListOdaPrivateEndpointAttachmentsSortOrderAsc ListOdaPrivateEndpointAttachmentsSortOrderEnum = "ASC"
ListOdaPrivateEndpointAttachmentsSortOrderDesc ListOdaPrivateEndpointAttachmentsSortOrderEnum = "DESC"
)
func GetListOdaPrivateEndpointAttachmentsSortOrderEnumValues() []ListOdaPrivateEndpointAttachmentsSortOrderEnum
GetListOdaPrivateEndpointAttachmentsSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointAttachmentsSortOrderEnum
func GetMappingListOdaPrivateEndpointAttachmentsSortOrderEnum(val string) (ListOdaPrivateEndpointAttachmentsSortOrderEnum, bool)
GetMappingListOdaPrivateEndpointAttachmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointScanProxiesRequest wrapper for the ListOdaPrivateEndpointScanProxies operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointScanProxies.go.html to see an example of how to use ListOdaPrivateEndpointScanProxiesRequest.
type ListOdaPrivateEndpointScanProxiesRequest struct {
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// List only the ODA Private Endpoint Scan Proxies that are in this lifecycle state.
LifecycleState OdaPrivateEndpointScanProxyLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListOdaPrivateEndpointScanProxiesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListOdaPrivateEndpointScanProxiesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListOdaPrivateEndpointScanProxiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOdaPrivateEndpointScanProxiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaPrivateEndpointScanProxiesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaPrivateEndpointScanProxiesRequest) String() string
func (request ListOdaPrivateEndpointScanProxiesRequest) 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
ListOdaPrivateEndpointScanProxiesResponse wrapper for the ListOdaPrivateEndpointScanProxies operation
type ListOdaPrivateEndpointScanProxiesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OdaPrivateEndpointScanProxyCollection instances
OdaPrivateEndpointScanProxyCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListOdaPrivateEndpointScanProxiesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaPrivateEndpointScanProxiesResponse) String() string
ListOdaPrivateEndpointScanProxiesSortByEnum Enum with underlying type: string
type ListOdaPrivateEndpointScanProxiesSortByEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointScanProxiesSortByEnum
const (
ListOdaPrivateEndpointScanProxiesSortByTimecreated ListOdaPrivateEndpointScanProxiesSortByEnum = "TIMECREATED"
ListOdaPrivateEndpointScanProxiesSortByDisplayname ListOdaPrivateEndpointScanProxiesSortByEnum = "DISPLAYNAME"
)
func GetListOdaPrivateEndpointScanProxiesSortByEnumValues() []ListOdaPrivateEndpointScanProxiesSortByEnum
GetListOdaPrivateEndpointScanProxiesSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointScanProxiesSortByEnum
func GetMappingListOdaPrivateEndpointScanProxiesSortByEnum(val string) (ListOdaPrivateEndpointScanProxiesSortByEnum, bool)
GetMappingListOdaPrivateEndpointScanProxiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointScanProxiesSortOrderEnum Enum with underlying type: string
type ListOdaPrivateEndpointScanProxiesSortOrderEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointScanProxiesSortOrderEnum
const (
ListOdaPrivateEndpointScanProxiesSortOrderAsc ListOdaPrivateEndpointScanProxiesSortOrderEnum = "ASC"
ListOdaPrivateEndpointScanProxiesSortOrderDesc ListOdaPrivateEndpointScanProxiesSortOrderEnum = "DESC"
)
func GetListOdaPrivateEndpointScanProxiesSortOrderEnumValues() []ListOdaPrivateEndpointScanProxiesSortOrderEnum
GetListOdaPrivateEndpointScanProxiesSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointScanProxiesSortOrderEnum
func GetMappingListOdaPrivateEndpointScanProxiesSortOrderEnum(val string) (ListOdaPrivateEndpointScanProxiesSortOrderEnum, bool)
GetMappingListOdaPrivateEndpointScanProxiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointsRequest wrapper for the ListOdaPrivateEndpoints operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpoints.go.html to see an example of how to use ListOdaPrivateEndpointsRequest.
type ListOdaPrivateEndpointsRequest struct {
// List the ODA Private Endpoints that belong to this compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// List only the ODA Private Endpoints that are in this lifecycle state.
LifecycleState OdaPrivateEndpointLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListOdaPrivateEndpointsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListOdaPrivateEndpointsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListOdaPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOdaPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaPrivateEndpointsRequest) String() string
func (request ListOdaPrivateEndpointsRequest) 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
ListOdaPrivateEndpointsResponse wrapper for the ListOdaPrivateEndpoints operation
type ListOdaPrivateEndpointsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of OdaPrivateEndpointCollection instances
OdaPrivateEndpointCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListOdaPrivateEndpointsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaPrivateEndpointsResponse) String() string
ListOdaPrivateEndpointsSortByEnum Enum with underlying type: string
type ListOdaPrivateEndpointsSortByEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointsSortByEnum
const (
ListOdaPrivateEndpointsSortByTimecreated ListOdaPrivateEndpointsSortByEnum = "TIMECREATED"
ListOdaPrivateEndpointsSortByDisplayname ListOdaPrivateEndpointsSortByEnum = "DISPLAYNAME"
)
func GetListOdaPrivateEndpointsSortByEnumValues() []ListOdaPrivateEndpointsSortByEnum
GetListOdaPrivateEndpointsSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointsSortByEnum
func GetMappingListOdaPrivateEndpointsSortByEnum(val string) (ListOdaPrivateEndpointsSortByEnum, bool)
GetMappingListOdaPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOdaPrivateEndpointsSortOrderEnum Enum with underlying type: string
type ListOdaPrivateEndpointsSortOrderEnum string
Set of constants representing the allowable values for ListOdaPrivateEndpointsSortOrderEnum
const (
ListOdaPrivateEndpointsSortOrderAsc ListOdaPrivateEndpointsSortOrderEnum = "ASC"
ListOdaPrivateEndpointsSortOrderDesc ListOdaPrivateEndpointsSortOrderEnum = "DESC"
)
func GetListOdaPrivateEndpointsSortOrderEnumValues() []ListOdaPrivateEndpointsSortOrderEnum
GetListOdaPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointsSortOrderEnum
func GetMappingListOdaPrivateEndpointsSortOrderEnum(val string) (ListOdaPrivateEndpointsSortOrderEnum, bool)
GetMappingListOdaPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListPackagesRequest wrapper for the ListPackages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListPackages.go.html to see an example of how to use ListPackagesRequest.
type ListPackagesRequest struct {
// List only the information for this Digital Assistant instance.
OdaInstanceId *string `mandatory:"false" contributesTo:"query" name:"odaInstanceId"`
// Resource type identifier. Used to limit query results to the items which are applicable to the given type.
ResourceType *string `mandatory:"false" contributesTo:"query" name:"resourceType"`
// List the packages that belong to this compartment.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// List only the information for the package with this name. Package names are unique to a publisher and may not change.
// Example: `My Package`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.
// Example: `My new resource`
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// Should we return only the latest version of a package (instead of all versions)?
IsLatestVersionOnly *bool `mandatory:"false" contributesTo:"query" name:"isLatestVersionOnly"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListPackagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`.
// The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending.
SortBy ListPackagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListPackagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListPackagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListPackagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListPackagesRequest) String() string
func (request ListPackagesRequest) 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
ListPackagesResponse wrapper for the ListPackages operation
type ListPackagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []PackageSummary instances
Items []PackageSummary `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListPackagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListPackagesResponse) String() string
ListPackagesSortByEnum Enum with underlying type: string
type ListPackagesSortByEnum string
Set of constants representing the allowable values for ListPackagesSortByEnum
const (
ListPackagesSortByTimecreated ListPackagesSortByEnum = "TIMECREATED"
ListPackagesSortByDisplayname ListPackagesSortByEnum = "DISPLAYNAME"
)
func GetListPackagesSortByEnumValues() []ListPackagesSortByEnum
GetListPackagesSortByEnumValues Enumerates the set of values for ListPackagesSortByEnum
func GetMappingListPackagesSortByEnum(val string) (ListPackagesSortByEnum, bool)
GetMappingListPackagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListPackagesSortOrderEnum Enum with underlying type: string
type ListPackagesSortOrderEnum string
Set of constants representing the allowable values for ListPackagesSortOrderEnum
const (
ListPackagesSortOrderAsc ListPackagesSortOrderEnum = "ASC"
ListPackagesSortOrderDesc ListPackagesSortOrderEnum = "DESC"
)
func GetListPackagesSortOrderEnumValues() []ListPackagesSortOrderEnum
GetListPackagesSortOrderEnumValues Enumerates the set of values for ListPackagesSortOrderEnum
func GetMappingListPackagesSortOrderEnum(val string) (ListPackagesSortOrderEnum, bool)
GetMappingListPackagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillParametersLifecycleStateEnum Enum with underlying type: string
type ListSkillParametersLifecycleStateEnum string
Set of constants representing the allowable values for ListSkillParametersLifecycleStateEnum
const (
ListSkillParametersLifecycleStateCreating ListSkillParametersLifecycleStateEnum = "CREATING"
ListSkillParametersLifecycleStateUpdating ListSkillParametersLifecycleStateEnum = "UPDATING"
ListSkillParametersLifecycleStateActive ListSkillParametersLifecycleStateEnum = "ACTIVE"
ListSkillParametersLifecycleStateInactive ListSkillParametersLifecycleStateEnum = "INACTIVE"
ListSkillParametersLifecycleStateDeleting ListSkillParametersLifecycleStateEnum = "DELETING"
ListSkillParametersLifecycleStateDeleted ListSkillParametersLifecycleStateEnum = "DELETED"
ListSkillParametersLifecycleStateFailed ListSkillParametersLifecycleStateEnum = "FAILED"
)
func GetListSkillParametersLifecycleStateEnumValues() []ListSkillParametersLifecycleStateEnum
GetListSkillParametersLifecycleStateEnumValues Enumerates the set of values for ListSkillParametersLifecycleStateEnum
func GetMappingListSkillParametersLifecycleStateEnum(val string) (ListSkillParametersLifecycleStateEnum, bool)
GetMappingListSkillParametersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillParametersRequest wrapper for the ListSkillParameters operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkillParameters.go.html to see an example of how to use ListSkillParametersRequest.
type ListSkillParametersRequest 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"`
// List only Parameters with this name.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only the resources that are in this lifecycle state.
LifecycleState ListSkillParametersLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListSkillParametersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `name`.
// The default sort order is ascending.
SortBy ListSkillParametersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListSkillParametersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSkillParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSkillParametersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSkillParametersRequest) String() string
func (request ListSkillParametersRequest) 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
ListSkillParametersResponse wrapper for the ListSkillParameters operation
type ListSkillParametersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SkillParameterCollection instances
SkillParameterCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListSkillParametersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSkillParametersResponse) String() string
ListSkillParametersSortByEnum Enum with underlying type: string
type ListSkillParametersSortByEnum string
Set of constants representing the allowable values for ListSkillParametersSortByEnum
const (
ListSkillParametersSortByName ListSkillParametersSortByEnum = "name"
ListSkillParametersSortByDisplayname ListSkillParametersSortByEnum = "displayName"
ListSkillParametersSortByType ListSkillParametersSortByEnum = "type"
)
func GetListSkillParametersSortByEnumValues() []ListSkillParametersSortByEnum
GetListSkillParametersSortByEnumValues Enumerates the set of values for ListSkillParametersSortByEnum
func GetMappingListSkillParametersSortByEnum(val string) (ListSkillParametersSortByEnum, bool)
GetMappingListSkillParametersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillParametersSortOrderEnum Enum with underlying type: string
type ListSkillParametersSortOrderEnum string
Set of constants representing the allowable values for ListSkillParametersSortOrderEnum
const (
ListSkillParametersSortOrderAsc ListSkillParametersSortOrderEnum = "ASC"
ListSkillParametersSortOrderDesc ListSkillParametersSortOrderEnum = "DESC"
)
func GetListSkillParametersSortOrderEnumValues() []ListSkillParametersSortOrderEnum
GetListSkillParametersSortOrderEnumValues Enumerates the set of values for ListSkillParametersSortOrderEnum
func GetMappingListSkillParametersSortOrderEnum(val string) (ListSkillParametersSortOrderEnum, bool)
GetMappingListSkillParametersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillsLifecycleStateEnum Enum with underlying type: string
type ListSkillsLifecycleStateEnum string
Set of constants representing the allowable values for ListSkillsLifecycleStateEnum
const (
ListSkillsLifecycleStateCreating ListSkillsLifecycleStateEnum = "CREATING"
ListSkillsLifecycleStateUpdating ListSkillsLifecycleStateEnum = "UPDATING"
ListSkillsLifecycleStateActive ListSkillsLifecycleStateEnum = "ACTIVE"
ListSkillsLifecycleStateInactive ListSkillsLifecycleStateEnum = "INACTIVE"
ListSkillsLifecycleStateDeleting ListSkillsLifecycleStateEnum = "DELETING"
ListSkillsLifecycleStateDeleted ListSkillsLifecycleStateEnum = "DELETED"
ListSkillsLifecycleStateFailed ListSkillsLifecycleStateEnum = "FAILED"
)
func GetListSkillsLifecycleStateEnumValues() []ListSkillsLifecycleStateEnum
GetListSkillsLifecycleStateEnumValues Enumerates the set of values for ListSkillsLifecycleStateEnum
func GetMappingListSkillsLifecycleStateEnum(val string) (ListSkillsLifecycleStateEnum, bool)
GetMappingListSkillsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillsRequest wrapper for the ListSkills operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkills.go.html to see an example of how to use ListSkillsRequest.
type ListSkillsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Skill identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only Bot resources with this category.
Category *string `mandatory:"false" contributesTo:"query" name:"category"`
// List only Bot resources with this name. Names are unique and may not change.
// Example: `MySkill`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only Bot resources with this version. Versions are unique and may not change.
// Example: `1.0`
Version *string `mandatory:"false" contributesTo:"query" name:"version"`
// List only Bot resources with this namespace. Namespaces may not change.
// Example: `MyNamespace`
Namespace *string `mandatory:"false" contributesTo:"query" name:"namespace"`
// List only Bot resources with this platform version.
PlatformVersion *string `mandatory:"false" contributesTo:"query" name:"platformVersion"`
// List only the resources that are in this lifecycle state.
LifecycleState ListSkillsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// List only Bot resources with this lifecycle details.
LifecycleDetails *string `mandatory:"false" contributesTo:"query" name:"lifecycleDetails"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListSkillsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending.
// For all other sort fields the default sort order is ascending.
SortBy ListSkillsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListSkillsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSkillsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSkillsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSkillsRequest) String() string
func (request ListSkillsRequest) 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
ListSkillsResponse wrapper for the ListSkills operation
type ListSkillsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of SkillCollection instances
SkillCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListSkillsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSkillsResponse) String() string
ListSkillsSortByEnum Enum with underlying type: string
type ListSkillsSortByEnum string
Set of constants representing the allowable values for ListSkillsSortByEnum
const (
ListSkillsSortByTimecreated ListSkillsSortByEnum = "timeCreated"
ListSkillsSortByTimeupdated ListSkillsSortByEnum = "timeUpdated"
ListSkillsSortByName ListSkillsSortByEnum = "name"
)
func GetListSkillsSortByEnumValues() []ListSkillsSortByEnum
GetListSkillsSortByEnumValues Enumerates the set of values for ListSkillsSortByEnum
func GetMappingListSkillsSortByEnum(val string) (ListSkillsSortByEnum, bool)
GetMappingListSkillsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSkillsSortOrderEnum Enum with underlying type: string
type ListSkillsSortOrderEnum string
Set of constants representing the allowable values for ListSkillsSortOrderEnum
const (
ListSkillsSortOrderAsc ListSkillsSortOrderEnum = "ASC"
ListSkillsSortOrderDesc ListSkillsSortOrderEnum = "DESC"
)
func GetListSkillsSortOrderEnumValues() []ListSkillsSortOrderEnum
GetListSkillsSortOrderEnumValues Enumerates the set of values for ListSkillsSortOrderEnum
func GetMappingListSkillsSortOrderEnum(val string) (ListSkillsSortOrderEnum, bool)
GetMappingListSkillsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranslatorsLifecycleStateEnum Enum with underlying type: string
type ListTranslatorsLifecycleStateEnum string
Set of constants representing the allowable values for ListTranslatorsLifecycleStateEnum
const (
ListTranslatorsLifecycleStateCreating ListTranslatorsLifecycleStateEnum = "CREATING"
ListTranslatorsLifecycleStateUpdating ListTranslatorsLifecycleStateEnum = "UPDATING"
ListTranslatorsLifecycleStateActive ListTranslatorsLifecycleStateEnum = "ACTIVE"
ListTranslatorsLifecycleStateInactive ListTranslatorsLifecycleStateEnum = "INACTIVE"
ListTranslatorsLifecycleStateDeleting ListTranslatorsLifecycleStateEnum = "DELETING"
ListTranslatorsLifecycleStateDeleted ListTranslatorsLifecycleStateEnum = "DELETED"
ListTranslatorsLifecycleStateFailed ListTranslatorsLifecycleStateEnum = "FAILED"
)
func GetListTranslatorsLifecycleStateEnumValues() []ListTranslatorsLifecycleStateEnum
GetListTranslatorsLifecycleStateEnumValues Enumerates the set of values for ListTranslatorsLifecycleStateEnum
func GetMappingListTranslatorsLifecycleStateEnum(val string) (ListTranslatorsLifecycleStateEnum, bool)
GetMappingListTranslatorsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranslatorsRequest wrapper for the ListTranslators operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListTranslators.go.html to see an example of how to use ListTranslatorsRequest.
type ListTranslatorsRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Translator identifier.
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// List only Translators of this type.
Type ListTranslatorsTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`
// List only Translators with this name. Translator names are unique and may not change.
// Example: `MyTranslator`
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// List only the resources that are in this lifecycle state.
LifecycleState ListTranslatorsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListTranslatorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Sort on this field. You can specify one sort order only. The default sort field is `timeCreated`.
// The default sort order for `timeCreated` and `timeUpdated` is descending.
// For all other sort fields the default sort order is ascending.
SortBy ListTranslatorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// 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 ListTranslatorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListTranslatorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListTranslatorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListTranslatorsRequest) String() string
func (request ListTranslatorsRequest) 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
ListTranslatorsResponse wrapper for the ListTranslators operation
type ListTranslatorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of TranslatorCollection instances
TranslatorCollection `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListTranslatorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListTranslatorsResponse) String() string
ListTranslatorsSortByEnum Enum with underlying type: string
type ListTranslatorsSortByEnum string
Set of constants representing the allowable values for ListTranslatorsSortByEnum
const (
ListTranslatorsSortByTimecreated ListTranslatorsSortByEnum = "timeCreated"
ListTranslatorsSortByTimeupdated ListTranslatorsSortByEnum = "timeUpdated"
ListTranslatorsSortByName ListTranslatorsSortByEnum = "name"
ListTranslatorsSortByType ListTranslatorsSortByEnum = "type"
)
func GetListTranslatorsSortByEnumValues() []ListTranslatorsSortByEnum
GetListTranslatorsSortByEnumValues Enumerates the set of values for ListTranslatorsSortByEnum
func GetMappingListTranslatorsSortByEnum(val string) (ListTranslatorsSortByEnum, bool)
GetMappingListTranslatorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranslatorsSortOrderEnum Enum with underlying type: string
type ListTranslatorsSortOrderEnum string
Set of constants representing the allowable values for ListTranslatorsSortOrderEnum
const (
ListTranslatorsSortOrderAsc ListTranslatorsSortOrderEnum = "ASC"
ListTranslatorsSortOrderDesc ListTranslatorsSortOrderEnum = "DESC"
)
func GetListTranslatorsSortOrderEnumValues() []ListTranslatorsSortOrderEnum
GetListTranslatorsSortOrderEnumValues Enumerates the set of values for ListTranslatorsSortOrderEnum
func GetMappingListTranslatorsSortOrderEnum(val string) (ListTranslatorsSortOrderEnum, bool)
GetMappingListTranslatorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListTranslatorsTypeEnum Enum with underlying type: string
type ListTranslatorsTypeEnum string
Set of constants representing the allowable values for ListTranslatorsTypeEnum
const (
ListTranslatorsTypeGoogle ListTranslatorsTypeEnum = "GOOGLE"
ListTranslatorsTypeMicrosoft ListTranslatorsTypeEnum = "MICROSOFT"
)
func GetListTranslatorsTypeEnumValues() []ListTranslatorsTypeEnum
GetListTranslatorsTypeEnumValues Enumerates the set of values for ListTranslatorsTypeEnum
func GetMappingListTranslatorsTypeEnum(val string) (ListTranslatorsTypeEnum, bool)
GetMappingListTranslatorsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The identifier of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.
// The default sort order for both `TIMESTAMP` and `CODE` is ascending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) 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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByCode ListWorkRequestErrorsSortByEnum = "CODE"
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "TIMESTAMP"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The identifier of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// 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"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.
// The default sort order for both `TIMESTAMP` and `MESSAGE` is ascending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) 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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByMessage ListWorkRequestLogsSortByEnum = "MESSAGE"
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "TIMESTAMP"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// List the Digital Assistant instances that belong to this compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// 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"`
// List only the information for this Digital Assistant instance.
OdaInstanceId *string `mandatory:"false" contributesTo:"query" name:"odaInstanceId"`
// List only the information for this resource.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// The page at which to start retrieving results.
// You get this value from the `opc-next-page` header in a previous list request.
// To retireve the first page, omit this query parameter.
// Example: `MToxMA==`
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return per page.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIME_ACCEPTED`.
// The default sort order for the time fields is descending. The default order for `DISPLAYNAME` and `STATUS` is ascending.default: TIME_ACCEPTED
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// 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 ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) 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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `presentIn:"body"`
// 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"`
// When you are paging through a list, if this header appears in the response,
// then there might be additional items still to get. Include this value as the
// `page` query parameter for the subsequent GET request.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// The total number of results that match the query.
OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE"
ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "STATUS"
ListWorkRequestsSortByTimeAccepted ListWorkRequestsSortByEnum = "TIME_ACCEPTED"
ListWorkRequestsSortByTimeStarted ListWorkRequestsSortByEnum = "TIME_STARTED"
ListWorkRequestsSortByTimeFinished ListWorkRequestsSortByEnum = "TIME_FINISHED"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ManagementClient a client for Management
type ManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ManagementClient, err error)
NewManagementClientWithConfigurationProvider Creates a new default Management client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ManagementClient, err error)
NewManagementClientWithOboToken Creates a new default Management client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client ManagementClient) BulkCreateSkillEntities(ctx context.Context, request BulkCreateSkillEntitiesRequest) (response BulkCreateSkillEntitiesResponse, err error)
BulkCreateSkillEntities Bulk create composite and value list entities into a skill.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/BulkCreateSkillEntities.go.html to see an example of how to use BulkCreateSkillEntities API. A default retry strategy applies to this operation BulkCreateSkillEntities()
func (client ManagementClient) CascadingDeleteSkillCustomEntities(ctx context.Context, request CascadingDeleteSkillCustomEntitiesRequest) (response CascadingDeleteSkillCustomEntitiesResponse, err error)
CascadingDeleteSkillCustomEntities Cascading delete of the custom entities in a skill.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CascadingDeleteSkillCustomEntities.go.html to see an example of how to use CascadingDeleteSkillCustomEntities API. A default retry strategy applies to this operation CascadingDeleteSkillCustomEntities()
func (client ManagementClient) ChangeOdaPrivateEndpointCompartment(ctx context.Context, request ChangeOdaPrivateEndpointCompartmentRequest) (response ChangeOdaPrivateEndpointCompartmentResponse, err error)
ChangeOdaPrivateEndpointCompartment Starts an asynchronous job to move the specified ODA Private Endpoint into a different compartment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ChangeOdaPrivateEndpointCompartment.go.html to see an example of how to use ChangeOdaPrivateEndpointCompartment API. A default retry strategy applies to this operation ChangeOdaPrivateEndpointCompartment()
func (client *ManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ManagementClient) ConfigureDigitalAssistantParameters(ctx context.Context, request ConfigureDigitalAssistantParametersRequest) (response ConfigureDigitalAssistantParametersResponse, err error)
ConfigureDigitalAssistantParameters This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ConfigureDigitalAssistantParameters.go.html to see an example of how to use ConfigureDigitalAssistantParameters API. A default retry strategy applies to this operation ConfigureDigitalAssistantParameters()
func (client ManagementClient) CreateAuthenticationProvider(ctx context.Context, request CreateAuthenticationProviderRequest) (response CreateAuthenticationProviderResponse, err error)
CreateAuthenticationProvider Creates a new Authentication Provider
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateAuthenticationProvider.go.html to see an example of how to use CreateAuthenticationProvider API. A default retry strategy applies to this operation CreateAuthenticationProvider()
func (client ManagementClient) CreateChannel(ctx context.Context, request CreateChannelRequest) (response CreateChannelResponse, err error)
CreateChannel Creates a new Channel.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateChannel.go.html to see an example of how to use CreateChannel API. A default retry strategy applies to this operation CreateChannel()
func (client ManagementClient) CreateDigitalAssistant(ctx context.Context, request CreateDigitalAssistantRequest) (response CreateDigitalAssistantResponse, err error)
CreateDigitalAssistant Creates a new Digital Assistant.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateDigitalAssistant.go.html to see an example of how to use CreateDigitalAssistant API. A default retry strategy applies to this operation CreateDigitalAssistant()
func (client ManagementClient) CreateOdaPrivateEndpoint(ctx context.Context, request CreateOdaPrivateEndpointRequest) (response CreateOdaPrivateEndpointResponse, err error)
CreateOdaPrivateEndpoint Starts an asynchronous job to create an ODA Private Endpoint. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpoint.go.html to see an example of how to use CreateOdaPrivateEndpoint API. A default retry strategy applies to this operation CreateOdaPrivateEndpoint()
func (client ManagementClient) CreateOdaPrivateEndpointAttachment(ctx context.Context, request CreateOdaPrivateEndpointAttachmentRequest) (response CreateOdaPrivateEndpointAttachmentResponse, err error)
CreateOdaPrivateEndpointAttachment Starts an asynchronous job to create an ODA Private Endpoint Attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpointAttachment.go.html to see an example of how to use CreateOdaPrivateEndpointAttachment API. A default retry strategy applies to this operation CreateOdaPrivateEndpointAttachment()
func (client ManagementClient) CreateOdaPrivateEndpointScanProxy(ctx context.Context, request CreateOdaPrivateEndpointScanProxyRequest) (response CreateOdaPrivateEndpointScanProxyResponse, err error)
CreateOdaPrivateEndpointScanProxy Starts an asynchronous job to create an ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpointScanProxy.go.html to see an example of how to use CreateOdaPrivateEndpointScanProxy API. A default retry strategy applies to this operation CreateOdaPrivateEndpointScanProxy()
func (client ManagementClient) CreateSkill(ctx context.Context, request CreateSkillRequest) (response CreateSkillResponse, err error)
CreateSkill Creates a new Skill from scratch.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateSkill.go.html to see an example of how to use CreateSkill API. A default retry strategy applies to this operation CreateSkill()
func (client ManagementClient) CreateSkillParameter(ctx context.Context, request CreateSkillParameterRequest) (response CreateSkillParameterResponse, err error)
CreateSkillParameter Creates a new Skill Parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateSkillParameter.go.html to see an example of how to use CreateSkillParameter API. A default retry strategy applies to this operation CreateSkillParameter()
func (client ManagementClient) CreateTranslator(ctx context.Context, request CreateTranslatorRequest) (response CreateTranslatorResponse, err error)
CreateTranslator Creates a new Translator
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateTranslator.go.html to see an example of how to use CreateTranslator API. A default retry strategy applies to this operation CreateTranslator()
func (client ManagementClient) DeleteAuthenticationProvider(ctx context.Context, request DeleteAuthenticationProviderRequest) (response DeleteAuthenticationProviderResponse, err error)
DeleteAuthenticationProvider Delete the specified Authentication Provider.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteAuthenticationProvider.go.html to see an example of how to use DeleteAuthenticationProvider API. A default retry strategy applies to this operation DeleteAuthenticationProvider()
func (client ManagementClient) DeleteChannel(ctx context.Context, request DeleteChannelRequest) (response DeleteChannelResponse, err error)
DeleteChannel Delete the specified Channel.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteChannel.go.html to see an example of how to use DeleteChannel API. A default retry strategy applies to this operation DeleteChannel()
func (client ManagementClient) DeleteDigitalAssistant(ctx context.Context, request DeleteDigitalAssistantRequest) (response DeleteDigitalAssistantResponse, err error)
DeleteDigitalAssistant Delete the specified Digital Assistant.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteDigitalAssistant.go.html to see an example of how to use DeleteDigitalAssistant API. A default retry strategy applies to this operation DeleteDigitalAssistant()
func (client ManagementClient) DeleteOdaPrivateEndpoint(ctx context.Context, request DeleteOdaPrivateEndpointRequest) (response DeleteOdaPrivateEndpointResponse, err error)
DeleteOdaPrivateEndpoint Starts an asynchronous job to delete the specified ODA Private Endpoint. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpoint.go.html to see an example of how to use DeleteOdaPrivateEndpoint API. A default retry strategy applies to this operation DeleteOdaPrivateEndpoint()
func (client ManagementClient) DeleteOdaPrivateEndpointAttachment(ctx context.Context, request DeleteOdaPrivateEndpointAttachmentRequest) (response DeleteOdaPrivateEndpointAttachmentResponse, err error)
DeleteOdaPrivateEndpointAttachment Starts an asynchronous job to delete the specified ODA Private Endpoint Attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointAttachment.go.html to see an example of how to use DeleteOdaPrivateEndpointAttachment API. A default retry strategy applies to this operation DeleteOdaPrivateEndpointAttachment()
func (client ManagementClient) DeleteOdaPrivateEndpointScanProxy(ctx context.Context, request DeleteOdaPrivateEndpointScanProxyRequest) (response DeleteOdaPrivateEndpointScanProxyResponse, err error)
DeleteOdaPrivateEndpointScanProxy Starts an asynchronous job to delete the specified ODA Private Endpoint Scan Proxy. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointScanProxy.go.html to see an example of how to use DeleteOdaPrivateEndpointScanProxy API. A default retry strategy applies to this operation DeleteOdaPrivateEndpointScanProxy()
func (client ManagementClient) DeleteSkill(ctx context.Context, request DeleteSkillRequest) (response DeleteSkillResponse, err error)
DeleteSkill Delete the specified Skill.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkill.go.html to see an example of how to use DeleteSkill API. A default retry strategy applies to this operation DeleteSkill()
func (client ManagementClient) DeleteSkillParameter(ctx context.Context, request DeleteSkillParameterRequest) (response DeleteSkillParameterResponse, err error)
DeleteSkillParameter Delete the specified Skill Parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkillParameter.go.html to see an example of how to use DeleteSkillParameter API. A default retry strategy applies to this operation DeleteSkillParameter()
func (client ManagementClient) DeleteTranslator(ctx context.Context, request DeleteTranslatorRequest) (response DeleteTranslatorResponse, err error)
DeleteTranslator Delete the specified Translator.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteTranslator.go.html to see an example of how to use DeleteTranslator API. A default retry strategy applies to this operation DeleteTranslator()
func (client ManagementClient) ExportDigitalAssistant(ctx context.Context, request ExportDigitalAssistantRequest) (response ExportDigitalAssistantResponse, err error)
ExportDigitalAssistant Exports the specified Digital Assistant as an archive to Object Storage.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportDigitalAssistant.go.html to see an example of how to use ExportDigitalAssistant API. A default retry strategy applies to this operation ExportDigitalAssistant()
func (client ManagementClient) ExportSkill(ctx context.Context, request ExportSkillRequest) (response ExportSkillResponse, err error)
ExportSkill Exports the specified Skill as an archive to Object Storage.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportSkill.go.html to see an example of how to use ExportSkill API. A default retry strategy applies to this operation ExportSkill()
func (client ManagementClient) GetAuthenticationProvider(ctx context.Context, request GetAuthenticationProviderRequest) (response GetAuthenticationProviderResponse, err error)
GetAuthenticationProvider Gets the specified Authentication Provider.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetAuthenticationProvider.go.html to see an example of how to use GetAuthenticationProvider API. A default retry strategy applies to this operation GetAuthenticationProvider()
func (client ManagementClient) GetChannel(ctx context.Context, request GetChannelRequest) (response GetChannelResponse, err error)
GetChannel Gets the specified Channel.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetChannel.go.html to see an example of how to use GetChannel API. A default retry strategy applies to this operation GetChannel()
func (client ManagementClient) GetDigitalAssistant(ctx context.Context, request GetDigitalAssistantRequest) (response GetDigitalAssistantResponse, err error)
GetDigitalAssistant Gets the specified Digital Assistant.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistant.go.html to see an example of how to use GetDigitalAssistant API. A default retry strategy applies to this operation GetDigitalAssistant()
func (client ManagementClient) GetDigitalAssistantParameter(ctx context.Context, request GetDigitalAssistantParameterRequest) (response GetDigitalAssistantParameterResponse, err error)
GetDigitalAssistantParameter Gets the specified Digital Assistant Parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistantParameter.go.html to see an example of how to use GetDigitalAssistantParameter API. A default retry strategy applies to this operation GetDigitalAssistantParameter()
func (client ManagementClient) GetOdaPrivateEndpoint(ctx context.Context, request GetOdaPrivateEndpointRequest) (response GetOdaPrivateEndpointResponse, err error)
GetOdaPrivateEndpoint Gets the specified ODA Private Endpoint.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpoint.go.html to see an example of how to use GetOdaPrivateEndpoint API. A default retry strategy applies to this operation GetOdaPrivateEndpoint()
func (client ManagementClient) GetOdaPrivateEndpointAttachment(ctx context.Context, request GetOdaPrivateEndpointAttachmentRequest) (response GetOdaPrivateEndpointAttachmentResponse, err error)
GetOdaPrivateEndpointAttachment Gets the specified ODA Private Endpoint Attachment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointAttachment.go.html to see an example of how to use GetOdaPrivateEndpointAttachment API. A default retry strategy applies to this operation GetOdaPrivateEndpointAttachment()
func (client ManagementClient) GetOdaPrivateEndpointScanProxy(ctx context.Context, request GetOdaPrivateEndpointScanProxyRequest) (response GetOdaPrivateEndpointScanProxyResponse, err error)
GetOdaPrivateEndpointScanProxy Gets the specified ODA Private Endpoint Scan Proxy.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointScanProxy.go.html to see an example of how to use GetOdaPrivateEndpointScanProxy API. A default retry strategy applies to this operation GetOdaPrivateEndpointScanProxy()
func (client ManagementClient) GetSkill(ctx context.Context, request GetSkillRequest) (response GetSkillResponse, err error)
GetSkill Gets the specified Skill.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkill.go.html to see an example of how to use GetSkill API. A default retry strategy applies to this operation GetSkill()
func (client ManagementClient) GetSkillParameter(ctx context.Context, request GetSkillParameterRequest) (response GetSkillParameterResponse, err error)
GetSkillParameter Gets the specified Skill Parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkillParameter.go.html to see an example of how to use GetSkillParameter API. A default retry strategy applies to this operation GetSkillParameter()
func (client ManagementClient) GetTranslator(ctx context.Context, request GetTranslatorRequest) (response GetTranslatorResponse, err error)
GetTranslator Gets the specified Translator.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetTranslator.go.html to see an example of how to use GetTranslator API. A default retry strategy applies to this operation GetTranslator()
func (client ManagementClient) ImportBot(ctx context.Context, request ImportBotRequest) (response ImportBotResponse, err error)
ImportBot Import a Bot archive from Object Storage.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ImportBot.go.html to see an example of how to use ImportBot API. A default retry strategy applies to this operation ImportBot()
func (client ManagementClient) ListAuthenticationProviders(ctx context.Context, request ListAuthenticationProvidersRequest) (response ListAuthenticationProvidersResponse, err error)
ListAuthenticationProviders Returns a page of Authentication Providers that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListAuthenticationProviders.go.html to see an example of how to use ListAuthenticationProviders API. A default retry strategy applies to this operation ListAuthenticationProviders()
func (client ManagementClient) ListChannels(ctx context.Context, request ListChannelsRequest) (response ListChannelsResponse, err error)
ListChannels Returns a page of Channels that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListChannels.go.html to see an example of how to use ListChannels API. A default retry strategy applies to this operation ListChannels()
func (client ManagementClient) ListDigitalAssistantParameters(ctx context.Context, request ListDigitalAssistantParametersRequest) (response ListDigitalAssistantParametersResponse, err error)
ListDigitalAssistantParameters Returns a page of Parameters that belong to the specified Digital Assistant. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistantParameters.go.html to see an example of how to use ListDigitalAssistantParameters API. A default retry strategy applies to this operation ListDigitalAssistantParameters()
func (client ManagementClient) ListDigitalAssistants(ctx context.Context, request ListDigitalAssistantsRequest) (response ListDigitalAssistantsResponse, err error)
ListDigitalAssistants Returns a page of Digital Assistants that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistants.go.html to see an example of how to use ListDigitalAssistants API. A default retry strategy applies to this operation ListDigitalAssistants()
func (client ManagementClient) ListOdaPrivateEndpointAttachments(ctx context.Context, request ListOdaPrivateEndpointAttachmentsRequest) (response ListOdaPrivateEndpointAttachmentsResponse, err error)
ListOdaPrivateEndpointAttachments Returns a page of ODA Instances attached to this ODA Private Endpoint. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointAttachments.go.html to see an example of how to use ListOdaPrivateEndpointAttachments API. A default retry strategy applies to this operation ListOdaPrivateEndpointAttachments()
func (client ManagementClient) ListOdaPrivateEndpointScanProxies(ctx context.Context, request ListOdaPrivateEndpointScanProxiesRequest) (response ListOdaPrivateEndpointScanProxiesResponse, err error)
ListOdaPrivateEndpointScanProxies Returns a page of ODA Private Endpoint Scan Proxies that belong to the specified ODA Private Endpoint. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointScanProxies.go.html to see an example of how to use ListOdaPrivateEndpointScanProxies API. A default retry strategy applies to this operation ListOdaPrivateEndpointScanProxies()
func (client ManagementClient) ListOdaPrivateEndpoints(ctx context.Context, request ListOdaPrivateEndpointsRequest) (response ListOdaPrivateEndpointsResponse, err error)
ListOdaPrivateEndpoints Returns a page of ODA Private Endpoints that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpoints.go.html to see an example of how to use ListOdaPrivateEndpoints API. A default retry strategy applies to this operation ListOdaPrivateEndpoints()
func (client ManagementClient) ListSkillParameters(ctx context.Context, request ListSkillParametersRequest) (response ListSkillParametersResponse, err error)
ListSkillParameters Returns a page of Skill Parameters that belong to the specified Skill. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkillParameters.go.html to see an example of how to use ListSkillParameters API. A default retry strategy applies to this operation ListSkillParameters()
func (client ManagementClient) ListSkills(ctx context.Context, request ListSkillsRequest) (response ListSkillsResponse, err error)
ListSkills Returns a page of Skills that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkills.go.html to see an example of how to use ListSkills API. A default retry strategy applies to this operation ListSkills()
func (client ManagementClient) ListTranslators(ctx context.Context, request ListTranslatorsRequest) (response ListTranslatorsResponse, err error)
ListTranslators Returns a page of Translators that belong to the specified Digital Assistant instance. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListTranslators.go.html to see an example of how to use ListTranslators API. A default retry strategy applies to this operation ListTranslators()
func (client ManagementClient) PublishDigitalAssistant(ctx context.Context, request PublishDigitalAssistantRequest) (response PublishDigitalAssistantResponse, err error)
PublishDigitalAssistant Publish a draft Digital Assistant. Once published the Digital Assistant cannot be modified.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishDigitalAssistant.go.html to see an example of how to use PublishDigitalAssistant API. A default retry strategy applies to this operation PublishDigitalAssistant()
func (client ManagementClient) PublishSkill(ctx context.Context, request PublishSkillRequest) (response PublishSkillResponse, err error)
PublishSkill Publish a draft Skill. Once published it cannot be modified.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishSkill.go.html to see an example of how to use PublishSkill API. A default retry strategy applies to this operation PublishSkill()
func (client ManagementClient) RotateChannelKeys(ctx context.Context, request RotateChannelKeysRequest) (response RotateChannelKeysResponse, err error)
RotateChannelKeys This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken). If a Channel has no generated keys then no changes will be made. Ensure that you take note of the newly generated keys in the response as they will not be returned again.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/RotateChannelKeys.go.html to see an example of how to use RotateChannelKeys API. A default retry strategy applies to this operation RotateChannelKeys()
func (client *ManagementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ManagementClient) StartChannel(ctx context.Context, request StartChannelRequest) (response StartChannelResponse, err error)
StartChannel Starts a Channel so that it will begin accepting messages.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartChannel.go.html to see an example of how to use StartChannel API. A default retry strategy applies to this operation StartChannel()
func (client ManagementClient) StopChannel(ctx context.Context, request StopChannelRequest) (response StopChannelResponse, err error)
StopChannel Stops a Channel so that it will no longer accept messages.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopChannel.go.html to see an example of how to use StopChannel API. A default retry strategy applies to this operation StopChannel()
func (client ManagementClient) TrainSkill(ctx context.Context, request TrainSkillRequest) (response TrainSkillResponse, err error)
TrainSkill Train a skill.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/TrainSkill.go.html to see an example of how to use TrainSkill API. A default retry strategy applies to this operation TrainSkill()
func (client ManagementClient) UpdateAuthenticationProvider(ctx context.Context, request UpdateAuthenticationProviderRequest) (response UpdateAuthenticationProviderResponse, err error)
UpdateAuthenticationProvider Updates the specified Authentication Provider with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateAuthenticationProvider.go.html to see an example of how to use UpdateAuthenticationProvider API. A default retry strategy applies to this operation UpdateAuthenticationProvider()
func (client ManagementClient) UpdateChannel(ctx context.Context, request UpdateChannelRequest) (response UpdateChannelResponse, err error)
UpdateChannel Updates the specified Channel with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateChannel.go.html to see an example of how to use UpdateChannel API. A default retry strategy applies to this operation UpdateChannel()
func (client ManagementClient) UpdateDigitalAssistant(ctx context.Context, request UpdateDigitalAssistantRequest) (response UpdateDigitalAssistantResponse, err error)
UpdateDigitalAssistant Updates the specified Digital Assistant with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistant.go.html to see an example of how to use UpdateDigitalAssistant API. A default retry strategy applies to this operation UpdateDigitalAssistant()
func (client ManagementClient) UpdateDigitalAssistantParameter(ctx context.Context, request UpdateDigitalAssistantParameterRequest) (response UpdateDigitalAssistantParameterResponse, err error)
UpdateDigitalAssistantParameter Updates the specified Digital Assistant Parameter with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistantParameter.go.html to see an example of how to use UpdateDigitalAssistantParameter API. A default retry strategy applies to this operation UpdateDigitalAssistantParameter()
func (client ManagementClient) UpdateOdaPrivateEndpoint(ctx context.Context, request UpdateOdaPrivateEndpointRequest) (response UpdateOdaPrivateEndpointResponse, err error)
UpdateOdaPrivateEndpoint Starts an asynchronous job to update the specified ODA Private Endpoint with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaPrivateEndpoint.go.html to see an example of how to use UpdateOdaPrivateEndpoint API. A default retry strategy applies to this operation UpdateOdaPrivateEndpoint()
func (client ManagementClient) UpdateSkill(ctx context.Context, request UpdateSkillRequest) (response UpdateSkillResponse, err error)
UpdateSkill Updates the specified Skill with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkill.go.html to see an example of how to use UpdateSkill API. A default retry strategy applies to this operation UpdateSkill()
func (client ManagementClient) UpdateSkillParameter(ctx context.Context, request UpdateSkillParameterRequest) (response UpdateSkillParameterResponse, err error)
UpdateSkillParameter Updates the specified Skill Parameter with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkillParameter.go.html to see an example of how to use UpdateSkillParameter API. A default retry strategy applies to this operation UpdateSkillParameter()
func (client ManagementClient) UpdateTranslator(ctx context.Context, request UpdateTranslatorRequest) (response UpdateTranslatorResponse, err error)
UpdateTranslator Updates the specified Translator with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateTranslator.go.html to see an example of how to use UpdateTranslator API. A default retry strategy applies to this operation UpdateTranslator()
MetadataProperty Property to describe and object.
type MetadataProperty struct {
// Name of property.
Name *string `mandatory:"true" json:"name"`
// Value for the property.
Value *string `mandatory:"true" json:"value"`
}
func (m MetadataProperty) String() string
func (m MetadataProperty) 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
ModelPackage Details of `Package` object.
type ModelPackage struct {
// Unique immutable identifier that was assigned when the Package was registered.
Id *string `mandatory:"true" json:"id"`
// ID of the publisher providing the package.
PublisherId *string `mandatory:"true" json:"publisherId"`
// Name of package.
Name *string `mandatory:"true" json:"name"`
// Display name for the package (displayed in UI and user-facing applications).
DisplayName *string `mandatory:"true" json:"displayName"`
// Version of the package.
Version *string `mandatory:"true" json:"version"`
// When the package was uploaded. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUploaded *common.SDKTime `mandatory:"true" json:"timeUploaded"`
// When the package was last published. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimePublished *common.SDKTime `mandatory:"true" json:"timePublished"`
// Description of the package.
Description *string `mandatory:"true" json:"description"`
// A list of resource types describing the content of the package.
ResourceTypes []string `mandatory:"true" json:"resourceTypes"`
// A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type.
ResourceTypesMetadata []ResourceTypeMetadata `mandatory:"true" json:"resourceTypesMetadata"`
// A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used.
PublisherMetadata []MetadataProperty `mandatory:"true" json:"publisherMetadata"`
ImportContract *ImportContract `mandatory:"true" json:"importContract"`
DefaultParameterValues *DefaultParameterValues `mandatory:"true" json:"defaultParameterValues"`
// 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 ModelPackage) String() string
func (m ModelPackage) 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
MsTeamsChannel The configuration for an MS Teams channel.
type MsTeamsChannel 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 MsTeamsChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m MsTeamsChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m MsTeamsChannel) GetDescription() *string
GetDescription returns Description
func (m MsTeamsChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m MsTeamsChannel) GetId() *string
GetId returns Id
func (m MsTeamsChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m MsTeamsChannel) GetName() *string
GetName returns Name
func (m MsTeamsChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m MsTeamsChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m MsTeamsChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m MsTeamsChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m MsTeamsChannel) String() string
func (m MsTeamsChannel) 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
NameMapping A language name mapping.
type NameMapping struct {
// Name of mapping.
Name *string `mandatory:"true" json:"name"`
}
func (m NameMapping) String() string
func (m NameMapping) 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
OdaClient a client for Oda
type OdaClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOdaClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OdaClient, err error)
NewOdaClientWithConfigurationProvider Creates a new default Oda client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOdaClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OdaClient, err error)
NewOdaClientWithOboToken Creates a new default Oda client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client OdaClient) ChangeOdaInstanceCompartment(ctx context.Context, request ChangeOdaInstanceCompartmentRequest) (response ChangeOdaInstanceCompartmentResponse, err error)
ChangeOdaInstanceCompartment Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ChangeOdaInstanceCompartment.go.html to see an example of how to use ChangeOdaInstanceCompartment API. A default retry strategy applies to this operation ChangeOdaInstanceCompartment()
func (client *OdaClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OdaClient) CreateOdaInstance(ctx context.Context, request CreateOdaInstanceRequest) (response CreateOdaInstanceResponse, err error)
CreateOdaInstance Starts an asynchronous job to create a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaInstance.go.html to see an example of how to use CreateOdaInstance API. A default retry strategy applies to this operation CreateOdaInstance()
func (client OdaClient) CreateOdaInstanceAttachment(ctx context.Context, request CreateOdaInstanceAttachmentRequest) (response CreateOdaInstanceAttachmentResponse, err error)
CreateOdaInstanceAttachment Starts an asynchronous job to create a Digital Assistant instance attachment. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaInstanceAttachment.go.html to see an example of how to use CreateOdaInstanceAttachment API. A default retry strategy applies to this operation CreateOdaInstanceAttachment()
func (client OdaClient) DeleteOdaInstance(ctx context.Context, request DeleteOdaInstanceRequest) (response DeleteOdaInstanceResponse, err error)
DeleteOdaInstance Starts an asynchronous job to delete the specified Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstance.go.html to see an example of how to use DeleteOdaInstance API. A default retry strategy applies to this operation DeleteOdaInstance()
func (client OdaClient) DeleteOdaInstanceAttachment(ctx context.Context, request DeleteOdaInstanceAttachmentRequest) (response DeleteOdaInstanceAttachmentResponse, err error)
DeleteOdaInstanceAttachment Starts an asynchronous job to delete the specified Digital Assistant instance attachment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstanceAttachment.go.html to see an example of how to use DeleteOdaInstanceAttachment API. A default retry strategy applies to this operation DeleteOdaInstanceAttachment()
func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)
GetOdaInstance Gets the specified Digital Assistant instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstance.go.html to see an example of how to use GetOdaInstance API. A default retry strategy applies to this operation GetOdaInstance()
func (client OdaClient) GetOdaInstanceAttachment(ctx context.Context, request GetOdaInstanceAttachmentRequest) (response GetOdaInstanceAttachmentResponse, err error)
GetOdaInstanceAttachment Gets an ODA instance attachment by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstanceAttachment.go.html to see an example of how to use GetOdaInstanceAttachment API. A default retry strategy applies to this operation GetOdaInstanceAttachment()
func (client OdaClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client OdaClient) ListOdaInstanceAttachments(ctx context.Context, request ListOdaInstanceAttachmentsRequest) (response ListOdaInstanceAttachmentsResponse, err error)
ListOdaInstanceAttachments Returns a list of ODA instance attachments
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstanceAttachments.go.html to see an example of how to use ListOdaInstanceAttachments API. A default retry strategy applies to this operation ListOdaInstanceAttachments()
func (client OdaClient) ListOdaInstances(ctx context.Context, request ListOdaInstancesRequest) (response ListOdaInstancesResponse, err error)
ListOdaInstances Returns a page of Digital Assistant instances that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstances.go.html to see an example of how to use ListOdaInstances API. A default retry strategy applies to this operation ListOdaInstances()
func (client OdaClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a page of errors for the specified work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client OdaClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a page of of log messages for a given work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client OdaClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Returns a page of work requests for the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *OdaClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OdaClient) StartOdaInstance(ctx context.Context, request StartOdaInstanceRequest) (response StartOdaInstanceResponse, err error)
StartOdaInstance Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartOdaInstance.go.html to see an example of how to use StartOdaInstance API. A default retry strategy applies to this operation StartOdaInstance()
func (client OdaClient) StopOdaInstance(ctx context.Context, request StopOdaInstanceRequest) (response StopOdaInstanceResponse, err error)
StopOdaInstance Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopOdaInstance.go.html to see an example of how to use StopOdaInstance API. A default retry strategy applies to this operation StopOdaInstance()
func (client OdaClient) UpdateOdaInstance(ctx context.Context, request UpdateOdaInstanceRequest) (response UpdateOdaInstanceResponse, err error)
UpdateOdaInstance Updates the specified Digital Assistant instance with the information in the request body.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstance.go.html to see an example of how to use UpdateOdaInstance API. A default retry strategy applies to this operation UpdateOdaInstance()
func (client OdaClient) UpdateOdaInstanceAttachment(ctx context.Context, request UpdateOdaInstanceAttachmentRequest) (response UpdateOdaInstanceAttachmentResponse, err error)
UpdateOdaInstanceAttachment Updates the ODA instance attachment
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstanceAttachment.go.html to see an example of how to use UpdateOdaInstanceAttachment API. A default retry strategy applies to this operation UpdateOdaInstanceAttachment()
OdaInstance Description of `OdaServiceInstance` object.
type OdaInstance struct {
// Unique immutable identifier that was assigned when the instance was created.
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment that the instance belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// Shape or size of the instance.
ShapeName OdaInstanceShapeNameEnum `mandatory:"true" json:"shapeName"`
// User-defined name for the Digital Assistant instance. Avoid entering confidential information.
// You can change this value.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the Digital Assistant instance.
Description *string `mandatory:"false" json:"description"`
// URL for the Digital Assistant web application that's associated with the instance.
WebAppUrl *string `mandatory:"false" json:"webAppUrl"`
// URL for the connector's endpoint.
ConnectorUrl *string `mandatory:"false" json:"connectorUrl"`
// When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current state of the Digital Assistant instance.
LifecycleState OdaInstanceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// The current sub-state of the Digital Assistant instance.
LifecycleSubState OdaInstanceLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// A message that describes the current state in more detail.
// For example, actionable information about an instance that's in the `FAILED` state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
IsRoleBasedAccess *bool `mandatory:"false" json:"isRoleBasedAccess"`
// If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
IdentityDomain *string `mandatory:"false" json:"identityDomain"`
// If isRoleBasedAccess is set to true, this property specifies the GUID of the Identity Application instance Digital Assistant has created inside the user-specified identity domain. This identity application instance may be used to host user roll mappings to grant access to this Digital Assistant instance for users within the identity domain.
IdentityAppGuid *string `mandatory:"false" json:"identityAppGuid"`
// If isRoleBasedAccess is set to true, this property specifies the URL for the administration console used to manage the Identity Application instance Digital Assistant has created inside the user-specified identity domain.
IdentityAppConsoleUrl *string `mandatory:"false" json:"identityAppConsoleUrl"`
// A list of package names imported into this instance (if any). Use importedPackageIds field to get the details of the imported packages.
ImportedPackageNames []string `mandatory:"false" json:"importedPackageNames"`
// A list of package ids imported into this instance (if any). Use GetImportedPackage to get the details of the imported packages.
ImportedPackageIds []string `mandatory:"false" json:"importedPackageIds"`
// A list of attachment types for this instance (if any). Use attachmentIds to get the details of the attachments.
AttachmentTypes []string `mandatory:"false" json:"attachmentTypes"`
// A list of attachment identifiers for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
AttachmentIds []string `mandatory:"false" json:"attachmentIds"`
// A list of restricted operations (across all attachments) for this instance (if any). Use GetOdaInstanceAttachment to get the details of the attachments.
RestrictedOperations []RestrictedOperation `mandatory:"false" json:"restrictedOperations"`
}
func (m OdaInstance) String() string
func (m OdaInstance) 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
OdaInstanceAttachment Description of an ODA instance attachment.
type OdaInstanceAttachment struct {
// Unique immutable identifier that was assigned when the ODA instance attachment was created.
Id *string `mandatory:"true" json:"id"`
// The OCID of the ODA instance to which the attachment applies.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached.
AttachToId *string `mandatory:"true" json:"attachToId"`
// The type of attachment defined as an enum.
AttachmentType OdaInstanceAttachmentAttachmentTypeEnum `mandatory:"true" json:"attachmentType"`
// The current state of the attachment.
LifecycleState OdaInstanceAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Attachment-specific metadata, defined by the target service.
AttachmentMetadata *string `mandatory:"false" json:"attachmentMetadata"`
// List of operation names that are restricted while this ODA instance is attached.
RestrictedOperations []string `mandatory:"false" json:"restrictedOperations"`
Owner *OdaInstanceOwner `mandatory:"false" json:"owner"`
// The time the attachment was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the attachment was last modified. An RFC3339 formatted datetime string
TimeLastUpdate *common.SDKTime `mandatory:"false" json:"timeLastUpdate"`
// 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 OdaInstanceAttachment) String() string
func (m OdaInstanceAttachment) 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
OdaInstanceAttachmentAttachmentTypeEnum Enum with underlying type: string
type OdaInstanceAttachmentAttachmentTypeEnum string
Set of constants representing the allowable values for OdaInstanceAttachmentAttachmentTypeEnum
const (
OdaInstanceAttachmentAttachmentTypeFusion OdaInstanceAttachmentAttachmentTypeEnum = "FUSION"
OdaInstanceAttachmentAttachmentTypeMax OdaInstanceAttachmentAttachmentTypeEnum = "MAX"
)
func GetMappingOdaInstanceAttachmentAttachmentTypeEnum(val string) (OdaInstanceAttachmentAttachmentTypeEnum, bool)
GetMappingOdaInstanceAttachmentAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceAttachmentAttachmentTypeEnumValues() []OdaInstanceAttachmentAttachmentTypeEnum
GetOdaInstanceAttachmentAttachmentTypeEnumValues Enumerates the set of values for OdaInstanceAttachmentAttachmentTypeEnum
OdaInstanceAttachmentCollection Results of a Oda instance attachment search. Contains OdaInstanceAttachment items.
type OdaInstanceAttachmentCollection struct {
// List of Oda instance attachments.
Items []OdaInstanceAttachmentSummary `mandatory:"true" json:"items"`
}
func (m OdaInstanceAttachmentCollection) String() string
func (m OdaInstanceAttachmentCollection) 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
OdaInstanceAttachmentLifecycleStateEnum Enum with underlying type: string
type OdaInstanceAttachmentLifecycleStateEnum string
Set of constants representing the allowable values for OdaInstanceAttachmentLifecycleStateEnum
const (
OdaInstanceAttachmentLifecycleStateAttaching OdaInstanceAttachmentLifecycleStateEnum = "ATTACHING"
OdaInstanceAttachmentLifecycleStateActive OdaInstanceAttachmentLifecycleStateEnum = "ACTIVE"
OdaInstanceAttachmentLifecycleStateDetaching OdaInstanceAttachmentLifecycleStateEnum = "DETACHING"
OdaInstanceAttachmentLifecycleStateInactive OdaInstanceAttachmentLifecycleStateEnum = "INACTIVE"
OdaInstanceAttachmentLifecycleStateFailed OdaInstanceAttachmentLifecycleStateEnum = "FAILED"
)
func GetMappingOdaInstanceAttachmentLifecycleStateEnum(val string) (OdaInstanceAttachmentLifecycleStateEnum, bool)
GetMappingOdaInstanceAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceAttachmentLifecycleStateEnumValues() []OdaInstanceAttachmentLifecycleStateEnum
GetOdaInstanceAttachmentLifecycleStateEnumValues Enumerates the set of values for OdaInstanceAttachmentLifecycleStateEnum
OdaInstanceAttachmentOwner Details about an attachment owner
type OdaInstanceAttachmentOwner struct {
// Name of the owner service principal
OwnerServiceName *string `mandatory:"true" json:"ownerServiceName"`
// Tenancy OCID of the owner service principal
OwnerServiceTenancy *string `mandatory:"true" json:"ownerServiceTenancy"`
}
func (m OdaInstanceAttachmentOwner) String() string
func (m OdaInstanceAttachmentOwner) 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
OdaInstanceAttachmentSummary Description of an ODA instance attachment.
type OdaInstanceAttachmentSummary struct {
// Unique immutable identifier that was assigned when the ODA instance attachment was created.
Id *string `mandatory:"true" json:"id"`
// The OCID of the ODA instance to which the attachment applies.
InstanceId *string `mandatory:"true" json:"instanceId"`
// The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which the ODA instance is or is being attached.
AttachToId *string `mandatory:"true" json:"attachToId"`
// The type of attachment defined as an enum.
AttachmentType OdaInstanceAttachmentSummaryAttachmentTypeEnum `mandatory:"true" json:"attachmentType"`
// The current state of the attachment.
LifecycleState OdaInstanceAttachmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// Attachment-specific metadata, defined by the target service.
AttachmentMetadata *string `mandatory:"false" json:"attachmentMetadata"`
// List of operation names that are restricted while this ODA instance is attached.
RestrictedOperations []string `mandatory:"false" json:"restrictedOperations"`
Owner *OdaInstanceOwner `mandatory:"false" json:"owner"`
// The time the attachment was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// The time the attachment was last modified. An RFC3339 formatted datetime string
TimeLastUpdate *common.SDKTime `mandatory:"false" json:"timeLastUpdate"`
// 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 OdaInstanceAttachmentSummary) String() string
func (m OdaInstanceAttachmentSummary) 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
OdaInstanceAttachmentSummaryAttachmentTypeEnum Enum with underlying type: string
type OdaInstanceAttachmentSummaryAttachmentTypeEnum string
Set of constants representing the allowable values for OdaInstanceAttachmentSummaryAttachmentTypeEnum
const (
OdaInstanceAttachmentSummaryAttachmentTypeFusion OdaInstanceAttachmentSummaryAttachmentTypeEnum = "FUSION"
OdaInstanceAttachmentSummaryAttachmentTypeMax OdaInstanceAttachmentSummaryAttachmentTypeEnum = "MAX"
)
func GetMappingOdaInstanceAttachmentSummaryAttachmentTypeEnum(val string) (OdaInstanceAttachmentSummaryAttachmentTypeEnum, bool)
GetMappingOdaInstanceAttachmentSummaryAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumValues() []OdaInstanceAttachmentSummaryAttachmentTypeEnum
GetOdaInstanceAttachmentSummaryAttachmentTypeEnumValues Enumerates the set of values for OdaInstanceAttachmentSummaryAttachmentTypeEnum
OdaInstanceLifecycleStateEnum Enum with underlying type: string
type OdaInstanceLifecycleStateEnum string
Set of constants representing the allowable values for OdaInstanceLifecycleStateEnum
const (
OdaInstanceLifecycleStateCreating OdaInstanceLifecycleStateEnum = "CREATING"
OdaInstanceLifecycleStateUpdating OdaInstanceLifecycleStateEnum = "UPDATING"
OdaInstanceLifecycleStateActive OdaInstanceLifecycleStateEnum = "ACTIVE"
OdaInstanceLifecycleStateInactive OdaInstanceLifecycleStateEnum = "INACTIVE"
OdaInstanceLifecycleStateDeleting OdaInstanceLifecycleStateEnum = "DELETING"
OdaInstanceLifecycleStateDeleted OdaInstanceLifecycleStateEnum = "DELETED"
OdaInstanceLifecycleStateFailed OdaInstanceLifecycleStateEnum = "FAILED"
)
func GetMappingOdaInstanceLifecycleStateEnum(val string) (OdaInstanceLifecycleStateEnum, bool)
GetMappingOdaInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum
GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum
OdaInstanceLifecycleSubStateEnum Enum with underlying type: string
type OdaInstanceLifecycleSubStateEnum string
Set of constants representing the allowable values for OdaInstanceLifecycleSubStateEnum
const (
OdaInstanceLifecycleSubStateCreating OdaInstanceLifecycleSubStateEnum = "CREATING"
OdaInstanceLifecycleSubStateStarting OdaInstanceLifecycleSubStateEnum = "STARTING"
OdaInstanceLifecycleSubStateStopping OdaInstanceLifecycleSubStateEnum = "STOPPING"
OdaInstanceLifecycleSubStateChangingCompartment OdaInstanceLifecycleSubStateEnum = "CHANGING_COMPARTMENT"
OdaInstanceLifecycleSubStateActivatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "ACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateUpdatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "UPDATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateDeactivatingCustomerEncryptionKey OdaInstanceLifecycleSubStateEnum = "DEACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceLifecycleSubStateDeleting OdaInstanceLifecycleSubStateEnum = "DELETING"
OdaInstanceLifecycleSubStateDeletePending OdaInstanceLifecycleSubStateEnum = "DELETE_PENDING"
OdaInstanceLifecycleSubStateRecovering OdaInstanceLifecycleSubStateEnum = "RECOVERING"
OdaInstanceLifecycleSubStateUpdating OdaInstanceLifecycleSubStateEnum = "UPDATING"
OdaInstanceLifecycleSubStatePurging OdaInstanceLifecycleSubStateEnum = "PURGING"
OdaInstanceLifecycleSubStateQueued OdaInstanceLifecycleSubStateEnum = "QUEUED"
)
func GetMappingOdaInstanceLifecycleSubStateEnum(val string) (OdaInstanceLifecycleSubStateEnum, bool)
GetMappingOdaInstanceLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum
GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum
OdaInstanceOwner Details about an ODA instance owner
type OdaInstanceOwner struct {
// Name of the owner service principal
OwnerServiceName *string `mandatory:"true" json:"ownerServiceName"`
// Tenancy OCID of the owner service principal
OwnerServiceTenancy *string `mandatory:"true" json:"ownerServiceTenancy"`
}
func (m OdaInstanceOwner) String() string
func (m OdaInstanceOwner) 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
OdaInstanceShapeNameEnum Enum with underlying type: string
type OdaInstanceShapeNameEnum string
Set of constants representing the allowable values for OdaInstanceShapeNameEnum
const (
OdaInstanceShapeNameDevelopment OdaInstanceShapeNameEnum = "DEVELOPMENT"
OdaInstanceShapeNameProduction OdaInstanceShapeNameEnum = "PRODUCTION"
)
func GetMappingOdaInstanceShapeNameEnum(val string) (OdaInstanceShapeNameEnum, bool)
GetMappingOdaInstanceShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum
GetOdaInstanceShapeNameEnumValues Enumerates the set of values for OdaInstanceShapeNameEnum
OdaInstanceSummary Summary of the Digital Assistant instance.
type OdaInstanceSummary struct {
// Unique identifier of the Digital Assistant instance.
Id *string `mandatory:"true" json:"id"`
// Identifier of the compartment that the instance belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the instance.
LifecycleState OdaInstanceSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// User-defined name for the Digital Assistant instance. You can change this value.
DisplayName *string `mandatory:"false" json:"displayName"`
// Description of the Digital Assistant instance.
Description *string `mandatory:"false" json:"description"`
// Shape or size of the instance.
ShapeName OdaInstanceSummaryShapeNameEnum `mandatory:"false" json:"shapeName,omitempty"`
// When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// The current sub-state of the Digital Assistant instance.
LifecycleSubState OdaInstanceSummaryLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"`
// A message describing the current state in more detail. For example, actionable
// information about an instance that's in the `FAILED` state.
StateMessage *string `mandatory:"false" json:"stateMessage"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Should this Digital Assistant instance use role-based authorization via an identity domain (true) or use the default policy-based authorization via IAM policies (false)
IsRoleBasedAccess *bool `mandatory:"false" json:"isRoleBasedAccess"`
// If isRoleBasedAccess is set to true, this property specifies the identity domain that is to be used to implement this type of authorzation. Digital Assistant will create an Identity Application instance and Application Roles within this identity domain. The caller may then perform and user roll mappings they like to grant access to users within the identity domain.
IdentityDomain *string `mandatory:"false" json:"identityDomain"`
// A list of package names imported into this instance (if any).
ImportedPackageNames []string `mandatory:"false" json:"importedPackageNames"`
// A list of attachment types for this instance (if any).
AttachmentTypes []string `mandatory:"false" json:"attachmentTypes"`
}
func (m OdaInstanceSummary) String() string
func (m OdaInstanceSummary) 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
OdaInstanceSummaryLifecycleStateEnum Enum with underlying type: string
type OdaInstanceSummaryLifecycleStateEnum string
Set of constants representing the allowable values for OdaInstanceSummaryLifecycleStateEnum
const (
OdaInstanceSummaryLifecycleStateCreating OdaInstanceSummaryLifecycleStateEnum = "CREATING"
OdaInstanceSummaryLifecycleStateUpdating OdaInstanceSummaryLifecycleStateEnum = "UPDATING"
OdaInstanceSummaryLifecycleStateActive OdaInstanceSummaryLifecycleStateEnum = "ACTIVE"
OdaInstanceSummaryLifecycleStateInactive OdaInstanceSummaryLifecycleStateEnum = "INACTIVE"
OdaInstanceSummaryLifecycleStateDeleting OdaInstanceSummaryLifecycleStateEnum = "DELETING"
OdaInstanceSummaryLifecycleStateDeleted OdaInstanceSummaryLifecycleStateEnum = "DELETED"
OdaInstanceSummaryLifecycleStateFailed OdaInstanceSummaryLifecycleStateEnum = "FAILED"
)
func GetMappingOdaInstanceSummaryLifecycleStateEnum(val string) (OdaInstanceSummaryLifecycleStateEnum, bool)
GetMappingOdaInstanceSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum
GetOdaInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleStateEnum
OdaInstanceSummaryLifecycleSubStateEnum Enum with underlying type: string
type OdaInstanceSummaryLifecycleSubStateEnum string
Set of constants representing the allowable values for OdaInstanceSummaryLifecycleSubStateEnum
const (
OdaInstanceSummaryLifecycleSubStateCreating OdaInstanceSummaryLifecycleSubStateEnum = "CREATING"
OdaInstanceSummaryLifecycleSubStateStarting OdaInstanceSummaryLifecycleSubStateEnum = "STARTING"
OdaInstanceSummaryLifecycleSubStateStopping OdaInstanceSummaryLifecycleSubStateEnum = "STOPPING"
OdaInstanceSummaryLifecycleSubStateChangingCompartment OdaInstanceSummaryLifecycleSubStateEnum = "CHANGING_COMPARTMENT"
OdaInstanceSummaryLifecycleSubStateActivatingCustomerEncryptionKey OdaInstanceSummaryLifecycleSubStateEnum = "ACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceSummaryLifecycleSubStateUpdatingCustomerEncryptionKey OdaInstanceSummaryLifecycleSubStateEnum = "UPDATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceSummaryLifecycleSubStateDeactivatingCustomerEncryptionKey OdaInstanceSummaryLifecycleSubStateEnum = "DEACTIVATING_CUSTOMER_ENCRYPTION_KEY"
OdaInstanceSummaryLifecycleSubStateDeleting OdaInstanceSummaryLifecycleSubStateEnum = "DELETING"
OdaInstanceSummaryLifecycleSubStateDeletePending OdaInstanceSummaryLifecycleSubStateEnum = "DELETE_PENDING"
OdaInstanceSummaryLifecycleSubStateRecovering OdaInstanceSummaryLifecycleSubStateEnum = "RECOVERING"
OdaInstanceSummaryLifecycleSubStateUpdating OdaInstanceSummaryLifecycleSubStateEnum = "UPDATING"
OdaInstanceSummaryLifecycleSubStatePurging OdaInstanceSummaryLifecycleSubStateEnum = "PURGING"
OdaInstanceSummaryLifecycleSubStateQueued OdaInstanceSummaryLifecycleSubStateEnum = "QUEUED"
)
func GetMappingOdaInstanceSummaryLifecycleSubStateEnum(val string) (OdaInstanceSummaryLifecycleSubStateEnum, bool)
GetMappingOdaInstanceSummaryLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceSummaryLifecycleSubStateEnumValues() []OdaInstanceSummaryLifecycleSubStateEnum
GetOdaInstanceSummaryLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleSubStateEnum
OdaInstanceSummaryShapeNameEnum Enum with underlying type: string
type OdaInstanceSummaryShapeNameEnum string
Set of constants representing the allowable values for OdaInstanceSummaryShapeNameEnum
const (
OdaInstanceSummaryShapeNameDevelopment OdaInstanceSummaryShapeNameEnum = "DEVELOPMENT"
OdaInstanceSummaryShapeNameProduction OdaInstanceSummaryShapeNameEnum = "PRODUCTION"
)
func GetMappingOdaInstanceSummaryShapeNameEnum(val string) (OdaInstanceSummaryShapeNameEnum, bool)
GetMappingOdaInstanceSummaryShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum
GetOdaInstanceSummaryShapeNameEnumValues Enumerates the set of values for OdaInstanceSummaryShapeNameEnum
OdaPrivateEndpoint A private endpoint allows Digital Assistant Instance to access resources in a customer's virtual cloud network (VCN).
type OdaPrivateEndpoint struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that was assigned when the ODA private endpoint was created.
Id *string `mandatory:"true" json:"id"`
// User-defined name for the ODA private endpoint. Avoid entering confidential information.
// You can change this value.
DisplayName *string `mandatory:"true" json:"displayName"`
// The OCID (https://docs.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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
SubnetId *string `mandatory:"true" json:"subnetId"`
// Description of the ODA private endpoint.
Description *string `mandatory:"false" json:"description"`
// 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:"false" 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:"false" json:"timeUpdated"`
// The current state of the ODA private endpoint.
LifecycleState OdaPrivateEndpointLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// List of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.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 OdaPrivateEndpoint) String() string
func (m OdaPrivateEndpoint) 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
OdaPrivateEndpointAttachment ODA Private Endpoint Attachment is used to attach ODA Private Endpoint to ODA (Digital Assistant) Instance.
type OdaPrivateEndpointAttachment struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint attachment belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the ODA Private Endpoint attachment.
LifecycleState OdaPrivateEndpointAttachmentLifecycleStateEnum `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:"false" json:"timeUpdated"`
}
func (m OdaPrivateEndpointAttachment) String() string
func (m OdaPrivateEndpointAttachment) 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
OdaPrivateEndpointAttachmentCollection A collection of ODA Private Endpoint Attachment summaries.
type OdaPrivateEndpointAttachmentCollection struct {
// The ODA Private Endpoint Attachment summaries.
Items []OdaPrivateEndpointAttachmentSummary `mandatory:"true" json:"items"`
}
func (m OdaPrivateEndpointAttachmentCollection) String() string
func (m OdaPrivateEndpointAttachmentCollection) 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
OdaPrivateEndpointAttachmentLifecycleStateEnum Enum with underlying type: string
type OdaPrivateEndpointAttachmentLifecycleStateEnum string
Set of constants representing the allowable values for OdaPrivateEndpointAttachmentLifecycleStateEnum
const (
OdaPrivateEndpointAttachmentLifecycleStateCreating OdaPrivateEndpointAttachmentLifecycleStateEnum = "CREATING"
OdaPrivateEndpointAttachmentLifecycleStateUpdating OdaPrivateEndpointAttachmentLifecycleStateEnum = "UPDATING"
OdaPrivateEndpointAttachmentLifecycleStateActive OdaPrivateEndpointAttachmentLifecycleStateEnum = "ACTIVE"
OdaPrivateEndpointAttachmentLifecycleStateDeleting OdaPrivateEndpointAttachmentLifecycleStateEnum = "DELETING"
OdaPrivateEndpointAttachmentLifecycleStateDeleted OdaPrivateEndpointAttachmentLifecycleStateEnum = "DELETED"
OdaPrivateEndpointAttachmentLifecycleStateFailed OdaPrivateEndpointAttachmentLifecycleStateEnum = "FAILED"
)
func GetMappingOdaPrivateEndpointAttachmentLifecycleStateEnum(val string) (OdaPrivateEndpointAttachmentLifecycleStateEnum, bool)
GetMappingOdaPrivateEndpointAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaPrivateEndpointAttachmentLifecycleStateEnumValues() []OdaPrivateEndpointAttachmentLifecycleStateEnum
GetOdaPrivateEndpointAttachmentLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointAttachmentLifecycleStateEnum
OdaPrivateEndpointAttachmentSummary Summary of the ODA private endpoint attachment.
type OdaPrivateEndpointAttachmentSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint attachment belongs to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The current state of the ODA Private Endpoint attachment.
LifecycleState OdaPrivateEndpointAttachmentLifecycleStateEnum `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:"false" json:"timeUpdated"`
}
func (m OdaPrivateEndpointAttachmentSummary) String() string
func (m OdaPrivateEndpointAttachmentSummary) 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
OdaPrivateEndpointCollection A collection of ODA Private Endpoint summaries.
type OdaPrivateEndpointCollection struct {
// The ODA Private Endpoint summaries.
Items []OdaPrivateEndpointSummary `mandatory:"true" json:"items"`
}
func (m OdaPrivateEndpointCollection) String() string
func (m OdaPrivateEndpointCollection) 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
OdaPrivateEndpointLifecycleStateEnum Enum with underlying type: string
type OdaPrivateEndpointLifecycleStateEnum string
Set of constants representing the allowable values for OdaPrivateEndpointLifecycleStateEnum
const (
OdaPrivateEndpointLifecycleStateCreating OdaPrivateEndpointLifecycleStateEnum = "CREATING"
OdaPrivateEndpointLifecycleStateUpdating OdaPrivateEndpointLifecycleStateEnum = "UPDATING"
OdaPrivateEndpointLifecycleStateActive OdaPrivateEndpointLifecycleStateEnum = "ACTIVE"
OdaPrivateEndpointLifecycleStateDeleting OdaPrivateEndpointLifecycleStateEnum = "DELETING"
OdaPrivateEndpointLifecycleStateDeleted OdaPrivateEndpointLifecycleStateEnum = "DELETED"
OdaPrivateEndpointLifecycleStateFailed OdaPrivateEndpointLifecycleStateEnum = "FAILED"
)
func GetMappingOdaPrivateEndpointLifecycleStateEnum(val string) (OdaPrivateEndpointLifecycleStateEnum, bool)
GetMappingOdaPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaPrivateEndpointLifecycleStateEnumValues() []OdaPrivateEndpointLifecycleStateEnum
GetOdaPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointLifecycleStateEnum
OdaPrivateEndpointScanProxy Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs
type OdaPrivateEndpointScanProxy struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Scan Proxy.
Id *string `mandatory:"true" json:"id"`
// 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"`
// The current state of the ODA Private Endpoint Scan Proxy.
LifecycleState OdaPrivateEndpointScanProxyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// 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:"false" json:"timeCreated"`
}
func (m OdaPrivateEndpointScanProxy) String() string
func (m OdaPrivateEndpointScanProxy) 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
OdaPrivateEndpointScanProxyCollection A collection of ODA Private Endpoint Scan Proxy summaries.
type OdaPrivateEndpointScanProxyCollection struct {
// The ODA Private Endpoint Scan Proxy summaries.
Items []OdaPrivateEndpointScanProxySummary `mandatory:"true" json:"items"`
}
func (m OdaPrivateEndpointScanProxyCollection) String() string
func (m OdaPrivateEndpointScanProxyCollection) 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
OdaPrivateEndpointScanProxyLifecycleStateEnum Enum with underlying type: string
type OdaPrivateEndpointScanProxyLifecycleStateEnum string
Set of constants representing the allowable values for OdaPrivateEndpointScanProxyLifecycleStateEnum
const (
OdaPrivateEndpointScanProxyLifecycleStateCreating OdaPrivateEndpointScanProxyLifecycleStateEnum = "CREATING"
OdaPrivateEndpointScanProxyLifecycleStateActive OdaPrivateEndpointScanProxyLifecycleStateEnum = "ACTIVE"
OdaPrivateEndpointScanProxyLifecycleStateDeleting OdaPrivateEndpointScanProxyLifecycleStateEnum = "DELETING"
OdaPrivateEndpointScanProxyLifecycleStateDeleted OdaPrivateEndpointScanProxyLifecycleStateEnum = "DELETED"
OdaPrivateEndpointScanProxyLifecycleStateFailed OdaPrivateEndpointScanProxyLifecycleStateEnum = "FAILED"
)
func GetMappingOdaPrivateEndpointScanProxyLifecycleStateEnum(val string) (OdaPrivateEndpointScanProxyLifecycleStateEnum, bool)
GetMappingOdaPrivateEndpointScanProxyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaPrivateEndpointScanProxyLifecycleStateEnumValues() []OdaPrivateEndpointScanProxyLifecycleStateEnum
GetOdaPrivateEndpointScanProxyLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyLifecycleStateEnum
OdaPrivateEndpointScanProxyProtocolEnum Enum with underlying type: string
type OdaPrivateEndpointScanProxyProtocolEnum string
Set of constants representing the allowable values for OdaPrivateEndpointScanProxyProtocolEnum
const (
OdaPrivateEndpointScanProxyProtocolTcp OdaPrivateEndpointScanProxyProtocolEnum = "TCP"
)
func GetMappingOdaPrivateEndpointScanProxyProtocolEnum(val string) (OdaPrivateEndpointScanProxyProtocolEnum, bool)
GetMappingOdaPrivateEndpointScanProxyProtocolEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaPrivateEndpointScanProxyProtocolEnumValues() []OdaPrivateEndpointScanProxyProtocolEnum
GetOdaPrivateEndpointScanProxyProtocolEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyProtocolEnum
OdaPrivateEndpointScanProxyScanListenerTypeEnum Enum with underlying type: string
type OdaPrivateEndpointScanProxyScanListenerTypeEnum string
Set of constants representing the allowable values for OdaPrivateEndpointScanProxyScanListenerTypeEnum
const (
OdaPrivateEndpointScanProxyScanListenerTypeFqdn OdaPrivateEndpointScanProxyScanListenerTypeEnum = "FQDN"
OdaPrivateEndpointScanProxyScanListenerTypeIp OdaPrivateEndpointScanProxyScanListenerTypeEnum = "IP"
)
func GetMappingOdaPrivateEndpointScanProxyScanListenerTypeEnum(val string) (OdaPrivateEndpointScanProxyScanListenerTypeEnum, bool)
GetMappingOdaPrivateEndpointScanProxyScanListenerTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumValues() []OdaPrivateEndpointScanProxyScanListenerTypeEnum
GetOdaPrivateEndpointScanProxyScanListenerTypeEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyScanListenerTypeEnum
OdaPrivateEndpointScanProxySummary Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs
type OdaPrivateEndpointScanProxySummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Scan Proxy.
Id *string `mandatory:"true" json:"id"`
// 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"`
// The current state of the ODA Private Endpoint Scan Proxy.
LifecycleState OdaPrivateEndpointScanProxyLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
// 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:"false" json:"timeCreated"`
}
func (m OdaPrivateEndpointScanProxySummary) String() string
func (m OdaPrivateEndpointScanProxySummary) 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
OdaPrivateEndpointSummary Summary of the ODA private endpoint.
type OdaPrivateEndpointSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that was assigned when the ODA private endpoint was created.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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 current state of the ODA private endpoint.
LifecycleState OdaPrivateEndpointLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// 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"`
// 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:"false" 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:"false" 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 OdaPrivateEndpointSummary) String() string
func (m OdaPrivateEndpointSummary) 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
OdapackageClient a client for Odapackage
type OdapackageClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOdapackageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OdapackageClient, err error)
NewOdapackageClientWithConfigurationProvider Creates a new default Odapackage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOdapackageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OdapackageClient, err error)
NewOdapackageClientWithOboToken Creates a new default Odapackage client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *OdapackageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OdapackageClient) CreateImportedPackage(ctx context.Context, request CreateImportedPackageRequest) (response CreateImportedPackageResponse, err error)
CreateImportedPackage Starts an asynchronous job to import a package into a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateImportedPackage.go.html to see an example of how to use CreateImportedPackage API. A default retry strategy applies to this operation CreateImportedPackage()
func (client OdapackageClient) DeleteImportedPackage(ctx context.Context, request DeleteImportedPackageRequest) (response DeleteImportedPackageResponse, err error)
DeleteImportedPackage Starts an asynchronous job to delete a package from a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteImportedPackage.go.html to see an example of how to use DeleteImportedPackage API. A default retry strategy applies to this operation DeleteImportedPackage()
func (client OdapackageClient) GetImportedPackage(ctx context.Context, request GetImportedPackageRequest) (response GetImportedPackageResponse, err error)
GetImportedPackage Returns a list of summaries for imported packages in the instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetImportedPackage.go.html to see an example of how to use GetImportedPackage API. A default retry strategy applies to this operation GetImportedPackage()
func (client OdapackageClient) GetPackage(ctx context.Context, request GetPackageRequest) (response GetPackageResponse, err error)
GetPackage Returns details about a package, and how to import it.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetPackage.go.html to see an example of how to use GetPackage API. A default retry strategy applies to this operation GetPackage()
func (client OdapackageClient) ListImportedPackages(ctx context.Context, request ListImportedPackagesRequest) (response ListImportedPackagesResponse, err error)
ListImportedPackages Returns a list of summaries for imported packages in the instance.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListImportedPackages.go.html to see an example of how to use ListImportedPackages API. A default retry strategy applies to this operation ListImportedPackages()
func (client OdapackageClient) ListPackages(ctx context.Context, request ListPackagesRequest) (response ListPackagesResponse, err error)
ListPackages Returns a page of summaries for packages that are available for import. The optional odaInstanceId query parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId query parameter is not provided, the returned list will include packages available within the region indicated by the request URL. The optional resourceType query param may be specified to filter packages that contain the indicated resource type. If no resourceType query param is given, packages containing all resource types will be returned. The optional name query parameter can be used to limit the list to packages whose name matches the given name. The optional displayName query parameter can be used to limit the list to packages whose displayName matches the given name. The optional isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version of any given package. If not specified, all versions of any otherwise matching package will be returned. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListPackages.go.html to see an example of how to use ListPackages API. A default retry strategy applies to this operation ListPackages()
func (client *OdapackageClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OdapackageClient) UpdateImportedPackage(ctx context.Context, request UpdateImportedPackageRequest) (response UpdateImportedPackageResponse, err error)
UpdateImportedPackage Starts an asynchronous job to update a package within a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateImportedPackage.go.html to see an example of how to use UpdateImportedPackage API. A default retry strategy applies to this operation UpdateImportedPackage()
OssChannel The configuration for an Oracle Streaming Service (OSS) channel.
type OssChannel 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 OssChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m OssChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OssChannel) GetDescription() *string
GetDescription returns Description
func (m OssChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OssChannel) GetId() *string
GetId returns Id
func (m OssChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OssChannel) GetName() *string
GetName returns Name
func (m OssChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m OssChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OssChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OssChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OssChannel) String() string
func (m OssChannel) 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
OsvcChannel The configuration for an OSVC channel.
type OsvcChannel struct {
// Unique immutable identifier that was assigned when the Channel was created.
Id *string `mandatory:"true" json:"id"`
// The Channel's name. The name can contain only letters, numbers, periods, and underscores. The name must begin with a letter.
Name *string `mandatory:"true" json:"name"`
// When the resource was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// When the resource was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The host.
//
// For OSVC, you can derive these values from the URL that you use to launch the Agent Browser User Interface
// or the chat launch page. For example, if the URL is https://sitename.exampledomain.com/app/chat/chat_launch,
// then the host is sitename.exampledomain.com.
//
// For FUSION, this is the host portion of your Oracle Applications Cloud (Fusion) instance's URL.
// For example: sitename.exampledomain.com.
Host *string `mandatory:"true" json:"host"`
// The port.
Port *string `mandatory:"true" json:"port"`
// The user name for the digital-assistant agent.
UserName *string `mandatory:"true" json:"userName"`
// The total session count.
TotalSessionCount *int `mandatory:"true" json:"totalSessionCount"`
// The name of the Authentication Provider to use to authenticate the user.
AuthenticationProviderName *string `mandatory:"true" json:"authenticationProviderName"`
// A short description of the Channel.
Description *string `mandatory:"false" json:"description"`
// The number of milliseconds before a session expires.
SessionExpiryDurationInMilliseconds *int64 `mandatory:"false" json:"sessionExpiryDurationInMilliseconds"`
// Simple key-value pair that is applied without any predefined name, type, or scope.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
// The category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The type of OSVC service.
ChannelService OsvcServiceTypeEnum `mandatory:"true" json:"channelService"`
}
func (m OsvcChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m OsvcChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m OsvcChannel) GetDescription() *string
GetDescription returns Description
func (m OsvcChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m OsvcChannel) GetId() *string
GetId returns Id
func (m OsvcChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m OsvcChannel) GetName() *string
GetName returns Name
func (m OsvcChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m OsvcChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m OsvcChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m OsvcChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OsvcChannel) String() string
func (m OsvcChannel) 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
OsvcServiceTypeEnum Enum with underlying type: string
type OsvcServiceTypeEnum string
Set of constants representing the allowable values for OsvcServiceTypeEnum
const (
OsvcServiceTypeOsvc OsvcServiceTypeEnum = "OSVC"
OsvcServiceTypeFusion OsvcServiceTypeEnum = "FUSION"
)
func GetMappingOsvcServiceTypeEnum(val string) (OsvcServiceTypeEnum, bool)
GetMappingOsvcServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOsvcServiceTypeEnumValues() []OsvcServiceTypeEnum
GetOsvcServiceTypeEnumValues Enumerates the set of values for OsvcServiceTypeEnum
PackageSummary Summary of `Package` object.
type PackageSummary struct {
// Unique immutable identifier that was assigned when the Package was registered.
Id *string `mandatory:"true" json:"id"`
// ID of the publisher providing the package.
PublisherId *string `mandatory:"true" json:"publisherId"`
// Name of package.
Name *string `mandatory:"true" json:"name"`
// Display name for the package (displayed in UI and user-facing applications).
DisplayName *string `mandatory:"true" json:"displayName"`
// Version of the package.
Version *string `mandatory:"true" json:"version"`
// When the package was last published. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimePublished *common.SDKTime `mandatory:"true" json:"timePublished"`
// Description of the package.
Description *string `mandatory:"true" json:"description"`
// A list of resource types describing the content of the package.
ResourceTypes []string `mandatory:"true" json:"resourceTypes"`
// A map of resource type to metadata key/value map that further describes the content for the resource types in this package.. Keys are resource type names, values are a map of name/value pairs per resource type.
ResourceTypesMetadata []ResourceTypeMetadata `mandatory:"true" json:"resourceTypesMetadata"`
// A map of metadata key/value pairs that further describes the publisher and the platform in which the package might be used.
PublisherMetadata []MetadataProperty `mandatory:"true" json:"publisherMetadata"`
// 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 PackageSummary) String() string
func (m PackageSummary) 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
Parameter Metadata for a Parameter.
type Parameter 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"`
// The Parameter's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
}
func (m Parameter) String() string
func (m Parameter) 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
ParameterDefinition A parameter to a resource.
type ParameterDefinition struct {
// The name of the parameter
Name *string `mandatory:"true" json:"name"`
// Enumerated parameter type.
Type ParameterDefinitionTypeEnum `mandatory:"true" json:"type"`
// Description of the parameter.
Description *string `mandatory:"false" json:"description"`
// Is this parameter required. Ignored for parameters with direction = OUTPUT.
IsRequired *bool `mandatory:"false" json:"isRequired"`
// Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.)
IsSensitive *bool `mandatory:"false" json:"isSensitive"`
// Default value for the parameter.
DefaultValue *string `mandatory:"false" json:"defaultValue"`
// Used for character string types such as STRING to constrain the length of the value
MinLength *int `mandatory:"false" json:"minLength"`
// Used for character string types such as STRING to constrain the length of the value
MaxLength *int `mandatory:"false" json:"maxLength"`
// Regular expression used to validate the value of a string type such as STRING
Pattern *string `mandatory:"false" json:"pattern"`
// Is this parameter an input parameter, output parameter, or both?
Direction ParameterDefinitionDirectionEnum `mandatory:"false" json:"direction,omitempty"`
// A forward-slash-delimited 'path' in an imaginary hierarchy, at which this parameter's UI widgets should be placed
UiPlacementHint *string `mandatory:"false" json:"uiPlacementHint"`
// Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.).
ResourceTypeMetadata *interface{} `mandatory:"false" json:"resourceTypeMetadata"`
}
func (m ParameterDefinition) String() string
func (m ParameterDefinition) 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
ParameterDefinitionDirectionEnum Enum with underlying type: string
type ParameterDefinitionDirectionEnum string
Set of constants representing the allowable values for ParameterDefinitionDirectionEnum
const (
ParameterDefinitionDirectionInput ParameterDefinitionDirectionEnum = "INPUT"
ParameterDefinitionDirectionOutput ParameterDefinitionDirectionEnum = "OUTPUT"
)
func GetMappingParameterDefinitionDirectionEnum(val string) (ParameterDefinitionDirectionEnum, bool)
GetMappingParameterDefinitionDirectionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetParameterDefinitionDirectionEnumValues() []ParameterDefinitionDirectionEnum
GetParameterDefinitionDirectionEnumValues Enumerates the set of values for ParameterDefinitionDirectionEnum
ParameterDefinitionTypeEnum Enum with underlying type: string
type ParameterDefinitionTypeEnum string
Set of constants representing the allowable values for ParameterDefinitionTypeEnum
const (
ParameterDefinitionTypeString ParameterDefinitionTypeEnum = "STRING"
ParameterDefinitionTypeUri ParameterDefinitionTypeEnum = "URI"
ParameterDefinitionTypeUrl ParameterDefinitionTypeEnum = "URL"
ParameterDefinitionTypeNumber ParameterDefinitionTypeEnum = "NUMBER"
ParameterDefinitionTypeBoolean ParameterDefinitionTypeEnum = "BOOLEAN"
)
func GetMappingParameterDefinitionTypeEnum(val string) (ParameterDefinitionTypeEnum, bool)
GetMappingParameterDefinitionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetParameterDefinitionTypeEnumValues() []ParameterDefinitionTypeEnum
GetParameterDefinitionTypeEnumValues Enumerates the set of values for ParameterDefinitionTypeEnum
ParameterTypeEnum Enum with underlying type: string
type ParameterTypeEnum string
Set of constants representing the allowable values for ParameterTypeEnum
const (
ParameterTypeString ParameterTypeEnum = "STRING"
ParameterTypeInteger ParameterTypeEnum = "INTEGER"
ParameterTypeFloat ParameterTypeEnum = "FLOAT"
ParameterTypeBoolean ParameterTypeEnum = "BOOLEAN"
ParameterTypeSecure ParameterTypeEnum = "SECURE"
)
func GetMappingParameterTypeEnum(val string) (ParameterTypeEnum, bool)
GetMappingParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetParameterTypeEnumValues() []ParameterTypeEnum
GetParameterTypeEnumValues Enumerates the set of values for ParameterTypeEnum
PublishDigitalAssistantRequest wrapper for the PublishDigitalAssistant operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishDigitalAssistant.go.html to see an example of how to use PublishDigitalAssistantRequest.
type PublishDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// 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"`
// 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 PublishDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PublishDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PublishDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PublishDigitalAssistantRequest) String() string
func (request PublishDigitalAssistantRequest) 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
PublishDigitalAssistantResponse wrapper for the PublishDigitalAssistant operation
type PublishDigitalAssistantResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalAssistant instance
DigitalAssistant `presentIn:"body"`
// 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 PublishDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PublishDigitalAssistantResponse) String() string
PublishSkillRequest wrapper for the PublishSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishSkill.go.html to see an example of how to use PublishSkillRequest.
type PublishSkillRequest 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"`
// 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"`
// 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 PublishSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PublishSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PublishSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PublishSkillRequest) String() string
func (request PublishSkillRequest) 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
PublishSkillResponse wrapper for the PublishSkill operation
type PublishSkillResponse struct {
// The underlying http response
RawResponse *http.Response
// The Skill instance
Skill `presentIn:"body"`
// 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 PublishSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PublishSkillResponse) String() string
ResourceTypeDefaultParameterValues Default values needed to import a resource type for a package.
type ResourceTypeDefaultParameterValues struct {
// The type of resource to which these resourceType-specific parameter values apply
ResourceType *string `mandatory:"true" json:"resourceType"`
// A list of parameter values used to import the package.
ParameterValues map[string]string `mandatory:"true" json:"parameterValues"`
}
func (m ResourceTypeDefaultParameterValues) String() string
func (m ResourceTypeDefaultParameterValues) 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
ResourceTypeImportContract The contract guiding the import experience for the consumer and behavior of the resource provider for a single resourceType.
type ResourceTypeImportContract struct {
// The type of resource to which this resourceType-specific contract applies
ResourceType *string `mandatory:"true" json:"resourceType"`
// A list of definitions for parameters that are required to import this package into a target instance.
Parameters []ParameterDefinition `mandatory:"true" json:"parameters"`
}
func (m ResourceTypeImportContract) String() string
func (m ResourceTypeImportContract) 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
ResourceTypeMetadata Describes resources of a given type within a package.
type ResourceTypeMetadata struct {
// The type of the resource described by this metadata object.
ResourceType *string `mandatory:"false" json:"resourceType"`
// Any properties needed to describe the content and its usage for this resource type, and within the containing package.
Properties []MetadataProperty `mandatory:"false" json:"properties"`
}
func (m ResourceTypeMetadata) String() string
func (m ResourceTypeMetadata) 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
RestrictedOperation Summary of a restricted operation for a Digital Assistant instance.
type RestrictedOperation struct {
// Name of the restricted operation.
OperationName *string `mandatory:"true" json:"operationName"`
// Name of the service restricting the operation.
RestrictingService *string `mandatory:"true" json:"restrictingService"`
}
func (m RestrictedOperation) String() string
func (m RestrictedOperation) 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
RotateChannelKeysRequest wrapper for the RotateChannelKeys operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/RotateChannelKeys.go.html to see an example of how to use RotateChannelKeysRequest.
type RotateChannelKeysRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// 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"`
// 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"`
// 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 RotateChannelKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RotateChannelKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RotateChannelKeysRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RotateChannelKeysRequest) String() string
func (request RotateChannelKeysRequest) 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
RotateChannelKeysResponse wrapper for the RotateChannelKeys operation
type RotateChannelKeysResponse struct {
// The underlying http response
RawResponse *http.Response
// The CreateChannelResult instance
CreateChannelResult `presentIn:"body"`
// 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 RotateChannelKeysResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RotateChannelKeysResponse) String() string
ScanListenerInfo Customer's Real Application Cluster (RAC)'s SCAN listener FQDN, port or list IPs and their ports.
type ScanListenerInfo struct {
// FQDN of the customer's Real Application Cluster (RAC)'s SCAN listeners.
ScanListenerFqdn *string `mandatory:"false" json:"scanListenerFqdn"`
// A SCAN listener's IP of the customer's Real Application Cluster (RAC).
ScanListenerIp *string `mandatory:"false" json:"scanListenerIp"`
// The port that customer's Real Application Cluster (RAC)'s SCAN listeners are listening on.
ScanListenerPort *int `mandatory:"false" json:"scanListenerPort"`
}
func (m ScanListenerInfo) String() string
func (m ScanListenerInfo) 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
ServiceCloudChannel The configuration for a Service Cloud agent channel.
type ServiceCloudChannel 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 ServiceCloudChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m ServiceCloudChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m ServiceCloudChannel) GetDescription() *string
GetDescription returns Description
func (m ServiceCloudChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m ServiceCloudChannel) GetId() *string
GetId returns Id
func (m ServiceCloudChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ServiceCloudChannel) GetName() *string
GetName returns Name
func (m ServiceCloudChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m ServiceCloudChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m ServiceCloudChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m ServiceCloudChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ServiceCloudChannel) String() string
func (m ServiceCloudChannel) 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
ServiceCloudClientTypeEnum Enum with underlying type: string
type ServiceCloudClientTypeEnum string
Set of constants representing the allowable values for ServiceCloudClientTypeEnum
const (
ServiceCloudClientTypeWsdl ServiceCloudClientTypeEnum = "WSDL"
ServiceCloudClientTypeRest ServiceCloudClientTypeEnum = "REST"
)
func GetMappingServiceCloudClientTypeEnum(val string) (ServiceCloudClientTypeEnum, bool)
GetMappingServiceCloudClientTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetServiceCloudClientTypeEnumValues() []ServiceCloudClientTypeEnum
GetServiceCloudClientTypeEnumValues Enumerates the set of values for ServiceCloudClientTypeEnum
Skill Skill metadata.
type Skill 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 resource's dialog version.
DialogVersion *string `mandatory:"false" json:"dialogVersion"`
// 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 Skill) String() string
func (m Skill) 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
SkillCollection A collection of Skill summaries.
type SkillCollection struct {
// The Skill summaries.
Items []SkillSummary `mandatory:"true" json:"items"`
}
func (m SkillCollection) String() string
func (m SkillCollection) 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
SkillParameter Metadata for a Skill Parameter.
type SkillParameter 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"`
// The Parameter's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
}
func (m SkillParameter) String() string
func (m SkillParameter) 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
SkillParameterCollection A collection of Skill Parameter summaries.
type SkillParameterCollection struct {
// The Skill Parameter summaries.
Items []SkillParameterSummary `mandatory:"true" json:"items"`
}
func (m SkillParameterCollection) String() string
func (m SkillParameterCollection) 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
SkillParameterSummary Metadata for a Skill Parameter property.
type SkillParameterSummary 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 Parameter's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
// The current value. The value will be interpreted based on the `type`.
Value *string `mandatory:"false" json:"value"`
}
func (m SkillParameterSummary) String() string
func (m SkillParameterSummary) 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
SkillSummary Summary of a Skill.
type SkillSummary 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 namespace.
Namespace *string `mandatory:"true" json:"namespace"`
// The resource's category. This is used to group resource's together.
Category *string `mandatory:"true" json:"category"`
// 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"`
// 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 SkillSummary) String() string
func (m SkillSummary) 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
SlackChannel The configuration for a Slack channel.
type SlackChannel 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 Slack Client Id for the Slack app.
ClientId *string `mandatory:"true" json:"clientId"`
// 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 redirect to when authentication is successful.
AuthSuccessUrl *string `mandatory:"false" json:"authSuccessUrl"`
// The URL to redirect to when authentication is unsuccessful.
AuthErrorUrl *string `mandatory:"false" json:"authErrorUrl"`
// 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 SlackChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m SlackChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m SlackChannel) GetDescription() *string
GetDescription returns Description
func (m SlackChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m SlackChannel) GetId() *string
GetId returns Id
func (m SlackChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m SlackChannel) GetName() *string
GetName returns Name
func (m SlackChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m SlackChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m SlackChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m SlackChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m SlackChannel) String() string
func (m SlackChannel) 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
StartChannelRequest wrapper for the StartChannel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartChannel.go.html to see an example of how to use StartChannelRequest.
type StartChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// 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"`
// 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"`
// 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 StartChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartChannelRequest) String() string
func (request StartChannelRequest) 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
StartChannelResponse wrapper for the StartChannel operation
type StartChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// 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 StartChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartChannelResponse) String() string
StartOdaInstanceRequest wrapper for the StartOdaInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartOdaInstance.go.html to see an example of how to use StartOdaInstanceRequest.
type StartOdaInstanceRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// 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"`
// 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"`
// 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 StartOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartOdaInstanceRequest) String() string
func (request StartOdaInstanceRequest) 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
StartOdaInstanceResponse wrapper for the StartOdaInstance operation
type StartOdaInstanceResponse 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 StartOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartOdaInstanceResponse) String() string
StaticEntityValue Value in a static entity.
type StaticEntityValue struct {
// Value for a static entity.
CanonicalName *string `mandatory:"true" json:"canonicalName"`
NaturalLanguageMapping *StaticEntityValueNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
}
func (m StaticEntityValue) String() string
func (m StaticEntityValue) 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
StaticEntityValueNaturalLanguageMapping Natural language mapping of a static entity value.
type StaticEntityValueNaturalLanguageMapping struct {
// List of natural language mapped values.
Languages []LanguageMapping `mandatory:"true" json:"languages"`
}
func (m StaticEntityValueNaturalLanguageMapping) String() string
func (m StaticEntityValueNaturalLanguageMapping) 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
StopChannelRequest wrapper for the StopChannel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopChannel.go.html to see an example of how to use StopChannelRequest.
type StopChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// 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"`
// 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"`
// 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 StopChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopChannelRequest) String() string
func (request StopChannelRequest) 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
StopChannelResponse wrapper for the StopChannel operation
type StopChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// 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 StopChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopChannelResponse) String() string
StopOdaInstanceRequest wrapper for the StopOdaInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopOdaInstance.go.html to see an example of how to use StopOdaInstanceRequest.
type StopOdaInstanceRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// 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"`
// 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"`
// 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 StopOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopOdaInstanceRequest) String() string
func (request StopOdaInstanceRequest) 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
StopOdaInstanceResponse wrapper for the StopOdaInstance operation
type StopOdaInstanceResponse 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 StopOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopOdaInstanceResponse) String() string
StorageLocation Properties that point to a specific object in Object Storage.
type StorageLocation struct {
// The region id.
RegionId *string `mandatory:"true" json:"regionId"`
// The unique identifier for the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The Object Storage namespace.
NamespaceName *string `mandatory:"true" json:"namespaceName"`
// The name of the bucket.
BucketName *string `mandatory:"true" json:"bucketName"`
// The name of the object.
ObjectName *string `mandatory:"true" json:"objectName"`
}
func (m StorageLocation) String() string
func (m StorageLocation) 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
TemporalPreferenceEnum Enum with underlying type: string
type TemporalPreferenceEnum string
Set of constants representing the allowable values for TemporalPreferenceEnum
const (
TemporalPreferencePast TemporalPreferenceEnum = "PAST"
TemporalPreferenceFuture TemporalPreferenceEnum = "FUTURE"
TemporalPreferenceNearest TemporalPreferenceEnum = "NEAREST"
)
func GetMappingTemporalPreferenceEnum(val string) (TemporalPreferenceEnum, bool)
GetMappingTemporalPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTemporalPreferenceEnumValues() []TemporalPreferenceEnum
GetTemporalPreferenceEnumValues Enumerates the set of values for TemporalPreferenceEnum
TestChannel The configuration for the Test channel.
type TestChannel 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 category of the Channel.
Category ChannelCategoryEnum `mandatory:"true" json:"category"`
// The Channel's current state.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
}
func (m TestChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m TestChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m TestChannel) GetDescription() *string
GetDescription returns Description
func (m TestChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m TestChannel) GetId() *string
GetId returns Id
func (m TestChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m TestChannel) GetName() *string
GetName returns Name
func (m TestChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m TestChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m TestChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m TestChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TestChannel) String() string
func (m TestChannel) 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
TrainSkillDetails Parameters for training the skill.
type TrainSkillDetails struct {
// List of parameters for training the skill.
Items []TrainSkillParameter `mandatory:"true" json:"items"`
}
func (m TrainSkillDetails) String() string
func (m *TrainSkillDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TrainSkillDetails) 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
TrainSkillParameter Train skill parameter.
type TrainSkillParameter interface {
}
TrainSkillParameterTypeEnum Enum with underlying type: string
type TrainSkillParameterTypeEnum string
Set of constants representing the allowable values for TrainSkillParameterTypeEnum
const (
TrainSkillParameterTypeQueryEntity TrainSkillParameterTypeEnum = "QUERY_ENTITY"
)
func GetMappingTrainSkillParameterTypeEnum(val string) (TrainSkillParameterTypeEnum, bool)
GetMappingTrainSkillParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTrainSkillParameterTypeEnumValues() []TrainSkillParameterTypeEnum
GetTrainSkillParameterTypeEnumValues Enumerates the set of values for TrainSkillParameterTypeEnum
TrainSkillQueryEntityParameter Query entity parameter for training the skill.
type TrainSkillQueryEntityParameter struct {
}
func (m TrainSkillQueryEntityParameter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TrainSkillQueryEntityParameter) String() string
func (m TrainSkillQueryEntityParameter) 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
TrainSkillRequest wrapper for the TrainSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/TrainSkill.go.html to see an example of how to use TrainSkillRequest.
type TrainSkillRequest 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"`
// Metadata for training a skill.
TrainSkillDetails `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 TrainSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request TrainSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request TrainSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request TrainSkillRequest) String() string
func (request TrainSkillRequest) 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
TrainSkillResponse wrapper for the TrainSkill operation
type TrainSkillResponse 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"`
// 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 TrainSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response TrainSkillResponse) String() string
TranslationServiceEnum Enum with underlying type: string
type TranslationServiceEnum string
Set of constants representing the allowable values for TranslationServiceEnum
const (
TranslationServiceGoogle TranslationServiceEnum = "GOOGLE"
TranslationServiceMicrosoft TranslationServiceEnum = "MICROSOFT"
)
func GetMappingTranslationServiceEnum(val string) (TranslationServiceEnum, bool)
GetMappingTranslationServiceEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTranslationServiceEnumValues() []TranslationServiceEnum
GetTranslationServiceEnumValues Enumerates the set of values for TranslationServiceEnum
Translator The properties for a Translator.
type Translator struct {
// Unique immutable identifier that was assigned when the Translator was created.
Id *string `mandatory:"true" json:"id"`
// The Translation Service to use for this Translator.
Type TranslationServiceEnum `mandatory:"true" json:"type"`
// The descriptive name for this Translator.
Name *string `mandatory:"true" json:"name"`
// The base URL for invoking the Translation Service.
BaseUrl *string `mandatory:"true" json:"baseUrl"`
// The Translator'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"`
// Properties used when invoking the translation service.
// Each property is a simple key-value pair.
Properties map[string]string `mandatory:"false" json:"properties"`
// 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 Translator) String() string
func (m Translator) 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
TranslatorCollection A collection of Translator summaries.
type TranslatorCollection struct {
// The Translator summaries.
Items []TranslatorSummary `mandatory:"true" json:"items"`
}
func (m TranslatorCollection) String() string
func (m TranslatorCollection) 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
TranslatorSummary Summary of the Translator.
type TranslatorSummary struct {
// Unique immutable identifier that was assigned when the Translator was created.
Id *string `mandatory:"true" json:"id"`
// The Translation Service to use for this Translator.
Type TranslationServiceEnum `mandatory:"true" json:"type"`
// The descriptive name for this Translator.
Name *string `mandatory:"true" json:"name"`
// The Translator'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 TranslatorSummary) String() string
func (m TranslatorSummary) 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
TwilioChannel The configuration for a Twilio channel.
type TwilioChannel 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 Account SID for the Twilio number.
AccountSID *string `mandatory:"true" json:"accountSID"`
// The Twilio phone number.
PhoneNumber *string `mandatory:"true" json:"phoneNumber"`
// Whether MMS is enabled for this channel or not.
IsMmsEnabled *bool `mandatory:"true" json:"isMmsEnabled"`
// 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 original connectors URL (used for backward compatibility).
OriginalConnectorsUrl *string `mandatory:"false" json:"originalConnectorsUrl"`
// 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 TwilioChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m TwilioChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m TwilioChannel) GetDescription() *string
GetDescription returns Description
func (m TwilioChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m TwilioChannel) GetId() *string
GetId returns Id
func (m TwilioChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m TwilioChannel) GetName() *string
GetName returns Name
func (m TwilioChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m TwilioChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m TwilioChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m TwilioChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TwilioChannel) String() string
func (m TwilioChannel) 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
UpdateAndroidChannelDetails Properties to update an Android channel.
type UpdateAndroidChannelDetails 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:"false" 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"false" json:"isClientAuthenticationEnabled"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateAndroidChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAndroidChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAndroidChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAndroidChannelDetails) GetName() *string
GetName returns Name
func (m UpdateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateAndroidChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAndroidChannelDetails) String() string
func (m UpdateAndroidChannelDetails) 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
UpdateAppEventChannelDetails Properties to update an Application Event channel.
type UpdateAppEventChannelDetails 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:"false" 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 UpdateAppEventChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateAppEventChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateAppEventChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateAppEventChannelDetails) GetName() *string
GetName returns Name
func (m UpdateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateAppEventChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateAppEventChannelDetails) String() string
func (m UpdateAppEventChannelDetails) 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
UpdateApplicationChannelDetails Properties to update an Application channel.
type UpdateApplicationChannelDetails 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:"false" 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 to send response and error messages to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// True if the user id in the AIC message should be treated as an authenticated user id.
IsAuthenticatedUserId *bool `mandatory:"false" json:"isAuthenticatedUserId"`
}
func (m UpdateApplicationChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateApplicationChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateApplicationChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateApplicationChannelDetails) GetName() *string
GetName returns Name
func (m UpdateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateApplicationChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateApplicationChannelDetails) String() string
func (m UpdateApplicationChannelDetails) 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
UpdateAuthenticationProviderDetails Properties to update an Authentication Provider.
type UpdateAuthenticationProviderDetails struct {
// The IDPs URL for requesting access tokens.
TokenEndpointUrl *string `mandatory:"false" json:"tokenEndpointUrl"`
// 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 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:"false" 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:"false" 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:"false" json:"scopes"`
// 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 UpdateAuthenticationProviderDetails) String() string
func (m UpdateAuthenticationProviderDetails) 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
UpdateAuthenticationProviderRequest wrapper for the UpdateAuthenticationProvider operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateAuthenticationProvider.go.html to see an example of how to use UpdateAuthenticationProviderRequest.
type UpdateAuthenticationProviderRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Authentication Provider identifier.
AuthenticationProviderId *string `mandatory:"true" contributesTo:"path" name:"authenticationProviderId"`
// Property values to update the Authentication Provider.
UpdateAuthenticationProviderDetails `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"`
// 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 UpdateAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateAuthenticationProviderRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateAuthenticationProviderRequest) String() string
func (request UpdateAuthenticationProviderRequest) 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
UpdateAuthenticationProviderResponse wrapper for the UpdateAuthenticationProvider operation
type UpdateAuthenticationProviderResponse struct {
// The underlying http response
RawResponse *http.Response
// The AuthenticationProvider instance
AuthenticationProvider `presentIn:"body"`
// 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 UpdateAuthenticationProviderResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateAuthenticationProviderResponse) String() string
UpdateChannelDetails Properties to update a Channel.
type UpdateChannelDetails 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{}
}
UpdateChannelRequest wrapper for the UpdateChannel operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateChannel.go.html to see an example of how to use UpdateChannelRequest.
type UpdateChannelRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Channel identifier.
ChannelId *string `mandatory:"true" contributesTo:"path" name:"channelId"`
// Property values to update the Channel.
UpdateChannelDetails `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"`
// 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 UpdateChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateChannelRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateChannelRequest) String() string
func (request UpdateChannelRequest) 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
UpdateChannelResponse wrapper for the UpdateChannel operation
type UpdateChannelResponse struct {
// The underlying http response
RawResponse *http.Response
// The Channel instance
Channel `presentIn:"body"`
// 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 UpdateChannelResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateChannelResponse) String() string
UpdateCortanaChannelDetails Properties to update a Cortana channel.
type UpdateCortanaChannelDetails 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:"false" 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 Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"false" json:"msaAppId"`
// The client secret that you obtained from your bot registration.
MsaAppPassword *string `mandatory:"false" json:"msaAppPassword"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateCortanaChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateCortanaChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateCortanaChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateCortanaChannelDetails) GetName() *string
GetName returns Name
func (m UpdateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateCortanaChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateCortanaChannelDetails) String() string
func (m UpdateCortanaChannelDetails) 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
UpdateDigitalAssistantDetails Properties to update a Digital Assistant.
type UpdateDigitalAssistantDetails struct {
// 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"`
// 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 UpdateDigitalAssistantDetails) String() string
func (m UpdateDigitalAssistantDetails) 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
UpdateDigitalAssistantParameterDetails Properties to update a Digital Assistant Parameter.
type UpdateDigitalAssistantParameterDetails struct {
// The current value. The value will be interpreted based on the `type`.
Value *string `mandatory:"true" json:"value"`
}
func (m UpdateDigitalAssistantParameterDetails) String() string
func (m UpdateDigitalAssistantParameterDetails) 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
UpdateDigitalAssistantParameterRequest wrapper for the UpdateDigitalAssistantParameter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistantParameter.go.html to see an example of how to use UpdateDigitalAssistantParameterRequest.
type UpdateDigitalAssistantParameterRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// The name of a Digital Assistant Parameter. This is unique with the Digital Assistant.
ParameterName *string `mandatory:"true" contributesTo:"path" name:"parameterName"`
// Property values to update the Digital Assistant Parameter.
UpdateDigitalAssistantParameterDetails `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"`
// 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 UpdateDigitalAssistantParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalAssistantParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalAssistantParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalAssistantParameterRequest) String() string
func (request UpdateDigitalAssistantParameterRequest) 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
UpdateDigitalAssistantParameterResponse wrapper for the UpdateDigitalAssistantParameter operation
type UpdateDigitalAssistantParameterResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalAssistantParameter instance
DigitalAssistantParameter `presentIn:"body"`
// 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 UpdateDigitalAssistantParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalAssistantParameterResponse) String() string
UpdateDigitalAssistantRequest wrapper for the UpdateDigitalAssistant operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistant.go.html to see an example of how to use UpdateDigitalAssistantRequest.
type UpdateDigitalAssistantRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant identifier.
DigitalAssistantId *string `mandatory:"true" contributesTo:"path" name:"digitalAssistantId"`
// Property values to update the Digital Assistant.
UpdateDigitalAssistantDetails `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"`
// 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 UpdateDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDigitalAssistantRequest) String() string
func (request UpdateDigitalAssistantRequest) 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
UpdateDigitalAssistantResponse wrapper for the UpdateDigitalAssistant operation
type UpdateDigitalAssistantResponse struct {
// The underlying http response
RawResponse *http.Response
// The DigitalAssistant instance
DigitalAssistant `presentIn:"body"`
// 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 UpdateDigitalAssistantResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDigitalAssistantResponse) String() string
UpdateFacebookChannelDetails Properties to update a Facebook channel.
type UpdateFacebookChannelDetails 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:"false" 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 app secret for your Facebook app.
AppSecret *string `mandatory:"false" json:"appSecret"`
// The page access token that you generated for your Facebook page.
PageAccessToken *string `mandatory:"false" json:"pageAccessToken"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateFacebookChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateFacebookChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateFacebookChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateFacebookChannelDetails) GetName() *string
GetName returns Name
func (m UpdateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateFacebookChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateFacebookChannelDetails) String() string
func (m UpdateFacebookChannelDetails) 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
UpdateImportedPackageDetails Payload for updating an imported package
type UpdateImportedPackageDetails struct {
// ID of the new package (i.e. version) to import, replacing the old imported package. Leave null if no new package resources are required. The name of the new package must must match the name of the already-imported package.
CurrentPackageId *string `mandatory:"true" json:"currentPackageId"`
// A list of the updated parameter values to apply to this imported package.
ParameterValues map[string]string `mandatory:"true" 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 UpdateImportedPackageDetails) String() string
func (m UpdateImportedPackageDetails) 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
UpdateImportedPackageRequest wrapper for the UpdateImportedPackage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateImportedPackage.go.html to see an example of how to use UpdateImportedPackageRequest.
type UpdateImportedPackageRequest struct {
// Parameter values required to import the package, with updated values.
UpdateImportedPackageDetails `contributesTo:"body"`
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant package identifier.
PackageId *string `mandatory:"true" contributesTo:"path" name:"packageId"`
// Should old skills be replaced by new skills if packageId differs from already imported package?
IsReplaceSkills *bool `mandatory:"false" contributesTo:"query" name:"isReplaceSkills"`
// 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"`
// 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"`
// 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 UpdateImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateImportedPackageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateImportedPackageRequest) String() string
func (request UpdateImportedPackageRequest) 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
UpdateImportedPackageResponse wrapper for the UpdateImportedPackage operation
type UpdateImportedPackageResponse 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 UpdateImportedPackageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateImportedPackageResponse) String() string
UpdateIosChannelDetails Properties to update an iOS channel.
type UpdateIosChannelDetails 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:"false" 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"false" json:"isClientAuthenticationEnabled"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateIosChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateIosChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateIosChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateIosChannelDetails) GetName() *string
GetName returns Name
func (m UpdateIosChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateIosChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateIosChannelDetails) String() string
func (m UpdateIosChannelDetails) 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
UpdateMsTeamsChannelDetails Properties to update an MS Teams channel.
type UpdateMsTeamsChannelDetails 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:"false" 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 Microsoft App ID that you obtained when you created your bot registration in Azure.
MsaAppId *string `mandatory:"false" json:"msaAppId"`
// The client secret that you obtained from your bot registration.
MsaAppPassword *string `mandatory:"false" json:"msaAppPassword"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateMsTeamsChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateMsTeamsChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateMsTeamsChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateMsTeamsChannelDetails) GetName() *string
GetName returns Name
func (m UpdateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateMsTeamsChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateMsTeamsChannelDetails) String() string
func (m UpdateMsTeamsChannelDetails) 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
UpdateOdaInstanceAttachmentDetails ODA attachment details to be updated.
type UpdateOdaInstanceAttachmentDetails struct {
// Attachment specific metadata. Defined by the target service.
AttachmentMetadata *string `mandatory:"true" json:"attachmentMetadata"`
// List of operations that are restricted while this instance is attached.
RestrictedOperations []string `mandatory:"true" json:"restrictedOperations"`
Owner *OdaInstanceAttachmentOwner `mandatory:"true" json:"owner"`
// 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 UpdateOdaInstanceAttachmentDetails) String() string
func (m UpdateOdaInstanceAttachmentDetails) 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
UpdateOdaInstanceAttachmentRequest wrapper for the UpdateOdaInstanceAttachment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstanceAttachment.go.html to see an example of how to use UpdateOdaInstanceAttachmentRequest.
type UpdateOdaInstanceAttachmentRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Digital Assistant instance attachment identifier.
AttachmentId *string `mandatory:"true" contributesTo:"path" name:"attachmentId"`
// The information to be updated.
UpdateOdaInstanceAttachmentDetails `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"`
// 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 UpdateOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOdaInstanceAttachmentRequest) String() string
func (request UpdateOdaInstanceAttachmentRequest) 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
UpdateOdaInstanceAttachmentResponse wrapper for the UpdateOdaInstanceAttachment operation
type UpdateOdaInstanceAttachmentResponse 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"`
// 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 UpdateOdaInstanceAttachmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOdaInstanceAttachmentResponse) String() string
UpdateOdaInstanceDetails The Digital Assistant instance information to be updated.
type UpdateOdaInstanceDetails struct {
// User-friendly name for the Digital Assistant instance.
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"`
}
func (m UpdateOdaInstanceDetails) String() string
func (m UpdateOdaInstanceDetails) 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
UpdateOdaInstanceRequest wrapper for the UpdateOdaInstance operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstance.go.html to see an example of how to use UpdateOdaInstanceRequest.
type UpdateOdaInstanceRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// The information to update.
UpdateOdaInstanceDetails `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"`
// 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 UpdateOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOdaInstanceRequest) String() string
func (request UpdateOdaInstanceRequest) 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
UpdateOdaInstanceResponse wrapper for the UpdateOdaInstance operation
type UpdateOdaInstanceResponse struct {
// The underlying http response
RawResponse *http.Response
// The OdaInstance instance
OdaInstance `presentIn:"body"`
// 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 UpdateOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOdaInstanceResponse) String() string
UpdateOdaPrivateEndpointDetails The ODA Private Endpoint information to be updated.
type UpdateOdaPrivateEndpointDetails struct {
// 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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.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 UpdateOdaPrivateEndpointDetails) String() string
func (m UpdateOdaPrivateEndpointDetails) 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
UpdateOdaPrivateEndpointRequest wrapper for the UpdateOdaPrivateEndpoint operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaPrivateEndpoint.go.html to see an example of how to use UpdateOdaPrivateEndpointRequest.
type UpdateOdaPrivateEndpointRequest struct {
// Unique ODA Private Endpoint identifier which is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`
// The information to update.
UpdateOdaPrivateEndpointDetails `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"`
// 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 UpdateOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOdaPrivateEndpointRequest) String() string
func (request UpdateOdaPrivateEndpointRequest) 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
UpdateOdaPrivateEndpointResponse wrapper for the UpdateOdaPrivateEndpoint operation
type UpdateOdaPrivateEndpointResponse 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"`
// 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 UpdateOdaPrivateEndpointResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOdaPrivateEndpointResponse) String() string
UpdateOssChannelDetails Properties to update an Oracle Streaming Service (OSS) channel.
type UpdateOssChannelDetails 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:"false" 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 IDs of the Skills and Digital Assistants that the Channel is routed to.
EventSinkBotIds []string `mandatory:"false" json:"eventSinkBotIds"`
// The topic inbound messages are received on.
InboundMessageTopic *string `mandatory:"false" json:"inboundMessageTopic"`
// The topic outbound messages are sent on.
OutboundMessageTopic *string `mandatory:"false" json:"outboundMessageTopic"`
// The Oracle Streaming Service bootstrap servers.
BootstrapServers *string `mandatory:"false" 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:"false" 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:"false" json:"saslMechanism"`
// The tenancy to use when connecting to the Oracle Streaming Service.
TenancyName *string `mandatory:"false" json:"tenancyName"`
// The user name to use when connecting to the Oracle Streaming Service.
UserName *string `mandatory:"false" json:"userName"`
// The stream pool OCI to use when connecting to the Oracle Streaming Service.
StreamPoolId *string `mandatory:"false" json:"streamPoolId"`
// The authentication token to use when connecting to the Oracle Streaming Service.
AuthToken *string `mandatory:"false" json:"authToken"`
}
func (m UpdateOssChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOssChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateOssChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOssChannelDetails) GetName() *string
GetName returns Name
func (m UpdateOssChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateOssChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOssChannelDetails) String() string
func (m UpdateOssChannelDetails) 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
UpdateOsvcChannelDetails Properties required to update an OSVC channel.
type UpdateOsvcChannelDetails 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:"false" 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 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:"false" json:"host"`
// The port.
Port *string `mandatory:"false" json:"port"`
// The user name for the digital-assistant agent.
UserName *string `mandatory:"false" json:"userName"`
// The password for the digital-assistant agent.
Password *string `mandatory:"false" json:"password"`
// The total session count.
TotalSessionCount *int `mandatory:"false" json:"totalSessionCount"`
// The name of the Authentication Provider to use to authenticate the user.
AuthenticationProviderName *string `mandatory:"false" json:"authenticationProviderName"`
// 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 UpdateOsvcChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateOsvcChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateOsvcChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateOsvcChannelDetails) GetName() *string
GetName returns Name
func (m UpdateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateOsvcChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateOsvcChannelDetails) String() string
func (m UpdateOsvcChannelDetails) 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
UpdateServiceCloudChannelDetails Properties to update a Service Cloud agent channel.
type UpdateServiceCloudChannelDetails 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:"false" 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 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:"false" 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:"false" json:"hostNamePrefix"`
// The user name for an Oracle B2C Service staff member who has the necessary profile permissions.
UserName *string `mandatory:"false" json:"userName"`
// The password for the Oracle B2C Service staff member who has the necessary profile permissions.
Password *string `mandatory:"false" json:"password"`
// The type of Service Cloud client.
ClientType ServiceCloudClientTypeEnum `mandatory:"false" json:"clientType,omitempty"`
}
func (m UpdateServiceCloudChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateServiceCloudChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateServiceCloudChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateServiceCloudChannelDetails) GetName() *string
GetName returns Name
func (m UpdateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateServiceCloudChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateServiceCloudChannelDetails) String() string
func (m UpdateServiceCloudChannelDetails) 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
UpdateSkillDetails Properties to update a Skill.
type UpdateSkillDetails struct {
// 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"`
// 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 UpdateSkillDetails) String() string
func (m UpdateSkillDetails) 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
UpdateSkillParameterDetails Properties to update a Skill Parameter.
type UpdateSkillParameterDetails struct {
// The display name for the Parameter.
DisplayName *string `mandatory:"false" json:"displayName"`
// A description of the Parameter.
Description *string `mandatory:"false" json:"description"`
// The current value. The value will be interpreted based on the `type`.
Value *string `mandatory:"false" json:"value"`
}
func (m UpdateSkillParameterDetails) String() string
func (m UpdateSkillParameterDetails) 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
UpdateSkillParameterRequest wrapper for the UpdateSkillParameter operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkillParameter.go.html to see an example of how to use UpdateSkillParameterRequest.
type UpdateSkillParameterRequest 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"`
// The name of a Skill Parameter.
ParameterName *string `mandatory:"true" contributesTo:"path" name:"parameterName"`
// Property values to update the Skill Parameter.
UpdateSkillParameterDetails `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"`
// 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 UpdateSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSkillParameterRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSkillParameterRequest) String() string
func (request UpdateSkillParameterRequest) 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
UpdateSkillParameterResponse wrapper for the UpdateSkillParameter operation
type UpdateSkillParameterResponse struct {
// The underlying http response
RawResponse *http.Response
// The SkillParameter instance
SkillParameter `presentIn:"body"`
// 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 UpdateSkillParameterResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSkillParameterResponse) String() string
UpdateSkillRequest wrapper for the UpdateSkill operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkill.go.html to see an example of how to use UpdateSkillRequest.
type UpdateSkillRequest 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 to update the Skill.
UpdateSkillDetails `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"`
// 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 UpdateSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSkillRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSkillRequest) String() string
func (request UpdateSkillRequest) 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
UpdateSkillResponse wrapper for the UpdateSkill operation
type UpdateSkillResponse struct {
// The underlying http response
RawResponse *http.Response
// The Skill instance
Skill `presentIn:"body"`
// 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 UpdateSkillResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSkillResponse) String() string
UpdateSlackChannelDetails Properties to update a Slack channel.
type UpdateSlackChannelDetails 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:"false" 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 Slack Client Id for the Slack app.
ClientId *string `mandatory:"false" json:"clientId"`
// The URL to redirect to when authentication is successful.
AuthSuccessUrl *string `mandatory:"false" json:"authSuccessUrl"`
// The URL to redirect to when authentication is unsuccessful.
AuthErrorUrl *string `mandatory:"false" json:"authErrorUrl"`
// The Signing Secret for the Slack App.
SigningSecret *string `mandatory:"false" json:"signingSecret"`
// The Client Secret for the Slack App.
ClientSecret *string `mandatory:"false" json:"clientSecret"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateSlackChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateSlackChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateSlackChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateSlackChannelDetails) GetName() *string
GetName returns Name
func (m UpdateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateSlackChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateSlackChannelDetails) String() string
func (m UpdateSlackChannelDetails) 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
UpdateTranslatorDetails Properties to update a Translator.
type UpdateTranslatorDetails struct {
// The base URL for invoking the Translation Service.
BaseUrl *string `mandatory:"false" json:"baseUrl"`
// The authentication token to use when invoking the Translation Service
AuthToken *string `mandatory:"false" json:"authToken"`
// Properties used when invoking the translation service.
// Each property is a simple key-value pair.
Properties map[string]string `mandatory:"false" json:"properties"`
// 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 UpdateTranslatorDetails) String() string
func (m UpdateTranslatorDetails) 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
UpdateTranslatorRequest wrapper for the UpdateTranslator operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateTranslator.go.html to see an example of how to use UpdateTranslatorRequest.
type UpdateTranslatorRequest struct {
// Unique Digital Assistant instance identifier.
OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"`
// Unique Translator identifier.
TranslatorId *string `mandatory:"true" contributesTo:"path" name:"translatorId"`
// Property values to update the Translator.
UpdateTranslatorDetails `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"`
// 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 UpdateTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateTranslatorRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateTranslatorRequest) String() string
func (request UpdateTranslatorRequest) 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
UpdateTranslatorResponse wrapper for the UpdateTranslator operation
type UpdateTranslatorResponse struct {
// The underlying http response
RawResponse *http.Response
// The Translator instance
Translator `presentIn:"body"`
// 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 UpdateTranslatorResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateTranslatorResponse) String() string
UpdateTwilioChannelDetails Properties to update a Twilio channel.
type UpdateTwilioChannelDetails 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:"false" 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 Account SID for the Twilio number.
AccountSID *string `mandatory:"false" json:"accountSID"`
// The Twilio phone number.
PhoneNumber *string `mandatory:"false" json:"phoneNumber"`
// The Auth Token for the Twilio number.
AuthToken *string `mandatory:"false" json:"authToken"`
// Whether MMS is enabled for this channel or not.
IsMmsEnabled *bool `mandatory:"false" json:"isMmsEnabled"`
// The original connectors URL (used for backward compatibility).
OriginalConnectorsUrl *string `mandatory:"false" json:"originalConnectorsUrl"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateTwilioChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateTwilioChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateTwilioChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateTwilioChannelDetails) GetName() *string
GetName returns Name
func (m UpdateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateTwilioChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateTwilioChannelDetails) String() string
func (m UpdateTwilioChannelDetails) 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
UpdateWebChannelDetails Properties to update a Web channel.
type UpdateWebChannelDetails 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:"false" 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 maximum time until the token expires (in minutes).
MaxTokenExpirationTimeInMinutes *int64 `mandatory:"false" json:"maxTokenExpirationTimeInMinutes"`
// Whether client authentication is enabled or not.
IsClientAuthenticationEnabled *bool `mandatory:"false" json:"isClientAuthenticationEnabled"`
// A comma-delimited whitelist of allowed domains.
//
// The channel will only communicate with the sites from the domains that you add to this list.
// For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access
// to the channel from any domain.
//
// Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.
AllowedDomains *string `mandatory:"false" json:"allowedDomains"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
}
func (m UpdateWebChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateWebChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateWebChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateWebChannelDetails) GetName() *string
GetName returns Name
func (m UpdateWebChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateWebChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateWebChannelDetails) String() string
func (m UpdateWebChannelDetails) 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
UpdateWebhookChannelDetails Properties to update a Webhook channel.
type UpdateWebhookChannelDetails 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:"false" 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 to send responses to.
OutboundUrl *string `mandatory:"false" json:"outboundUrl"`
// The ID of the Skill or Digital Assistant that the Channel is routed to.
BotId *string `mandatory:"false" json:"botId"`
// The version for payloads.
PayloadVersion WebhookPayloadVersionEnum `mandatory:"false" json:"payloadVersion,omitempty"`
}
func (m UpdateWebhookChannelDetails) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m UpdateWebhookChannelDetails) GetDescription() *string
GetDescription returns Description
func (m UpdateWebhookChannelDetails) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m UpdateWebhookChannelDetails) GetName() *string
GetName returns Name
func (m UpdateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m UpdateWebhookChannelDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m UpdateWebhookChannelDetails) String() string
func (m UpdateWebhookChannelDetails) 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
ValueListEntity Metadata for a value list entity.
type ValueListEntity struct {
// Unique immutable identifier that was assigned when the resource was created.
Id *string `mandatory:"true" json:"id"`
// The entity name. This must be unique within the parent resource.
Name *string `mandatory:"true" json:"name"`
// List of values for a value list entity.
Values []StaticEntityValue `mandatory:"true" json:"values"`
}
func (m ValueListEntity) GetId() *string
GetId returns Id
func (m ValueListEntity) GetName() *string
GetName returns Name
func (m ValueListEntity) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ValueListEntity) String() string
func (m ValueListEntity) 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
WebChannel The configuration for a Web channel.
type WebChannel 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"`
// A comma-delimited whitelist of allowed domains.
//
// The channel will only communicate with the sites from the domains that you add to this list.
// For example, *.corp.example.com, *.hdr.example.com. Entering a single asterisk (*) allows unrestricted access
// to the channel from any domain.
//
// Typically, you'd only enter a single asterisk during development. For production, you would add an allowlist of domains.
AllowedDomains *string `mandatory:"false" json:"allowedDomains"`
// 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 WebChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m WebChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m WebChannel) GetDescription() *string
GetDescription returns Description
func (m WebChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m WebChannel) GetId() *string
GetId returns Id
func (m WebChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m WebChannel) GetName() *string
GetName returns Name
func (m WebChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m WebChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m WebChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m WebChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m WebChannel) String() string
func (m WebChannel) 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
WebhookChannel The configuration for a Webhook channel.
type WebhookChannel 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 send 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 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 version for payloads.
PayloadVersion WebhookPayloadVersionEnum `mandatory:"true" json:"payloadVersion"`
}
func (m WebhookChannel) GetCategory() ChannelCategoryEnum
GetCategory returns Category
func (m WebhookChannel) GetDefinedTags() map[string]map[string]interface{}
GetDefinedTags returns DefinedTags
func (m WebhookChannel) GetDescription() *string
GetDescription returns Description
func (m WebhookChannel) GetFreeformTags() map[string]string
GetFreeformTags returns FreeformTags
func (m WebhookChannel) GetId() *string
GetId returns Id
func (m WebhookChannel) GetLifecycleState() LifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m WebhookChannel) GetName() *string
GetName returns Name
func (m WebhookChannel) GetSessionExpiryDurationInMilliseconds() *int64
GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds
func (m WebhookChannel) GetTimeCreated() *common.SDKTime
GetTimeCreated returns TimeCreated
func (m WebhookChannel) GetTimeUpdated() *common.SDKTime
GetTimeUpdated returns TimeUpdated
func (m WebhookChannel) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m WebhookChannel) String() string
func (m WebhookChannel) 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
WebhookPayloadVersionEnum Enum with underlying type: string
type WebhookPayloadVersionEnum string
Set of constants representing the allowable values for WebhookPayloadVersionEnum
const (
WebhookPayloadVersion10 WebhookPayloadVersionEnum = "1.0"
WebhookPayloadVersion11 WebhookPayloadVersionEnum = "1.1"
)
func GetMappingWebhookPayloadVersionEnum(val string) (WebhookPayloadVersionEnum, bool)
GetMappingWebhookPayloadVersionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWebhookPayloadVersionEnumValues() []WebhookPayloadVersionEnum
GetWebhookPayloadVersionEnumValues Enumerates the set of values for WebhookPayloadVersionEnum
WorkRequest The description of work request, including its status.
type WorkRequest struct {
// The identifier of the work request.
Id *string `mandatory:"true" json:"id"`
// The identifier of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The identifier of the Digital Assistant instance to which this work request pertains.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The identifier of the resource to which this work request pertains.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The type of the operation that's associated with the work request.
RequestAction WorkRequestRequestActionEnum `mandatory:"true" json:"requestAction"`
// The status of current work request.
Status WorkRequestStatusEnum `mandatory:"true" json:"status"`
// The resources that this work request affects.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time that the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// A short message that provides more detail about the current status.
// For example, if a work request fails, then this may include information
// about why it failed.
StatusMessage *string `mandatory:"false" json:"statusMessage"`
// The date and time that the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), CKQ
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time that the object finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). CKQ
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) 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
WorkRequestError Description of the unexpected error that prevented completion of the request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. Error codes are listed at
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human-readable description of the issue.
Message *string `mandatory:"true" json:"message"`
// When the error occurred. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeStamp *common.SDKTime `mandatory:"true" json:"timeStamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) 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
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// When the log message was written. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeStamp *common.SDKTime `mandatory:"true" json:"timeStamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) 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
WorkRequestRequestActionEnum Enum with underlying type: string
type WorkRequestRequestActionEnum string
Set of constants representing the allowable values for WorkRequestRequestActionEnum
const (
WorkRequestRequestActionCreateOdaInstance WorkRequestRequestActionEnum = "CREATE_ODA_INSTANCE"
WorkRequestRequestActionUpgradeOdaInstance WorkRequestRequestActionEnum = "UPGRADE_ODA_INSTANCE"
WorkRequestRequestActionDeleteOdaInstance WorkRequestRequestActionEnum = "DELETE_ODA_INSTANCE"
WorkRequestRequestActionPurgeOdaInstance WorkRequestRequestActionEnum = "PURGE_ODA_INSTANCE"
WorkRequestRequestActionRecoverOdaInstance WorkRequestRequestActionEnum = "RECOVER_ODA_INSTANCE"
WorkRequestRequestActionStopOdaInstance WorkRequestRequestActionEnum = "STOP_ODA_INSTANCE"
WorkRequestRequestActionStartOdaInstance WorkRequestRequestActionEnum = "START_ODA_INSTANCE"
WorkRequestRequestActionChangeOdaInstanceCompartment WorkRequestRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT"
WorkRequestRequestActionChangeCustEncKey WorkRequestRequestActionEnum = "CHANGE_CUST_ENC_KEY"
WorkRequestRequestActionDeactCustEncKey WorkRequestRequestActionEnum = "DEACT_CUST_ENC_KEY"
WorkRequestRequestActionCreateAssociation WorkRequestRequestActionEnum = "CREATE_ASSOCIATION"
WorkRequestRequestActionDeleteAssociation WorkRequestRequestActionEnum = "DELETE_ASSOCIATION"
WorkRequestRequestActionCreatePcsInstance WorkRequestRequestActionEnum = "CREATE_PCS_INSTANCE"
WorkRequestRequestActionUpdateEntitlementsForCacct WorkRequestRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT"
WorkRequestRequestActionLookupOdaInstancesForCacct WorkRequestRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT"
WorkRequestRequestActionCreateOdaInstanceAttachment WorkRequestRequestActionEnum = "CREATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestRequestActionUpdateOdaInstanceAttachment WorkRequestRequestActionEnum = "UPDATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestRequestActionDeleteOdaInstanceAttachment WorkRequestRequestActionEnum = "DELETE_ODA_INSTANCE_ATTACHMENT"
WorkRequestRequestActionCreateImportedPackage WorkRequestRequestActionEnum = "CREATE_IMPORTED_PACKAGE"
WorkRequestRequestActionUpdateImportedPackage WorkRequestRequestActionEnum = "UPDATE_IMPORTED_PACKAGE"
WorkRequestRequestActionDeleteImportedPackage WorkRequestRequestActionEnum = "DELETE_IMPORTED_PACKAGE"
WorkRequestRequestActionImportBot WorkRequestRequestActionEnum = "IMPORT_BOT"
WorkRequestRequestActionCreateSkill WorkRequestRequestActionEnum = "CREATE_SKILL"
WorkRequestRequestActionCloneSkill WorkRequestRequestActionEnum = "CLONE_SKILL"
WorkRequestRequestActionExtendSkill WorkRequestRequestActionEnum = "EXTEND_SKILL"
WorkRequestRequestActionVersionSkill WorkRequestRequestActionEnum = "VERSION_SKILL"
WorkRequestRequestActionExportSkill WorkRequestRequestActionEnum = "EXPORT_SKILL"
WorkRequestRequestActionCreateDigitalAssistant WorkRequestRequestActionEnum = "CREATE_DIGITAL_ASSISTANT"
WorkRequestRequestActionCloneDigitalAssistant WorkRequestRequestActionEnum = "CLONE_DIGITAL_ASSISTANT"
WorkRequestRequestActionExtendDigitalAssistant WorkRequestRequestActionEnum = "EXTEND_DIGITAL_ASSISTANT"
WorkRequestRequestActionVersionDigitalAssistant WorkRequestRequestActionEnum = "VERSION_DIGITAL_ASSISTANT"
WorkRequestRequestActionExportDigitalAssistant WorkRequestRequestActionEnum = "EXPORT_DIGITAL_ASSISTANT"
WorkRequestRequestActionCreateOdaPrivateEndpoint WorkRequestRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT"
WorkRequestRequestActionDeleteOdaPrivateEndpoint WorkRequestRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT"
WorkRequestRequestActionUpdateOdaPrivateEndpoint WorkRequestRequestActionEnum = "UPDATE_ODA_PRIVATE_ENDPOINT"
WorkRequestRequestActionChangeOdaPrivateEndpointCompartment WorkRequestRequestActionEnum = "CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT"
WorkRequestRequestActionCreateOdaPrivateEndpointScanProxy WorkRequestRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY"
WorkRequestRequestActionDeleteOdaPrivateEndpointScanProxy WorkRequestRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY"
WorkRequestRequestActionCreateOdaPrivateEndpointAttachment WorkRequestRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT_ATTACHMENT"
WorkRequestRequestActionDeleteOdaPrivateEndpointAttachment WorkRequestRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT_ATTACHMENT"
WorkRequestRequestActionTrainSkill WorkRequestRequestActionEnum = "TRAIN_SKILL"
WorkRequestRequestActionDeleteSkillEntities WorkRequestRequestActionEnum = "DELETE_SKILL_ENTITIES"
WorkRequestRequestActionImportSkillEntities WorkRequestRequestActionEnum = "IMPORT_SKILL_ENTITIES"
)
func GetMappingWorkRequestRequestActionEnum(val string) (WorkRequestRequestActionEnum, bool)
GetMappingWorkRequestRequestActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum
GetWorkRequestRequestActionEnumValues Enumerates the set of values for WorkRequestRequestActionEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The action to take against the resource.
ResourceAction WorkRequestResourceResourceActionEnum `mandatory:"true" json:"resourceAction"`
// The resource type that the work request affects.
ResourceType *string `mandatory:"true" json:"resourceType"`
// The identifier of the resource that is the subject of the request.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The current state of the work request. The `SUCCEEDED`, `FAILED`, AND `CANCELED` states
// correspond to the action being performed.
Status WorkRequestResourceStatusEnum `mandatory:"true" json:"status"`
// Short message providing more detail for the current status. For example, if an operation fails
// this may include information about the reason for the failure and a possible resolution.
StatusMessage *string `mandatory:"false" json:"statusMessage"`
// The URI path that the user can do a GET on to access the resource metadata.
ResourceUri *string `mandatory:"false" json:"resourceUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) 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
WorkRequestResourceResourceActionEnum Enum with underlying type: string
type WorkRequestResourceResourceActionEnum string
Set of constants representing the allowable values for WorkRequestResourceResourceActionEnum
const (
WorkRequestResourceResourceActionCreate WorkRequestResourceResourceActionEnum = "CREATE"
WorkRequestResourceResourceActionUpdate WorkRequestResourceResourceActionEnum = "UPDATE"
WorkRequestResourceResourceActionDelete WorkRequestResourceResourceActionEnum = "DELETE"
WorkRequestResourceResourceActionPurge WorkRequestResourceResourceActionEnum = "PURGE"
WorkRequestResourceResourceActionRecover WorkRequestResourceResourceActionEnum = "RECOVER"
WorkRequestResourceResourceActionStop WorkRequestResourceResourceActionEnum = "STOP"
WorkRequestResourceResourceActionStart WorkRequestResourceResourceActionEnum = "START"
WorkRequestResourceResourceActionChangeCompartment WorkRequestResourceResourceActionEnum = "CHANGE_COMPARTMENT"
WorkRequestResourceResourceActionChangeCustEncKey WorkRequestResourceResourceActionEnum = "CHANGE_CUST_ENC_KEY"
WorkRequestResourceResourceActionDeactCustEncKey WorkRequestResourceResourceActionEnum = "DEACT_CUST_ENC_KEY"
WorkRequestResourceResourceActionCreateAssociation WorkRequestResourceResourceActionEnum = "CREATE_ASSOCIATION"
WorkRequestResourceResourceActionDeleteAssociation WorkRequestResourceResourceActionEnum = "DELETE_ASSOCIATION"
WorkRequestResourceResourceActionUpdateEntitlementsForCacct WorkRequestResourceResourceActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT"
WorkRequestResourceResourceActionCreateOdaInstanceAttachment WorkRequestResourceResourceActionEnum = "CREATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestResourceResourceActionUpdateOdaInstanceAttachment WorkRequestResourceResourceActionEnum = "UPDATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestResourceResourceActionDeleteOdaInstanceAttachment WorkRequestResourceResourceActionEnum = "DELETE_ODA_INSTANCE_ATTACHMENT"
WorkRequestResourceResourceActionCreateImportedPackage WorkRequestResourceResourceActionEnum = "CREATE_IMPORTED_PACKAGE"
WorkRequestResourceResourceActionUpdateImportedPackage WorkRequestResourceResourceActionEnum = "UPDATE_IMPORTED_PACKAGE"
WorkRequestResourceResourceActionDeleteImportedPackage WorkRequestResourceResourceActionEnum = "DELETE_IMPORTED_PACKAGE"
WorkRequestResourceResourceActionExport WorkRequestResourceResourceActionEnum = "EXPORT"
)
func GetMappingWorkRequestResourceResourceActionEnum(val string) (WorkRequestResourceResourceActionEnum, bool)
GetMappingWorkRequestResourceResourceActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceResourceActionEnumValues() []WorkRequestResourceResourceActionEnum
GetWorkRequestResourceResourceActionEnumValues Enumerates the set of values for WorkRequestResourceResourceActionEnum
WorkRequestResourceStatusEnum Enum with underlying type: string
type WorkRequestResourceStatusEnum string
Set of constants representing the allowable values for WorkRequestResourceStatusEnum
const (
WorkRequestResourceStatusAccepted WorkRequestResourceStatusEnum = "ACCEPTED"
WorkRequestResourceStatusInProgress WorkRequestResourceStatusEnum = "IN_PROGRESS"
WorkRequestResourceStatusSucceeded WorkRequestResourceStatusEnum = "SUCCEEDED"
WorkRequestResourceStatusFailed WorkRequestResourceStatusEnum = "FAILED"
WorkRequestResourceStatusCanceling WorkRequestResourceStatusEnum = "CANCELING"
WorkRequestResourceStatusCanceled WorkRequestResourceStatusEnum = "CANCELED"
)
func GetMappingWorkRequestResourceStatusEnum(val string) (WorkRequestResourceStatusEnum, bool)
GetMappingWorkRequestResourceStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceStatusEnumValues() []WorkRequestResourceStatusEnum
GetWorkRequestResourceStatusEnumValues Enumerates the set of values for WorkRequestResourceStatusEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const (
WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED"
WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED"
WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED"
WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING"
WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED"
)
func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A description of the work request's status.
type WorkRequestSummary struct {
// The identifier of the work request.
Id *string `mandatory:"true" json:"id"`
// The identifier of the compartment that contains the work request.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The identifier of the Digital Assistant instance to which this work request pertains.
OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`
// The identifier of the resource to which this work request pertains.
ResourceId *string `mandatory:"true" json:"resourceId"`
// The type of the operation that's associated with the work request.
RequestAction WorkRequestSummaryRequestActionEnum `mandatory:"true" json:"requestAction"`
// The status of current work request.
Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`
// The resources that this work request affects.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) 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
WorkRequestSummaryRequestActionEnum Enum with underlying type: string
type WorkRequestSummaryRequestActionEnum string
Set of constants representing the allowable values for WorkRequestSummaryRequestActionEnum
const (
WorkRequestSummaryRequestActionCreateOdaInstance WorkRequestSummaryRequestActionEnum = "CREATE_ODA_INSTANCE"
WorkRequestSummaryRequestActionUpgradeOdaInstance WorkRequestSummaryRequestActionEnum = "UPGRADE_ODA_INSTANCE"
WorkRequestSummaryRequestActionDeleteOdaInstance WorkRequestSummaryRequestActionEnum = "DELETE_ODA_INSTANCE"
WorkRequestSummaryRequestActionPurgeOdaInstance WorkRequestSummaryRequestActionEnum = "PURGE_ODA_INSTANCE"
WorkRequestSummaryRequestActionRecoverOdaInstance WorkRequestSummaryRequestActionEnum = "RECOVER_ODA_INSTANCE"
WorkRequestSummaryRequestActionStopOdaInstance WorkRequestSummaryRequestActionEnum = "STOP_ODA_INSTANCE"
WorkRequestSummaryRequestActionStartOdaInstance WorkRequestSummaryRequestActionEnum = "START_ODA_INSTANCE"
WorkRequestSummaryRequestActionChangeOdaInstanceCompartment WorkRequestSummaryRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT"
WorkRequestSummaryRequestActionChangeCustEncKey WorkRequestSummaryRequestActionEnum = "CHANGE_CUST_ENC_KEY"
WorkRequestSummaryRequestActionDeactCustEncKey WorkRequestSummaryRequestActionEnum = "DEACT_CUST_ENC_KEY"
WorkRequestSummaryRequestActionCreateAssociation WorkRequestSummaryRequestActionEnum = "CREATE_ASSOCIATION"
WorkRequestSummaryRequestActionDeleteAssociation WorkRequestSummaryRequestActionEnum = "DELETE_ASSOCIATION"
WorkRequestSummaryRequestActionUpdateEntitlementsForCacct WorkRequestSummaryRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT"
WorkRequestSummaryRequestActionLookupOdaInstancesForCacct WorkRequestSummaryRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT"
WorkRequestSummaryRequestActionCreateOdaInstanceAttachment WorkRequestSummaryRequestActionEnum = "CREATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestSummaryRequestActionUpdateOdaInstanceAttachment WorkRequestSummaryRequestActionEnum = "UPDATE_ODA_INSTANCE_ATTACHMENT"
WorkRequestSummaryRequestActionDeleteOdaInstanceAttachment WorkRequestSummaryRequestActionEnum = "DELETE_ODA_INSTANCE_ATTACHMENT"
WorkRequestSummaryRequestActionCreateImportedPackage WorkRequestSummaryRequestActionEnum = "CREATE_IMPORTED_PACKAGE"
WorkRequestSummaryRequestActionUpdateImportedPackage WorkRequestSummaryRequestActionEnum = "UPDATE_IMPORTED_PACKAGE"
WorkRequestSummaryRequestActionDeleteImportedPackage WorkRequestSummaryRequestActionEnum = "DELETE_IMPORTED_PACKAGE"
WorkRequestSummaryRequestActionImportBot WorkRequestSummaryRequestActionEnum = "IMPORT_BOT"
WorkRequestSummaryRequestActionCreateSkill WorkRequestSummaryRequestActionEnum = "CREATE_SKILL"
WorkRequestSummaryRequestActionCloneSkill WorkRequestSummaryRequestActionEnum = "CLONE_SKILL"
WorkRequestSummaryRequestActionExtendSkill WorkRequestSummaryRequestActionEnum = "EXTEND_SKILL"
WorkRequestSummaryRequestActionVersionSkill WorkRequestSummaryRequestActionEnum = "VERSION_SKILL"
WorkRequestSummaryRequestActionExportSkill WorkRequestSummaryRequestActionEnum = "EXPORT_SKILL"
WorkRequestSummaryRequestActionCreateDigitalAssistant WorkRequestSummaryRequestActionEnum = "CREATE_DIGITAL_ASSISTANT"
WorkRequestSummaryRequestActionCloneDigitalAssistant WorkRequestSummaryRequestActionEnum = "CLONE_DIGITAL_ASSISTANT"
WorkRequestSummaryRequestActionExtendDigitalAssistant WorkRequestSummaryRequestActionEnum = "EXTEND_DIGITAL_ASSISTANT"
WorkRequestSummaryRequestActionVersionDigitalAssistant WorkRequestSummaryRequestActionEnum = "VERSION_DIGITAL_ASSISTANT"
WorkRequestSummaryRequestActionExportDigitalAssistant WorkRequestSummaryRequestActionEnum = "EXPORT_DIGITAL_ASSISTANT"
WorkRequestSummaryRequestActionCreateOdaPrivateEndpoint WorkRequestSummaryRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT"
WorkRequestSummaryRequestActionDeleteOdaPrivateEndpoint WorkRequestSummaryRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT"
WorkRequestSummaryRequestActionUpdateOdaPrivateEndpoint WorkRequestSummaryRequestActionEnum = "UPDATE_ODA_PRIVATE_ENDPOINT"
WorkRequestSummaryRequestActionChangeOdaPrivateEndpointCompartment WorkRequestSummaryRequestActionEnum = "CHANGE_ODA_PRIVATE_ENDPOINT_COMPARTMENT"
WorkRequestSummaryRequestActionCreateOdaPrivateEndpointScanProxy WorkRequestSummaryRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY"
WorkRequestSummaryRequestActionDeleteOdaPrivateEndpointScanProxy WorkRequestSummaryRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT_SCAN_PROXY"
WorkRequestSummaryRequestActionCreateOdaPrivateEndpointAttachment WorkRequestSummaryRequestActionEnum = "CREATE_ODA_PRIVATE_ENDPOINT_ATTACHMENT"
WorkRequestSummaryRequestActionDeleteOdaPrivateEndpointAttachment WorkRequestSummaryRequestActionEnum = "DELETE_ODA_PRIVATE_ENDPOINT_ATTACHMENT"
)
func GetMappingWorkRequestSummaryRequestActionEnum(val string) (WorkRequestSummaryRequestActionEnum, bool)
GetMappingWorkRequestSummaryRequestActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryRequestActionEnumValues() []WorkRequestSummaryRequestActionEnum
GetWorkRequestSummaryRequestActionEnumValues Enumerates the set of values for WorkRequestSummaryRequestActionEnum
WorkRequestSummaryStatusEnum Enum with underlying type: string
type WorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for WorkRequestSummaryStatusEnum
const (
WorkRequestSummaryStatusAccepted WorkRequestSummaryStatusEnum = "ACCEPTED"
WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
WorkRequestSummaryStatusSucceeded WorkRequestSummaryStatusEnum = "SUCCEEDED"
WorkRequestSummaryStatusFailed WorkRequestSummaryStatusEnum = "FAILED"
WorkRequestSummaryStatusCanceling WorkRequestSummaryStatusEnum = "CANCELING"
WorkRequestSummaryStatusCanceled WorkRequestSummaryStatusEnum = "CANCELED"
)
func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)
GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum