oda

package
v65.65.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2024 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 1

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetAuthenticationGrantTypeEnumStringValues ¶ added in v65.7.0

func GetAuthenticationGrantTypeEnumStringValues() []string

GetAuthenticationGrantTypeEnumStringValues Enumerates the set of values in String for AuthenticationGrantTypeEnum

func GetAuthenticationIdentityProviderEnumStringValues ¶ added in v65.7.0

func GetAuthenticationIdentityProviderEnumStringValues() []string

GetAuthenticationIdentityProviderEnumStringValues Enumerates the set of values in String for AuthenticationIdentityProviderEnum

func GetBotMultilingualModeEnumStringValues ¶ added in v65.7.0

func GetBotMultilingualModeEnumStringValues() []string

GetBotMultilingualModeEnumStringValues Enumerates the set of values in String for BotMultilingualModeEnum

func GetBotPublishStateEnumStringValues ¶ added in v65.7.0

func GetBotPublishStateEnumStringValues() []string

GetBotPublishStateEnumStringValues Enumerates the set of values in String for BotPublishStateEnum

func GetChannelCategoryEnumStringValues ¶ added in v65.7.0

func GetChannelCategoryEnumStringValues() []string

GetChannelCategoryEnumStringValues Enumerates the set of values in String for ChannelCategoryEnum

func GetChannelTypeEnumStringValues ¶ added in v65.7.0

func GetChannelTypeEnumStringValues() []string

GetChannelTypeEnumStringValues Enumerates the set of values in String for ChannelTypeEnum

func GetCreateBotKindEnumStringValues ¶ added in v65.7.0

func GetCreateBotKindEnumStringValues() []string

GetCreateBotKindEnumStringValues Enumerates the set of values in String for CreateBotKindEnum

func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumStringValues ¶ added in v65.7.0

func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumStringValues() []string

GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumStringValues Enumerates the set of values in String for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum

func GetCreateOdaInstanceDetailsShapeNameEnumStringValues ¶

func GetCreateOdaInstanceDetailsShapeNameEnumStringValues() []string

GetCreateOdaInstanceDetailsShapeNameEnumStringValues Enumerates the set of values in String for CreateOdaInstanceDetailsShapeNameEnum

func GetEntityAttributeTypeEnumStringValues ¶ added in v65.60.0

func GetEntityAttributeTypeEnumStringValues() []string

GetEntityAttributeTypeEnumStringValues Enumerates the set of values in String for EntityAttributeTypeEnum

func GetEntityTypeEnumStringValues ¶ added in v65.60.0

func GetEntityTypeEnumStringValues() []string

GetEntityTypeEnumStringValues Enumerates the set of values in String for EntityTypeEnum

func GetImportedPackageStatusEnumStringValues ¶ added in v65.7.0

func GetImportedPackageStatusEnumStringValues() []string

GetImportedPackageStatusEnumStringValues Enumerates the set of values in String for ImportedPackageStatusEnum

func GetLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetLifecycleStateEnumStringValues() []string

GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum

func GetListAuthenticationProvidersIdentityProviderEnumStringValues ¶ added in v65.7.0

func GetListAuthenticationProvidersIdentityProviderEnumStringValues() []string

GetListAuthenticationProvidersIdentityProviderEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersIdentityProviderEnum

func GetListAuthenticationProvidersLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListAuthenticationProvidersLifecycleStateEnumStringValues() []string

GetListAuthenticationProvidersLifecycleStateEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersLifecycleStateEnum

func GetListAuthenticationProvidersSortByEnumStringValues ¶ added in v65.7.0

func GetListAuthenticationProvidersSortByEnumStringValues() []string

GetListAuthenticationProvidersSortByEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersSortByEnum

func GetListAuthenticationProvidersSortOrderEnumStringValues ¶ added in v65.7.0

func GetListAuthenticationProvidersSortOrderEnumStringValues() []string

GetListAuthenticationProvidersSortOrderEnumStringValues Enumerates the set of values in String for ListAuthenticationProvidersSortOrderEnum

func GetListChannelsCategoryEnumStringValues ¶ added in v65.7.0

func GetListChannelsCategoryEnumStringValues() []string

GetListChannelsCategoryEnumStringValues Enumerates the set of values in String for ListChannelsCategoryEnum

func GetListChannelsLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListChannelsLifecycleStateEnumStringValues() []string

GetListChannelsLifecycleStateEnumStringValues Enumerates the set of values in String for ListChannelsLifecycleStateEnum

func GetListChannelsSortByEnumStringValues ¶ added in v65.7.0

func GetListChannelsSortByEnumStringValues() []string

GetListChannelsSortByEnumStringValues Enumerates the set of values in String for ListChannelsSortByEnum

func GetListChannelsSortOrderEnumStringValues ¶ added in v65.7.0

func GetListChannelsSortOrderEnumStringValues() []string

GetListChannelsSortOrderEnumStringValues Enumerates the set of values in String for ListChannelsSortOrderEnum

func GetListChannelsTypeEnumStringValues ¶ added in v65.7.0

func GetListChannelsTypeEnumStringValues() []string

GetListChannelsTypeEnumStringValues Enumerates the set of values in String for ListChannelsTypeEnum

func GetListDigitalAssistantParametersLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersLifecycleStateEnumStringValues() []string

GetListDigitalAssistantParametersLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersLifecycleStateEnum

func GetListDigitalAssistantParametersSortByEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersSortByEnumStringValues() []string

GetListDigitalAssistantParametersSortByEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersSortByEnum

func GetListDigitalAssistantParametersSortOrderEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersSortOrderEnumStringValues() []string

GetListDigitalAssistantParametersSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalAssistantParametersSortOrderEnum

func GetListDigitalAssistantsLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantsLifecycleStateEnumStringValues() []string

GetListDigitalAssistantsLifecycleStateEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsLifecycleStateEnum

func GetListDigitalAssistantsSortByEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantsSortByEnumStringValues() []string

GetListDigitalAssistantsSortByEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsSortByEnum

func GetListDigitalAssistantsSortOrderEnumStringValues ¶ added in v65.7.0

func GetListDigitalAssistantsSortOrderEnumStringValues() []string

GetListDigitalAssistantsSortOrderEnumStringValues Enumerates the set of values in String for ListDigitalAssistantsSortOrderEnum

func GetListImportedPackagesSortByEnumStringValues ¶ added in v65.7.0

func GetListImportedPackagesSortByEnumStringValues() []string

GetListImportedPackagesSortByEnumStringValues Enumerates the set of values in String for ListImportedPackagesSortByEnum

func GetListImportedPackagesSortOrderEnumStringValues ¶ added in v65.7.0

func GetListImportedPackagesSortOrderEnumStringValues() []string

GetListImportedPackagesSortOrderEnumStringValues Enumerates the set of values in String for ListImportedPackagesSortOrderEnum

func GetListOdaInstanceAttachmentsLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsLifecycleStateEnumStringValues() []string

GetListOdaInstanceAttachmentsLifecycleStateEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsLifecycleStateEnum

func GetListOdaInstanceAttachmentsSortByEnumStringValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsSortByEnumStringValues() []string

GetListOdaInstanceAttachmentsSortByEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsSortByEnum

func GetListOdaInstanceAttachmentsSortOrderEnumStringValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsSortOrderEnumStringValues() []string

GetListOdaInstanceAttachmentsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaInstanceAttachmentsSortOrderEnum

func GetListOdaInstancesLifecycleStateEnumStringValues ¶

func GetListOdaInstancesLifecycleStateEnumStringValues() []string

GetListOdaInstancesLifecycleStateEnumStringValues Enumerates the set of values in String for ListOdaInstancesLifecycleStateEnum

func GetListOdaInstancesSortByEnumStringValues ¶

func GetListOdaInstancesSortByEnumStringValues() []string

GetListOdaInstancesSortByEnumStringValues Enumerates the set of values in String for ListOdaInstancesSortByEnum

func GetListOdaInstancesSortOrderEnumStringValues ¶

func GetListOdaInstancesSortOrderEnumStringValues() []string

GetListOdaInstancesSortOrderEnumStringValues Enumerates the set of values in String for ListOdaInstancesSortOrderEnum

func GetListOdaPrivateEndpointAttachmentsSortByEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointAttachmentsSortByEnumStringValues() []string

GetListOdaPrivateEndpointAttachmentsSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointAttachmentsSortByEnum

func GetListOdaPrivateEndpointAttachmentsSortOrderEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointAttachmentsSortOrderEnumStringValues() []string

GetListOdaPrivateEndpointAttachmentsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointAttachmentsSortOrderEnum

func GetListOdaPrivateEndpointScanProxiesSortByEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointScanProxiesSortByEnumStringValues() []string

GetListOdaPrivateEndpointScanProxiesSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointScanProxiesSortByEnum

func GetListOdaPrivateEndpointScanProxiesSortOrderEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointScanProxiesSortOrderEnumStringValues() []string

GetListOdaPrivateEndpointScanProxiesSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointScanProxiesSortOrderEnum

func GetListOdaPrivateEndpointsSortByEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointsSortByEnumStringValues() []string

GetListOdaPrivateEndpointsSortByEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointsSortByEnum

func GetListOdaPrivateEndpointsSortOrderEnumStringValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointsSortOrderEnumStringValues() []string

GetListOdaPrivateEndpointsSortOrderEnumStringValues Enumerates the set of values in String for ListOdaPrivateEndpointsSortOrderEnum

func GetListPackagesSortByEnumStringValues ¶ added in v65.7.0

func GetListPackagesSortByEnumStringValues() []string

GetListPackagesSortByEnumStringValues Enumerates the set of values in String for ListPackagesSortByEnum

func GetListPackagesSortOrderEnumStringValues ¶ added in v65.7.0

func GetListPackagesSortOrderEnumStringValues() []string

GetListPackagesSortOrderEnumStringValues Enumerates the set of values in String for ListPackagesSortOrderEnum

func GetListSkillParametersLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListSkillParametersLifecycleStateEnumStringValues() []string

GetListSkillParametersLifecycleStateEnumStringValues Enumerates the set of values in String for ListSkillParametersLifecycleStateEnum

func GetListSkillParametersSortByEnumStringValues ¶ added in v65.7.0

func GetListSkillParametersSortByEnumStringValues() []string

GetListSkillParametersSortByEnumStringValues Enumerates the set of values in String for ListSkillParametersSortByEnum

func GetListSkillParametersSortOrderEnumStringValues ¶ added in v65.7.0

func GetListSkillParametersSortOrderEnumStringValues() []string

GetListSkillParametersSortOrderEnumStringValues Enumerates the set of values in String for ListSkillParametersSortOrderEnum

func GetListSkillsLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListSkillsLifecycleStateEnumStringValues() []string

GetListSkillsLifecycleStateEnumStringValues Enumerates the set of values in String for ListSkillsLifecycleStateEnum

func GetListSkillsSortByEnumStringValues ¶ added in v65.7.0

func GetListSkillsSortByEnumStringValues() []string

GetListSkillsSortByEnumStringValues Enumerates the set of values in String for ListSkillsSortByEnum

func GetListSkillsSortOrderEnumStringValues ¶ added in v65.7.0

func GetListSkillsSortOrderEnumStringValues() []string

GetListSkillsSortOrderEnumStringValues Enumerates the set of values in String for ListSkillsSortOrderEnum

func GetListTranslatorsLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetListTranslatorsLifecycleStateEnumStringValues() []string

GetListTranslatorsLifecycleStateEnumStringValues Enumerates the set of values in String for ListTranslatorsLifecycleStateEnum

func GetListTranslatorsSortByEnumStringValues ¶ added in v65.7.0

func GetListTranslatorsSortByEnumStringValues() []string

GetListTranslatorsSortByEnumStringValues Enumerates the set of values in String for ListTranslatorsSortByEnum

func GetListTranslatorsSortOrderEnumStringValues ¶ added in v65.7.0

func GetListTranslatorsSortOrderEnumStringValues() []string

GetListTranslatorsSortOrderEnumStringValues Enumerates the set of values in String for ListTranslatorsSortOrderEnum

func GetListTranslatorsTypeEnumStringValues ¶ added in v65.7.0

func GetListTranslatorsTypeEnumStringValues() []string

GetListTranslatorsTypeEnumStringValues Enumerates the set of values in String for ListTranslatorsTypeEnum

func GetListWorkRequestErrorsSortByEnumStringValues ¶

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues ¶

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues ¶

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues ¶

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues ¶

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues ¶

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetOdaInstanceAttachmentAttachmentTypeEnumStringValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentAttachmentTypeEnumStringValues() []string

GetOdaInstanceAttachmentAttachmentTypeEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentAttachmentTypeEnum

func GetOdaInstanceAttachmentLifecycleStateEnumStringValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentLifecycleStateEnumStringValues() []string

GetOdaInstanceAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentLifecycleStateEnum

func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumStringValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumStringValues() []string

GetOdaInstanceAttachmentSummaryAttachmentTypeEnumStringValues Enumerates the set of values in String for OdaInstanceAttachmentSummaryAttachmentTypeEnum

func GetOdaInstanceLifecycleStateEnumStringValues ¶

func GetOdaInstanceLifecycleStateEnumStringValues() []string

GetOdaInstanceLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleStateEnum

func GetOdaInstanceLifecycleSubStateEnumStringValues ¶

func GetOdaInstanceLifecycleSubStateEnumStringValues() []string

GetOdaInstanceLifecycleSubStateEnumStringValues Enumerates the set of values in String for OdaInstanceLifecycleSubStateEnum

func GetOdaInstanceShapeNameEnumStringValues ¶

func GetOdaInstanceShapeNameEnumStringValues() []string

GetOdaInstanceShapeNameEnumStringValues Enumerates the set of values in String for OdaInstanceShapeNameEnum

func GetOdaInstanceSummaryLifecycleStateEnumStringValues ¶

func GetOdaInstanceSummaryLifecycleStateEnumStringValues() []string

GetOdaInstanceSummaryLifecycleStateEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryLifecycleStateEnum

func GetOdaInstanceSummaryLifecycleSubStateEnumStringValues ¶

func GetOdaInstanceSummaryLifecycleSubStateEnumStringValues() []string

GetOdaInstanceSummaryLifecycleSubStateEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryLifecycleSubStateEnum

func GetOdaInstanceSummaryShapeNameEnumStringValues ¶

func GetOdaInstanceSummaryShapeNameEnumStringValues() []string

GetOdaInstanceSummaryShapeNameEnumStringValues Enumerates the set of values in String for OdaInstanceSummaryShapeNameEnum

func GetOdaPrivateEndpointAttachmentLifecycleStateEnumStringValues ¶ added in v65.36.0

func GetOdaPrivateEndpointAttachmentLifecycleStateEnumStringValues() []string

GetOdaPrivateEndpointAttachmentLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointAttachmentLifecycleStateEnum

func GetOdaPrivateEndpointLifecycleStateEnumStringValues ¶ added in v65.36.0

func GetOdaPrivateEndpointLifecycleStateEnumStringValues() []string

GetOdaPrivateEndpointLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointLifecycleStateEnum

func GetOdaPrivateEndpointScanProxyLifecycleStateEnumStringValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyLifecycleStateEnumStringValues() []string

GetOdaPrivateEndpointScanProxyLifecycleStateEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyLifecycleStateEnum

func GetOdaPrivateEndpointScanProxyProtocolEnumStringValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyProtocolEnumStringValues() []string

GetOdaPrivateEndpointScanProxyProtocolEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyProtocolEnum

func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumStringValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumStringValues() []string

GetOdaPrivateEndpointScanProxyScanListenerTypeEnumStringValues Enumerates the set of values in String for OdaPrivateEndpointScanProxyScanListenerTypeEnum

func GetOsvcServiceTypeEnumStringValues ¶ added in v65.7.0

func GetOsvcServiceTypeEnumStringValues() []string

GetOsvcServiceTypeEnumStringValues Enumerates the set of values in String for OsvcServiceTypeEnum

func GetParameterDefinitionDirectionEnumStringValues ¶ added in v65.7.0

func GetParameterDefinitionDirectionEnumStringValues() []string

GetParameterDefinitionDirectionEnumStringValues Enumerates the set of values in String for ParameterDefinitionDirectionEnum

func GetParameterDefinitionTypeEnumStringValues ¶ added in v65.7.0

func GetParameterDefinitionTypeEnumStringValues() []string

GetParameterDefinitionTypeEnumStringValues Enumerates the set of values in String for ParameterDefinitionTypeEnum

func GetParameterTypeEnumStringValues ¶ added in v65.7.0

func GetParameterTypeEnumStringValues() []string

GetParameterTypeEnumStringValues Enumerates the set of values in String for ParameterTypeEnum

func GetServiceCloudClientTypeEnumStringValues ¶ added in v65.7.0

func GetServiceCloudClientTypeEnumStringValues() []string

GetServiceCloudClientTypeEnumStringValues Enumerates the set of values in String for ServiceCloudClientTypeEnum

func GetTemporalPreferenceEnumStringValues ¶ added in v65.60.0

func GetTemporalPreferenceEnumStringValues() []string

GetTemporalPreferenceEnumStringValues Enumerates the set of values in String for TemporalPreferenceEnum

func GetTrainSkillParameterTypeEnumStringValues ¶ added in v65.60.0

func GetTrainSkillParameterTypeEnumStringValues() []string

GetTrainSkillParameterTypeEnumStringValues Enumerates the set of values in String for TrainSkillParameterTypeEnum

func GetTranslationServiceEnumStringValues ¶ added in v65.7.0

func GetTranslationServiceEnumStringValues() []string

GetTranslationServiceEnumStringValues Enumerates the set of values in String for TranslationServiceEnum

func GetWebhookPayloadVersionEnumStringValues ¶ added in v65.7.0

func GetWebhookPayloadVersionEnumStringValues() []string

GetWebhookPayloadVersionEnumStringValues Enumerates the set of values in String for WebhookPayloadVersionEnum

func GetWorkRequestRequestActionEnumStringValues ¶

func GetWorkRequestRequestActionEnumStringValues() []string

GetWorkRequestRequestActionEnumStringValues Enumerates the set of values in String for WorkRequestRequestActionEnum

func GetWorkRequestResourceResourceActionEnumStringValues ¶

func GetWorkRequestResourceResourceActionEnumStringValues() []string

GetWorkRequestResourceResourceActionEnumStringValues Enumerates the set of values in String for WorkRequestResourceResourceActionEnum

func GetWorkRequestResourceStatusEnumStringValues ¶

func GetWorkRequestResourceStatusEnumStringValues() []string

GetWorkRequestResourceStatusEnumStringValues Enumerates the set of values in String for WorkRequestResourceStatusEnum

func GetWorkRequestStatusEnumStringValues ¶

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

func GetWorkRequestSummaryRequestActionEnumStringValues ¶

func GetWorkRequestSummaryRequestActionEnumStringValues() []string

GetWorkRequestSummaryRequestActionEnumStringValues Enumerates the set of values in String for WorkRequestSummaryRequestActionEnum

func GetWorkRequestSummaryStatusEnumStringValues ¶

func GetWorkRequestSummaryStatusEnumStringValues() []string

GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum

Types ¶

type AndroidChannel ¶ added in v65.7.0

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"`
}

AndroidChannel The configuration for an Android channel.

func (AndroidChannel) GetCategory ¶ added in v65.7.0

func (m AndroidChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (AndroidChannel) GetDefinedTags ¶ added in v65.7.0

func (m AndroidChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (AndroidChannel) GetDescription ¶ added in v65.7.0

func (m AndroidChannel) GetDescription() *string

GetDescription returns Description

func (AndroidChannel) GetFreeformTags ¶ added in v65.7.0

func (m AndroidChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (AndroidChannel) GetId ¶ added in v65.7.0

func (m AndroidChannel) GetId() *string

GetId returns Id

func (AndroidChannel) GetLifecycleState ¶ added in v65.7.0

func (m AndroidChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (AndroidChannel) GetName ¶ added in v65.7.0

func (m AndroidChannel) GetName() *string

GetName returns Name

func (AndroidChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m AndroidChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (AndroidChannel) GetTimeCreated ¶ added in v65.7.0

func (m AndroidChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (AndroidChannel) GetTimeUpdated ¶ added in v65.7.0

func (m AndroidChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (AndroidChannel) MarshalJSON ¶ added in v65.7.0

func (m AndroidChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AndroidChannel) String ¶ added in v65.7.0

func (m AndroidChannel) String() string

func (AndroidChannel) ValidateEnumValue ¶ added in v65.7.0

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

type AppEventChannel ¶ added in v65.7.0

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"`
}

AppEventChannel The configuration for an Application Event channel.

func (AppEventChannel) GetCategory ¶ added in v65.7.0

func (m AppEventChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (AppEventChannel) GetDefinedTags ¶ added in v65.7.0

func (m AppEventChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (AppEventChannel) GetDescription ¶ added in v65.7.0

func (m AppEventChannel) GetDescription() *string

GetDescription returns Description

func (AppEventChannel) GetFreeformTags ¶ added in v65.7.0

func (m AppEventChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (AppEventChannel) GetId ¶ added in v65.7.0

func (m AppEventChannel) GetId() *string

GetId returns Id

func (AppEventChannel) GetLifecycleState ¶ added in v65.7.0

func (m AppEventChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (AppEventChannel) GetName ¶ added in v65.7.0

func (m AppEventChannel) GetName() *string

GetName returns Name

func (AppEventChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m AppEventChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (AppEventChannel) GetTimeCreated ¶ added in v65.7.0

func (m AppEventChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (AppEventChannel) GetTimeUpdated ¶ added in v65.7.0

func (m AppEventChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (AppEventChannel) MarshalJSON ¶ added in v65.7.0

func (m AppEventChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (AppEventChannel) String ¶ added in v65.7.0

func (m AppEventChannel) String() string

func (AppEventChannel) ValidateEnumValue ¶ added in v65.7.0

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

type ApplicationChannel ¶ added in v65.7.0

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"`
}

ApplicationChannel The configuration for an Application channel.

func (ApplicationChannel) GetCategory ¶ added in v65.7.0

func (m ApplicationChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (ApplicationChannel) GetDefinedTags ¶ added in v65.7.0

func (m ApplicationChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ApplicationChannel) GetDescription ¶ added in v65.7.0

func (m ApplicationChannel) GetDescription() *string

GetDescription returns Description

func (ApplicationChannel) GetFreeformTags ¶ added in v65.7.0

func (m ApplicationChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ApplicationChannel) GetId ¶ added in v65.7.0

func (m ApplicationChannel) GetId() *string

GetId returns Id

func (ApplicationChannel) GetLifecycleState ¶ added in v65.7.0

func (m ApplicationChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (ApplicationChannel) GetName ¶ added in v65.7.0

func (m ApplicationChannel) GetName() *string

GetName returns Name

func (ApplicationChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m ApplicationChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (ApplicationChannel) GetTimeCreated ¶ added in v65.7.0

func (m ApplicationChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ApplicationChannel) GetTimeUpdated ¶ added in v65.7.0

func (m ApplicationChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ApplicationChannel) MarshalJSON ¶ added in v65.7.0

func (m ApplicationChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ApplicationChannel) String ¶ added in v65.7.0

func (m ApplicationChannel) String() string

func (ApplicationChannel) ValidateEnumValue ¶ added in v65.7.0

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

type AuthenticationGrantTypeEnum ¶ added in v65.7.0

type AuthenticationGrantTypeEnum string

AuthenticationGrantTypeEnum Enum with underlying type: string

const (
	AuthenticationGrantTypeClientCredentials AuthenticationGrantTypeEnum = "CLIENT_CREDENTIALS"
	AuthenticationGrantTypeAuthorizationCode AuthenticationGrantTypeEnum = "AUTHORIZATION_CODE"
)

Set of constants representing the allowable values for AuthenticationGrantTypeEnum

func GetAuthenticationGrantTypeEnumValues ¶ added in v65.7.0

func GetAuthenticationGrantTypeEnumValues() []AuthenticationGrantTypeEnum

GetAuthenticationGrantTypeEnumValues Enumerates the set of values for AuthenticationGrantTypeEnum

func GetMappingAuthenticationGrantTypeEnum ¶ added in v65.7.0

func GetMappingAuthenticationGrantTypeEnum(val string) (AuthenticationGrantTypeEnum, bool)

GetMappingAuthenticationGrantTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type AuthenticationIdentityProviderEnum ¶ added in v65.7.0

type AuthenticationIdentityProviderEnum string

AuthenticationIdentityProviderEnum Enum with underlying type: string

const (
	AuthenticationIdentityProviderGeneric   AuthenticationIdentityProviderEnum = "GENERIC"
	AuthenticationIdentityProviderOam       AuthenticationIdentityProviderEnum = "OAM"
	AuthenticationIdentityProviderGoogle    AuthenticationIdentityProviderEnum = "GOOGLE"
	AuthenticationIdentityProviderMicrosoft AuthenticationIdentityProviderEnum = "MICROSOFT"
)

Set of constants representing the allowable values for AuthenticationIdentityProviderEnum

func GetAuthenticationIdentityProviderEnumValues ¶ added in v65.7.0

func GetAuthenticationIdentityProviderEnumValues() []AuthenticationIdentityProviderEnum

GetAuthenticationIdentityProviderEnumValues Enumerates the set of values for AuthenticationIdentityProviderEnum

func GetMappingAuthenticationIdentityProviderEnum ¶ added in v65.7.0

func GetMappingAuthenticationIdentityProviderEnum(val string) (AuthenticationIdentityProviderEnum, bool)

GetMappingAuthenticationIdentityProviderEnum performs case Insensitive comparison on enum value and return the desired enum

type AuthenticationProvider ¶ added in v65.7.0

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"`
}

AuthenticationProvider Settings for the Authentication Provider.

func (AuthenticationProvider) String ¶ added in v65.7.0

func (m AuthenticationProvider) String() string

func (AuthenticationProvider) ValidateEnumValue ¶ added in v65.7.0

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

type AuthenticationProviderCollection ¶ added in v65.7.0

type AuthenticationProviderCollection struct {

	// The Authentication Provider summaries.
	Items []AuthenticationProviderSummary `mandatory:"true" json:"items"`
}

AuthenticationProviderCollection A collection of Authentication Provider summaries.

func (AuthenticationProviderCollection) String ¶ added in v65.7.0

func (AuthenticationProviderCollection) ValidateEnumValue ¶ added in v65.7.0

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

type AuthenticationProviderSummary ¶ added in v65.7.0

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"`
}

AuthenticationProviderSummary Summary of the Authentication Provider.

func (AuthenticationProviderSummary) String ¶ added in v65.7.0

func (AuthenticationProviderSummary) ValidateEnumValue ¶ added in v65.7.0

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

type Bot ¶ added in v65.7.0

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"`
}

Bot Metadata for a Bot resource.

func (Bot) String ¶ added in v65.7.0

func (m Bot) String() string

func (Bot) ValidateEnumValue ¶ added in v65.7.0

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

type BotMultilingualModeEnum ¶ added in v65.7.0

type BotMultilingualModeEnum string

BotMultilingualModeEnum Enum with underlying type: string

const (
	BotMultilingualModeNative      BotMultilingualModeEnum = "NATIVE"
	BotMultilingualModeTranslation BotMultilingualModeEnum = "TRANSLATION"
)

Set of constants representing the allowable values for BotMultilingualModeEnum

func GetBotMultilingualModeEnumValues ¶ added in v65.7.0

func GetBotMultilingualModeEnumValues() []BotMultilingualModeEnum

GetBotMultilingualModeEnumValues Enumerates the set of values for BotMultilingualModeEnum

func GetMappingBotMultilingualModeEnum ¶ added in v65.7.0

func GetMappingBotMultilingualModeEnum(val string) (BotMultilingualModeEnum, bool)

GetMappingBotMultilingualModeEnum performs case Insensitive comparison on enum value and return the desired enum

type BotPublishStateEnum ¶ added in v65.7.0

type BotPublishStateEnum string

BotPublishStateEnum Enum with underlying type: string

const (
	BotPublishStatePublished BotPublishStateEnum = "PUBLISHED"
	BotPublishStateDraft     BotPublishStateEnum = "DRAFT"
)

Set of constants representing the allowable values for BotPublishStateEnum

func GetBotPublishStateEnumValues ¶ added in v65.7.0

func GetBotPublishStateEnumValues() []BotPublishStateEnum

GetBotPublishStateEnumValues Enumerates the set of values for BotPublishStateEnum

func GetMappingBotPublishStateEnum ¶ added in v65.7.0

func GetMappingBotPublishStateEnum(val string) (BotPublishStateEnum, bool)

GetMappingBotPublishStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BulkCreateSkillEntitiesDetails ¶ added in v65.60.0

type BulkCreateSkillEntitiesDetails struct {

	// List of the skill entity objects to create.
	Items []CreateSkillEntityDetails `mandatory:"true" json:"items"`
}

BulkCreateSkillEntitiesDetails A collection of skill entities to create.

func (BulkCreateSkillEntitiesDetails) String ¶ added in v65.60.0

func (*BulkCreateSkillEntitiesDetails) UnmarshalJSON ¶ added in v65.60.0

func (m *BulkCreateSkillEntitiesDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BulkCreateSkillEntitiesDetails) ValidateEnumValue ¶ added in v65.60.0

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

type BulkCreateSkillEntitiesRequest ¶ added in v65.60.0

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
}

BulkCreateSkillEntitiesRequest wrapper for the BulkCreateSkillEntities operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/BulkCreateSkillEntities.go.html to see an example of how to use BulkCreateSkillEntitiesRequest.

func (BulkCreateSkillEntitiesRequest) BinaryRequestBody ¶ added in v65.60.0

func (request BulkCreateSkillEntitiesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (BulkCreateSkillEntitiesRequest) HTTPRequest ¶ added in v65.60.0

func (request BulkCreateSkillEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (BulkCreateSkillEntitiesRequest) RetryPolicy ¶ added in v65.60.0

func (request BulkCreateSkillEntitiesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (BulkCreateSkillEntitiesRequest) String ¶ added in v65.60.0

func (request BulkCreateSkillEntitiesRequest) String() string

func (BulkCreateSkillEntitiesRequest) ValidateEnumValue ¶ added in v65.60.0

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

type BulkCreateSkillEntitiesResponse ¶ added in v65.60.0

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"`
}

BulkCreateSkillEntitiesResponse wrapper for the BulkCreateSkillEntities operation

func (BulkCreateSkillEntitiesResponse) HTTPResponse ¶ added in v65.60.0

func (response BulkCreateSkillEntitiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (BulkCreateSkillEntitiesResponse) String ¶ added in v65.60.0

func (response BulkCreateSkillEntitiesResponse) String() string

type CascadingDeleteSkillCustomEntitiesRequest ¶ added in v65.60.0

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
}

CascadingDeleteSkillCustomEntitiesRequest wrapper for the CascadingDeleteSkillCustomEntities operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CascadingDeleteSkillCustomEntities.go.html to see an example of how to use CascadingDeleteSkillCustomEntitiesRequest.

func (CascadingDeleteSkillCustomEntitiesRequest) BinaryRequestBody ¶ added in v65.60.0

BinaryRequestBody implements the OCIRequest interface

func (CascadingDeleteSkillCustomEntitiesRequest) HTTPRequest ¶ added in v65.60.0

func (request CascadingDeleteSkillCustomEntitiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CascadingDeleteSkillCustomEntitiesRequest) RetryPolicy ¶ added in v65.60.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CascadingDeleteSkillCustomEntitiesRequest) String ¶ added in v65.60.0

func (CascadingDeleteSkillCustomEntitiesRequest) ValidateEnumValue ¶ added in v65.60.0

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

type CascadingDeleteSkillCustomEntitiesResponse ¶ added in v65.60.0

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"`
}

CascadingDeleteSkillCustomEntitiesResponse wrapper for the CascadingDeleteSkillCustomEntities operation

func (CascadingDeleteSkillCustomEntitiesResponse) HTTPResponse ¶ added in v65.60.0

func (response CascadingDeleteSkillCustomEntitiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CascadingDeleteSkillCustomEntitiesResponse) String ¶ added in v65.60.0

type ChangeOdaInstanceCompartmentDetails ¶

type ChangeOdaInstanceCompartmentDetails struct {

	// Identifier of the compartment into which the Digital Assistant instance should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeOdaInstanceCompartmentDetails Properties required to move a Digital Assistant instance from one compartment to another.

func (ChangeOdaInstanceCompartmentDetails) String ¶

func (ChangeOdaInstanceCompartmentDetails) ValidateEnumValue ¶

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

type 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
}

ChangeOdaInstanceCompartmentRequest wrapper for the ChangeOdaInstanceCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ChangeOdaInstanceCompartment.go.html to see an example of how to use ChangeOdaInstanceCompartmentRequest.

func (ChangeOdaInstanceCompartmentRequest) BinaryRequestBody ¶

func (request ChangeOdaInstanceCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeOdaInstanceCompartmentRequest) HTTPRequest ¶

func (request ChangeOdaInstanceCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeOdaInstanceCompartmentRequest) RetryPolicy ¶

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeOdaInstanceCompartmentRequest) String ¶

func (ChangeOdaInstanceCompartmentRequest) ValidateEnumValue ¶

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

type ChangeOdaInstanceCompartmentResponse ¶

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"`
}

ChangeOdaInstanceCompartmentResponse wrapper for the ChangeOdaInstanceCompartment operation

func (ChangeOdaInstanceCompartmentResponse) HTTPResponse ¶

func (response ChangeOdaInstanceCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeOdaInstanceCompartmentResponse) String ¶

func (response ChangeOdaInstanceCompartmentResponse) String() string

type ChangeOdaPrivateEndpointCompartmentDetails ¶ added in v65.36.0

type ChangeOdaPrivateEndpointCompartmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeOdaPrivateEndpointCompartmentDetails Properties required to move an ODA Private Endpoint from one compartment to another.

func (ChangeOdaPrivateEndpointCompartmentDetails) String ¶ added in v65.36.0

func (ChangeOdaPrivateEndpointCompartmentDetails) ValidateEnumValue ¶ added in v65.36.0

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

type ChangeOdaPrivateEndpointCompartmentRequest ¶ added in v65.36.0

type ChangeOdaPrivateEndpointCompartmentRequest struct {

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// The compartment to which the Digital Assistant instance should be moved.
	ChangeOdaPrivateEndpointCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control in a PUT or DELETE call for
	// a Digital Assistant instance, set the `if-match` query parameter
	// to the value of the `ETAG` header from a previous GET or POST
	// response for that instance. The service updates or deletes the
	// instance only if the etag that you provide matches the instance's
	// current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// The client request ID for tracing. This value is included in the opc-request-id response header.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so that you can retry the request if there's
	// a timeout or server error without the risk of executing that same action again.
	// Retry tokens expire after 24 hours, but they can become invalid before then if there are
	// conflicting operations. For example, if an instance was deleted and purged from the system,
	// then the service might reject a retry of the original creation request.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeOdaPrivateEndpointCompartmentRequest wrapper for the ChangeOdaPrivateEndpointCompartment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ChangeOdaPrivateEndpointCompartment.go.html to see an example of how to use ChangeOdaPrivateEndpointCompartmentRequest.

func (ChangeOdaPrivateEndpointCompartmentRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (ChangeOdaPrivateEndpointCompartmentRequest) HTTPRequest ¶ added in v65.36.0

func (request ChangeOdaPrivateEndpointCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeOdaPrivateEndpointCompartmentRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeOdaPrivateEndpointCompartmentRequest) String ¶ added in v65.36.0

func (ChangeOdaPrivateEndpointCompartmentRequest) ValidateEnumValue ¶ added in v65.36.0

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

type ChangeOdaPrivateEndpointCompartmentResponse ¶ added in v65.36.0

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"`
}

ChangeOdaPrivateEndpointCompartmentResponse wrapper for the ChangeOdaPrivateEndpointCompartment operation

func (ChangeOdaPrivateEndpointCompartmentResponse) HTTPResponse ¶ added in v65.36.0

HTTPResponse implements the OCIResponse interface

func (ChangeOdaPrivateEndpointCompartmentResponse) String ¶ added in v65.36.0

type Channel ¶ added in v65.7.0

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{}
}

Channel Properties of a Channel.

type ChannelCategoryEnum ¶ added in v65.7.0

type ChannelCategoryEnum string

ChannelCategoryEnum Enum with underlying type: string

const (
	ChannelCategoryAgent       ChannelCategoryEnum = "AGENT"
	ChannelCategoryApplication ChannelCategoryEnum = "APPLICATION"
	ChannelCategoryBot         ChannelCategoryEnum = "BOT"
	ChannelCategoryBotAsAgent  ChannelCategoryEnum = "BOT_AS_AGENT"
	ChannelCategorySystem      ChannelCategoryEnum = "SYSTEM"
	ChannelCategoryEvent       ChannelCategoryEnum = "EVENT"
)

Set of constants representing the allowable values for ChannelCategoryEnum

func GetChannelCategoryEnumValues ¶ added in v65.7.0

func GetChannelCategoryEnumValues() []ChannelCategoryEnum

GetChannelCategoryEnumValues Enumerates the set of values for ChannelCategoryEnum

func GetMappingChannelCategoryEnum ¶ added in v65.7.0

func GetMappingChannelCategoryEnum(val string) (ChannelCategoryEnum, bool)

GetMappingChannelCategoryEnum performs case Insensitive comparison on enum value and return the desired enum

type ChannelCollection ¶ added in v65.7.0

type ChannelCollection struct {

	// The Channel summaries.
	Items []ChannelSummary `mandatory:"true" json:"items"`
}

ChannelCollection A collection of Channel summaries.

func (ChannelCollection) String ¶ added in v65.7.0

func (m ChannelCollection) String() string

func (ChannelCollection) ValidateEnumValue ¶ added in v65.7.0

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

type ChannelSummary ¶ added in v65.7.0

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"`
}

ChannelSummary Summary of the Channel.

func (ChannelSummary) String ¶ added in v65.7.0

func (m ChannelSummary) String() string

func (ChannelSummary) ValidateEnumValue ¶ added in v65.7.0

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

type ChannelTypeEnum ¶ added in v65.7.0

type ChannelTypeEnum string

ChannelTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ChannelTypeEnum

func GetChannelTypeEnumValues ¶ added in v65.7.0

func GetChannelTypeEnumValues() []ChannelTypeEnum

GetChannelTypeEnumValues Enumerates the set of values for ChannelTypeEnum

func GetMappingChannelTypeEnum ¶ added in v65.7.0

func GetMappingChannelTypeEnum(val string) (ChannelTypeEnum, bool)

GetMappingChannelTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CloneDigitalAssistantDetails ¶ added in v65.7.0

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"`
}

CloneDigitalAssistantDetails Properties that are required to create a new Digital Assistant by cloning an existing Digital Assistant.

func (CloneDigitalAssistantDetails) GetCategory ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetCategory() *string

GetCategory returns Category

func (CloneDigitalAssistantDetails) GetDefinedTags ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloneDigitalAssistantDetails) GetDescription ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetDescription() *string

GetDescription returns Description

func (CloneDigitalAssistantDetails) GetFreeformTags ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloneDigitalAssistantDetails) GetMultilingualMode ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetMultilingualMode() BotMultilingualModeEnum

GetMultilingualMode returns MultilingualMode

func (CloneDigitalAssistantDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CloneDigitalAssistantDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CloneDigitalAssistantDetails) MarshalJSON ¶ added in v65.7.0

func (m CloneDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloneDigitalAssistantDetails) String ¶ added in v65.7.0

func (CloneDigitalAssistantDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CloneSkillDetails ¶ added in v65.7.0

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"`
}

CloneSkillDetails Properties that are required to create a new Skill by cloning an existing Skill.

func (CloneSkillDetails) GetCategory ¶ added in v65.7.0

func (m CloneSkillDetails) GetCategory() *string

GetCategory returns Category

func (CloneSkillDetails) GetDefinedTags ¶ added in v65.7.0

func (m CloneSkillDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CloneSkillDetails) GetDescription ¶ added in v65.7.0

func (m CloneSkillDetails) GetDescription() *string

GetDescription returns Description

func (CloneSkillDetails) GetDialogVersion ¶ added in v65.60.0

func (m CloneSkillDetails) GetDialogVersion() *string

GetDialogVersion returns DialogVersion

func (CloneSkillDetails) GetFreeformTags ¶ added in v65.7.0

func (m CloneSkillDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CloneSkillDetails) GetMultilingualMode ¶ added in v65.7.0

func (m CloneSkillDetails) GetMultilingualMode() BotMultilingualModeEnum

GetMultilingualMode returns MultilingualMode

func (CloneSkillDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CloneSkillDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CloneSkillDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CloneSkillDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CloneSkillDetails) MarshalJSON ¶ added in v65.7.0

func (m CloneSkillDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CloneSkillDetails) String ¶ added in v65.7.0

func (m CloneSkillDetails) String() string

func (CloneSkillDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CompositeEntity ¶ added in v65.60.0

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"`
}

CompositeEntity Metadata for a composite entity.

func (CompositeEntity) GetId ¶ added in v65.60.0

func (m CompositeEntity) GetId() *string

GetId returns Id

func (CompositeEntity) GetName ¶ added in v65.60.0

func (m CompositeEntity) GetName() *string

GetName returns Name

func (CompositeEntity) MarshalJSON ¶ added in v65.60.0

func (m CompositeEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CompositeEntity) String ¶ added in v65.60.0

func (m CompositeEntity) String() string

func (CompositeEntity) ValidateEnumValue ¶ added in v65.60.0

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

type ConfigureDigitalAssistantParametersDetails ¶ added in v65.7.0

type ConfigureDigitalAssistantParametersDetails struct {

	// The values to use to configure the Digital Assistant Parameters.
	Parameters []DigitalAssistantParameterValue `mandatory:"true" json:"parameters"`
}

ConfigureDigitalAssistantParametersDetails Properties for configuring the Digital Assistant Parameters in a Digital Assistant instance.

func (ConfigureDigitalAssistantParametersDetails) String ¶ added in v65.7.0

func (ConfigureDigitalAssistantParametersDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ConfigureDigitalAssistantParametersRequest ¶ added in v65.7.0

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
}

ConfigureDigitalAssistantParametersRequest wrapper for the ConfigureDigitalAssistantParameters operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ConfigureDigitalAssistantParameters.go.html to see an example of how to use ConfigureDigitalAssistantParametersRequest.

func (ConfigureDigitalAssistantParametersRequest) BinaryRequestBody ¶ added in v65.7.0

BinaryRequestBody implements the OCIRequest interface

func (ConfigureDigitalAssistantParametersRequest) HTTPRequest ¶ added in v65.7.0

func (request ConfigureDigitalAssistantParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ConfigureDigitalAssistantParametersRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ConfigureDigitalAssistantParametersRequest) String ¶ added in v65.7.0

func (ConfigureDigitalAssistantParametersRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ConfigureDigitalAssistantParametersResponse ¶ added in v65.7.0

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"`
}

ConfigureDigitalAssistantParametersResponse wrapper for the ConfigureDigitalAssistantParameters operation

func (ConfigureDigitalAssistantParametersResponse) HTTPResponse ¶ added in v65.7.0

HTTPResponse implements the OCIResponse interface

func (ConfigureDigitalAssistantParametersResponse) String ¶ added in v65.7.0

type CortanaChannel ¶ added in v65.7.0

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"`
}

CortanaChannel The configuration for a Cortana channel.

func (CortanaChannel) GetCategory ¶ added in v65.7.0

func (m CortanaChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (CortanaChannel) GetDefinedTags ¶ added in v65.7.0

func (m CortanaChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CortanaChannel) GetDescription ¶ added in v65.7.0

func (m CortanaChannel) GetDescription() *string

GetDescription returns Description

func (CortanaChannel) GetFreeformTags ¶ added in v65.7.0

func (m CortanaChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CortanaChannel) GetId ¶ added in v65.7.0

func (m CortanaChannel) GetId() *string

GetId returns Id

func (CortanaChannel) GetLifecycleState ¶ added in v65.7.0

func (m CortanaChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CortanaChannel) GetName ¶ added in v65.7.0

func (m CortanaChannel) GetName() *string

GetName returns Name

func (CortanaChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CortanaChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CortanaChannel) GetTimeCreated ¶ added in v65.7.0

func (m CortanaChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CortanaChannel) GetTimeUpdated ¶ added in v65.7.0

func (m CortanaChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CortanaChannel) MarshalJSON ¶ added in v65.7.0

func (m CortanaChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CortanaChannel) String ¶ added in v65.7.0

func (m CortanaChannel) String() string

func (CortanaChannel) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAndroidChannelDetails ¶ added in v65.7.0

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"`
}

CreateAndroidChannelDetails Properties required to create an Android channel.

func (CreateAndroidChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateAndroidChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateAndroidChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateAndroidChannelDetails) GetName ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) GetName() *string

GetName returns Name

func (CreateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateAndroidChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateAndroidChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateAndroidChannelDetails) String ¶ added in v65.7.0

func (CreateAndroidChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAndroidChannelResult ¶ added in v65.7.0

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"`
}

CreateAndroidChannelResult The configuration for an Android channel.

func (CreateAndroidChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateAndroidChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateAndroidChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateAndroidChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateAndroidChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateAndroidChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateAndroidChannelResult) GetName ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetName() *string

GetName returns Name

func (CreateAndroidChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateAndroidChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateAndroidChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateAndroidChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateAndroidChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateAndroidChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateAndroidChannelResult) String ¶ added in v65.7.0

func (CreateAndroidChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAppEventChannelDetails ¶ added in v65.7.0

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"`
}

CreateAppEventChannelDetails Properties required to create an Application Event channel.

func (CreateAppEventChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateAppEventChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateAppEventChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateAppEventChannelDetails) GetName ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) GetName() *string

GetName returns Name

func (CreateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateAppEventChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateAppEventChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateAppEventChannelDetails) String ¶ added in v65.7.0

func (CreateAppEventChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAppEventChannelResult ¶ added in v65.7.0

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"`
}

CreateAppEventChannelResult The configuration for an Application Event channel.

func (CreateAppEventChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateAppEventChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateAppEventChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateAppEventChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateAppEventChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateAppEventChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateAppEventChannelResult) GetName ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetName() *string

GetName returns Name

func (CreateAppEventChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateAppEventChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateAppEventChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateAppEventChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateAppEventChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateAppEventChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateAppEventChannelResult) String ¶ added in v65.7.0

func (CreateAppEventChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateApplicationChannelDetails ¶ added in v65.7.0

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"`
}

CreateApplicationChannelDetails Properties required to create an Application channel.

func (CreateApplicationChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateApplicationChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateApplicationChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateApplicationChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateApplicationChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateApplicationChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateApplicationChannelDetails) GetName ¶ added in v65.7.0

GetName returns Name

func (CreateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateApplicationChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateApplicationChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateApplicationChannelDetails) String ¶ added in v65.7.0

func (CreateApplicationChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateApplicationChannelResult ¶ added in v65.7.0

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"`
}

CreateApplicationChannelResult The configuration for an Application channel.

func (CreateApplicationChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateApplicationChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateApplicationChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateApplicationChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateApplicationChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateApplicationChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateApplicationChannelResult) GetName ¶ added in v65.7.0

GetName returns Name

func (CreateApplicationChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateApplicationChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateApplicationChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateApplicationChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateApplicationChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateApplicationChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateApplicationChannelResult) String ¶ added in v65.7.0

func (CreateApplicationChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAuthenticationProviderDetails ¶ added in v65.7.0

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"`
}

CreateAuthenticationProviderDetails Properties required to create a new Authentication Provider.

func (CreateAuthenticationProviderDetails) String ¶ added in v65.7.0

func (CreateAuthenticationProviderDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAuthenticationProviderRequest ¶ added in v65.7.0

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
}

CreateAuthenticationProviderRequest wrapper for the CreateAuthenticationProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateAuthenticationProvider.go.html to see an example of how to use CreateAuthenticationProviderRequest.

func (CreateAuthenticationProviderRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateAuthenticationProviderRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateAuthenticationProviderRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateAuthenticationProviderRequest) String ¶ added in v65.7.0

func (CreateAuthenticationProviderRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateAuthenticationProviderResponse ¶ added in v65.7.0

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"`
}

CreateAuthenticationProviderResponse wrapper for the CreateAuthenticationProvider operation

func (CreateAuthenticationProviderResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateAuthenticationProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateAuthenticationProviderResponse) String ¶ added in v65.7.0

func (response CreateAuthenticationProviderResponse) String() string

type CreateBotKindEnum ¶ added in v65.7.0

type CreateBotKindEnum string

CreateBotKindEnum Enum with underlying type: string

const (
	CreateBotKindNew     CreateBotKindEnum = "NEW"
	CreateBotKindClone   CreateBotKindEnum = "CLONE"
	CreateBotKindVersion CreateBotKindEnum = "VERSION"
	CreateBotKindExtend  CreateBotKindEnum = "EXTEND"
)

Set of constants representing the allowable values for CreateBotKindEnum

func GetCreateBotKindEnumValues ¶ added in v65.7.0

func GetCreateBotKindEnumValues() []CreateBotKindEnum

GetCreateBotKindEnumValues Enumerates the set of values for CreateBotKindEnum

func GetMappingCreateBotKindEnum ¶ added in v65.7.0

func GetMappingCreateBotKindEnum(val string) (CreateBotKindEnum, bool)

GetMappingCreateBotKindEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateChannelDetails ¶ added in v65.7.0

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{}
}

CreateChannelDetails Properties that are required to create a Channel.

type CreateChannelRequest ¶ added in v65.7.0

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
}

CreateChannelRequest wrapper for the CreateChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateChannel.go.html to see an example of how to use CreateChannelRequest.

func (CreateChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateChannelRequest) String ¶ added in v65.7.0

func (request CreateChannelRequest) String() string

func (CreateChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateChannelResponse ¶ added in v65.7.0

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"`
}

CreateChannelResponse wrapper for the CreateChannel operation

func (CreateChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateChannelResponse) String ¶ added in v65.7.0

func (response CreateChannelResponse) String() string

type CreateChannelResult ¶ added in v65.7.0

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{}
}

CreateChannelResult Properties of a Channel.

type CreateCortanaChannelDetails ¶ added in v65.7.0

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"`
}

CreateCortanaChannelDetails Properties required to create a Cortana channel.

func (CreateCortanaChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateCortanaChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateCortanaChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateCortanaChannelDetails) GetName ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) GetName() *string

GetName returns Name

func (CreateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateCortanaChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateCortanaChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateCortanaChannelDetails) String ¶ added in v65.7.0

func (CreateCortanaChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateCortanaChannelResult ¶ added in v65.7.0

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"`
}

CreateCortanaChannelResult The configuration for a Cortana channel.

func (CreateCortanaChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateCortanaChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateCortanaChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateCortanaChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateCortanaChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateCortanaChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateCortanaChannelResult) GetName ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetName() *string

GetName returns Name

func (CreateCortanaChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateCortanaChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateCortanaChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateCortanaChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateCortanaChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateCortanaChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateCortanaChannelResult) String ¶ added in v65.7.0

func (CreateCortanaChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateDigitalAssistantDetails ¶ added in v65.7.0

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{}
}

CreateDigitalAssistantDetails Properties that are required to create a Digital Assistant.

type CreateDigitalAssistantRequest ¶ added in v65.7.0

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
}

CreateDigitalAssistantRequest wrapper for the CreateDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateDigitalAssistant.go.html to see an example of how to use CreateDigitalAssistantRequest.

func (CreateDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateDigitalAssistantRequest) String ¶ added in v65.7.0

func (request CreateDigitalAssistantRequest) String() string

func (CreateDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

CreateDigitalAssistantResponse wrapper for the CreateDigitalAssistant operation

func (CreateDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateDigitalAssistantResponse) String ¶ added in v65.7.0

func (response CreateDigitalAssistantResponse) String() string

type CreateDigitalAssistantVersionDetails ¶ added in v65.7.0

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"`
}

CreateDigitalAssistantVersionDetails Properties that are required to create a new version of an existing Digital Assistant.

func (CreateDigitalAssistantVersionDetails) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateDigitalAssistantVersionDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateDigitalAssistantVersionDetails) GetDescription ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) GetDescription() *string

GetDescription returns Description

func (CreateDigitalAssistantVersionDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateDigitalAssistantVersionDetails) GetMultilingualMode ¶ added in v65.7.0

GetMultilingualMode returns MultilingualMode

func (CreateDigitalAssistantVersionDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CreateDigitalAssistantVersionDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CreateDigitalAssistantVersionDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateDigitalAssistantVersionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateDigitalAssistantVersionDetails) String ¶ added in v65.7.0

func (CreateDigitalAssistantVersionDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateFacebookChannelDetails ¶ added in v65.7.0

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"`
}

CreateFacebookChannelDetails Properties required to create a Facebook channel.

func (CreateFacebookChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateFacebookChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateFacebookChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateFacebookChannelDetails) GetName ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) GetName() *string

GetName returns Name

func (CreateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateFacebookChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateFacebookChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateFacebookChannelDetails) String ¶ added in v65.7.0

func (CreateFacebookChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateFacebookChannelResult ¶ added in v65.7.0

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"`
}

CreateFacebookChannelResult The configuration for a Facebook channel.

func (CreateFacebookChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateFacebookChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateFacebookChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateFacebookChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateFacebookChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateFacebookChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateFacebookChannelResult) GetName ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetName() *string

GetName returns Name

func (CreateFacebookChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateFacebookChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateFacebookChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateFacebookChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateFacebookChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateFacebookChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateFacebookChannelResult) String ¶ added in v65.7.0

func (CreateFacebookChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateImportedPackageDetails ¶ added in v65.7.0

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"`
}

CreateImportedPackageDetails Payload for creating an imported package

func (CreateImportedPackageDetails) String ¶ added in v65.7.0

func (CreateImportedPackageDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateImportedPackageRequest ¶ added in v65.7.0

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
}

CreateImportedPackageRequest wrapper for the CreateImportedPackage operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateImportedPackage.go.html to see an example of how to use CreateImportedPackageRequest.

func (CreateImportedPackageRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateImportedPackageRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateImportedPackageRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateImportedPackageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateImportedPackageRequest) String ¶ added in v65.7.0

func (request CreateImportedPackageRequest) String() string

func (CreateImportedPackageRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateImportedPackageResponse ¶ added in v65.7.0

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"`
}

CreateImportedPackageResponse wrapper for the CreateImportedPackage operation

func (CreateImportedPackageResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateImportedPackageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateImportedPackageResponse) String ¶ added in v65.7.0

func (response CreateImportedPackageResponse) String() string

type CreateIosChannelDetails ¶ added in v65.7.0

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"`
}

CreateIosChannelDetails Properties required to create an iOS channel.

func (CreateIosChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateIosChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateIosChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateIosChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateIosChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateIosChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateIosChannelDetails) GetName ¶ added in v65.7.0

func (m CreateIosChannelDetails) GetName() *string

GetName returns Name

func (CreateIosChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateIosChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateIosChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateIosChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateIosChannelDetails) String ¶ added in v65.7.0

func (m CreateIosChannelDetails) String() string

func (CreateIosChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateIosChannelResult ¶ added in v65.7.0

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"`
}

CreateIosChannelResult The configuration for an iOS channel.

func (CreateIosChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateIosChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateIosChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateIosChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateIosChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateIosChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateIosChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateIosChannelResult) GetId ¶ added in v65.7.0

func (m CreateIosChannelResult) GetId() *string

GetId returns Id

func (CreateIosChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateIosChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateIosChannelResult) GetName ¶ added in v65.7.0

func (m CreateIosChannelResult) GetName() *string

GetName returns Name

func (CreateIosChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateIosChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateIosChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateIosChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateIosChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateIosChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateIosChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateIosChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateIosChannelResult) String ¶ added in v65.7.0

func (m CreateIosChannelResult) String() string

func (CreateIosChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateMsTeamsChannelDetails ¶ added in v65.7.0

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"`
}

CreateMsTeamsChannelDetails Properties required to create an MS Teams channel.

func (CreateMsTeamsChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateMsTeamsChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateMsTeamsChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateMsTeamsChannelDetails) GetName ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) GetName() *string

GetName returns Name

func (CreateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateMsTeamsChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateMsTeamsChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateMsTeamsChannelDetails) String ¶ added in v65.7.0

func (CreateMsTeamsChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateMsTeamsChannelResult ¶ added in v65.7.0

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"`
}

CreateMsTeamsChannelResult The configuration for an MS Teams channel.

func (CreateMsTeamsChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateMsTeamsChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateMsTeamsChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateMsTeamsChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateMsTeamsChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateMsTeamsChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateMsTeamsChannelResult) GetName ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetName() *string

GetName returns Name

func (CreateMsTeamsChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateMsTeamsChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateMsTeamsChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateMsTeamsChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateMsTeamsChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateMsTeamsChannelResult) String ¶ added in v65.7.0

func (CreateMsTeamsChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateNewDigitalAssistantDetails ¶ added in v65.7.0

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"`
}

CreateNewDigitalAssistantDetails Properties that are required to create a Digital Assistant from scratch.

func (CreateNewDigitalAssistantDetails) GetCategory ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetCategory() *string

GetCategory returns Category

func (CreateNewDigitalAssistantDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateNewDigitalAssistantDetails) GetDescription ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetDescription() *string

GetDescription returns Description

func (CreateNewDigitalAssistantDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateNewDigitalAssistantDetails) GetMultilingualMode ¶ added in v65.7.0

GetMultilingualMode returns MultilingualMode

func (CreateNewDigitalAssistantDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CreateNewDigitalAssistantDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CreateNewDigitalAssistantDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateNewDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateNewDigitalAssistantDetails) String ¶ added in v65.7.0

func (CreateNewDigitalAssistantDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateNewSkillDetails ¶ added in v65.7.0

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"`
}

CreateNewSkillDetails Properties that are required to create a Skill from scratch.

func (CreateNewSkillDetails) GetCategory ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetCategory() *string

GetCategory returns Category

func (CreateNewSkillDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateNewSkillDetails) GetDescription ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetDescription() *string

GetDescription returns Description

func (CreateNewSkillDetails) GetDialogVersion ¶ added in v65.60.0

func (m CreateNewSkillDetails) GetDialogVersion() *string

GetDialogVersion returns DialogVersion

func (CreateNewSkillDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateNewSkillDetails) GetMultilingualMode ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetMultilingualMode() BotMultilingualModeEnum

GetMultilingualMode returns MultilingualMode

func (CreateNewSkillDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CreateNewSkillDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CreateNewSkillDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CreateNewSkillDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateNewSkillDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateNewSkillDetails) String ¶ added in v65.7.0

func (m CreateNewSkillDetails) String() string

func (CreateNewSkillDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOdaInstanceAttachmentDetails ¶ added in v65.7.0

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"`
}

CreateOdaInstanceAttachmentDetails Properties required to create an ODA instance attachment.

func (CreateOdaInstanceAttachmentDetails) String ¶ added in v65.7.0

func (CreateOdaInstanceAttachmentDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum ¶ added in v65.7.0

type CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum string

CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum Enum with underlying type: string

const (
	CreateOdaInstanceAttachmentDetailsAttachmentTypeFusion CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum = "FUSION"
	CreateOdaInstanceAttachmentDetailsAttachmentTypeMax    CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum = "MAX"
)

Set of constants representing the allowable values for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum

func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumValues ¶ added in v65.7.0

func GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumValues() []CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum

GetCreateOdaInstanceAttachmentDetailsAttachmentTypeEnumValues Enumerates the set of values for CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum

func GetMappingCreateOdaInstanceAttachmentDetailsAttachmentTypeEnum ¶ added in v65.7.0

func GetMappingCreateOdaInstanceAttachmentDetailsAttachmentTypeEnum(val string) (CreateOdaInstanceAttachmentDetailsAttachmentTypeEnum, bool)

GetMappingCreateOdaInstanceAttachmentDetailsAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateOdaInstanceAttachmentRequest ¶ added in v65.7.0

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
}

CreateOdaInstanceAttachmentRequest wrapper for the CreateOdaInstanceAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaInstanceAttachment.go.html to see an example of how to use CreateOdaInstanceAttachmentRequest.

func (CreateOdaInstanceAttachmentRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateOdaInstanceAttachmentRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOdaInstanceAttachmentRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOdaInstanceAttachmentRequest) String ¶ added in v65.7.0

func (request CreateOdaInstanceAttachmentRequest) String() string

func (CreateOdaInstanceAttachmentRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOdaInstanceAttachmentResponse ¶ added in v65.7.0

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"`
}

CreateOdaInstanceAttachmentResponse wrapper for the CreateOdaInstanceAttachment operation

func (CreateOdaInstanceAttachmentResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateOdaInstanceAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOdaInstanceAttachmentResponse) String ¶ added in v65.7.0

func (response CreateOdaInstanceAttachmentResponse) String() string

type CreateOdaInstanceDetails ¶

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"`
}

CreateOdaInstanceDetails Properties that are required to create a Digital Assistant instance.

func (CreateOdaInstanceDetails) String ¶

func (m CreateOdaInstanceDetails) String() string

func (CreateOdaInstanceDetails) ValidateEnumValue ¶

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

type CreateOdaInstanceDetailsShapeNameEnum ¶

type CreateOdaInstanceDetailsShapeNameEnum string

CreateOdaInstanceDetailsShapeNameEnum Enum with underlying type: string

const (
	CreateOdaInstanceDetailsShapeNameDevelopment CreateOdaInstanceDetailsShapeNameEnum = "DEVELOPMENT"
	CreateOdaInstanceDetailsShapeNameProduction  CreateOdaInstanceDetailsShapeNameEnum = "PRODUCTION"
)

Set of constants representing the allowable values for CreateOdaInstanceDetailsShapeNameEnum

func GetCreateOdaInstanceDetailsShapeNameEnumValues ¶

func GetCreateOdaInstanceDetailsShapeNameEnumValues() []CreateOdaInstanceDetailsShapeNameEnum

GetCreateOdaInstanceDetailsShapeNameEnumValues Enumerates the set of values for CreateOdaInstanceDetailsShapeNameEnum

func GetMappingCreateOdaInstanceDetailsShapeNameEnum ¶

func GetMappingCreateOdaInstanceDetailsShapeNameEnum(val string) (CreateOdaInstanceDetailsShapeNameEnum, bool)

GetMappingCreateOdaInstanceDetailsShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

CreateOdaInstanceRequest wrapper for the CreateOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaInstance.go.html to see an example of how to use CreateOdaInstanceRequest.

func (CreateOdaInstanceRequest) BinaryRequestBody ¶

func (request CreateOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateOdaInstanceRequest) HTTPRequest ¶

func (request CreateOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOdaInstanceRequest) RetryPolicy ¶

func (request CreateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOdaInstanceRequest) String ¶

func (request CreateOdaInstanceRequest) String() string

func (CreateOdaInstanceRequest) ValidateEnumValue ¶

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

type CreateOdaInstanceResponse ¶

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"`
}

CreateOdaInstanceResponse wrapper for the CreateOdaInstance operation

func (CreateOdaInstanceResponse) HTTPResponse ¶

func (response CreateOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOdaInstanceResponse) String ¶

func (response CreateOdaInstanceResponse) String() string

type CreateOdaPrivateEndpointAttachmentDetails ¶ added in v65.36.0

type CreateOdaPrivateEndpointAttachmentDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
	OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
	OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`
}

CreateOdaPrivateEndpointAttachmentDetails Properties that are required to create an ODA private endpoint attachment.

func (CreateOdaPrivateEndpointAttachmentDetails) String ¶ added in v65.36.0

func (CreateOdaPrivateEndpointAttachmentDetails) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointAttachmentRequest ¶ added in v65.36.0

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
}

CreateOdaPrivateEndpointAttachmentRequest wrapper for the CreateOdaPrivateEndpointAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpointAttachment.go.html to see an example of how to use CreateOdaPrivateEndpointAttachmentRequest.

func (CreateOdaPrivateEndpointAttachmentRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (CreateOdaPrivateEndpointAttachmentRequest) HTTPRequest ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOdaPrivateEndpointAttachmentRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOdaPrivateEndpointAttachmentRequest) String ¶ added in v65.36.0

func (CreateOdaPrivateEndpointAttachmentRequest) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointAttachmentResponse ¶ added in v65.36.0

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"`
}

CreateOdaPrivateEndpointAttachmentResponse wrapper for the CreateOdaPrivateEndpointAttachment operation

func (CreateOdaPrivateEndpointAttachmentResponse) HTTPResponse ¶ added in v65.36.0

func (response CreateOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOdaPrivateEndpointAttachmentResponse) String ¶ added in v65.36.0

type CreateOdaPrivateEndpointDetails ¶ added in v65.36.0

type CreateOdaPrivateEndpointDetails struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// User-defined name for the ODA private endpoint. Avoid entering confidential information.
	// You can change this value.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Description of the ODA private endpoint.
	Description *string `mandatory:"false" json:"description"`

	// List of OCIDs (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm)
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateOdaPrivateEndpointDetails Properties that can be specified to create an ODA private endpoint.

func (CreateOdaPrivateEndpointDetails) String ¶ added in v65.36.0

func (CreateOdaPrivateEndpointDetails) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointRequest ¶ added in v65.36.0

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
}

CreateOdaPrivateEndpointRequest wrapper for the CreateOdaPrivateEndpoint operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpoint.go.html to see an example of how to use CreateOdaPrivateEndpointRequest.

func (CreateOdaPrivateEndpointRequest) BinaryRequestBody ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateOdaPrivateEndpointRequest) HTTPRequest ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOdaPrivateEndpointRequest) RetryPolicy ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOdaPrivateEndpointRequest) String ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointRequest) String() string

func (CreateOdaPrivateEndpointRequest) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointResponse ¶ added in v65.36.0

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"`
}

CreateOdaPrivateEndpointResponse wrapper for the CreateOdaPrivateEndpoint operation

func (CreateOdaPrivateEndpointResponse) HTTPResponse ¶ added in v65.36.0

func (response CreateOdaPrivateEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOdaPrivateEndpointResponse) String ¶ added in v65.36.0

func (response CreateOdaPrivateEndpointResponse) String() string

type CreateOdaPrivateEndpointScanProxyDetails ¶ added in v65.36.0

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"`
}

CreateOdaPrivateEndpointScanProxyDetails Properties that are required to create an ODA Private Endpoint Scan Proxy.

func (CreateOdaPrivateEndpointScanProxyDetails) String ¶ added in v65.36.0

func (CreateOdaPrivateEndpointScanProxyDetails) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointScanProxyRequest ¶ added in v65.36.0

type CreateOdaPrivateEndpointScanProxyRequest struct {

	// Details for the new ODA Private Endpoint Scan Proxy.
	CreateOdaPrivateEndpointScanProxyDetails `contributesTo:"body"`

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// The client request ID for tracing. This value is included in the opc-request-id response header.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// A token that uniquely identifies a request so that you can retry the request if there's
	// a timeout or server error without the risk of executing that same action again.
	// Retry tokens expire after 24 hours, but they can become invalid before then if there are
	// conflicting operations. For example, if an instance was deleted and purged from the system,
	// then the service might reject a retry of the original creation request.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateOdaPrivateEndpointScanProxyRequest wrapper for the CreateOdaPrivateEndpointScanProxy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateOdaPrivateEndpointScanProxy.go.html to see an example of how to use CreateOdaPrivateEndpointScanProxyRequest.

func (CreateOdaPrivateEndpointScanProxyRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (CreateOdaPrivateEndpointScanProxyRequest) HTTPRequest ¶ added in v65.36.0

func (request CreateOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateOdaPrivateEndpointScanProxyRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateOdaPrivateEndpointScanProxyRequest) String ¶ added in v65.36.0

func (CreateOdaPrivateEndpointScanProxyRequest) ValidateEnumValue ¶ added in v65.36.0

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

type CreateOdaPrivateEndpointScanProxyResponse ¶ added in v65.36.0

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"`
}

CreateOdaPrivateEndpointScanProxyResponse wrapper for the CreateOdaPrivateEndpointScanProxy operation

func (CreateOdaPrivateEndpointScanProxyResponse) HTTPResponse ¶ added in v65.36.0

func (response CreateOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateOdaPrivateEndpointScanProxyResponse) String ¶ added in v65.36.0

type CreateOssChannelDetails ¶ added in v65.7.0

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"`
}

CreateOssChannelDetails Properties required to create an Oracle Streaming Service (OSS) channel.

func (CreateOssChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateOssChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateOssChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateOssChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateOssChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateOssChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateOssChannelDetails) GetName ¶ added in v65.7.0

func (m CreateOssChannelDetails) GetName() *string

GetName returns Name

func (CreateOssChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateOssChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateOssChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateOssChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateOssChannelDetails) String ¶ added in v65.7.0

func (m CreateOssChannelDetails) String() string

func (CreateOssChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOssChannelResult ¶ added in v65.7.0

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"`
}

CreateOssChannelResult The configuration for an Oracle Streaming Service (OSS) channel.

func (CreateOssChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateOssChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateOssChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateOssChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateOssChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateOssChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateOssChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateOssChannelResult) GetId ¶ added in v65.7.0

func (m CreateOssChannelResult) GetId() *string

GetId returns Id

func (CreateOssChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateOssChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateOssChannelResult) GetName ¶ added in v65.7.0

func (m CreateOssChannelResult) GetName() *string

GetName returns Name

func (CreateOssChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateOssChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateOssChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateOssChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateOssChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateOssChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateOssChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateOssChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateOssChannelResult) String ¶ added in v65.7.0

func (m CreateOssChannelResult) String() string

func (CreateOssChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOsvcChannelDetails ¶ added in v65.7.0

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"`
}

CreateOsvcChannelDetails Properties required to create an OSVC channel.

func (CreateOsvcChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateOsvcChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateOsvcChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateOsvcChannelDetails) GetName ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) GetName() *string

GetName returns Name

func (CreateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateOsvcChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateOsvcChannelDetails) String ¶ added in v65.7.0

func (m CreateOsvcChannelDetails) String() string

func (CreateOsvcChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateOsvcChannelResult ¶ added in v65.7.0

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"`
}

CreateOsvcChannelResult The configuration for an OSVC channel.

func (CreateOsvcChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateOsvcChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateOsvcChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateOsvcChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateOsvcChannelResult) GetId ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetId() *string

GetId returns Id

func (CreateOsvcChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateOsvcChannelResult) GetName ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetName() *string

GetName returns Name

func (CreateOsvcChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateOsvcChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateOsvcChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateOsvcChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateOsvcChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateOsvcChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateOsvcChannelResult) String ¶ added in v65.7.0

func (m CreateOsvcChannelResult) String() string

func (CreateOsvcChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateServiceCloudChannelDetails ¶ added in v65.7.0

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"`
}

CreateServiceCloudChannelDetails Properties required to create an Service Cloud channel.

func (CreateServiceCloudChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateServiceCloudChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateServiceCloudChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateServiceCloudChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateServiceCloudChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateServiceCloudChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateServiceCloudChannelDetails) GetName ¶ added in v65.7.0

GetName returns Name

func (CreateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateServiceCloudChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateServiceCloudChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateServiceCloudChannelDetails) String ¶ added in v65.7.0

func (CreateServiceCloudChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateServiceCloudChannelResult ¶ added in v65.7.0

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"`
}

CreateServiceCloudChannelResult The configuration for a Service Cloud agent channel.

func (CreateServiceCloudChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateServiceCloudChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateServiceCloudChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateServiceCloudChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateServiceCloudChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateServiceCloudChannelResult) GetLifecycleState ¶ added in v65.7.0

GetLifecycleState returns LifecycleState

func (CreateServiceCloudChannelResult) GetName ¶ added in v65.7.0

GetName returns Name

func (CreateServiceCloudChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateServiceCloudChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateServiceCloudChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateServiceCloudChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateServiceCloudChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateServiceCloudChannelResult) String ¶ added in v65.7.0

func (CreateServiceCloudChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSkillCompositeEntityDetails ¶ added in v65.60.0

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"`
}

CreateSkillCompositeEntityDetails Properties that are required to create a skill composite entity.

func (CreateSkillCompositeEntityDetails) GetName ¶ added in v65.60.0

GetName returns Name

func (CreateSkillCompositeEntityDetails) MarshalJSON ¶ added in v65.60.0

func (m CreateSkillCompositeEntityDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSkillCompositeEntityDetails) String ¶ added in v65.60.0

func (CreateSkillCompositeEntityDetails) ValidateEnumValue ¶ added in v65.60.0

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

type CreateSkillDetails ¶ added in v65.7.0

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{}
}

CreateSkillDetails Properties that are required to create a Skill.

type CreateSkillEntityDetails ¶ added in v65.60.0

type CreateSkillEntityDetails interface {

	// The entity name. This must be unique within the parent resource.
	GetName() *string
}

CreateSkillEntityDetails Properties that are required to create a skill entity.

type CreateSkillParameterDetails ¶ added in v65.7.0

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"`
}

CreateSkillParameterDetails Properties that are required to create a Skill Parameter.

func (CreateSkillParameterDetails) String ¶ added in v65.7.0

func (CreateSkillParameterDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSkillParameterRequest ¶ added in v65.7.0

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
}

CreateSkillParameterRequest wrapper for the CreateSkillParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateSkillParameter.go.html to see an example of how to use CreateSkillParameterRequest.

func (CreateSkillParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSkillParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSkillParameterRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateSkillParameterRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSkillParameterRequest) String ¶ added in v65.7.0

func (request CreateSkillParameterRequest) String() string

func (CreateSkillParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSkillParameterResponse ¶ added in v65.7.0

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"`
}

CreateSkillParameterResponse wrapper for the CreateSkillParameter operation

func (CreateSkillParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateSkillParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSkillParameterResponse) String ¶ added in v65.7.0

func (response CreateSkillParameterResponse) String() string

type CreateSkillRequest ¶ added in v65.7.0

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
}

CreateSkillRequest wrapper for the CreateSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateSkill.go.html to see an example of how to use CreateSkillRequest.

func (CreateSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateSkillRequest) String ¶ added in v65.7.0

func (request CreateSkillRequest) String() string

func (CreateSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSkillResponse ¶ added in v65.7.0

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"`
}

CreateSkillResponse wrapper for the CreateSkill operation

func (CreateSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateSkillResponse) String ¶ added in v65.7.0

func (response CreateSkillResponse) String() string

type CreateSkillValueListEntityDetails ¶ added in v65.60.0

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"`
}

CreateSkillValueListEntityDetails Properties that are required to create a value list entity.

func (CreateSkillValueListEntityDetails) GetName ¶ added in v65.60.0

GetName returns Name

func (CreateSkillValueListEntityDetails) MarshalJSON ¶ added in v65.60.0

func (m CreateSkillValueListEntityDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSkillValueListEntityDetails) String ¶ added in v65.60.0

func (CreateSkillValueListEntityDetails) ValidateEnumValue ¶ added in v65.60.0

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

type CreateSkillVersionDetails ¶ added in v65.7.0

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"`
}

CreateSkillVersionDetails Properties that are required to create a new version of an existing Skill.

func (CreateSkillVersionDetails) GetCategory ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetCategory() *string

GetCategory returns Category

func (CreateSkillVersionDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateSkillVersionDetails) GetDescription ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetDescription() *string

GetDescription returns Description

func (CreateSkillVersionDetails) GetDialogVersion ¶ added in v65.60.0

func (m CreateSkillVersionDetails) GetDialogVersion() *string

GetDialogVersion returns DialogVersion

func (CreateSkillVersionDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateSkillVersionDetails) GetMultilingualMode ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetMultilingualMode() BotMultilingualModeEnum

GetMultilingualMode returns MultilingualMode

func (CreateSkillVersionDetails) GetPlatformVersion ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (CreateSkillVersionDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m CreateSkillVersionDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (CreateSkillVersionDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateSkillVersionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSkillVersionDetails) String ¶ added in v65.7.0

func (m CreateSkillVersionDetails) String() string

func (CreateSkillVersionDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSlackChannelDetails ¶ added in v65.7.0

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"`
}

CreateSlackChannelDetails Properties required to create a Slack channel.

func (CreateSlackChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateSlackChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateSlackChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateSlackChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateSlackChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateSlackChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateSlackChannelDetails) GetName ¶ added in v65.7.0

func (m CreateSlackChannelDetails) GetName() *string

GetName returns Name

func (CreateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateSlackChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateSlackChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSlackChannelDetails) String ¶ added in v65.7.0

func (m CreateSlackChannelDetails) String() string

func (CreateSlackChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateSlackChannelResult ¶ added in v65.7.0

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"`
}

CreateSlackChannelResult The configuration for a Slack channel.

func (CreateSlackChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateSlackChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateSlackChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateSlackChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateSlackChannelResult) GetId ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetId() *string

GetId returns Id

func (CreateSlackChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateSlackChannelResult) GetName ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetName() *string

GetName returns Name

func (CreateSlackChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateSlackChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateSlackChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateSlackChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateSlackChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateSlackChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateSlackChannelResult) String ¶ added in v65.7.0

func (m CreateSlackChannelResult) String() string

func (CreateSlackChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateTestChannelResult ¶ added in v65.7.0

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"`
}

CreateTestChannelResult The configuration for the Test channel.

func (CreateTestChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateTestChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateTestChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateTestChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateTestChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateTestChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateTestChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateTestChannelResult) GetId ¶ added in v65.7.0

func (m CreateTestChannelResult) GetId() *string

GetId returns Id

func (CreateTestChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateTestChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateTestChannelResult) GetName ¶ added in v65.7.0

func (m CreateTestChannelResult) GetName() *string

GetName returns Name

func (CreateTestChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateTestChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateTestChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateTestChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateTestChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateTestChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateTestChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateTestChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateTestChannelResult) String ¶ added in v65.7.0

func (m CreateTestChannelResult) String() string

func (CreateTestChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateTranslatorDetails ¶ added in v65.7.0

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"`
}

CreateTranslatorDetails Properties that are required to create a Translator.

func (CreateTranslatorDetails) String ¶ added in v65.7.0

func (m CreateTranslatorDetails) String() string

func (CreateTranslatorDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateTranslatorRequest ¶ added in v65.7.0

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
}

CreateTranslatorRequest wrapper for the CreateTranslator operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/CreateTranslator.go.html to see an example of how to use CreateTranslatorRequest.

func (CreateTranslatorRequest) BinaryRequestBody ¶ added in v65.7.0

func (request CreateTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateTranslatorRequest) HTTPRequest ¶ added in v65.7.0

func (request CreateTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateTranslatorRequest) RetryPolicy ¶ added in v65.7.0

func (request CreateTranslatorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateTranslatorRequest) String ¶ added in v65.7.0

func (request CreateTranslatorRequest) String() string

func (CreateTranslatorRequest) ValidateEnumValue ¶ added in v65.7.0

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

type CreateTranslatorResponse ¶ added in v65.7.0

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"`
}

CreateTranslatorResponse wrapper for the CreateTranslator operation

func (CreateTranslatorResponse) HTTPResponse ¶ added in v65.7.0

func (response CreateTranslatorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateTranslatorResponse) String ¶ added in v65.7.0

func (response CreateTranslatorResponse) String() string

type CreateTwilioChannelDetails ¶ added in v65.7.0

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"`
}

CreateTwilioChannelDetails Properties required to create a Twilio channel.

func (CreateTwilioChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateTwilioChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateTwilioChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateTwilioChannelDetails) GetName ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) GetName() *string

GetName returns Name

func (CreateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateTwilioChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateTwilioChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateTwilioChannelDetails) String ¶ added in v65.7.0

func (CreateTwilioChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateTwilioChannelResult ¶ added in v65.7.0

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"`
}

CreateTwilioChannelResult The configuration for a Twilio channel.

func (CreateTwilioChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateTwilioChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateTwilioChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateTwilioChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateTwilioChannelResult) GetId ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetId() *string

GetId returns Id

func (CreateTwilioChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateTwilioChannelResult) GetName ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetName() *string

GetName returns Name

func (CreateTwilioChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateTwilioChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateTwilioChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateTwilioChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateTwilioChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateTwilioChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateTwilioChannelResult) String ¶ added in v65.7.0

func (m CreateTwilioChannelResult) String() string

func (CreateTwilioChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateWebChannelDetails ¶ added in v65.7.0

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"`
}

CreateWebChannelDetails Properties required to create a Web channel.

func (CreateWebChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateWebChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateWebChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateWebChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateWebChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateWebChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateWebChannelDetails) GetName ¶ added in v65.7.0

func (m CreateWebChannelDetails) GetName() *string

GetName returns Name

func (CreateWebChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateWebChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateWebChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateWebChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateWebChannelDetails) String ¶ added in v65.7.0

func (m CreateWebChannelDetails) String() string

func (CreateWebChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateWebChannelResult ¶ added in v65.7.0

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"`
}

CreateWebChannelResult The configuration for a Web channel.

func (CreateWebChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateWebChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateWebChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateWebChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateWebChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateWebChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateWebChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateWebChannelResult) GetId ¶ added in v65.7.0

func (m CreateWebChannelResult) GetId() *string

GetId returns Id

func (CreateWebChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateWebChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateWebChannelResult) GetName ¶ added in v65.7.0

func (m CreateWebChannelResult) GetName() *string

GetName returns Name

func (CreateWebChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateWebChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateWebChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateWebChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateWebChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateWebChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateWebChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateWebChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateWebChannelResult) String ¶ added in v65.7.0

func (m CreateWebChannelResult) String() string

func (CreateWebChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type CreateWebhookChannelDetails ¶ added in v65.7.0

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"`
}

CreateWebhookChannelDetails Properties required to create a Webhook channel.

func (CreateWebhookChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateWebhookChannelDetails) GetDescription ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) GetDescription() *string

GetDescription returns Description

func (CreateWebhookChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateWebhookChannelDetails) GetName ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) GetName() *string

GetName returns Name

func (CreateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateWebhookChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m CreateWebhookChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateWebhookChannelDetails) String ¶ added in v65.7.0

func (CreateWebhookChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type CreateWebhookChannelResult ¶ added in v65.7.0

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"`
}

CreateWebhookChannelResult The configuration for a Webhook channel.

func (CreateWebhookChannelResult) GetCategory ¶ added in v65.7.0

GetCategory returns Category

func (CreateWebhookChannelResult) GetDefinedTags ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (CreateWebhookChannelResult) GetDescription ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetDescription() *string

GetDescription returns Description

func (CreateWebhookChannelResult) GetFreeformTags ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (CreateWebhookChannelResult) GetId ¶ added in v65.7.0

GetId returns Id

func (CreateWebhookChannelResult) GetLifecycleState ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (CreateWebhookChannelResult) GetName ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetName() *string

GetName returns Name

func (CreateWebhookChannelResult) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (CreateWebhookChannelResult) GetTimeCreated ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (CreateWebhookChannelResult) GetTimeUpdated ¶ added in v65.7.0

func (m CreateWebhookChannelResult) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (CreateWebhookChannelResult) MarshalJSON ¶ added in v65.7.0

func (m CreateWebhookChannelResult) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateWebhookChannelResult) String ¶ added in v65.7.0

func (CreateWebhookChannelResult) ValidateEnumValue ¶ added in v65.7.0

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

type DefaultParameterValues ¶ added in v65.7.0

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"`
}

DefaultParameterValues Default values for parameters required to import a package

func (DefaultParameterValues) String ¶ added in v65.7.0

func (m DefaultParameterValues) String() string

func (DefaultParameterValues) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteAuthenticationProviderRequest ¶ added in v65.7.0

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
}

DeleteAuthenticationProviderRequest wrapper for the DeleteAuthenticationProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteAuthenticationProvider.go.html to see an example of how to use DeleteAuthenticationProviderRequest.

func (DeleteAuthenticationProviderRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteAuthenticationProviderRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteAuthenticationProviderRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteAuthenticationProviderRequest) String ¶ added in v65.7.0

func (DeleteAuthenticationProviderRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteAuthenticationProviderResponse ¶ added in v65.7.0

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"`
}

DeleteAuthenticationProviderResponse wrapper for the DeleteAuthenticationProvider operation

func (DeleteAuthenticationProviderResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteAuthenticationProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteAuthenticationProviderResponse) String ¶ added in v65.7.0

func (response DeleteAuthenticationProviderResponse) String() string

type DeleteChannelRequest ¶ added in v65.7.0

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
}

DeleteChannelRequest wrapper for the DeleteChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteChannel.go.html to see an example of how to use DeleteChannelRequest.

func (DeleteChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteChannelRequest) String ¶ added in v65.7.0

func (request DeleteChannelRequest) String() string

func (DeleteChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteChannelResponse ¶ added in v65.7.0

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"`
}

DeleteChannelResponse wrapper for the DeleteChannel operation

func (DeleteChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteChannelResponse) String ¶ added in v65.7.0

func (response DeleteChannelResponse) String() string

type DeleteDigitalAssistantRequest ¶ added in v65.7.0

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
}

DeleteDigitalAssistantRequest wrapper for the DeleteDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteDigitalAssistant.go.html to see an example of how to use DeleteDigitalAssistantRequest.

func (DeleteDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteDigitalAssistantRequest) String ¶ added in v65.7.0

func (request DeleteDigitalAssistantRequest) String() string

func (DeleteDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

DeleteDigitalAssistantResponse wrapper for the DeleteDigitalAssistant operation

func (DeleteDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteDigitalAssistantResponse) String ¶ added in v65.7.0

func (response DeleteDigitalAssistantResponse) String() string

type DeleteImportedPackageRequest ¶ added in v65.7.0

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
}

DeleteImportedPackageRequest wrapper for the DeleteImportedPackage operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteImportedPackage.go.html to see an example of how to use DeleteImportedPackageRequest.

func (DeleteImportedPackageRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteImportedPackageRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteImportedPackageRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteImportedPackageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteImportedPackageRequest) String ¶ added in v65.7.0

func (request DeleteImportedPackageRequest) String() string

func (DeleteImportedPackageRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteImportedPackageResponse ¶ added in v65.7.0

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"`
}

DeleteImportedPackageResponse wrapper for the DeleteImportedPackage operation

func (DeleteImportedPackageResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteImportedPackageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteImportedPackageResponse) String ¶ added in v65.7.0

func (response DeleteImportedPackageResponse) String() string

type DeleteOdaInstanceAttachmentRequest ¶ added in v65.7.0

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
}

DeleteOdaInstanceAttachmentRequest wrapper for the DeleteOdaInstanceAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstanceAttachment.go.html to see an example of how to use DeleteOdaInstanceAttachmentRequest.

func (DeleteOdaInstanceAttachmentRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteOdaInstanceAttachmentRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOdaInstanceAttachmentRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOdaInstanceAttachmentRequest) String ¶ added in v65.7.0

func (request DeleteOdaInstanceAttachmentRequest) String() string

func (DeleteOdaInstanceAttachmentRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteOdaInstanceAttachmentResponse ¶ added in v65.7.0

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"`
}

DeleteOdaInstanceAttachmentResponse wrapper for the DeleteOdaInstanceAttachment operation

func (DeleteOdaInstanceAttachmentResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteOdaInstanceAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOdaInstanceAttachmentResponse) String ¶ added in v65.7.0

func (response DeleteOdaInstanceAttachmentResponse) String() string

type 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
}

DeleteOdaInstanceRequest wrapper for the DeleteOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaInstance.go.html to see an example of how to use DeleteOdaInstanceRequest.

func (DeleteOdaInstanceRequest) BinaryRequestBody ¶

func (request DeleteOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteOdaInstanceRequest) HTTPRequest ¶

func (request DeleteOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOdaInstanceRequest) RetryPolicy ¶

func (request DeleteOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOdaInstanceRequest) String ¶

func (request DeleteOdaInstanceRequest) String() string

func (DeleteOdaInstanceRequest) ValidateEnumValue ¶

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

type DeleteOdaInstanceResponse ¶

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"`
}

DeleteOdaInstanceResponse wrapper for the DeleteOdaInstance operation

func (DeleteOdaInstanceResponse) HTTPResponse ¶

func (response DeleteOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOdaInstanceResponse) String ¶

func (response DeleteOdaInstanceResponse) String() string

type DeleteOdaPrivateEndpointAttachmentRequest ¶ added in v65.36.0

type DeleteOdaPrivateEndpointAttachmentRequest struct {

	// The OCID (https://docs.cloud.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
}

DeleteOdaPrivateEndpointAttachmentRequest wrapper for the DeleteOdaPrivateEndpointAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointAttachment.go.html to see an example of how to use DeleteOdaPrivateEndpointAttachmentRequest.

func (DeleteOdaPrivateEndpointAttachmentRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (DeleteOdaPrivateEndpointAttachmentRequest) HTTPRequest ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOdaPrivateEndpointAttachmentRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOdaPrivateEndpointAttachmentRequest) String ¶ added in v65.36.0

func (DeleteOdaPrivateEndpointAttachmentRequest) ValidateEnumValue ¶ added in v65.36.0

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

type DeleteOdaPrivateEndpointAttachmentResponse ¶ added in v65.36.0

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"`
}

DeleteOdaPrivateEndpointAttachmentResponse wrapper for the DeleteOdaPrivateEndpointAttachment operation

func (DeleteOdaPrivateEndpointAttachmentResponse) HTTPResponse ¶ added in v65.36.0

func (response DeleteOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOdaPrivateEndpointAttachmentResponse) String ¶ added in v65.36.0

type DeleteOdaPrivateEndpointRequest ¶ added in v65.36.0

type DeleteOdaPrivateEndpointRequest struct {

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// 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
}

DeleteOdaPrivateEndpointRequest wrapper for the DeleteOdaPrivateEndpoint operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpoint.go.html to see an example of how to use DeleteOdaPrivateEndpointRequest.

func (DeleteOdaPrivateEndpointRequest) BinaryRequestBody ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteOdaPrivateEndpointRequest) HTTPRequest ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOdaPrivateEndpointRequest) RetryPolicy ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOdaPrivateEndpointRequest) String ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointRequest) String() string

func (DeleteOdaPrivateEndpointRequest) ValidateEnumValue ¶ added in v65.36.0

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

type DeleteOdaPrivateEndpointResponse ¶ added in v65.36.0

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"`
}

DeleteOdaPrivateEndpointResponse wrapper for the DeleteOdaPrivateEndpoint operation

func (DeleteOdaPrivateEndpointResponse) HTTPResponse ¶ added in v65.36.0

func (response DeleteOdaPrivateEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOdaPrivateEndpointResponse) String ¶ added in v65.36.0

func (response DeleteOdaPrivateEndpointResponse) String() string

type DeleteOdaPrivateEndpointScanProxyRequest ¶ added in v65.36.0

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.cloud.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
}

DeleteOdaPrivateEndpointScanProxyRequest wrapper for the DeleteOdaPrivateEndpointScanProxy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteOdaPrivateEndpointScanProxy.go.html to see an example of how to use DeleteOdaPrivateEndpointScanProxyRequest.

func (DeleteOdaPrivateEndpointScanProxyRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (DeleteOdaPrivateEndpointScanProxyRequest) HTTPRequest ¶ added in v65.36.0

func (request DeleteOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteOdaPrivateEndpointScanProxyRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteOdaPrivateEndpointScanProxyRequest) String ¶ added in v65.36.0

func (DeleteOdaPrivateEndpointScanProxyRequest) ValidateEnumValue ¶ added in v65.36.0

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

type DeleteOdaPrivateEndpointScanProxyResponse ¶ added in v65.36.0

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"`
}

DeleteOdaPrivateEndpointScanProxyResponse wrapper for the DeleteOdaPrivateEndpointScanProxy operation

func (DeleteOdaPrivateEndpointScanProxyResponse) HTTPResponse ¶ added in v65.36.0

func (response DeleteOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteOdaPrivateEndpointScanProxyResponse) String ¶ added in v65.36.0

type DeleteSkillParameterRequest ¶ added in v65.7.0

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
}

DeleteSkillParameterRequest wrapper for the DeleteSkillParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkillParameter.go.html to see an example of how to use DeleteSkillParameterRequest.

func (DeleteSkillParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSkillParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSkillParameterRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteSkillParameterRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSkillParameterRequest) String ¶ added in v65.7.0

func (request DeleteSkillParameterRequest) String() string

func (DeleteSkillParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteSkillParameterResponse ¶ added in v65.7.0

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"`
}

DeleteSkillParameterResponse wrapper for the DeleteSkillParameter operation

func (DeleteSkillParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteSkillParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSkillParameterResponse) String ¶ added in v65.7.0

func (response DeleteSkillParameterResponse) String() string

type DeleteSkillRequest ¶ added in v65.7.0

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
}

DeleteSkillRequest wrapper for the DeleteSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteSkill.go.html to see an example of how to use DeleteSkillRequest.

func (DeleteSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteSkillRequest) String ¶ added in v65.7.0

func (request DeleteSkillRequest) String() string

func (DeleteSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteSkillResponse ¶ added in v65.7.0

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"`
}

DeleteSkillResponse wrapper for the DeleteSkill operation

func (DeleteSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteSkillResponse) String ¶ added in v65.7.0

func (response DeleteSkillResponse) String() string

type DeleteTranslatorRequest ¶ added in v65.7.0

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
}

DeleteTranslatorRequest wrapper for the DeleteTranslator operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/DeleteTranslator.go.html to see an example of how to use DeleteTranslatorRequest.

func (DeleteTranslatorRequest) BinaryRequestBody ¶ added in v65.7.0

func (request DeleteTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteTranslatorRequest) HTTPRequest ¶ added in v65.7.0

func (request DeleteTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteTranslatorRequest) RetryPolicy ¶ added in v65.7.0

func (request DeleteTranslatorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteTranslatorRequest) String ¶ added in v65.7.0

func (request DeleteTranslatorRequest) String() string

func (DeleteTranslatorRequest) ValidateEnumValue ¶ added in v65.7.0

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

type DeleteTranslatorResponse ¶ added in v65.7.0

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"`
}

DeleteTranslatorResponse wrapper for the DeleteTranslator operation

func (DeleteTranslatorResponse) HTTPResponse ¶ added in v65.7.0

func (response DeleteTranslatorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteTranslatorResponse) String ¶ added in v65.7.0

func (response DeleteTranslatorResponse) String() string

type DigitalAssistant ¶ added in v65.7.0

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"`
}

DigitalAssistant Digital Assistant metadata.

func (DigitalAssistant) String ¶ added in v65.7.0

func (m DigitalAssistant) String() string

func (DigitalAssistant) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantCollection ¶ added in v65.7.0

type DigitalAssistantCollection struct {

	// The Digital Assistant summaries.
	Items []DigitalAssistantSummary `mandatory:"true" json:"items"`
}

DigitalAssistantCollection A collection of Digital Assistant summaries.

func (DigitalAssistantCollection) String ¶ added in v65.7.0

func (DigitalAssistantCollection) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantParameter ¶ added in v65.7.0

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"`
}

DigitalAssistantParameter Metadata for a Digital Assistant Parameter.

func (DigitalAssistantParameter) String ¶ added in v65.7.0

func (m DigitalAssistantParameter) String() string

func (DigitalAssistantParameter) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantParameterCollection ¶ added in v65.7.0

type DigitalAssistantParameterCollection struct {

	// The Digital Assistant Parameter summaries.
	Items []DigitalAssistantParameterSummary `mandatory:"true" json:"items"`
}

DigitalAssistantParameterCollection A collection of Digital Assistant Parameter summaries.

func (DigitalAssistantParameterCollection) String ¶ added in v65.7.0

func (DigitalAssistantParameterCollection) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantParameterSummary ¶ added in v65.7.0

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"`
}

DigitalAssistantParameterSummary Metadata for a Digital Assistant Parameter property.

func (DigitalAssistantParameterSummary) String ¶ added in v65.7.0

func (DigitalAssistantParameterSummary) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantParameterValue ¶ added in v65.7.0

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"`
}

DigitalAssistantParameterValue Properties for configuring a Parameter in a Digital Assistant instance.

func (DigitalAssistantParameterValue) String ¶ added in v65.7.0

func (DigitalAssistantParameterValue) ValidateEnumValue ¶ added in v65.7.0

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

type DigitalAssistantSummary ¶ added in v65.7.0

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"`
}

DigitalAssistantSummary Summary of a Digital Assistant.

func (DigitalAssistantSummary) String ¶ added in v65.7.0

func (m DigitalAssistantSummary) String() string

func (DigitalAssistantSummary) ValidateEnumValue ¶ added in v65.7.0

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

type Entity ¶ added in v65.60.0

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
}

Entity Metadata for an entity.

type EntityAction ¶ added in v65.60.0

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"`
}

EntityAction Action of an entity

func (EntityAction) String ¶ added in v65.60.0

func (m EntityAction) String() string

func (EntityAction) ValidateEnumValue ¶ added in v65.60.0

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

type EntityActionArgument ¶ added in v65.60.0

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"`
}

EntityActionArgument Argument of an entity action

func (EntityActionArgument) String ¶ added in v65.60.0

func (m EntityActionArgument) String() string

func (EntityActionArgument) ValidateEnumValue ¶ added in v65.60.0

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

type EntityActionArgumentNaturalLanguageMapping ¶ added in v65.60.0

type EntityActionArgumentNaturalLanguageMapping struct {

	// List of natural language mapped values.
	Languages []LanguageMapping `mandatory:"true" json:"languages"`
}

EntityActionArgumentNaturalLanguageMapping Natural language mapping of an entity action argument.

func (EntityActionArgumentNaturalLanguageMapping) String ¶ added in v65.60.0

func (EntityActionArgumentNaturalLanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type EntityActionNaturalLanguageMapping ¶ added in v65.60.0

type EntityActionNaturalLanguageMapping struct {

	// List of natural language mapped values.
	Languages []LanguageMapping `mandatory:"true" json:"languages"`
}

EntityActionNaturalLanguageMapping Natural language mapping of an entity action.

func (EntityActionNaturalLanguageMapping) String ¶ added in v65.60.0

func (EntityActionNaturalLanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type EntityAttribute ¶ added in v65.60.0

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"`
}

EntityAttribute Attribute of an entity

func (EntityAttribute) String ¶ added in v65.60.0

func (m EntityAttribute) String() string

func (EntityAttribute) ValidateEnumValue ¶ added in v65.60.0

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

type EntityAttributeNaturalLanguageMapping ¶ added in v65.60.0

type EntityAttributeNaturalLanguageMapping struct {

	// List of natural language mapped values.
	Languages []LanguageMapping `mandatory:"true" json:"languages"`
}

EntityAttributeNaturalLanguageMapping Natural language mapping of an entity attribute

func (EntityAttributeNaturalLanguageMapping) String ¶ added in v65.60.0

func (EntityAttributeNaturalLanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type EntityAttributeTypeEnum ¶ added in v65.60.0

type EntityAttributeTypeEnum string

EntityAttributeTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for EntityAttributeTypeEnum

func GetEntityAttributeTypeEnumValues ¶ added in v65.60.0

func GetEntityAttributeTypeEnumValues() []EntityAttributeTypeEnum

GetEntityAttributeTypeEnumValues Enumerates the set of values for EntityAttributeTypeEnum

func GetMappingEntityAttributeTypeEnum ¶ added in v65.60.0

func GetMappingEntityAttributeTypeEnum(val string) (EntityAttributeTypeEnum, bool)

GetMappingEntityAttributeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type EntityNaturalLanguageMapping ¶ added in v65.60.0

type EntityNaturalLanguageMapping struct {

	// List of natural language mapped values.
	Languages []LanguageMapping `mandatory:"true" json:"languages"`
}

EntityNaturalLanguageMapping Natural language mapping of an entity attribute.

func (EntityNaturalLanguageMapping) String ¶ added in v65.60.0

func (EntityNaturalLanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type EntityTypeEnum ¶ added in v65.60.0

type EntityTypeEnum string

EntityTypeEnum Enum with underlying type: string

const (
	EntityTypeComposite  EntityTypeEnum = "COMPOSITE"
	EntityTypeEnumValues EntityTypeEnum = "ENUM_VALUES"
)

Set of constants representing the allowable values for EntityTypeEnum

func GetEntityTypeEnumValues ¶ added in v65.60.0

func GetEntityTypeEnumValues() []EntityTypeEnum

GetEntityTypeEnumValues Enumerates the set of values for EntityTypeEnum

func GetMappingEntityTypeEnum ¶ added in v65.60.0

func GetMappingEntityTypeEnum(val string) (EntityTypeEnum, bool)

GetMappingEntityTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ErrorBody ¶

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"`
}

ErrorBody Error Information.

func (ErrorBody) String ¶

func (m ErrorBody) String() string

func (ErrorBody) ValidateEnumValue ¶

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

type ExportBotDetails ¶ added in v65.7.0

type ExportBotDetails struct {
	Target *StorageLocation `mandatory:"true" json:"target"`
}

ExportBotDetails Properties to export a Bot to Object Storage.

func (ExportBotDetails) String ¶ added in v65.7.0

func (m ExportBotDetails) String() string

func (ExportBotDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ExportDigitalAssistantDetails ¶ added in v65.7.0

type ExportDigitalAssistantDetails struct {
	Target *StorageLocation `mandatory:"true" json:"target"`
}

ExportDigitalAssistantDetails Properties that specify where in Object Storage to export the Digital Assistant to.

func (ExportDigitalAssistantDetails) String ¶ added in v65.7.0

func (ExportDigitalAssistantDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ExportDigitalAssistantRequest ¶ added in v65.7.0

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
}

ExportDigitalAssistantRequest wrapper for the ExportDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportDigitalAssistant.go.html to see an example of how to use ExportDigitalAssistantRequest.

func (ExportDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ExportDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ExportDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request ExportDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ExportDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request ExportDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ExportDigitalAssistantRequest) String ¶ added in v65.7.0

func (request ExportDigitalAssistantRequest) String() string

func (ExportDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ExportDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

ExportDigitalAssistantResponse wrapper for the ExportDigitalAssistant operation

func (ExportDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response ExportDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ExportDigitalAssistantResponse) String ¶ added in v65.7.0

func (response ExportDigitalAssistantResponse) String() string

type ExportSkillDetails ¶ added in v65.7.0

type ExportSkillDetails struct {
	Target *StorageLocation `mandatory:"true" json:"target"`
}

ExportSkillDetails Properties that specify where in Object Storage to export the Skill to.

func (ExportSkillDetails) String ¶ added in v65.7.0

func (m ExportSkillDetails) String() string

func (ExportSkillDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ExportSkillRequest ¶ added in v65.7.0

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
}

ExportSkillRequest wrapper for the ExportSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ExportSkill.go.html to see an example of how to use ExportSkillRequest.

func (ExportSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ExportSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ExportSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request ExportSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ExportSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request ExportSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ExportSkillRequest) String ¶ added in v65.7.0

func (request ExportSkillRequest) String() string

func (ExportSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ExportSkillResponse ¶ added in v65.7.0

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"`
}

ExportSkillResponse wrapper for the ExportSkill operation

func (ExportSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response ExportSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ExportSkillResponse) String ¶ added in v65.7.0

func (response ExportSkillResponse) String() string

type ExtendDigitalAssistantDetails ¶ added in v65.7.0

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"`
}

ExtendDigitalAssistantDetails Properties that are required to create a new Digital Assistant by extending an existing Digital Assistant.

func (ExtendDigitalAssistantDetails) GetCategory ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetCategory() *string

GetCategory returns Category

func (ExtendDigitalAssistantDetails) GetDefinedTags ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ExtendDigitalAssistantDetails) GetDescription ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetDescription() *string

GetDescription returns Description

func (ExtendDigitalAssistantDetails) GetFreeformTags ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ExtendDigitalAssistantDetails) GetMultilingualMode ¶ added in v65.7.0

GetMultilingualMode returns MultilingualMode

func (ExtendDigitalAssistantDetails) GetPlatformVersion ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (ExtendDigitalAssistantDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (ExtendDigitalAssistantDetails) MarshalJSON ¶ added in v65.7.0

func (m ExtendDigitalAssistantDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExtendDigitalAssistantDetails) String ¶ added in v65.7.0

func (ExtendDigitalAssistantDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ExtendSkillDetails ¶ added in v65.7.0

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"`
}

ExtendSkillDetails Properties that are required to create a new Skill by extending an existing Skill.

func (ExtendSkillDetails) GetCategory ¶ added in v65.7.0

func (m ExtendSkillDetails) GetCategory() *string

GetCategory returns Category

func (ExtendSkillDetails) GetDefinedTags ¶ added in v65.7.0

func (m ExtendSkillDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ExtendSkillDetails) GetDescription ¶ added in v65.7.0

func (m ExtendSkillDetails) GetDescription() *string

GetDescription returns Description

func (ExtendSkillDetails) GetDialogVersion ¶ added in v65.60.0

func (m ExtendSkillDetails) GetDialogVersion() *string

GetDialogVersion returns DialogVersion

func (ExtendSkillDetails) GetFreeformTags ¶ added in v65.7.0

func (m ExtendSkillDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ExtendSkillDetails) GetMultilingualMode ¶ added in v65.7.0

func (m ExtendSkillDetails) GetMultilingualMode() BotMultilingualModeEnum

GetMultilingualMode returns MultilingualMode

func (ExtendSkillDetails) GetPlatformVersion ¶ added in v65.7.0

func (m ExtendSkillDetails) GetPlatformVersion() *string

GetPlatformVersion returns PlatformVersion

func (ExtendSkillDetails) GetPrimaryLanguageTag ¶ added in v65.7.0

func (m ExtendSkillDetails) GetPrimaryLanguageTag() *string

GetPrimaryLanguageTag returns PrimaryLanguageTag

func (ExtendSkillDetails) MarshalJSON ¶ added in v65.7.0

func (m ExtendSkillDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ExtendSkillDetails) String ¶ added in v65.7.0

func (m ExtendSkillDetails) String() string

func (ExtendSkillDetails) ValidateEnumValue ¶ added in v65.7.0

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

type FacebookChannel ¶ added in v65.7.0

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"`
}

FacebookChannel The configuration for a Facebook channel.

func (FacebookChannel) GetCategory ¶ added in v65.7.0

func (m FacebookChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (FacebookChannel) GetDefinedTags ¶ added in v65.7.0

func (m FacebookChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (FacebookChannel) GetDescription ¶ added in v65.7.0

func (m FacebookChannel) GetDescription() *string

GetDescription returns Description

func (FacebookChannel) GetFreeformTags ¶ added in v65.7.0

func (m FacebookChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (FacebookChannel) GetId ¶ added in v65.7.0

func (m FacebookChannel) GetId() *string

GetId returns Id

func (FacebookChannel) GetLifecycleState ¶ added in v65.7.0

func (m FacebookChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (FacebookChannel) GetName ¶ added in v65.7.0

func (m FacebookChannel) GetName() *string

GetName returns Name

func (FacebookChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m FacebookChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (FacebookChannel) GetTimeCreated ¶ added in v65.7.0

func (m FacebookChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (FacebookChannel) GetTimeUpdated ¶ added in v65.7.0

func (m FacebookChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (FacebookChannel) MarshalJSON ¶ added in v65.7.0

func (m FacebookChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (FacebookChannel) String ¶ added in v65.7.0

func (m FacebookChannel) String() string

func (FacebookChannel) ValidateEnumValue ¶ added in v65.7.0

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

type GetAuthenticationProviderRequest ¶ added in v65.7.0

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
}

GetAuthenticationProviderRequest wrapper for the GetAuthenticationProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetAuthenticationProvider.go.html to see an example of how to use GetAuthenticationProviderRequest.

func (GetAuthenticationProviderRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetAuthenticationProviderRequest) HTTPRequest ¶ added in v65.7.0

func (request GetAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetAuthenticationProviderRequest) RetryPolicy ¶ added in v65.7.0

func (request GetAuthenticationProviderRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetAuthenticationProviderRequest) String ¶ added in v65.7.0

func (request GetAuthenticationProviderRequest) String() string

func (GetAuthenticationProviderRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetAuthenticationProviderResponse ¶ added in v65.7.0

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"`
}

GetAuthenticationProviderResponse wrapper for the GetAuthenticationProvider operation

func (GetAuthenticationProviderResponse) HTTPResponse ¶ added in v65.7.0

func (response GetAuthenticationProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetAuthenticationProviderResponse) String ¶ added in v65.7.0

func (response GetAuthenticationProviderResponse) String() string

type GetChannelRequest ¶ added in v65.7.0

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
}

GetChannelRequest wrapper for the GetChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetChannel.go.html to see an example of how to use GetChannelRequest.

func (GetChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request GetChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request GetChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetChannelRequest) String ¶ added in v65.7.0

func (request GetChannelRequest) String() string

func (GetChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetChannelResponse ¶ added in v65.7.0

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"`
}

GetChannelResponse wrapper for the GetChannel operation

func (GetChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response GetChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetChannelResponse) String ¶ added in v65.7.0

func (response GetChannelResponse) String() string

type GetDigitalAssistantParameterRequest ¶ added in v65.7.0

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
}

GetDigitalAssistantParameterRequest wrapper for the GetDigitalAssistantParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistantParameter.go.html to see an example of how to use GetDigitalAssistantParameterRequest.

func (GetDigitalAssistantParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetDigitalAssistantParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalAssistantParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request GetDigitalAssistantParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalAssistantParameterRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDigitalAssistantParameterRequest) String ¶ added in v65.7.0

func (GetDigitalAssistantParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetDigitalAssistantParameterResponse ¶ added in v65.7.0

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"`
}

GetDigitalAssistantParameterResponse wrapper for the GetDigitalAssistantParameter operation

func (GetDigitalAssistantParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response GetDigitalAssistantParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDigitalAssistantParameterResponse) String ¶ added in v65.7.0

func (response GetDigitalAssistantParameterResponse) String() string

type GetDigitalAssistantRequest ¶ added in v65.7.0

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
}

GetDigitalAssistantRequest wrapper for the GetDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetDigitalAssistant.go.html to see an example of how to use GetDigitalAssistantRequest.

func (GetDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request GetDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request GetDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetDigitalAssistantRequest) String ¶ added in v65.7.0

func (request GetDigitalAssistantRequest) String() string

func (GetDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

GetDigitalAssistantResponse wrapper for the GetDigitalAssistant operation

func (GetDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response GetDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetDigitalAssistantResponse) String ¶ added in v65.7.0

func (response GetDigitalAssistantResponse) String() string

type GetImportedPackageRequest ¶ added in v65.7.0

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
}

GetImportedPackageRequest wrapper for the GetImportedPackage operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetImportedPackage.go.html to see an example of how to use GetImportedPackageRequest.

func (GetImportedPackageRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetImportedPackageRequest) HTTPRequest ¶ added in v65.7.0

func (request GetImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetImportedPackageRequest) RetryPolicy ¶ added in v65.7.0

func (request GetImportedPackageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetImportedPackageRequest) String ¶ added in v65.7.0

func (request GetImportedPackageRequest) String() string

func (GetImportedPackageRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetImportedPackageResponse ¶ added in v65.7.0

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"`
}

GetImportedPackageResponse wrapper for the GetImportedPackage operation

func (GetImportedPackageResponse) HTTPResponse ¶ added in v65.7.0

func (response GetImportedPackageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetImportedPackageResponse) String ¶ added in v65.7.0

func (response GetImportedPackageResponse) String() string

type GetOdaInstanceAttachmentRequest ¶ added in v65.7.0

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
}

GetOdaInstanceAttachmentRequest wrapper for the GetOdaInstanceAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstanceAttachment.go.html to see an example of how to use GetOdaInstanceAttachmentRequest.

func (GetOdaInstanceAttachmentRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOdaInstanceAttachmentRequest) HTTPRequest ¶ added in v65.7.0

func (request GetOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOdaInstanceAttachmentRequest) RetryPolicy ¶ added in v65.7.0

func (request GetOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOdaInstanceAttachmentRequest) String ¶ added in v65.7.0

func (request GetOdaInstanceAttachmentRequest) String() string

func (GetOdaInstanceAttachmentRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetOdaInstanceAttachmentResponse ¶ added in v65.7.0

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"`
}

GetOdaInstanceAttachmentResponse wrapper for the GetOdaInstanceAttachment operation

func (GetOdaInstanceAttachmentResponse) HTTPResponse ¶ added in v65.7.0

func (response GetOdaInstanceAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOdaInstanceAttachmentResponse) String ¶ added in v65.7.0

func (response GetOdaInstanceAttachmentResponse) String() string

type 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
}

GetOdaInstanceRequest wrapper for the GetOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaInstance.go.html to see an example of how to use GetOdaInstanceRequest.

func (GetOdaInstanceRequest) BinaryRequestBody ¶

func (request GetOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOdaInstanceRequest) HTTPRequest ¶

func (request GetOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOdaInstanceRequest) RetryPolicy ¶

func (request GetOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOdaInstanceRequest) String ¶

func (request GetOdaInstanceRequest) String() string

func (GetOdaInstanceRequest) ValidateEnumValue ¶

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

type GetOdaInstanceResponse ¶

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"`
}

GetOdaInstanceResponse wrapper for the GetOdaInstance operation

func (GetOdaInstanceResponse) HTTPResponse ¶

func (response GetOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOdaInstanceResponse) String ¶

func (response GetOdaInstanceResponse) String() string

type GetOdaPrivateEndpointAttachmentRequest ¶ added in v65.36.0

type GetOdaPrivateEndpointAttachmentRequest struct {

	// The OCID (https://docs.cloud.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
}

GetOdaPrivateEndpointAttachmentRequest wrapper for the GetOdaPrivateEndpointAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointAttachment.go.html to see an example of how to use GetOdaPrivateEndpointAttachmentRequest.

func (GetOdaPrivateEndpointAttachmentRequest) BinaryRequestBody ¶ added in v65.36.0

func (request GetOdaPrivateEndpointAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOdaPrivateEndpointAttachmentRequest) HTTPRequest ¶ added in v65.36.0

func (request GetOdaPrivateEndpointAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOdaPrivateEndpointAttachmentRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOdaPrivateEndpointAttachmentRequest) String ¶ added in v65.36.0

func (GetOdaPrivateEndpointAttachmentRequest) ValidateEnumValue ¶ added in v65.36.0

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

type GetOdaPrivateEndpointAttachmentResponse ¶ added in v65.36.0

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"`
}

GetOdaPrivateEndpointAttachmentResponse wrapper for the GetOdaPrivateEndpointAttachment operation

func (GetOdaPrivateEndpointAttachmentResponse) HTTPResponse ¶ added in v65.36.0

func (response GetOdaPrivateEndpointAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOdaPrivateEndpointAttachmentResponse) String ¶ added in v65.36.0

type GetOdaPrivateEndpointRequest ¶ added in v65.36.0

type GetOdaPrivateEndpointRequest struct {

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// The 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
}

GetOdaPrivateEndpointRequest wrapper for the GetOdaPrivateEndpoint operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpoint.go.html to see an example of how to use GetOdaPrivateEndpointRequest.

func (GetOdaPrivateEndpointRequest) BinaryRequestBody ¶ added in v65.36.0

func (request GetOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOdaPrivateEndpointRequest) HTTPRequest ¶ added in v65.36.0

func (request GetOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOdaPrivateEndpointRequest) RetryPolicy ¶ added in v65.36.0

func (request GetOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOdaPrivateEndpointRequest) String ¶ added in v65.36.0

func (request GetOdaPrivateEndpointRequest) String() string

func (GetOdaPrivateEndpointRequest) ValidateEnumValue ¶ added in v65.36.0

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

type GetOdaPrivateEndpointResponse ¶ added in v65.36.0

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"`
}

GetOdaPrivateEndpointResponse wrapper for the GetOdaPrivateEndpoint operation

func (GetOdaPrivateEndpointResponse) HTTPResponse ¶ added in v65.36.0

func (response GetOdaPrivateEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOdaPrivateEndpointResponse) String ¶ added in v65.36.0

func (response GetOdaPrivateEndpointResponse) String() string

type GetOdaPrivateEndpointScanProxyRequest ¶ added in v65.36.0

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// The client request ID for tracing. This value is included in the opc-request-id response header.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// 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
}

GetOdaPrivateEndpointScanProxyRequest wrapper for the GetOdaPrivateEndpointScanProxy operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetOdaPrivateEndpointScanProxy.go.html to see an example of how to use GetOdaPrivateEndpointScanProxyRequest.

func (GetOdaPrivateEndpointScanProxyRequest) BinaryRequestBody ¶ added in v65.36.0

func (request GetOdaPrivateEndpointScanProxyRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetOdaPrivateEndpointScanProxyRequest) HTTPRequest ¶ added in v65.36.0

func (request GetOdaPrivateEndpointScanProxyRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetOdaPrivateEndpointScanProxyRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetOdaPrivateEndpointScanProxyRequest) String ¶ added in v65.36.0

func (GetOdaPrivateEndpointScanProxyRequest) ValidateEnumValue ¶ added in v65.36.0

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

type GetOdaPrivateEndpointScanProxyResponse ¶ added in v65.36.0

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"`
}

GetOdaPrivateEndpointScanProxyResponse wrapper for the GetOdaPrivateEndpointScanProxy operation

func (GetOdaPrivateEndpointScanProxyResponse) HTTPResponse ¶ added in v65.36.0

func (response GetOdaPrivateEndpointScanProxyResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetOdaPrivateEndpointScanProxyResponse) String ¶ added in v65.36.0

type GetPackageRequest ¶ added in v65.7.0

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
}

GetPackageRequest wrapper for the GetPackage operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetPackage.go.html to see an example of how to use GetPackageRequest.

func (GetPackageRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetPackageRequest) HTTPRequest ¶ added in v65.7.0

func (request GetPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetPackageRequest) RetryPolicy ¶ added in v65.7.0

func (request GetPackageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetPackageRequest) String ¶ added in v65.7.0

func (request GetPackageRequest) String() string

func (GetPackageRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetPackageResponse ¶ added in v65.7.0

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"`
}

GetPackageResponse wrapper for the GetPackage operation

func (GetPackageResponse) HTTPResponse ¶ added in v65.7.0

func (response GetPackageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetPackageResponse) String ¶ added in v65.7.0

func (response GetPackageResponse) String() string

type GetSkillParameterRequest ¶ added in v65.7.0

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
}

GetSkillParameterRequest wrapper for the GetSkillParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkillParameter.go.html to see an example of how to use GetSkillParameterRequest.

func (GetSkillParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSkillParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request GetSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSkillParameterRequest) RetryPolicy ¶ added in v65.7.0

func (request GetSkillParameterRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSkillParameterRequest) String ¶ added in v65.7.0

func (request GetSkillParameterRequest) String() string

func (GetSkillParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetSkillParameterResponse ¶ added in v65.7.0

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"`
}

GetSkillParameterResponse wrapper for the GetSkillParameter operation

func (GetSkillParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response GetSkillParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSkillParameterResponse) String ¶ added in v65.7.0

func (response GetSkillParameterResponse) String() string

type GetSkillRequest ¶ added in v65.7.0

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
}

GetSkillRequest wrapper for the GetSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetSkill.go.html to see an example of how to use GetSkillRequest.

func (GetSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request GetSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request GetSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetSkillRequest) String ¶ added in v65.7.0

func (request GetSkillRequest) String() string

func (GetSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetSkillResponse ¶ added in v65.7.0

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"`
}

GetSkillResponse wrapper for the GetSkill operation

func (GetSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response GetSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetSkillResponse) String ¶ added in v65.7.0

func (response GetSkillResponse) String() string

type GetTranslatorRequest ¶ added in v65.7.0

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
}

GetTranslatorRequest wrapper for the GetTranslator operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetTranslator.go.html to see an example of how to use GetTranslatorRequest.

func (GetTranslatorRequest) BinaryRequestBody ¶ added in v65.7.0

func (request GetTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetTranslatorRequest) HTTPRequest ¶ added in v65.7.0

func (request GetTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetTranslatorRequest) RetryPolicy ¶ added in v65.7.0

func (request GetTranslatorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetTranslatorRequest) String ¶ added in v65.7.0

func (request GetTranslatorRequest) String() string

func (GetTranslatorRequest) ValidateEnumValue ¶ added in v65.7.0

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

type GetTranslatorResponse ¶ added in v65.7.0

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"`
}

GetTranslatorResponse wrapper for the GetTranslator operation

func (GetTranslatorResponse) HTTPResponse ¶ added in v65.7.0

func (response GetTranslatorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetTranslatorResponse) String ¶ added in v65.7.0

func (response GetTranslatorResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody ¶

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest ¶

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy ¶

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String ¶

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue ¶

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

type GetWorkRequestResponse ¶

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"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse ¶

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String ¶

func (response GetWorkRequestResponse) String() string

type ImportBotDetails ¶ added in v65.7.0

type ImportBotDetails struct {
	Source *StorageLocation `mandatory:"true" json:"source"`
}

ImportBotDetails Properties to import a Bot resource from Object Storage.

func (ImportBotDetails) String ¶ added in v65.7.0

func (m ImportBotDetails) String() string

func (ImportBotDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ImportBotRequest ¶ added in v65.7.0

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
}

ImportBotRequest wrapper for the ImportBot operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ImportBot.go.html to see an example of how to use ImportBotRequest.

func (ImportBotRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ImportBotRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ImportBotRequest) HTTPRequest ¶ added in v65.7.0

func (request ImportBotRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ImportBotRequest) RetryPolicy ¶ added in v65.7.0

func (request ImportBotRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ImportBotRequest) String ¶ added in v65.7.0

func (request ImportBotRequest) String() string

func (ImportBotRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ImportBotResponse ¶ added in v65.7.0

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"`
}

ImportBotResponse wrapper for the ImportBot operation

func (ImportBotResponse) HTTPResponse ¶ added in v65.7.0

func (response ImportBotResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ImportBotResponse) String ¶ added in v65.7.0

func (response ImportBotResponse) String() string

type ImportContract ¶ added in v65.7.0

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"`
}

ImportContract The contract guiding the import experience for the consumer and behavior of the resource providers for all resource types in a package.

func (ImportContract) String ¶ added in v65.7.0

func (m ImportContract) String() string

func (ImportContract) ValidateEnumValue ¶ added in v65.7.0

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

type ImportedPackage ¶ added in v65.7.0

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"`
}

ImportedPackage An imported/instantiated package within an instance.

func (ImportedPackage) String ¶ added in v65.7.0

func (m ImportedPackage) String() string

func (ImportedPackage) ValidateEnumValue ¶ added in v65.7.0

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

type ImportedPackageStatusEnum ¶ added in v65.7.0

type ImportedPackageStatusEnum string

ImportedPackageStatusEnum Enum with underlying type: string

const (
	ImportedPackageStatusReady            ImportedPackageStatusEnum = "READY"
	ImportedPackageStatusOperationPending ImportedPackageStatusEnum = "OPERATION_PENDING"
	ImportedPackageStatusFailed           ImportedPackageStatusEnum = "FAILED"
)

Set of constants representing the allowable values for ImportedPackageStatusEnum

func GetImportedPackageStatusEnumValues ¶ added in v65.7.0

func GetImportedPackageStatusEnumValues() []ImportedPackageStatusEnum

GetImportedPackageStatusEnumValues Enumerates the set of values for ImportedPackageStatusEnum

func GetMappingImportedPackageStatusEnum ¶ added in v65.7.0

func GetMappingImportedPackageStatusEnum(val string) (ImportedPackageStatusEnum, bool)

GetMappingImportedPackageStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ImportedPackageSummary ¶ added in v65.7.0

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"`
}

ImportedPackageSummary A summary of an imported/instantiated package within an instance.

func (ImportedPackageSummary) String ¶ added in v65.7.0

func (m ImportedPackageSummary) String() string

func (ImportedPackageSummary) ValidateEnumValue ¶ added in v65.7.0

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

type IosChannel ¶ added in v65.7.0

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"`
}

IosChannel The configuration for an iOS channel.

func (IosChannel) GetCategory ¶ added in v65.7.0

func (m IosChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (IosChannel) GetDefinedTags ¶ added in v65.7.0

func (m IosChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (IosChannel) GetDescription ¶ added in v65.7.0

func (m IosChannel) GetDescription() *string

GetDescription returns Description

func (IosChannel) GetFreeformTags ¶ added in v65.7.0

func (m IosChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (IosChannel) GetId ¶ added in v65.7.0

func (m IosChannel) GetId() *string

GetId returns Id

func (IosChannel) GetLifecycleState ¶ added in v65.7.0

func (m IosChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (IosChannel) GetName ¶ added in v65.7.0

func (m IosChannel) GetName() *string

GetName returns Name

func (IosChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m IosChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (IosChannel) GetTimeCreated ¶ added in v65.7.0

func (m IosChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (IosChannel) GetTimeUpdated ¶ added in v65.7.0

func (m IosChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (IosChannel) MarshalJSON ¶ added in v65.7.0

func (m IosChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (IosChannel) String ¶ added in v65.7.0

func (m IosChannel) String() string

func (IosChannel) ValidateEnumValue ¶ added in v65.7.0

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

type LanguageMapping ¶ added in v65.60.0

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"`
}

LanguageMapping A natural language mapping.

func (LanguageMapping) String ¶ added in v65.60.0

func (m LanguageMapping) String() string

func (LanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type LifecycleStateEnum ¶ added in v65.7.0

type LifecycleStateEnum string

LifecycleStateEnum Enum with underlying type: string

const (
	LifecycleStateCreating LifecycleStateEnum = "CREATING"
	LifecycleStateUpdating LifecycleStateEnum = "UPDATING"
	LifecycleStateActive   LifecycleStateEnum = "ACTIVE"
	LifecycleStateInactive LifecycleStateEnum = "INACTIVE"
	LifecycleStateDeleting LifecycleStateEnum = "DELETING"
	LifecycleStateDeleted  LifecycleStateEnum = "DELETED"
	LifecycleStateFailed   LifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for LifecycleStateEnum

func GetLifecycleStateEnumValues ¶ added in v65.7.0

func GetLifecycleStateEnumValues() []LifecycleStateEnum

GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum

func GetMappingLifecycleStateEnum ¶ added in v65.7.0

func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)

GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAuthenticationProvidersIdentityProviderEnum ¶ added in v65.7.0

type ListAuthenticationProvidersIdentityProviderEnum string

ListAuthenticationProvidersIdentityProviderEnum Enum with underlying type: string

const (
	ListAuthenticationProvidersIdentityProviderGeneric   ListAuthenticationProvidersIdentityProviderEnum = "GENERIC"
	ListAuthenticationProvidersIdentityProviderOam       ListAuthenticationProvidersIdentityProviderEnum = "OAM"
	ListAuthenticationProvidersIdentityProviderGoogle    ListAuthenticationProvidersIdentityProviderEnum = "GOOGLE"
	ListAuthenticationProvidersIdentityProviderMicrosoft ListAuthenticationProvidersIdentityProviderEnum = "MICROSOFT"
)

Set of constants representing the allowable values for ListAuthenticationProvidersIdentityProviderEnum

func GetListAuthenticationProvidersIdentityProviderEnumValues ¶ added in v65.7.0

func GetListAuthenticationProvidersIdentityProviderEnumValues() []ListAuthenticationProvidersIdentityProviderEnum

GetListAuthenticationProvidersIdentityProviderEnumValues Enumerates the set of values for ListAuthenticationProvidersIdentityProviderEnum

func GetMappingListAuthenticationProvidersIdentityProviderEnum ¶ added in v65.7.0

func GetMappingListAuthenticationProvidersIdentityProviderEnum(val string) (ListAuthenticationProvidersIdentityProviderEnum, bool)

GetMappingListAuthenticationProvidersIdentityProviderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAuthenticationProvidersLifecycleStateEnum ¶ added in v65.7.0

type ListAuthenticationProvidersLifecycleStateEnum string

ListAuthenticationProvidersLifecycleStateEnum Enum with underlying type: string

const (
	ListAuthenticationProvidersLifecycleStateCreating ListAuthenticationProvidersLifecycleStateEnum = "CREATING"
	ListAuthenticationProvidersLifecycleStateUpdating ListAuthenticationProvidersLifecycleStateEnum = "UPDATING"
	ListAuthenticationProvidersLifecycleStateActive   ListAuthenticationProvidersLifecycleStateEnum = "ACTIVE"
	ListAuthenticationProvidersLifecycleStateInactive ListAuthenticationProvidersLifecycleStateEnum = "INACTIVE"
	ListAuthenticationProvidersLifecycleStateDeleting ListAuthenticationProvidersLifecycleStateEnum = "DELETING"
	ListAuthenticationProvidersLifecycleStateDeleted  ListAuthenticationProvidersLifecycleStateEnum = "DELETED"
	ListAuthenticationProvidersLifecycleStateFailed   ListAuthenticationProvidersLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListAuthenticationProvidersLifecycleStateEnum

func GetListAuthenticationProvidersLifecycleStateEnumValues ¶ added in v65.7.0

func GetListAuthenticationProvidersLifecycleStateEnumValues() []ListAuthenticationProvidersLifecycleStateEnum

GetListAuthenticationProvidersLifecycleStateEnumValues Enumerates the set of values for ListAuthenticationProvidersLifecycleStateEnum

func GetMappingListAuthenticationProvidersLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListAuthenticationProvidersLifecycleStateEnum(val string) (ListAuthenticationProvidersLifecycleStateEnum, bool)

GetMappingListAuthenticationProvidersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAuthenticationProvidersRequest ¶ added in v65.7.0

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
}

ListAuthenticationProvidersRequest wrapper for the ListAuthenticationProviders operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListAuthenticationProviders.go.html to see an example of how to use ListAuthenticationProvidersRequest.

func (ListAuthenticationProvidersRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListAuthenticationProvidersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListAuthenticationProvidersRequest) HTTPRequest ¶ added in v65.7.0

func (request ListAuthenticationProvidersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListAuthenticationProvidersRequest) RetryPolicy ¶ added in v65.7.0

func (request ListAuthenticationProvidersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListAuthenticationProvidersRequest) String ¶ added in v65.7.0

func (request ListAuthenticationProvidersRequest) String() string

func (ListAuthenticationProvidersRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListAuthenticationProvidersResponse ¶ added in v65.7.0

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"`
}

ListAuthenticationProvidersResponse wrapper for the ListAuthenticationProviders operation

func (ListAuthenticationProvidersResponse) HTTPResponse ¶ added in v65.7.0

func (response ListAuthenticationProvidersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListAuthenticationProvidersResponse) String ¶ added in v65.7.0

func (response ListAuthenticationProvidersResponse) String() string

type ListAuthenticationProvidersSortByEnum ¶ added in v65.7.0

type ListAuthenticationProvidersSortByEnum string

ListAuthenticationProvidersSortByEnum Enum with underlying type: string

const (
	ListAuthenticationProvidersSortByTimecreated      ListAuthenticationProvidersSortByEnum = "timeCreated"
	ListAuthenticationProvidersSortByTimeupdated      ListAuthenticationProvidersSortByEnum = "timeUpdated"
	ListAuthenticationProvidersSortByName             ListAuthenticationProvidersSortByEnum = "name"
	ListAuthenticationProvidersSortByIdentityprovider ListAuthenticationProvidersSortByEnum = "identityProvider"
)

Set of constants representing the allowable values for ListAuthenticationProvidersSortByEnum

func GetListAuthenticationProvidersSortByEnumValues ¶ added in v65.7.0

func GetListAuthenticationProvidersSortByEnumValues() []ListAuthenticationProvidersSortByEnum

GetListAuthenticationProvidersSortByEnumValues Enumerates the set of values for ListAuthenticationProvidersSortByEnum

func GetMappingListAuthenticationProvidersSortByEnum ¶ added in v65.7.0

func GetMappingListAuthenticationProvidersSortByEnum(val string) (ListAuthenticationProvidersSortByEnum, bool)

GetMappingListAuthenticationProvidersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListAuthenticationProvidersSortOrderEnum ¶ added in v65.7.0

type ListAuthenticationProvidersSortOrderEnum string

ListAuthenticationProvidersSortOrderEnum Enum with underlying type: string

const (
	ListAuthenticationProvidersSortOrderAsc  ListAuthenticationProvidersSortOrderEnum = "ASC"
	ListAuthenticationProvidersSortOrderDesc ListAuthenticationProvidersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAuthenticationProvidersSortOrderEnum

func GetListAuthenticationProvidersSortOrderEnumValues ¶ added in v65.7.0

func GetListAuthenticationProvidersSortOrderEnumValues() []ListAuthenticationProvidersSortOrderEnum

GetListAuthenticationProvidersSortOrderEnumValues Enumerates the set of values for ListAuthenticationProvidersSortOrderEnum

func GetMappingListAuthenticationProvidersSortOrderEnum ¶ added in v65.7.0

func GetMappingListAuthenticationProvidersSortOrderEnum(val string) (ListAuthenticationProvidersSortOrderEnum, bool)

GetMappingListAuthenticationProvidersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListChannelsCategoryEnum ¶ added in v65.7.0

type ListChannelsCategoryEnum string

ListChannelsCategoryEnum Enum with underlying type: string

const (
	ListChannelsCategoryAgent       ListChannelsCategoryEnum = "AGENT"
	ListChannelsCategoryApplication ListChannelsCategoryEnum = "APPLICATION"
	ListChannelsCategoryBot         ListChannelsCategoryEnum = "BOT"
	ListChannelsCategoryBotAsAgent  ListChannelsCategoryEnum = "BOT_AS_AGENT"
	ListChannelsCategorySystem      ListChannelsCategoryEnum = "SYSTEM"
	ListChannelsCategoryEvent       ListChannelsCategoryEnum = "EVENT"
)

Set of constants representing the allowable values for ListChannelsCategoryEnum

func GetListChannelsCategoryEnumValues ¶ added in v65.7.0

func GetListChannelsCategoryEnumValues() []ListChannelsCategoryEnum

GetListChannelsCategoryEnumValues Enumerates the set of values for ListChannelsCategoryEnum

func GetMappingListChannelsCategoryEnum ¶ added in v65.7.0

func GetMappingListChannelsCategoryEnum(val string) (ListChannelsCategoryEnum, bool)

GetMappingListChannelsCategoryEnum performs case Insensitive comparison on enum value and return the desired enum

type ListChannelsLifecycleStateEnum ¶ added in v65.7.0

type ListChannelsLifecycleStateEnum string

ListChannelsLifecycleStateEnum Enum with underlying type: string

const (
	ListChannelsLifecycleStateCreating ListChannelsLifecycleStateEnum = "CREATING"
	ListChannelsLifecycleStateUpdating ListChannelsLifecycleStateEnum = "UPDATING"
	ListChannelsLifecycleStateActive   ListChannelsLifecycleStateEnum = "ACTIVE"
	ListChannelsLifecycleStateInactive ListChannelsLifecycleStateEnum = "INACTIVE"
	ListChannelsLifecycleStateDeleting ListChannelsLifecycleStateEnum = "DELETING"
	ListChannelsLifecycleStateDeleted  ListChannelsLifecycleStateEnum = "DELETED"
	ListChannelsLifecycleStateFailed   ListChannelsLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListChannelsLifecycleStateEnum

func GetListChannelsLifecycleStateEnumValues ¶ added in v65.7.0

func GetListChannelsLifecycleStateEnumValues() []ListChannelsLifecycleStateEnum

GetListChannelsLifecycleStateEnumValues Enumerates the set of values for ListChannelsLifecycleStateEnum

func GetMappingListChannelsLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListChannelsLifecycleStateEnum(val string) (ListChannelsLifecycleStateEnum, bool)

GetMappingListChannelsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListChannelsRequest ¶ added in v65.7.0

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
}

ListChannelsRequest wrapper for the ListChannels operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListChannels.go.html to see an example of how to use ListChannelsRequest.

func (ListChannelsRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListChannelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListChannelsRequest) HTTPRequest ¶ added in v65.7.0

func (request ListChannelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListChannelsRequest) RetryPolicy ¶ added in v65.7.0

func (request ListChannelsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListChannelsRequest) String ¶ added in v65.7.0

func (request ListChannelsRequest) String() string

func (ListChannelsRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListChannelsResponse ¶ added in v65.7.0

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"`
}

ListChannelsResponse wrapper for the ListChannels operation

func (ListChannelsResponse) HTTPResponse ¶ added in v65.7.0

func (response ListChannelsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListChannelsResponse) String ¶ added in v65.7.0

func (response ListChannelsResponse) String() string

type ListChannelsSortByEnum ¶ added in v65.7.0

type ListChannelsSortByEnum string

ListChannelsSortByEnum Enum with underlying type: string

const (
	ListChannelsSortByTimecreated ListChannelsSortByEnum = "timeCreated"
	ListChannelsSortByTimeupdated ListChannelsSortByEnum = "timeUpdated"
	ListChannelsSortByName        ListChannelsSortByEnum = "name"
)

Set of constants representing the allowable values for ListChannelsSortByEnum

func GetListChannelsSortByEnumValues ¶ added in v65.7.0

func GetListChannelsSortByEnumValues() []ListChannelsSortByEnum

GetListChannelsSortByEnumValues Enumerates the set of values for ListChannelsSortByEnum

func GetMappingListChannelsSortByEnum ¶ added in v65.7.0

func GetMappingListChannelsSortByEnum(val string) (ListChannelsSortByEnum, bool)

GetMappingListChannelsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListChannelsSortOrderEnum ¶ added in v65.7.0

type ListChannelsSortOrderEnum string

ListChannelsSortOrderEnum Enum with underlying type: string

const (
	ListChannelsSortOrderAsc  ListChannelsSortOrderEnum = "ASC"
	ListChannelsSortOrderDesc ListChannelsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListChannelsSortOrderEnum

func GetListChannelsSortOrderEnumValues ¶ added in v65.7.0

func GetListChannelsSortOrderEnumValues() []ListChannelsSortOrderEnum

GetListChannelsSortOrderEnumValues Enumerates the set of values for ListChannelsSortOrderEnum

func GetMappingListChannelsSortOrderEnum ¶ added in v65.7.0

func GetMappingListChannelsSortOrderEnum(val string) (ListChannelsSortOrderEnum, bool)

GetMappingListChannelsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListChannelsTypeEnum ¶ added in v65.7.0

type ListChannelsTypeEnum string

ListChannelsTypeEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for ListChannelsTypeEnum

func GetListChannelsTypeEnumValues ¶ added in v65.7.0

func GetListChannelsTypeEnumValues() []ListChannelsTypeEnum

GetListChannelsTypeEnumValues Enumerates the set of values for ListChannelsTypeEnum

func GetMappingListChannelsTypeEnum ¶ added in v65.7.0

func GetMappingListChannelsTypeEnum(val string) (ListChannelsTypeEnum, bool)

GetMappingListChannelsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantParametersLifecycleStateEnum ¶ added in v65.7.0

type ListDigitalAssistantParametersLifecycleStateEnum string

ListDigitalAssistantParametersLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalAssistantParametersLifecycleStateCreating ListDigitalAssistantParametersLifecycleStateEnum = "CREATING"
	ListDigitalAssistantParametersLifecycleStateUpdating ListDigitalAssistantParametersLifecycleStateEnum = "UPDATING"
	ListDigitalAssistantParametersLifecycleStateActive   ListDigitalAssistantParametersLifecycleStateEnum = "ACTIVE"
	ListDigitalAssistantParametersLifecycleStateInactive ListDigitalAssistantParametersLifecycleStateEnum = "INACTIVE"
	ListDigitalAssistantParametersLifecycleStateDeleting ListDigitalAssistantParametersLifecycleStateEnum = "DELETING"
	ListDigitalAssistantParametersLifecycleStateDeleted  ListDigitalAssistantParametersLifecycleStateEnum = "DELETED"
	ListDigitalAssistantParametersLifecycleStateFailed   ListDigitalAssistantParametersLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListDigitalAssistantParametersLifecycleStateEnum

func GetListDigitalAssistantParametersLifecycleStateEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersLifecycleStateEnumValues() []ListDigitalAssistantParametersLifecycleStateEnum

GetListDigitalAssistantParametersLifecycleStateEnumValues Enumerates the set of values for ListDigitalAssistantParametersLifecycleStateEnum

func GetMappingListDigitalAssistantParametersLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantParametersLifecycleStateEnum(val string) (ListDigitalAssistantParametersLifecycleStateEnum, bool)

GetMappingListDigitalAssistantParametersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantParametersRequest ¶ added in v65.7.0

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
}

ListDigitalAssistantParametersRequest wrapper for the ListDigitalAssistantParameters operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistantParameters.go.html to see an example of how to use ListDigitalAssistantParametersRequest.

func (ListDigitalAssistantParametersRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListDigitalAssistantParametersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalAssistantParametersRequest) HTTPRequest ¶ added in v65.7.0

func (request ListDigitalAssistantParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalAssistantParametersRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDigitalAssistantParametersRequest) String ¶ added in v65.7.0

func (ListDigitalAssistantParametersRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListDigitalAssistantParametersResponse ¶ added in v65.7.0

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"`
}

ListDigitalAssistantParametersResponse wrapper for the ListDigitalAssistantParameters operation

func (ListDigitalAssistantParametersResponse) HTTPResponse ¶ added in v65.7.0

func (response ListDigitalAssistantParametersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDigitalAssistantParametersResponse) String ¶ added in v65.7.0

type ListDigitalAssistantParametersSortByEnum ¶ added in v65.7.0

type ListDigitalAssistantParametersSortByEnum string

ListDigitalAssistantParametersSortByEnum Enum with underlying type: string

const (
	ListDigitalAssistantParametersSortByName        ListDigitalAssistantParametersSortByEnum = "name"
	ListDigitalAssistantParametersSortByDisplayname ListDigitalAssistantParametersSortByEnum = "displayName"
	ListDigitalAssistantParametersSortByType        ListDigitalAssistantParametersSortByEnum = "type"
)

Set of constants representing the allowable values for ListDigitalAssistantParametersSortByEnum

func GetListDigitalAssistantParametersSortByEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersSortByEnumValues() []ListDigitalAssistantParametersSortByEnum

GetListDigitalAssistantParametersSortByEnumValues Enumerates the set of values for ListDigitalAssistantParametersSortByEnum

func GetMappingListDigitalAssistantParametersSortByEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantParametersSortByEnum(val string) (ListDigitalAssistantParametersSortByEnum, bool)

GetMappingListDigitalAssistantParametersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantParametersSortOrderEnum ¶ added in v65.7.0

type ListDigitalAssistantParametersSortOrderEnum string

ListDigitalAssistantParametersSortOrderEnum Enum with underlying type: string

const (
	ListDigitalAssistantParametersSortOrderAsc  ListDigitalAssistantParametersSortOrderEnum = "ASC"
	ListDigitalAssistantParametersSortOrderDesc ListDigitalAssistantParametersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalAssistantParametersSortOrderEnum

func GetListDigitalAssistantParametersSortOrderEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantParametersSortOrderEnumValues() []ListDigitalAssistantParametersSortOrderEnum

GetListDigitalAssistantParametersSortOrderEnumValues Enumerates the set of values for ListDigitalAssistantParametersSortOrderEnum

func GetMappingListDigitalAssistantParametersSortOrderEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantParametersSortOrderEnum(val string) (ListDigitalAssistantParametersSortOrderEnum, bool)

GetMappingListDigitalAssistantParametersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantsLifecycleStateEnum ¶ added in v65.7.0

type ListDigitalAssistantsLifecycleStateEnum string

ListDigitalAssistantsLifecycleStateEnum Enum with underlying type: string

const (
	ListDigitalAssistantsLifecycleStateCreating ListDigitalAssistantsLifecycleStateEnum = "CREATING"
	ListDigitalAssistantsLifecycleStateUpdating ListDigitalAssistantsLifecycleStateEnum = "UPDATING"
	ListDigitalAssistantsLifecycleStateActive   ListDigitalAssistantsLifecycleStateEnum = "ACTIVE"
	ListDigitalAssistantsLifecycleStateInactive ListDigitalAssistantsLifecycleStateEnum = "INACTIVE"
	ListDigitalAssistantsLifecycleStateDeleting ListDigitalAssistantsLifecycleStateEnum = "DELETING"
	ListDigitalAssistantsLifecycleStateDeleted  ListDigitalAssistantsLifecycleStateEnum = "DELETED"
	ListDigitalAssistantsLifecycleStateFailed   ListDigitalAssistantsLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListDigitalAssistantsLifecycleStateEnum

func GetListDigitalAssistantsLifecycleStateEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantsLifecycleStateEnumValues() []ListDigitalAssistantsLifecycleStateEnum

GetListDigitalAssistantsLifecycleStateEnumValues Enumerates the set of values for ListDigitalAssistantsLifecycleStateEnum

func GetMappingListDigitalAssistantsLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantsLifecycleStateEnum(val string) (ListDigitalAssistantsLifecycleStateEnum, bool)

GetMappingListDigitalAssistantsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantsRequest ¶ added in v65.7.0

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
}

ListDigitalAssistantsRequest wrapper for the ListDigitalAssistants operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListDigitalAssistants.go.html to see an example of how to use ListDigitalAssistantsRequest.

func (ListDigitalAssistantsRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListDigitalAssistantsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListDigitalAssistantsRequest) HTTPRequest ¶ added in v65.7.0

func (request ListDigitalAssistantsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListDigitalAssistantsRequest) RetryPolicy ¶ added in v65.7.0

func (request ListDigitalAssistantsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListDigitalAssistantsRequest) String ¶ added in v65.7.0

func (request ListDigitalAssistantsRequest) String() string

func (ListDigitalAssistantsRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListDigitalAssistantsResponse ¶ added in v65.7.0

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"`
}

ListDigitalAssistantsResponse wrapper for the ListDigitalAssistants operation

func (ListDigitalAssistantsResponse) HTTPResponse ¶ added in v65.7.0

func (response ListDigitalAssistantsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListDigitalAssistantsResponse) String ¶ added in v65.7.0

func (response ListDigitalAssistantsResponse) String() string

type ListDigitalAssistantsSortByEnum ¶ added in v65.7.0

type ListDigitalAssistantsSortByEnum string

ListDigitalAssistantsSortByEnum Enum with underlying type: string

const (
	ListDigitalAssistantsSortByTimecreated ListDigitalAssistantsSortByEnum = "timeCreated"
	ListDigitalAssistantsSortByTimeupdated ListDigitalAssistantsSortByEnum = "timeUpdated"
	ListDigitalAssistantsSortByName        ListDigitalAssistantsSortByEnum = "name"
)

Set of constants representing the allowable values for ListDigitalAssistantsSortByEnum

func GetListDigitalAssistantsSortByEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantsSortByEnumValues() []ListDigitalAssistantsSortByEnum

GetListDigitalAssistantsSortByEnumValues Enumerates the set of values for ListDigitalAssistantsSortByEnum

func GetMappingListDigitalAssistantsSortByEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantsSortByEnum(val string) (ListDigitalAssistantsSortByEnum, bool)

GetMappingListDigitalAssistantsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListDigitalAssistantsSortOrderEnum ¶ added in v65.7.0

type ListDigitalAssistantsSortOrderEnum string

ListDigitalAssistantsSortOrderEnum Enum with underlying type: string

const (
	ListDigitalAssistantsSortOrderAsc  ListDigitalAssistantsSortOrderEnum = "ASC"
	ListDigitalAssistantsSortOrderDesc ListDigitalAssistantsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDigitalAssistantsSortOrderEnum

func GetListDigitalAssistantsSortOrderEnumValues ¶ added in v65.7.0

func GetListDigitalAssistantsSortOrderEnumValues() []ListDigitalAssistantsSortOrderEnum

GetListDigitalAssistantsSortOrderEnumValues Enumerates the set of values for ListDigitalAssistantsSortOrderEnum

func GetMappingListDigitalAssistantsSortOrderEnum ¶ added in v65.7.0

func GetMappingListDigitalAssistantsSortOrderEnum(val string) (ListDigitalAssistantsSortOrderEnum, bool)

GetMappingListDigitalAssistantsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListImportedPackagesRequest ¶ added in v65.7.0

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
}

ListImportedPackagesRequest wrapper for the ListImportedPackages operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListImportedPackages.go.html to see an example of how to use ListImportedPackagesRequest.

func (ListImportedPackagesRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListImportedPackagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListImportedPackagesRequest) HTTPRequest ¶ added in v65.7.0

func (request ListImportedPackagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListImportedPackagesRequest) RetryPolicy ¶ added in v65.7.0

func (request ListImportedPackagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListImportedPackagesRequest) String ¶ added in v65.7.0

func (request ListImportedPackagesRequest) String() string

func (ListImportedPackagesRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListImportedPackagesResponse ¶ added in v65.7.0

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"`
}

ListImportedPackagesResponse wrapper for the ListImportedPackages operation

func (ListImportedPackagesResponse) HTTPResponse ¶ added in v65.7.0

func (response ListImportedPackagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListImportedPackagesResponse) String ¶ added in v65.7.0

func (response ListImportedPackagesResponse) String() string

type ListImportedPackagesSortByEnum ¶ added in v65.7.0

type ListImportedPackagesSortByEnum string

ListImportedPackagesSortByEnum Enum with underlying type: string

const (
	ListImportedPackagesSortByTimecreated ListImportedPackagesSortByEnum = "TIMECREATED"
	ListImportedPackagesSortByDisplayname ListImportedPackagesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListImportedPackagesSortByEnum

func GetListImportedPackagesSortByEnumValues ¶ added in v65.7.0

func GetListImportedPackagesSortByEnumValues() []ListImportedPackagesSortByEnum

GetListImportedPackagesSortByEnumValues Enumerates the set of values for ListImportedPackagesSortByEnum

func GetMappingListImportedPackagesSortByEnum ¶ added in v65.7.0

func GetMappingListImportedPackagesSortByEnum(val string) (ListImportedPackagesSortByEnum, bool)

GetMappingListImportedPackagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListImportedPackagesSortOrderEnum ¶ added in v65.7.0

type ListImportedPackagesSortOrderEnum string

ListImportedPackagesSortOrderEnum Enum with underlying type: string

const (
	ListImportedPackagesSortOrderAsc  ListImportedPackagesSortOrderEnum = "ASC"
	ListImportedPackagesSortOrderDesc ListImportedPackagesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListImportedPackagesSortOrderEnum

func GetListImportedPackagesSortOrderEnumValues ¶ added in v65.7.0

func GetListImportedPackagesSortOrderEnumValues() []ListImportedPackagesSortOrderEnum

GetListImportedPackagesSortOrderEnumValues Enumerates the set of values for ListImportedPackagesSortOrderEnum

func GetMappingListImportedPackagesSortOrderEnum ¶ added in v65.7.0

func GetMappingListImportedPackagesSortOrderEnum(val string) (ListImportedPackagesSortOrderEnum, bool)

GetMappingListImportedPackagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaInstanceAttachmentsLifecycleStateEnum ¶ added in v65.7.0

type ListOdaInstanceAttachmentsLifecycleStateEnum string

ListOdaInstanceAttachmentsLifecycleStateEnum Enum with underlying type: string

const (
	ListOdaInstanceAttachmentsLifecycleStateAttaching ListOdaInstanceAttachmentsLifecycleStateEnum = "ATTACHING"
	ListOdaInstanceAttachmentsLifecycleStateActive    ListOdaInstanceAttachmentsLifecycleStateEnum = "ACTIVE"
	ListOdaInstanceAttachmentsLifecycleStateDetaching ListOdaInstanceAttachmentsLifecycleStateEnum = "DETACHING"
	ListOdaInstanceAttachmentsLifecycleStateInactive  ListOdaInstanceAttachmentsLifecycleStateEnum = "INACTIVE"
	ListOdaInstanceAttachmentsLifecycleStateFailed    ListOdaInstanceAttachmentsLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListOdaInstanceAttachmentsLifecycleStateEnum

func GetListOdaInstanceAttachmentsLifecycleStateEnumValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsLifecycleStateEnumValues() []ListOdaInstanceAttachmentsLifecycleStateEnum

GetListOdaInstanceAttachmentsLifecycleStateEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsLifecycleStateEnum

func GetMappingListOdaInstanceAttachmentsLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListOdaInstanceAttachmentsLifecycleStateEnum(val string) (ListOdaInstanceAttachmentsLifecycleStateEnum, bool)

GetMappingListOdaInstanceAttachmentsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaInstanceAttachmentsRequest ¶ added in v65.7.0

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
}

ListOdaInstanceAttachmentsRequest wrapper for the ListOdaInstanceAttachments operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstanceAttachments.go.html to see an example of how to use ListOdaInstanceAttachmentsRequest.

func (ListOdaInstanceAttachmentsRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListOdaInstanceAttachmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOdaInstanceAttachmentsRequest) HTTPRequest ¶ added in v65.7.0

func (request ListOdaInstanceAttachmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOdaInstanceAttachmentsRequest) RetryPolicy ¶ added in v65.7.0

func (request ListOdaInstanceAttachmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOdaInstanceAttachmentsRequest) String ¶ added in v65.7.0

func (request ListOdaInstanceAttachmentsRequest) String() string

func (ListOdaInstanceAttachmentsRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListOdaInstanceAttachmentsResponse ¶ added in v65.7.0

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"`
}

ListOdaInstanceAttachmentsResponse wrapper for the ListOdaInstanceAttachments operation

func (ListOdaInstanceAttachmentsResponse) HTTPResponse ¶ added in v65.7.0

func (response ListOdaInstanceAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOdaInstanceAttachmentsResponse) String ¶ added in v65.7.0

func (response ListOdaInstanceAttachmentsResponse) String() string

type ListOdaInstanceAttachmentsSortByEnum ¶ added in v65.7.0

type ListOdaInstanceAttachmentsSortByEnum string

ListOdaInstanceAttachmentsSortByEnum Enum with underlying type: string

const (
	ListOdaInstanceAttachmentsSortByTimecreated ListOdaInstanceAttachmentsSortByEnum = "TIMECREATED"
)

Set of constants representing the allowable values for ListOdaInstanceAttachmentsSortByEnum

func GetListOdaInstanceAttachmentsSortByEnumValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsSortByEnumValues() []ListOdaInstanceAttachmentsSortByEnum

GetListOdaInstanceAttachmentsSortByEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsSortByEnum

func GetMappingListOdaInstanceAttachmentsSortByEnum ¶ added in v65.7.0

func GetMappingListOdaInstanceAttachmentsSortByEnum(val string) (ListOdaInstanceAttachmentsSortByEnum, bool)

GetMappingListOdaInstanceAttachmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaInstanceAttachmentsSortOrderEnum ¶ added in v65.7.0

type ListOdaInstanceAttachmentsSortOrderEnum string

ListOdaInstanceAttachmentsSortOrderEnum Enum with underlying type: string

const (
	ListOdaInstanceAttachmentsSortOrderAsc  ListOdaInstanceAttachmentsSortOrderEnum = "ASC"
	ListOdaInstanceAttachmentsSortOrderDesc ListOdaInstanceAttachmentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOdaInstanceAttachmentsSortOrderEnum

func GetListOdaInstanceAttachmentsSortOrderEnumValues ¶ added in v65.7.0

func GetListOdaInstanceAttachmentsSortOrderEnumValues() []ListOdaInstanceAttachmentsSortOrderEnum

GetListOdaInstanceAttachmentsSortOrderEnumValues Enumerates the set of values for ListOdaInstanceAttachmentsSortOrderEnum

func GetMappingListOdaInstanceAttachmentsSortOrderEnum ¶ added in v65.7.0

func GetMappingListOdaInstanceAttachmentsSortOrderEnum(val string) (ListOdaInstanceAttachmentsSortOrderEnum, bool)

GetMappingListOdaInstanceAttachmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaInstancesLifecycleStateEnum ¶

type ListOdaInstancesLifecycleStateEnum string

ListOdaInstancesLifecycleStateEnum Enum with underlying type: string

const (
	ListOdaInstancesLifecycleStateCreating ListOdaInstancesLifecycleStateEnum = "CREATING"
	ListOdaInstancesLifecycleStateUpdating ListOdaInstancesLifecycleStateEnum = "UPDATING"
	ListOdaInstancesLifecycleStateActive   ListOdaInstancesLifecycleStateEnum = "ACTIVE"
	ListOdaInstancesLifecycleStateInactive ListOdaInstancesLifecycleStateEnum = "INACTIVE"
	ListOdaInstancesLifecycleStateDeleting ListOdaInstancesLifecycleStateEnum = "DELETING"
	ListOdaInstancesLifecycleStateDeleted  ListOdaInstancesLifecycleStateEnum = "DELETED"
	ListOdaInstancesLifecycleStateFailed   ListOdaInstancesLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListOdaInstancesLifecycleStateEnum

func GetListOdaInstancesLifecycleStateEnumValues ¶

func GetListOdaInstancesLifecycleStateEnumValues() []ListOdaInstancesLifecycleStateEnum

GetListOdaInstancesLifecycleStateEnumValues Enumerates the set of values for ListOdaInstancesLifecycleStateEnum

func GetMappingListOdaInstancesLifecycleStateEnum ¶

func GetMappingListOdaInstancesLifecycleStateEnum(val string) (ListOdaInstancesLifecycleStateEnum, bool)

GetMappingListOdaInstancesLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListOdaInstancesRequest wrapper for the ListOdaInstances operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaInstances.go.html to see an example of how to use ListOdaInstancesRequest.

func (ListOdaInstancesRequest) BinaryRequestBody ¶

func (request ListOdaInstancesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOdaInstancesRequest) HTTPRequest ¶

func (request ListOdaInstancesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOdaInstancesRequest) RetryPolicy ¶

func (request ListOdaInstancesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOdaInstancesRequest) String ¶

func (request ListOdaInstancesRequest) String() string

func (ListOdaInstancesRequest) ValidateEnumValue ¶

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

type ListOdaInstancesResponse ¶

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"`
}

ListOdaInstancesResponse wrapper for the ListOdaInstances operation

func (ListOdaInstancesResponse) HTTPResponse ¶

func (response ListOdaInstancesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOdaInstancesResponse) String ¶

func (response ListOdaInstancesResponse) String() string

type ListOdaInstancesSortByEnum ¶

type ListOdaInstancesSortByEnum string

ListOdaInstancesSortByEnum Enum with underlying type: string

const (
	ListOdaInstancesSortByTimecreated ListOdaInstancesSortByEnum = "TIMECREATED"
	ListOdaInstancesSortByDisplayname ListOdaInstancesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListOdaInstancesSortByEnum

func GetListOdaInstancesSortByEnumValues ¶

func GetListOdaInstancesSortByEnumValues() []ListOdaInstancesSortByEnum

GetListOdaInstancesSortByEnumValues Enumerates the set of values for ListOdaInstancesSortByEnum

func GetMappingListOdaInstancesSortByEnum ¶

func GetMappingListOdaInstancesSortByEnum(val string) (ListOdaInstancesSortByEnum, bool)

GetMappingListOdaInstancesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaInstancesSortOrderEnum ¶

type ListOdaInstancesSortOrderEnum string

ListOdaInstancesSortOrderEnum Enum with underlying type: string

const (
	ListOdaInstancesSortOrderAsc  ListOdaInstancesSortOrderEnum = "ASC"
	ListOdaInstancesSortOrderDesc ListOdaInstancesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOdaInstancesSortOrderEnum

func GetListOdaInstancesSortOrderEnumValues ¶

func GetListOdaInstancesSortOrderEnumValues() []ListOdaInstancesSortOrderEnum

GetListOdaInstancesSortOrderEnumValues Enumerates the set of values for ListOdaInstancesSortOrderEnum

func GetMappingListOdaInstancesSortOrderEnum ¶

func GetMappingListOdaInstancesSortOrderEnum(val string) (ListOdaInstancesSortOrderEnum, bool)

GetMappingListOdaInstancesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointAttachmentsRequest ¶ added in v65.36.0

type ListOdaPrivateEndpointAttachmentsRequest struct {

	// The OCID (https://docs.cloud.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
}

ListOdaPrivateEndpointAttachmentsRequest wrapper for the ListOdaPrivateEndpointAttachments operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointAttachments.go.html to see an example of how to use ListOdaPrivateEndpointAttachmentsRequest.

func (ListOdaPrivateEndpointAttachmentsRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (ListOdaPrivateEndpointAttachmentsRequest) HTTPRequest ¶ added in v65.36.0

func (request ListOdaPrivateEndpointAttachmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOdaPrivateEndpointAttachmentsRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOdaPrivateEndpointAttachmentsRequest) String ¶ added in v65.36.0

func (ListOdaPrivateEndpointAttachmentsRequest) ValidateEnumValue ¶ added in v65.36.0

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

type ListOdaPrivateEndpointAttachmentsResponse ¶ added in v65.36.0

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"`
}

ListOdaPrivateEndpointAttachmentsResponse wrapper for the ListOdaPrivateEndpointAttachments operation

func (ListOdaPrivateEndpointAttachmentsResponse) HTTPResponse ¶ added in v65.36.0

func (response ListOdaPrivateEndpointAttachmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOdaPrivateEndpointAttachmentsResponse) String ¶ added in v65.36.0

type ListOdaPrivateEndpointAttachmentsSortByEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointAttachmentsSortByEnum string

ListOdaPrivateEndpointAttachmentsSortByEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointAttachmentsSortByTimecreated ListOdaPrivateEndpointAttachmentsSortByEnum = "TIMECREATED"
	ListOdaPrivateEndpointAttachmentsSortByDisplayname ListOdaPrivateEndpointAttachmentsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointAttachmentsSortByEnum

func GetListOdaPrivateEndpointAttachmentsSortByEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointAttachmentsSortByEnumValues() []ListOdaPrivateEndpointAttachmentsSortByEnum

GetListOdaPrivateEndpointAttachmentsSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointAttachmentsSortByEnum

func GetMappingListOdaPrivateEndpointAttachmentsSortByEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointAttachmentsSortByEnum(val string) (ListOdaPrivateEndpointAttachmentsSortByEnum, bool)

GetMappingListOdaPrivateEndpointAttachmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointAttachmentsSortOrderEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointAttachmentsSortOrderEnum string

ListOdaPrivateEndpointAttachmentsSortOrderEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointAttachmentsSortOrderAsc  ListOdaPrivateEndpointAttachmentsSortOrderEnum = "ASC"
	ListOdaPrivateEndpointAttachmentsSortOrderDesc ListOdaPrivateEndpointAttachmentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointAttachmentsSortOrderEnum

func GetListOdaPrivateEndpointAttachmentsSortOrderEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointAttachmentsSortOrderEnumValues() []ListOdaPrivateEndpointAttachmentsSortOrderEnum

GetListOdaPrivateEndpointAttachmentsSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointAttachmentsSortOrderEnum

func GetMappingListOdaPrivateEndpointAttachmentsSortOrderEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointAttachmentsSortOrderEnum(val string) (ListOdaPrivateEndpointAttachmentsSortOrderEnum, bool)

GetMappingListOdaPrivateEndpointAttachmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointScanProxiesRequest ¶ added in v65.36.0

type ListOdaPrivateEndpointScanProxiesRequest struct {

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// 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
}

ListOdaPrivateEndpointScanProxiesRequest wrapper for the ListOdaPrivateEndpointScanProxies operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpointScanProxies.go.html to see an example of how to use ListOdaPrivateEndpointScanProxiesRequest.

func (ListOdaPrivateEndpointScanProxiesRequest) BinaryRequestBody ¶ added in v65.36.0

BinaryRequestBody implements the OCIRequest interface

func (ListOdaPrivateEndpointScanProxiesRequest) HTTPRequest ¶ added in v65.36.0

func (request ListOdaPrivateEndpointScanProxiesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOdaPrivateEndpointScanProxiesRequest) RetryPolicy ¶ added in v65.36.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOdaPrivateEndpointScanProxiesRequest) String ¶ added in v65.36.0

func (ListOdaPrivateEndpointScanProxiesRequest) ValidateEnumValue ¶ added in v65.36.0

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

type ListOdaPrivateEndpointScanProxiesResponse ¶ added in v65.36.0

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"`
}

ListOdaPrivateEndpointScanProxiesResponse wrapper for the ListOdaPrivateEndpointScanProxies operation

func (ListOdaPrivateEndpointScanProxiesResponse) HTTPResponse ¶ added in v65.36.0

func (response ListOdaPrivateEndpointScanProxiesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOdaPrivateEndpointScanProxiesResponse) String ¶ added in v65.36.0

type ListOdaPrivateEndpointScanProxiesSortByEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointScanProxiesSortByEnum string

ListOdaPrivateEndpointScanProxiesSortByEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointScanProxiesSortByTimecreated ListOdaPrivateEndpointScanProxiesSortByEnum = "TIMECREATED"
	ListOdaPrivateEndpointScanProxiesSortByDisplayname ListOdaPrivateEndpointScanProxiesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointScanProxiesSortByEnum

func GetListOdaPrivateEndpointScanProxiesSortByEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointScanProxiesSortByEnumValues() []ListOdaPrivateEndpointScanProxiesSortByEnum

GetListOdaPrivateEndpointScanProxiesSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointScanProxiesSortByEnum

func GetMappingListOdaPrivateEndpointScanProxiesSortByEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointScanProxiesSortByEnum(val string) (ListOdaPrivateEndpointScanProxiesSortByEnum, bool)

GetMappingListOdaPrivateEndpointScanProxiesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointScanProxiesSortOrderEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointScanProxiesSortOrderEnum string

ListOdaPrivateEndpointScanProxiesSortOrderEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointScanProxiesSortOrderAsc  ListOdaPrivateEndpointScanProxiesSortOrderEnum = "ASC"
	ListOdaPrivateEndpointScanProxiesSortOrderDesc ListOdaPrivateEndpointScanProxiesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointScanProxiesSortOrderEnum

func GetListOdaPrivateEndpointScanProxiesSortOrderEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointScanProxiesSortOrderEnumValues() []ListOdaPrivateEndpointScanProxiesSortOrderEnum

GetListOdaPrivateEndpointScanProxiesSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointScanProxiesSortOrderEnum

func GetMappingListOdaPrivateEndpointScanProxiesSortOrderEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointScanProxiesSortOrderEnum(val string) (ListOdaPrivateEndpointScanProxiesSortOrderEnum, bool)

GetMappingListOdaPrivateEndpointScanProxiesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointsRequest ¶ added in v65.36.0

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
}

ListOdaPrivateEndpointsRequest wrapper for the ListOdaPrivateEndpoints operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListOdaPrivateEndpoints.go.html to see an example of how to use ListOdaPrivateEndpointsRequest.

func (ListOdaPrivateEndpointsRequest) BinaryRequestBody ¶ added in v65.36.0

func (request ListOdaPrivateEndpointsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListOdaPrivateEndpointsRequest) HTTPRequest ¶ added in v65.36.0

func (request ListOdaPrivateEndpointsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListOdaPrivateEndpointsRequest) RetryPolicy ¶ added in v65.36.0

func (request ListOdaPrivateEndpointsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListOdaPrivateEndpointsRequest) String ¶ added in v65.36.0

func (request ListOdaPrivateEndpointsRequest) String() string

func (ListOdaPrivateEndpointsRequest) ValidateEnumValue ¶ added in v65.36.0

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

type ListOdaPrivateEndpointsResponse ¶ added in v65.36.0

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"`
}

ListOdaPrivateEndpointsResponse wrapper for the ListOdaPrivateEndpoints operation

func (ListOdaPrivateEndpointsResponse) HTTPResponse ¶ added in v65.36.0

func (response ListOdaPrivateEndpointsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListOdaPrivateEndpointsResponse) String ¶ added in v65.36.0

func (response ListOdaPrivateEndpointsResponse) String() string

type ListOdaPrivateEndpointsSortByEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointsSortByEnum string

ListOdaPrivateEndpointsSortByEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointsSortByTimecreated ListOdaPrivateEndpointsSortByEnum = "TIMECREATED"
	ListOdaPrivateEndpointsSortByDisplayname ListOdaPrivateEndpointsSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointsSortByEnum

func GetListOdaPrivateEndpointsSortByEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointsSortByEnumValues() []ListOdaPrivateEndpointsSortByEnum

GetListOdaPrivateEndpointsSortByEnumValues Enumerates the set of values for ListOdaPrivateEndpointsSortByEnum

func GetMappingListOdaPrivateEndpointsSortByEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointsSortByEnum(val string) (ListOdaPrivateEndpointsSortByEnum, bool)

GetMappingListOdaPrivateEndpointsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListOdaPrivateEndpointsSortOrderEnum ¶ added in v65.36.0

type ListOdaPrivateEndpointsSortOrderEnum string

ListOdaPrivateEndpointsSortOrderEnum Enum with underlying type: string

const (
	ListOdaPrivateEndpointsSortOrderAsc  ListOdaPrivateEndpointsSortOrderEnum = "ASC"
	ListOdaPrivateEndpointsSortOrderDesc ListOdaPrivateEndpointsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListOdaPrivateEndpointsSortOrderEnum

func GetListOdaPrivateEndpointsSortOrderEnumValues ¶ added in v65.36.0

func GetListOdaPrivateEndpointsSortOrderEnumValues() []ListOdaPrivateEndpointsSortOrderEnum

GetListOdaPrivateEndpointsSortOrderEnumValues Enumerates the set of values for ListOdaPrivateEndpointsSortOrderEnum

func GetMappingListOdaPrivateEndpointsSortOrderEnum ¶ added in v65.36.0

func GetMappingListOdaPrivateEndpointsSortOrderEnum(val string) (ListOdaPrivateEndpointsSortOrderEnum, bool)

GetMappingListOdaPrivateEndpointsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListPackagesRequest ¶ added in v65.7.0

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
}

ListPackagesRequest wrapper for the ListPackages operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListPackages.go.html to see an example of how to use ListPackagesRequest.

func (ListPackagesRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListPackagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListPackagesRequest) HTTPRequest ¶ added in v65.7.0

func (request ListPackagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListPackagesRequest) RetryPolicy ¶ added in v65.7.0

func (request ListPackagesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListPackagesRequest) String ¶ added in v65.7.0

func (request ListPackagesRequest) String() string

func (ListPackagesRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListPackagesResponse ¶ added in v65.7.0

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"`
}

ListPackagesResponse wrapper for the ListPackages operation

func (ListPackagesResponse) HTTPResponse ¶ added in v65.7.0

func (response ListPackagesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListPackagesResponse) String ¶ added in v65.7.0

func (response ListPackagesResponse) String() string

type ListPackagesSortByEnum ¶ added in v65.7.0

type ListPackagesSortByEnum string

ListPackagesSortByEnum Enum with underlying type: string

const (
	ListPackagesSortByTimecreated ListPackagesSortByEnum = "TIMECREATED"
	ListPackagesSortByDisplayname ListPackagesSortByEnum = "DISPLAYNAME"
)

Set of constants representing the allowable values for ListPackagesSortByEnum

func GetListPackagesSortByEnumValues ¶ added in v65.7.0

func GetListPackagesSortByEnumValues() []ListPackagesSortByEnum

GetListPackagesSortByEnumValues Enumerates the set of values for ListPackagesSortByEnum

func GetMappingListPackagesSortByEnum ¶ added in v65.7.0

func GetMappingListPackagesSortByEnum(val string) (ListPackagesSortByEnum, bool)

GetMappingListPackagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListPackagesSortOrderEnum ¶ added in v65.7.0

type ListPackagesSortOrderEnum string

ListPackagesSortOrderEnum Enum with underlying type: string

const (
	ListPackagesSortOrderAsc  ListPackagesSortOrderEnum = "ASC"
	ListPackagesSortOrderDesc ListPackagesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListPackagesSortOrderEnum

func GetListPackagesSortOrderEnumValues ¶ added in v65.7.0

func GetListPackagesSortOrderEnumValues() []ListPackagesSortOrderEnum

GetListPackagesSortOrderEnumValues Enumerates the set of values for ListPackagesSortOrderEnum

func GetMappingListPackagesSortOrderEnum ¶ added in v65.7.0

func GetMappingListPackagesSortOrderEnum(val string) (ListPackagesSortOrderEnum, bool)

GetMappingListPackagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillParametersLifecycleStateEnum ¶ added in v65.7.0

type ListSkillParametersLifecycleStateEnum string

ListSkillParametersLifecycleStateEnum Enum with underlying type: string

const (
	ListSkillParametersLifecycleStateCreating ListSkillParametersLifecycleStateEnum = "CREATING"
	ListSkillParametersLifecycleStateUpdating ListSkillParametersLifecycleStateEnum = "UPDATING"
	ListSkillParametersLifecycleStateActive   ListSkillParametersLifecycleStateEnum = "ACTIVE"
	ListSkillParametersLifecycleStateInactive ListSkillParametersLifecycleStateEnum = "INACTIVE"
	ListSkillParametersLifecycleStateDeleting ListSkillParametersLifecycleStateEnum = "DELETING"
	ListSkillParametersLifecycleStateDeleted  ListSkillParametersLifecycleStateEnum = "DELETED"
	ListSkillParametersLifecycleStateFailed   ListSkillParametersLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListSkillParametersLifecycleStateEnum

func GetListSkillParametersLifecycleStateEnumValues ¶ added in v65.7.0

func GetListSkillParametersLifecycleStateEnumValues() []ListSkillParametersLifecycleStateEnum

GetListSkillParametersLifecycleStateEnumValues Enumerates the set of values for ListSkillParametersLifecycleStateEnum

func GetMappingListSkillParametersLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListSkillParametersLifecycleStateEnum(val string) (ListSkillParametersLifecycleStateEnum, bool)

GetMappingListSkillParametersLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillParametersRequest ¶ added in v65.7.0

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
}

ListSkillParametersRequest wrapper for the ListSkillParameters operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkillParameters.go.html to see an example of how to use ListSkillParametersRequest.

func (ListSkillParametersRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListSkillParametersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSkillParametersRequest) HTTPRequest ¶ added in v65.7.0

func (request ListSkillParametersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSkillParametersRequest) RetryPolicy ¶ added in v65.7.0

func (request ListSkillParametersRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSkillParametersRequest) String ¶ added in v65.7.0

func (request ListSkillParametersRequest) String() string

func (ListSkillParametersRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListSkillParametersResponse ¶ added in v65.7.0

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"`
}

ListSkillParametersResponse wrapper for the ListSkillParameters operation

func (ListSkillParametersResponse) HTTPResponse ¶ added in v65.7.0

func (response ListSkillParametersResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSkillParametersResponse) String ¶ added in v65.7.0

func (response ListSkillParametersResponse) String() string

type ListSkillParametersSortByEnum ¶ added in v65.7.0

type ListSkillParametersSortByEnum string

ListSkillParametersSortByEnum Enum with underlying type: string

const (
	ListSkillParametersSortByName        ListSkillParametersSortByEnum = "name"
	ListSkillParametersSortByDisplayname ListSkillParametersSortByEnum = "displayName"
	ListSkillParametersSortByType        ListSkillParametersSortByEnum = "type"
)

Set of constants representing the allowable values for ListSkillParametersSortByEnum

func GetListSkillParametersSortByEnumValues ¶ added in v65.7.0

func GetListSkillParametersSortByEnumValues() []ListSkillParametersSortByEnum

GetListSkillParametersSortByEnumValues Enumerates the set of values for ListSkillParametersSortByEnum

func GetMappingListSkillParametersSortByEnum ¶ added in v65.7.0

func GetMappingListSkillParametersSortByEnum(val string) (ListSkillParametersSortByEnum, bool)

GetMappingListSkillParametersSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillParametersSortOrderEnum ¶ added in v65.7.0

type ListSkillParametersSortOrderEnum string

ListSkillParametersSortOrderEnum Enum with underlying type: string

const (
	ListSkillParametersSortOrderAsc  ListSkillParametersSortOrderEnum = "ASC"
	ListSkillParametersSortOrderDesc ListSkillParametersSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSkillParametersSortOrderEnum

func GetListSkillParametersSortOrderEnumValues ¶ added in v65.7.0

func GetListSkillParametersSortOrderEnumValues() []ListSkillParametersSortOrderEnum

GetListSkillParametersSortOrderEnumValues Enumerates the set of values for ListSkillParametersSortOrderEnum

func GetMappingListSkillParametersSortOrderEnum ¶ added in v65.7.0

func GetMappingListSkillParametersSortOrderEnum(val string) (ListSkillParametersSortOrderEnum, bool)

GetMappingListSkillParametersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillsLifecycleStateEnum ¶ added in v65.7.0

type ListSkillsLifecycleStateEnum string

ListSkillsLifecycleStateEnum Enum with underlying type: string

const (
	ListSkillsLifecycleStateCreating ListSkillsLifecycleStateEnum = "CREATING"
	ListSkillsLifecycleStateUpdating ListSkillsLifecycleStateEnum = "UPDATING"
	ListSkillsLifecycleStateActive   ListSkillsLifecycleStateEnum = "ACTIVE"
	ListSkillsLifecycleStateInactive ListSkillsLifecycleStateEnum = "INACTIVE"
	ListSkillsLifecycleStateDeleting ListSkillsLifecycleStateEnum = "DELETING"
	ListSkillsLifecycleStateDeleted  ListSkillsLifecycleStateEnum = "DELETED"
	ListSkillsLifecycleStateFailed   ListSkillsLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListSkillsLifecycleStateEnum

func GetListSkillsLifecycleStateEnumValues ¶ added in v65.7.0

func GetListSkillsLifecycleStateEnumValues() []ListSkillsLifecycleStateEnum

GetListSkillsLifecycleStateEnumValues Enumerates the set of values for ListSkillsLifecycleStateEnum

func GetMappingListSkillsLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListSkillsLifecycleStateEnum(val string) (ListSkillsLifecycleStateEnum, bool)

GetMappingListSkillsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillsRequest ¶ added in v65.7.0

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
}

ListSkillsRequest wrapper for the ListSkills operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListSkills.go.html to see an example of how to use ListSkillsRequest.

func (ListSkillsRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListSkillsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListSkillsRequest) HTTPRequest ¶ added in v65.7.0

func (request ListSkillsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListSkillsRequest) RetryPolicy ¶ added in v65.7.0

func (request ListSkillsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListSkillsRequest) String ¶ added in v65.7.0

func (request ListSkillsRequest) String() string

func (ListSkillsRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListSkillsResponse ¶ added in v65.7.0

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"`
}

ListSkillsResponse wrapper for the ListSkills operation

func (ListSkillsResponse) HTTPResponse ¶ added in v65.7.0

func (response ListSkillsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListSkillsResponse) String ¶ added in v65.7.0

func (response ListSkillsResponse) String() string

type ListSkillsSortByEnum ¶ added in v65.7.0

type ListSkillsSortByEnum string

ListSkillsSortByEnum Enum with underlying type: string

const (
	ListSkillsSortByTimecreated ListSkillsSortByEnum = "timeCreated"
	ListSkillsSortByTimeupdated ListSkillsSortByEnum = "timeUpdated"
	ListSkillsSortByName        ListSkillsSortByEnum = "name"
)

Set of constants representing the allowable values for ListSkillsSortByEnum

func GetListSkillsSortByEnumValues ¶ added in v65.7.0

func GetListSkillsSortByEnumValues() []ListSkillsSortByEnum

GetListSkillsSortByEnumValues Enumerates the set of values for ListSkillsSortByEnum

func GetMappingListSkillsSortByEnum ¶ added in v65.7.0

func GetMappingListSkillsSortByEnum(val string) (ListSkillsSortByEnum, bool)

GetMappingListSkillsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListSkillsSortOrderEnum ¶ added in v65.7.0

type ListSkillsSortOrderEnum string

ListSkillsSortOrderEnum Enum with underlying type: string

const (
	ListSkillsSortOrderAsc  ListSkillsSortOrderEnum = "ASC"
	ListSkillsSortOrderDesc ListSkillsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSkillsSortOrderEnum

func GetListSkillsSortOrderEnumValues ¶ added in v65.7.0

func GetListSkillsSortOrderEnumValues() []ListSkillsSortOrderEnum

GetListSkillsSortOrderEnumValues Enumerates the set of values for ListSkillsSortOrderEnum

func GetMappingListSkillsSortOrderEnum ¶ added in v65.7.0

func GetMappingListSkillsSortOrderEnum(val string) (ListSkillsSortOrderEnum, bool)

GetMappingListSkillsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranslatorsLifecycleStateEnum ¶ added in v65.7.0

type ListTranslatorsLifecycleStateEnum string

ListTranslatorsLifecycleStateEnum Enum with underlying type: string

const (
	ListTranslatorsLifecycleStateCreating ListTranslatorsLifecycleStateEnum = "CREATING"
	ListTranslatorsLifecycleStateUpdating ListTranslatorsLifecycleStateEnum = "UPDATING"
	ListTranslatorsLifecycleStateActive   ListTranslatorsLifecycleStateEnum = "ACTIVE"
	ListTranslatorsLifecycleStateInactive ListTranslatorsLifecycleStateEnum = "INACTIVE"
	ListTranslatorsLifecycleStateDeleting ListTranslatorsLifecycleStateEnum = "DELETING"
	ListTranslatorsLifecycleStateDeleted  ListTranslatorsLifecycleStateEnum = "DELETED"
	ListTranslatorsLifecycleStateFailed   ListTranslatorsLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ListTranslatorsLifecycleStateEnum

func GetListTranslatorsLifecycleStateEnumValues ¶ added in v65.7.0

func GetListTranslatorsLifecycleStateEnumValues() []ListTranslatorsLifecycleStateEnum

GetListTranslatorsLifecycleStateEnumValues Enumerates the set of values for ListTranslatorsLifecycleStateEnum

func GetMappingListTranslatorsLifecycleStateEnum ¶ added in v65.7.0

func GetMappingListTranslatorsLifecycleStateEnum(val string) (ListTranslatorsLifecycleStateEnum, bool)

GetMappingListTranslatorsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranslatorsRequest ¶ added in v65.7.0

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
}

ListTranslatorsRequest wrapper for the ListTranslators operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListTranslators.go.html to see an example of how to use ListTranslatorsRequest.

func (ListTranslatorsRequest) BinaryRequestBody ¶ added in v65.7.0

func (request ListTranslatorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListTranslatorsRequest) HTTPRequest ¶ added in v65.7.0

func (request ListTranslatorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListTranslatorsRequest) RetryPolicy ¶ added in v65.7.0

func (request ListTranslatorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListTranslatorsRequest) String ¶ added in v65.7.0

func (request ListTranslatorsRequest) String() string

func (ListTranslatorsRequest) ValidateEnumValue ¶ added in v65.7.0

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

type ListTranslatorsResponse ¶ added in v65.7.0

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"`
}

ListTranslatorsResponse wrapper for the ListTranslators operation

func (ListTranslatorsResponse) HTTPResponse ¶ added in v65.7.0

func (response ListTranslatorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListTranslatorsResponse) String ¶ added in v65.7.0

func (response ListTranslatorsResponse) String() string

type ListTranslatorsSortByEnum ¶ added in v65.7.0

type ListTranslatorsSortByEnum string

ListTranslatorsSortByEnum Enum with underlying type: string

const (
	ListTranslatorsSortByTimecreated ListTranslatorsSortByEnum = "timeCreated"
	ListTranslatorsSortByTimeupdated ListTranslatorsSortByEnum = "timeUpdated"
	ListTranslatorsSortByName        ListTranslatorsSortByEnum = "name"
	ListTranslatorsSortByType        ListTranslatorsSortByEnum = "type"
)

Set of constants representing the allowable values for ListTranslatorsSortByEnum

func GetListTranslatorsSortByEnumValues ¶ added in v65.7.0

func GetListTranslatorsSortByEnumValues() []ListTranslatorsSortByEnum

GetListTranslatorsSortByEnumValues Enumerates the set of values for ListTranslatorsSortByEnum

func GetMappingListTranslatorsSortByEnum ¶ added in v65.7.0

func GetMappingListTranslatorsSortByEnum(val string) (ListTranslatorsSortByEnum, bool)

GetMappingListTranslatorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranslatorsSortOrderEnum ¶ added in v65.7.0

type ListTranslatorsSortOrderEnum string

ListTranslatorsSortOrderEnum Enum with underlying type: string

const (
	ListTranslatorsSortOrderAsc  ListTranslatorsSortOrderEnum = "ASC"
	ListTranslatorsSortOrderDesc ListTranslatorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListTranslatorsSortOrderEnum

func GetListTranslatorsSortOrderEnumValues ¶ added in v65.7.0

func GetListTranslatorsSortOrderEnumValues() []ListTranslatorsSortOrderEnum

GetListTranslatorsSortOrderEnumValues Enumerates the set of values for ListTranslatorsSortOrderEnum

func GetMappingListTranslatorsSortOrderEnum ¶ added in v65.7.0

func GetMappingListTranslatorsSortOrderEnum(val string) (ListTranslatorsSortOrderEnum, bool)

GetMappingListTranslatorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListTranslatorsTypeEnum ¶ added in v65.7.0

type ListTranslatorsTypeEnum string

ListTranslatorsTypeEnum Enum with underlying type: string

const (
	ListTranslatorsTypeGoogle    ListTranslatorsTypeEnum = "GOOGLE"
	ListTranslatorsTypeMicrosoft ListTranslatorsTypeEnum = "MICROSOFT"
)

Set of constants representing the allowable values for ListTranslatorsTypeEnum

func GetListTranslatorsTypeEnumValues ¶ added in v65.7.0

func GetListTranslatorsTypeEnumValues() []ListTranslatorsTypeEnum

GetListTranslatorsTypeEnumValues Enumerates the set of values for ListTranslatorsTypeEnum

func GetMappingListTranslatorsTypeEnum ¶ added in v65.7.0

func GetMappingListTranslatorsTypeEnum(val string) (ListTranslatorsTypeEnum, bool)

GetMappingListTranslatorsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody ¶

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest ¶

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy ¶

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String ¶

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue ¶

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

type ListWorkRequestErrorsResponse ¶

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"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse ¶

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String ¶

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum ¶

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByCode      ListWorkRequestErrorsSortByEnum = "CODE"
	ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "TIMESTAMP"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues ¶

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum ¶

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum ¶

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues ¶

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum ¶

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody ¶

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest ¶

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy ¶

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String ¶

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue ¶

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

type ListWorkRequestLogsResponse ¶

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"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse ¶

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String ¶

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum ¶

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByMessage   ListWorkRequestLogsSortByEnum = "MESSAGE"
	ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "TIMESTAMP"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues ¶

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum ¶

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum ¶

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues ¶

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum ¶

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody ¶

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest ¶

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy ¶

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String ¶

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue ¶

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

type ListWorkRequestsResponse ¶

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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse ¶

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String ¶

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum ¶

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE"
	ListWorkRequestsSortByStatus        ListWorkRequestsSortByEnum = "STATUS"
	ListWorkRequestsSortByTimeAccepted  ListWorkRequestsSortByEnum = "TIME_ACCEPTED"
	ListWorkRequestsSortByTimeStarted   ListWorkRequestsSortByEnum = "TIME_STARTED"
	ListWorkRequestsSortByTimeFinished  ListWorkRequestsSortByEnum = "TIME_FINISHED"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues ¶

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum ¶

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum ¶

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues ¶

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum ¶

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ManagementClient ¶ added in v65.7.0

type ManagementClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

ManagementClient a client for Management

func NewManagementClientWithConfigurationProvider ¶ added in v65.7.0

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 ¶ added in v65.7.0

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 (ManagementClient) BulkCreateSkillEntities ¶ added in v65.60.0

func (client ManagementClient) BulkCreateSkillEntities(ctx context.Context, request BulkCreateSkillEntitiesRequest) (response BulkCreateSkillEntitiesResponse, err error)

BulkCreateSkillEntities Bulk create composite and value list entities into a skill.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CascadingDeleteSkillCustomEntities ¶ added in v65.60.0

func (client ManagementClient) CascadingDeleteSkillCustomEntities(ctx context.Context, request CascadingDeleteSkillCustomEntitiesRequest) (response CascadingDeleteSkillCustomEntitiesResponse, err error)

CascadingDeleteSkillCustomEntities Cascading delete of the custom entities in a skill.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ChangeOdaPrivateEndpointCompartment ¶ added in v65.36.0

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.

See also ¶

Click https://docs.cloud.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 (*ManagementClient) ConfigurationProvider ¶ added in v65.7.0

func (client *ManagementClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (ManagementClient) ConfigureDigitalAssistantParameters ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateAuthenticationProvider ¶ added in v65.7.0

func (client ManagementClient) CreateAuthenticationProvider(ctx context.Context, request CreateAuthenticationProviderRequest) (response CreateAuthenticationProviderResponse, err error)

CreateAuthenticationProvider Creates a new Authentication Provider

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateChannel ¶ added in v65.7.0

func (client ManagementClient) CreateChannel(ctx context.Context, request CreateChannelRequest) (response CreateChannelResponse, err error)

CreateChannel Creates a new Channel.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateDigitalAssistant ¶ added in v65.7.0

func (client ManagementClient) CreateDigitalAssistant(ctx context.Context, request CreateDigitalAssistantRequest) (response CreateDigitalAssistantResponse, err error)

CreateDigitalAssistant Creates a new Digital Assistant.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateOdaPrivateEndpoint ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateOdaPrivateEndpointAttachment ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateOdaPrivateEndpointScanProxy ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateSkill ¶ added in v65.7.0

func (client ManagementClient) CreateSkill(ctx context.Context, request CreateSkillRequest) (response CreateSkillResponse, err error)

CreateSkill Creates a new Skill from scratch.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateSkillParameter ¶ added in v65.7.0

func (client ManagementClient) CreateSkillParameter(ctx context.Context, request CreateSkillParameterRequest) (response CreateSkillParameterResponse, err error)

CreateSkillParameter Creates a new Skill Parameter.

See also ¶

Click https://docs.cloud.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 (ManagementClient) CreateTranslator ¶ added in v65.7.0

func (client ManagementClient) CreateTranslator(ctx context.Context, request CreateTranslatorRequest) (response CreateTranslatorResponse, err error)

CreateTranslator Creates a new Translator

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteAuthenticationProvider ¶ added in v65.7.0

func (client ManagementClient) DeleteAuthenticationProvider(ctx context.Context, request DeleteAuthenticationProviderRequest) (response DeleteAuthenticationProviderResponse, err error)

DeleteAuthenticationProvider Delete the specified Authentication Provider.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteChannel ¶ added in v65.7.0

func (client ManagementClient) DeleteChannel(ctx context.Context, request DeleteChannelRequest) (response DeleteChannelResponse, err error)

DeleteChannel Delete the specified Channel.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteDigitalAssistant ¶ added in v65.7.0

func (client ManagementClient) DeleteDigitalAssistant(ctx context.Context, request DeleteDigitalAssistantRequest) (response DeleteDigitalAssistantResponse, err error)

DeleteDigitalAssistant Delete the specified Digital Assistant.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteOdaPrivateEndpoint ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteOdaPrivateEndpointAttachment ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteOdaPrivateEndpointScanProxy ¶ added in v65.36.0

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}`.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteSkill ¶ added in v65.7.0

func (client ManagementClient) DeleteSkill(ctx context.Context, request DeleteSkillRequest) (response DeleteSkillResponse, err error)

DeleteSkill Delete the specified Skill.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteSkillParameter ¶ added in v65.7.0

func (client ManagementClient) DeleteSkillParameter(ctx context.Context, request DeleteSkillParameterRequest) (response DeleteSkillParameterResponse, err error)

DeleteSkillParameter Delete the specified Skill Parameter.

See also ¶

Click https://docs.cloud.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 (ManagementClient) DeleteTranslator ¶ added in v65.7.0

func (client ManagementClient) DeleteTranslator(ctx context.Context, request DeleteTranslatorRequest) (response DeleteTranslatorResponse, err error)

DeleteTranslator Delete the specified Translator.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ExportDigitalAssistant ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ExportSkill ¶ added in v65.7.0

func (client ManagementClient) ExportSkill(ctx context.Context, request ExportSkillRequest) (response ExportSkillResponse, err error)

ExportSkill Exports the specified Skill as an archive to Object Storage.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetAuthenticationProvider ¶ added in v65.7.0

func (client ManagementClient) GetAuthenticationProvider(ctx context.Context, request GetAuthenticationProviderRequest) (response GetAuthenticationProviderResponse, err error)

GetAuthenticationProvider Gets the specified Authentication Provider.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetChannel ¶ added in v65.7.0

func (client ManagementClient) GetChannel(ctx context.Context, request GetChannelRequest) (response GetChannelResponse, err error)

GetChannel Gets the specified Channel.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetDigitalAssistant ¶ added in v65.7.0

func (client ManagementClient) GetDigitalAssistant(ctx context.Context, request GetDigitalAssistantRequest) (response GetDigitalAssistantResponse, err error)

GetDigitalAssistant Gets the specified Digital Assistant.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetDigitalAssistantParameter ¶ added in v65.7.0

func (client ManagementClient) GetDigitalAssistantParameter(ctx context.Context, request GetDigitalAssistantParameterRequest) (response GetDigitalAssistantParameterResponse, err error)

GetDigitalAssistantParameter Gets the specified Digital Assistant Parameter.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetOdaPrivateEndpoint ¶ added in v65.36.0

func (client ManagementClient) GetOdaPrivateEndpoint(ctx context.Context, request GetOdaPrivateEndpointRequest) (response GetOdaPrivateEndpointResponse, err error)

GetOdaPrivateEndpoint Gets the specified ODA Private Endpoint.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetOdaPrivateEndpointAttachment ¶ added in v65.36.0

func (client ManagementClient) GetOdaPrivateEndpointAttachment(ctx context.Context, request GetOdaPrivateEndpointAttachmentRequest) (response GetOdaPrivateEndpointAttachmentResponse, err error)

GetOdaPrivateEndpointAttachment Gets the specified ODA Private Endpoint Attachment.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetOdaPrivateEndpointScanProxy ¶ added in v65.36.0

func (client ManagementClient) GetOdaPrivateEndpointScanProxy(ctx context.Context, request GetOdaPrivateEndpointScanProxyRequest) (response GetOdaPrivateEndpointScanProxyResponse, err error)

GetOdaPrivateEndpointScanProxy Gets the specified ODA Private Endpoint Scan Proxy.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetSkill ¶ added in v65.7.0

func (client ManagementClient) GetSkill(ctx context.Context, request GetSkillRequest) (response GetSkillResponse, err error)

GetSkill Gets the specified Skill.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetSkillParameter ¶ added in v65.7.0

func (client ManagementClient) GetSkillParameter(ctx context.Context, request GetSkillParameterRequest) (response GetSkillParameterResponse, err error)

GetSkillParameter Gets the specified Skill Parameter.

See also ¶

Click https://docs.cloud.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 (ManagementClient) GetTranslator ¶ added in v65.7.0

func (client ManagementClient) GetTranslator(ctx context.Context, request GetTranslatorRequest) (response GetTranslatorResponse, err error)

GetTranslator Gets the specified Translator.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ImportBot ¶ added in v65.7.0

func (client ManagementClient) ImportBot(ctx context.Context, request ImportBotRequest) (response ImportBotResponse, err error)

ImportBot Import a Bot archive from Object Storage.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListAuthenticationProviders ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListChannels ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListDigitalAssistantParameters ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListDigitalAssistants ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListOdaPrivateEndpointAttachments ¶ added in v65.36.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListOdaPrivateEndpointScanProxies ¶ added in v65.36.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListOdaPrivateEndpoints ¶ added in v65.36.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListSkillParameters ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListSkills ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) ListTranslators ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) PublishDigitalAssistant ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) PublishSkill ¶ added in v65.7.0

func (client ManagementClient) PublishSkill(ctx context.Context, request PublishSkillRequest) (response PublishSkillResponse, err error)

PublishSkill Publish a draft Skill. Once published it cannot be modified.

See also ¶

Click https://docs.cloud.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 (ManagementClient) RotateChannelKeys ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (*ManagementClient) SetRegion ¶ added in v65.7.0

func (client *ManagementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (ManagementClient) StartChannel ¶ added in v65.7.0

func (client ManagementClient) StartChannel(ctx context.Context, request StartChannelRequest) (response StartChannelResponse, err error)

StartChannel Starts a Channel so that it will begin accepting messages.

See also ¶

Click https://docs.cloud.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 (ManagementClient) StopChannel ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) TrainSkill ¶ added in v65.60.0

func (client ManagementClient) TrainSkill(ctx context.Context, request TrainSkillRequest) (response TrainSkillResponse, err error)

TrainSkill Train a skill.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateAuthenticationProvider ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateChannel ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateDigitalAssistant ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateDigitalAssistantParameter ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateOdaPrivateEndpoint ¶ added in v65.36.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateSkill ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateSkillParameter ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (ManagementClient) UpdateTranslator ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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()

type MetadataProperty ¶ added in v65.7.0

type MetadataProperty struct {

	// Name of property.
	Name *string `mandatory:"true" json:"name"`

	// Value for the property.
	Value *string `mandatory:"true" json:"value"`
}

MetadataProperty Property to describe and object.

func (MetadataProperty) String ¶ added in v65.7.0

func (m MetadataProperty) String() string

func (MetadataProperty) ValidateEnumValue ¶ added in v65.7.0

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

type ModelPackage ¶ added in v65.7.0

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"`
}

ModelPackage Details of `Package` object.

func (ModelPackage) String ¶ added in v65.7.0

func (m ModelPackage) String() string

func (ModelPackage) ValidateEnumValue ¶ added in v65.7.0

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

type MsTeamsChannel ¶ added in v65.7.0

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"`
}

MsTeamsChannel The configuration for an MS Teams channel.

func (MsTeamsChannel) GetCategory ¶ added in v65.7.0

func (m MsTeamsChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (MsTeamsChannel) GetDefinedTags ¶ added in v65.7.0

func (m MsTeamsChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (MsTeamsChannel) GetDescription ¶ added in v65.7.0

func (m MsTeamsChannel) GetDescription() *string

GetDescription returns Description

func (MsTeamsChannel) GetFreeformTags ¶ added in v65.7.0

func (m MsTeamsChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (MsTeamsChannel) GetId ¶ added in v65.7.0

func (m MsTeamsChannel) GetId() *string

GetId returns Id

func (MsTeamsChannel) GetLifecycleState ¶ added in v65.7.0

func (m MsTeamsChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (MsTeamsChannel) GetName ¶ added in v65.7.0

func (m MsTeamsChannel) GetName() *string

GetName returns Name

func (MsTeamsChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m MsTeamsChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (MsTeamsChannel) GetTimeCreated ¶ added in v65.7.0

func (m MsTeamsChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (MsTeamsChannel) GetTimeUpdated ¶ added in v65.7.0

func (m MsTeamsChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (MsTeamsChannel) MarshalJSON ¶ added in v65.7.0

func (m MsTeamsChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (MsTeamsChannel) String ¶ added in v65.7.0

func (m MsTeamsChannel) String() string

func (MsTeamsChannel) ValidateEnumValue ¶ added in v65.7.0

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

type NameMapping ¶ added in v65.60.0

type NameMapping struct {

	// Name of mapping.
	Name *string `mandatory:"true" json:"name"`
}

NameMapping A language name mapping.

func (NameMapping) String ¶ added in v65.60.0

func (m NameMapping) String() string

func (NameMapping) ValidateEnumValue ¶ added in v65.60.0

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

type OdaClient ¶

type OdaClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

OdaClient a client for Oda

func NewOdaClientWithConfigurationProvider ¶

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 ¶

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 (OdaClient) ChangeOdaInstanceCompartment ¶

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.

See also ¶

Click https://docs.cloud.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 (*OdaClient) ConfigurationProvider ¶

func (client *OdaClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OdaClient) CreateOdaInstance ¶

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}`.

See also ¶

Click https://docs.cloud.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 (OdaClient) CreateOdaInstanceAttachment ¶ added in v65.7.0

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}`.

See also ¶

Click https://docs.cloud.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 (OdaClient) DeleteOdaInstance ¶

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}`.

See also ¶

Click https://docs.cloud.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 (OdaClient) DeleteOdaInstanceAttachment ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) GetOdaInstance ¶

func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)

GetOdaInstance Gets the specified Digital Assistant instance.

See also ¶

Click https://docs.cloud.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 (OdaClient) GetOdaInstanceAttachment ¶ added in v65.7.0

func (client OdaClient) GetOdaInstanceAttachment(ctx context.Context, request GetOdaInstanceAttachmentRequest) (response GetOdaInstanceAttachmentResponse, err error)

GetOdaInstanceAttachment Gets an ODA instance attachment by identifier

See also ¶

Click https://docs.cloud.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 (OdaClient) GetWorkRequest ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) ListOdaInstanceAttachments ¶ added in v65.7.0

func (client OdaClient) ListOdaInstanceAttachments(ctx context.Context, request ListOdaInstanceAttachmentsRequest) (response ListOdaInstanceAttachmentsResponse, err error)

ListOdaInstanceAttachments Returns a list of ODA instance attachments

See also ¶

Click https://docs.cloud.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 (OdaClient) ListOdaInstances ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) ListWorkRequestErrors ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) ListWorkRequestLogs ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) ListWorkRequests ¶

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.

See also ¶

Click https://docs.cloud.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 (*OdaClient) SetRegion ¶

func (client *OdaClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OdaClient) StartOdaInstance ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) StopOdaInstance ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) UpdateOdaInstance ¶

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.

See also ¶

Click https://docs.cloud.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 (OdaClient) UpdateOdaInstanceAttachment ¶ added in v65.7.0

func (client OdaClient) UpdateOdaInstanceAttachment(ctx context.Context, request UpdateOdaInstanceAttachmentRequest) (response UpdateOdaInstanceAttachmentResponse, err error)

UpdateOdaInstanceAttachment Updates the ODA instance attachment

See also ¶

Click https://docs.cloud.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()

type OdaInstance ¶

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"`
}

OdaInstance Description of `OdaServiceInstance` object.

func (OdaInstance) String ¶

func (m OdaInstance) String() string

func (OdaInstance) ValidateEnumValue ¶

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

type OdaInstanceAttachment ¶ added in v65.7.0

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"`
}

OdaInstanceAttachment Description of an ODA instance attachment.

func (OdaInstanceAttachment) String ¶ added in v65.7.0

func (m OdaInstanceAttachment) String() string

func (OdaInstanceAttachment) ValidateEnumValue ¶ added in v65.7.0

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

type OdaInstanceAttachmentAttachmentTypeEnum ¶ added in v65.7.0

type OdaInstanceAttachmentAttachmentTypeEnum string

OdaInstanceAttachmentAttachmentTypeEnum Enum with underlying type: string

const (
	OdaInstanceAttachmentAttachmentTypeFusion OdaInstanceAttachmentAttachmentTypeEnum = "FUSION"
	OdaInstanceAttachmentAttachmentTypeMax    OdaInstanceAttachmentAttachmentTypeEnum = "MAX"
)

Set of constants representing the allowable values for OdaInstanceAttachmentAttachmentTypeEnum

func GetMappingOdaInstanceAttachmentAttachmentTypeEnum ¶ added in v65.7.0

func GetMappingOdaInstanceAttachmentAttachmentTypeEnum(val string) (OdaInstanceAttachmentAttachmentTypeEnum, bool)

GetMappingOdaInstanceAttachmentAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceAttachmentAttachmentTypeEnumValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentAttachmentTypeEnumValues() []OdaInstanceAttachmentAttachmentTypeEnum

GetOdaInstanceAttachmentAttachmentTypeEnumValues Enumerates the set of values for OdaInstanceAttachmentAttachmentTypeEnum

type OdaInstanceAttachmentCollection ¶ added in v65.7.0

type OdaInstanceAttachmentCollection struct {

	// List of Oda instance attachments.
	Items []OdaInstanceAttachmentSummary `mandatory:"true" json:"items"`
}

OdaInstanceAttachmentCollection Results of a Oda instance attachment search. Contains OdaInstanceAttachment items.

func (OdaInstanceAttachmentCollection) String ¶ added in v65.7.0

func (OdaInstanceAttachmentCollection) ValidateEnumValue ¶ added in v65.7.0

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

type OdaInstanceAttachmentLifecycleStateEnum ¶ added in v65.7.0

type OdaInstanceAttachmentLifecycleStateEnum string

OdaInstanceAttachmentLifecycleStateEnum Enum with underlying type: string

const (
	OdaInstanceAttachmentLifecycleStateAttaching OdaInstanceAttachmentLifecycleStateEnum = "ATTACHING"
	OdaInstanceAttachmentLifecycleStateActive    OdaInstanceAttachmentLifecycleStateEnum = "ACTIVE"
	OdaInstanceAttachmentLifecycleStateDetaching OdaInstanceAttachmentLifecycleStateEnum = "DETACHING"
	OdaInstanceAttachmentLifecycleStateInactive  OdaInstanceAttachmentLifecycleStateEnum = "INACTIVE"
	OdaInstanceAttachmentLifecycleStateFailed    OdaInstanceAttachmentLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaInstanceAttachmentLifecycleStateEnum

func GetMappingOdaInstanceAttachmentLifecycleStateEnum ¶ added in v65.7.0

func GetMappingOdaInstanceAttachmentLifecycleStateEnum(val string) (OdaInstanceAttachmentLifecycleStateEnum, bool)

GetMappingOdaInstanceAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceAttachmentLifecycleStateEnumValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentLifecycleStateEnumValues() []OdaInstanceAttachmentLifecycleStateEnum

GetOdaInstanceAttachmentLifecycleStateEnumValues Enumerates the set of values for OdaInstanceAttachmentLifecycleStateEnum

type OdaInstanceAttachmentOwner ¶ added in v65.7.0

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"`
}

OdaInstanceAttachmentOwner Details about an attachment owner

func (OdaInstanceAttachmentOwner) String ¶ added in v65.7.0

func (OdaInstanceAttachmentOwner) ValidateEnumValue ¶ added in v65.7.0

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

type OdaInstanceAttachmentSummary ¶ added in v65.7.0

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"`
}

OdaInstanceAttachmentSummary Description of an ODA instance attachment.

func (OdaInstanceAttachmentSummary) String ¶ added in v65.7.0

func (OdaInstanceAttachmentSummary) ValidateEnumValue ¶ added in v65.7.0

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

type OdaInstanceAttachmentSummaryAttachmentTypeEnum ¶ added in v65.7.0

type OdaInstanceAttachmentSummaryAttachmentTypeEnum string

OdaInstanceAttachmentSummaryAttachmentTypeEnum Enum with underlying type: string

const (
	OdaInstanceAttachmentSummaryAttachmentTypeFusion OdaInstanceAttachmentSummaryAttachmentTypeEnum = "FUSION"
	OdaInstanceAttachmentSummaryAttachmentTypeMax    OdaInstanceAttachmentSummaryAttachmentTypeEnum = "MAX"
)

Set of constants representing the allowable values for OdaInstanceAttachmentSummaryAttachmentTypeEnum

func GetMappingOdaInstanceAttachmentSummaryAttachmentTypeEnum ¶ added in v65.7.0

func GetMappingOdaInstanceAttachmentSummaryAttachmentTypeEnum(val string) (OdaInstanceAttachmentSummaryAttachmentTypeEnum, bool)

GetMappingOdaInstanceAttachmentSummaryAttachmentTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumValues ¶ added in v65.7.0

func GetOdaInstanceAttachmentSummaryAttachmentTypeEnumValues() []OdaInstanceAttachmentSummaryAttachmentTypeEnum

GetOdaInstanceAttachmentSummaryAttachmentTypeEnumValues Enumerates the set of values for OdaInstanceAttachmentSummaryAttachmentTypeEnum

type OdaInstanceLifecycleStateEnum ¶

type OdaInstanceLifecycleStateEnum string

OdaInstanceLifecycleStateEnum Enum with underlying type: string

const (
	OdaInstanceLifecycleStateCreating OdaInstanceLifecycleStateEnum = "CREATING"
	OdaInstanceLifecycleStateUpdating OdaInstanceLifecycleStateEnum = "UPDATING"
	OdaInstanceLifecycleStateActive   OdaInstanceLifecycleStateEnum = "ACTIVE"
	OdaInstanceLifecycleStateInactive OdaInstanceLifecycleStateEnum = "INACTIVE"
	OdaInstanceLifecycleStateDeleting OdaInstanceLifecycleStateEnum = "DELETING"
	OdaInstanceLifecycleStateDeleted  OdaInstanceLifecycleStateEnum = "DELETED"
	OdaInstanceLifecycleStateFailed   OdaInstanceLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaInstanceLifecycleStateEnum

func GetMappingOdaInstanceLifecycleStateEnum ¶

func GetMappingOdaInstanceLifecycleStateEnum(val string) (OdaInstanceLifecycleStateEnum, bool)

GetMappingOdaInstanceLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceLifecycleStateEnumValues ¶

func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum

GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum

type OdaInstanceLifecycleSubStateEnum ¶

type OdaInstanceLifecycleSubStateEnum string

OdaInstanceLifecycleSubStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for OdaInstanceLifecycleSubStateEnum

func GetMappingOdaInstanceLifecycleSubStateEnum ¶

func GetMappingOdaInstanceLifecycleSubStateEnum(val string) (OdaInstanceLifecycleSubStateEnum, bool)

GetMappingOdaInstanceLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceLifecycleSubStateEnumValues ¶

func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum

GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum

type OdaInstanceOwner ¶ added in v65.7.0

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"`
}

OdaInstanceOwner Details about an ODA instance owner

func (OdaInstanceOwner) String ¶ added in v65.7.0

func (m OdaInstanceOwner) String() string

func (OdaInstanceOwner) ValidateEnumValue ¶ added in v65.7.0

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

type OdaInstanceShapeNameEnum ¶

type OdaInstanceShapeNameEnum string

OdaInstanceShapeNameEnum Enum with underlying type: string

const (
	OdaInstanceShapeNameDevelopment OdaInstanceShapeNameEnum = "DEVELOPMENT"
	OdaInstanceShapeNameProduction  OdaInstanceShapeNameEnum = "PRODUCTION"
)

Set of constants representing the allowable values for OdaInstanceShapeNameEnum

func GetMappingOdaInstanceShapeNameEnum ¶

func GetMappingOdaInstanceShapeNameEnum(val string) (OdaInstanceShapeNameEnum, bool)

GetMappingOdaInstanceShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceShapeNameEnumValues ¶

func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum

GetOdaInstanceShapeNameEnumValues Enumerates the set of values for OdaInstanceShapeNameEnum

type OdaInstanceSummary ¶

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"`
}

OdaInstanceSummary Summary of the Digital Assistant instance.

func (OdaInstanceSummary) String ¶

func (m OdaInstanceSummary) String() string

func (OdaInstanceSummary) ValidateEnumValue ¶

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

type OdaInstanceSummaryLifecycleStateEnum ¶

type OdaInstanceSummaryLifecycleStateEnum string

OdaInstanceSummaryLifecycleStateEnum Enum with underlying type: string

const (
	OdaInstanceSummaryLifecycleStateCreating OdaInstanceSummaryLifecycleStateEnum = "CREATING"
	OdaInstanceSummaryLifecycleStateUpdating OdaInstanceSummaryLifecycleStateEnum = "UPDATING"
	OdaInstanceSummaryLifecycleStateActive   OdaInstanceSummaryLifecycleStateEnum = "ACTIVE"
	OdaInstanceSummaryLifecycleStateInactive OdaInstanceSummaryLifecycleStateEnum = "INACTIVE"
	OdaInstanceSummaryLifecycleStateDeleting OdaInstanceSummaryLifecycleStateEnum = "DELETING"
	OdaInstanceSummaryLifecycleStateDeleted  OdaInstanceSummaryLifecycleStateEnum = "DELETED"
	OdaInstanceSummaryLifecycleStateFailed   OdaInstanceSummaryLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaInstanceSummaryLifecycleStateEnum

func GetMappingOdaInstanceSummaryLifecycleStateEnum ¶

func GetMappingOdaInstanceSummaryLifecycleStateEnum(val string) (OdaInstanceSummaryLifecycleStateEnum, bool)

GetMappingOdaInstanceSummaryLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceSummaryLifecycleStateEnumValues ¶

func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum

GetOdaInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleStateEnum

type OdaInstanceSummaryLifecycleSubStateEnum ¶

type OdaInstanceSummaryLifecycleSubStateEnum string

OdaInstanceSummaryLifecycleSubStateEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for OdaInstanceSummaryLifecycleSubStateEnum

func GetMappingOdaInstanceSummaryLifecycleSubStateEnum ¶

func GetMappingOdaInstanceSummaryLifecycleSubStateEnum(val string) (OdaInstanceSummaryLifecycleSubStateEnum, bool)

GetMappingOdaInstanceSummaryLifecycleSubStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceSummaryLifecycleSubStateEnumValues ¶

func GetOdaInstanceSummaryLifecycleSubStateEnumValues() []OdaInstanceSummaryLifecycleSubStateEnum

GetOdaInstanceSummaryLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleSubStateEnum

type OdaInstanceSummaryShapeNameEnum ¶

type OdaInstanceSummaryShapeNameEnum string

OdaInstanceSummaryShapeNameEnum Enum with underlying type: string

const (
	OdaInstanceSummaryShapeNameDevelopment OdaInstanceSummaryShapeNameEnum = "DEVELOPMENT"
	OdaInstanceSummaryShapeNameProduction  OdaInstanceSummaryShapeNameEnum = "PRODUCTION"
)

Set of constants representing the allowable values for OdaInstanceSummaryShapeNameEnum

func GetMappingOdaInstanceSummaryShapeNameEnum ¶

func GetMappingOdaInstanceSummaryShapeNameEnum(val string) (OdaInstanceSummaryShapeNameEnum, bool)

GetMappingOdaInstanceSummaryShapeNameEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaInstanceSummaryShapeNameEnumValues ¶

func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum

GetOdaInstanceSummaryShapeNameEnumValues Enumerates the set of values for OdaInstanceSummaryShapeNameEnum

type OdaPrivateEndpoint ¶ added in v65.36.0

type OdaPrivateEndpoint struct {

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that the private endpoint belongs to.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// 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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm)
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

OdaPrivateEndpoint A private endpoint allows Digital Assistant Instance to access resources in a customer's virtual cloud network (VCN).

func (OdaPrivateEndpoint) String ¶ added in v65.36.0

func (m OdaPrivateEndpoint) String() string

func (OdaPrivateEndpoint) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointAttachment ¶ added in v65.36.0

type OdaPrivateEndpointAttachment struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
	OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
	OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`

	// The OCID (https://docs.cloud.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"`
}

OdaPrivateEndpointAttachment ODA Private Endpoint Attachment is used to attach ODA Private Endpoint to ODA (Digital Assistant) Instance.

func (OdaPrivateEndpointAttachment) String ¶ added in v65.36.0

func (OdaPrivateEndpointAttachment) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointAttachmentCollection ¶ added in v65.36.0

type OdaPrivateEndpointAttachmentCollection struct {

	// The ODA Private Endpoint Attachment summaries.
	Items []OdaPrivateEndpointAttachmentSummary `mandatory:"true" json:"items"`
}

OdaPrivateEndpointAttachmentCollection A collection of ODA Private Endpoint Attachment summaries.

func (OdaPrivateEndpointAttachmentCollection) String ¶ added in v65.36.0

func (OdaPrivateEndpointAttachmentCollection) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointAttachmentLifecycleStateEnum ¶ added in v65.36.0

type OdaPrivateEndpointAttachmentLifecycleStateEnum string

OdaPrivateEndpointAttachmentLifecycleStateEnum Enum with underlying type: string

const (
	OdaPrivateEndpointAttachmentLifecycleStateCreating OdaPrivateEndpointAttachmentLifecycleStateEnum = "CREATING"
	OdaPrivateEndpointAttachmentLifecycleStateUpdating OdaPrivateEndpointAttachmentLifecycleStateEnum = "UPDATING"
	OdaPrivateEndpointAttachmentLifecycleStateActive   OdaPrivateEndpointAttachmentLifecycleStateEnum = "ACTIVE"
	OdaPrivateEndpointAttachmentLifecycleStateDeleting OdaPrivateEndpointAttachmentLifecycleStateEnum = "DELETING"
	OdaPrivateEndpointAttachmentLifecycleStateDeleted  OdaPrivateEndpointAttachmentLifecycleStateEnum = "DELETED"
	OdaPrivateEndpointAttachmentLifecycleStateFailed   OdaPrivateEndpointAttachmentLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaPrivateEndpointAttachmentLifecycleStateEnum

func GetMappingOdaPrivateEndpointAttachmentLifecycleStateEnum ¶ added in v65.36.0

func GetMappingOdaPrivateEndpointAttachmentLifecycleStateEnum(val string) (OdaPrivateEndpointAttachmentLifecycleStateEnum, bool)

GetMappingOdaPrivateEndpointAttachmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaPrivateEndpointAttachmentLifecycleStateEnumValues ¶ added in v65.36.0

func GetOdaPrivateEndpointAttachmentLifecycleStateEnumValues() []OdaPrivateEndpointAttachmentLifecycleStateEnum

GetOdaPrivateEndpointAttachmentLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointAttachmentLifecycleStateEnum

type OdaPrivateEndpointAttachmentSummary ¶ added in v65.36.0

type OdaPrivateEndpointAttachmentSummary struct {

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint Attachment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the attached ODA Instance.
	OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the ODA Private Endpoint.
	OdaPrivateEndpointId *string `mandatory:"true" json:"odaPrivateEndpointId"`

	// The OCID (https://docs.cloud.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"`
}

OdaPrivateEndpointAttachmentSummary Summary of the ODA private endpoint attachment.

func (OdaPrivateEndpointAttachmentSummary) String ¶ added in v65.36.0

func (OdaPrivateEndpointAttachmentSummary) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointCollection ¶ added in v65.36.0

type OdaPrivateEndpointCollection struct {

	// The ODA Private Endpoint summaries.
	Items []OdaPrivateEndpointSummary `mandatory:"true" json:"items"`
}

OdaPrivateEndpointCollection A collection of ODA Private Endpoint summaries.

func (OdaPrivateEndpointCollection) String ¶ added in v65.36.0

func (OdaPrivateEndpointCollection) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointLifecycleStateEnum ¶ added in v65.36.0

type OdaPrivateEndpointLifecycleStateEnum string

OdaPrivateEndpointLifecycleStateEnum Enum with underlying type: string

const (
	OdaPrivateEndpointLifecycleStateCreating OdaPrivateEndpointLifecycleStateEnum = "CREATING"
	OdaPrivateEndpointLifecycleStateUpdating OdaPrivateEndpointLifecycleStateEnum = "UPDATING"
	OdaPrivateEndpointLifecycleStateActive   OdaPrivateEndpointLifecycleStateEnum = "ACTIVE"
	OdaPrivateEndpointLifecycleStateDeleting OdaPrivateEndpointLifecycleStateEnum = "DELETING"
	OdaPrivateEndpointLifecycleStateDeleted  OdaPrivateEndpointLifecycleStateEnum = "DELETED"
	OdaPrivateEndpointLifecycleStateFailed   OdaPrivateEndpointLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaPrivateEndpointLifecycleStateEnum

func GetMappingOdaPrivateEndpointLifecycleStateEnum ¶ added in v65.36.0

func GetMappingOdaPrivateEndpointLifecycleStateEnum(val string) (OdaPrivateEndpointLifecycleStateEnum, bool)

GetMappingOdaPrivateEndpointLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaPrivateEndpointLifecycleStateEnumValues ¶ added in v65.36.0

func GetOdaPrivateEndpointLifecycleStateEnumValues() []OdaPrivateEndpointLifecycleStateEnum

GetOdaPrivateEndpointLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointLifecycleStateEnum

type OdaPrivateEndpointScanProxy ¶ added in v65.36.0

type OdaPrivateEndpointScanProxy struct {

	// The OCID (https://docs.cloud.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"`
}

OdaPrivateEndpointScanProxy Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs

func (OdaPrivateEndpointScanProxy) String ¶ added in v65.36.0

func (OdaPrivateEndpointScanProxy) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointScanProxyCollection ¶ added in v65.36.0

type OdaPrivateEndpointScanProxyCollection struct {

	// The ODA Private Endpoint Scan Proxy summaries.
	Items []OdaPrivateEndpointScanProxySummary `mandatory:"true" json:"items"`
}

OdaPrivateEndpointScanProxyCollection A collection of ODA Private Endpoint Scan Proxy summaries.

func (OdaPrivateEndpointScanProxyCollection) String ¶ added in v65.36.0

func (OdaPrivateEndpointScanProxyCollection) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointScanProxyLifecycleStateEnum ¶ added in v65.36.0

type OdaPrivateEndpointScanProxyLifecycleStateEnum string

OdaPrivateEndpointScanProxyLifecycleStateEnum Enum with underlying type: string

const (
	OdaPrivateEndpointScanProxyLifecycleStateCreating OdaPrivateEndpointScanProxyLifecycleStateEnum = "CREATING"
	OdaPrivateEndpointScanProxyLifecycleStateActive   OdaPrivateEndpointScanProxyLifecycleStateEnum = "ACTIVE"
	OdaPrivateEndpointScanProxyLifecycleStateDeleting OdaPrivateEndpointScanProxyLifecycleStateEnum = "DELETING"
	OdaPrivateEndpointScanProxyLifecycleStateDeleted  OdaPrivateEndpointScanProxyLifecycleStateEnum = "DELETED"
	OdaPrivateEndpointScanProxyLifecycleStateFailed   OdaPrivateEndpointScanProxyLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for OdaPrivateEndpointScanProxyLifecycleStateEnum

func GetMappingOdaPrivateEndpointScanProxyLifecycleStateEnum ¶ added in v65.36.0

func GetMappingOdaPrivateEndpointScanProxyLifecycleStateEnum(val string) (OdaPrivateEndpointScanProxyLifecycleStateEnum, bool)

GetMappingOdaPrivateEndpointScanProxyLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaPrivateEndpointScanProxyLifecycleStateEnumValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyLifecycleStateEnumValues() []OdaPrivateEndpointScanProxyLifecycleStateEnum

GetOdaPrivateEndpointScanProxyLifecycleStateEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyLifecycleStateEnum

type OdaPrivateEndpointScanProxyProtocolEnum ¶ added in v65.36.0

type OdaPrivateEndpointScanProxyProtocolEnum string

OdaPrivateEndpointScanProxyProtocolEnum Enum with underlying type: string

const (
	OdaPrivateEndpointScanProxyProtocolTcp OdaPrivateEndpointScanProxyProtocolEnum = "TCP"
)

Set of constants representing the allowable values for OdaPrivateEndpointScanProxyProtocolEnum

func GetMappingOdaPrivateEndpointScanProxyProtocolEnum ¶ added in v65.36.0

func GetMappingOdaPrivateEndpointScanProxyProtocolEnum(val string) (OdaPrivateEndpointScanProxyProtocolEnum, bool)

GetMappingOdaPrivateEndpointScanProxyProtocolEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaPrivateEndpointScanProxyProtocolEnumValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyProtocolEnumValues() []OdaPrivateEndpointScanProxyProtocolEnum

GetOdaPrivateEndpointScanProxyProtocolEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyProtocolEnum

type OdaPrivateEndpointScanProxyScanListenerTypeEnum ¶ added in v65.36.0

type OdaPrivateEndpointScanProxyScanListenerTypeEnum string

OdaPrivateEndpointScanProxyScanListenerTypeEnum Enum with underlying type: string

const (
	OdaPrivateEndpointScanProxyScanListenerTypeFqdn OdaPrivateEndpointScanProxyScanListenerTypeEnum = "FQDN"
	OdaPrivateEndpointScanProxyScanListenerTypeIp   OdaPrivateEndpointScanProxyScanListenerTypeEnum = "IP"
)

Set of constants representing the allowable values for OdaPrivateEndpointScanProxyScanListenerTypeEnum

func GetMappingOdaPrivateEndpointScanProxyScanListenerTypeEnum ¶ added in v65.36.0

func GetMappingOdaPrivateEndpointScanProxyScanListenerTypeEnum(val string) (OdaPrivateEndpointScanProxyScanListenerTypeEnum, bool)

GetMappingOdaPrivateEndpointScanProxyScanListenerTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumValues ¶ added in v65.36.0

func GetOdaPrivateEndpointScanProxyScanListenerTypeEnumValues() []OdaPrivateEndpointScanProxyScanListenerTypeEnum

GetOdaPrivateEndpointScanProxyScanListenerTypeEnumValues Enumerates the set of values for OdaPrivateEndpointScanProxyScanListenerTypeEnum

type OdaPrivateEndpointScanProxySummary ¶ added in v65.36.0

type OdaPrivateEndpointScanProxySummary struct {

	// The OCID (https://docs.cloud.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"`
}

OdaPrivateEndpointScanProxySummary Details pertaining to a scan proxy instance created for a scan listener FQDN/IPs

func (OdaPrivateEndpointScanProxySummary) String ¶ added in v65.36.0

func (OdaPrivateEndpointScanProxySummary) ValidateEnumValue ¶ added in v65.36.0

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

type OdaPrivateEndpointSummary ¶ added in v65.36.0

type OdaPrivateEndpointSummary struct {

	// The OCID (https://docs.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that the ODA private endpoint belongs to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The 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"`
}

OdaPrivateEndpointSummary Summary of the ODA private endpoint.

func (OdaPrivateEndpointSummary) String ¶ added in v65.36.0

func (m OdaPrivateEndpointSummary) String() string

func (OdaPrivateEndpointSummary) ValidateEnumValue ¶ added in v65.36.0

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

type OdapackageClient ¶ added in v65.7.0

type OdapackageClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

OdapackageClient a client for Odapackage

func NewOdapackageClientWithConfigurationProvider ¶ added in v65.7.0

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 ¶ added in v65.7.0

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 (*OdapackageClient) ConfigurationProvider ¶ added in v65.7.0

func (client *OdapackageClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OdapackageClient) CreateImportedPackage ¶ added in v65.7.0

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}`.

See also ¶

Click https://docs.cloud.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 (OdapackageClient) DeleteImportedPackage ¶ added in v65.7.0

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}`.

See also ¶

Click https://docs.cloud.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 (OdapackageClient) GetImportedPackage ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (OdapackageClient) GetPackage ¶ added in v65.7.0

func (client OdapackageClient) GetPackage(ctx context.Context, request GetPackageRequest) (response GetPackageResponse, err error)

GetPackage Returns details about a package, and how to import it.

See also ¶

Click https://docs.cloud.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 (OdapackageClient) ListImportedPackages ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (OdapackageClient) ListPackages ¶ added in v65.7.0

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.

See also ¶

Click https://docs.cloud.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 (*OdapackageClient) SetRegion ¶ added in v65.7.0

func (client *OdapackageClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OdapackageClient) UpdateImportedPackage ¶ added in v65.7.0

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}`.

See also ¶

Click https://docs.cloud.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()

type OssChannel ¶ added in v65.7.0

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"`
}

OssChannel The configuration for an Oracle Streaming Service (OSS) channel.

func (OssChannel) GetCategory ¶ added in v65.7.0

func (m OssChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (OssChannel) GetDefinedTags ¶ added in v65.7.0

func (m OssChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (OssChannel) GetDescription ¶ added in v65.7.0

func (m OssChannel) GetDescription() *string

GetDescription returns Description

func (OssChannel) GetFreeformTags ¶ added in v65.7.0

func (m OssChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (OssChannel) GetId ¶ added in v65.7.0

func (m OssChannel) GetId() *string

GetId returns Id

func (OssChannel) GetLifecycleState ¶ added in v65.7.0

func (m OssChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (OssChannel) GetName ¶ added in v65.7.0

func (m OssChannel) GetName() *string

GetName returns Name

func (OssChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m OssChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (OssChannel) GetTimeCreated ¶ added in v65.7.0

func (m OssChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (OssChannel) GetTimeUpdated ¶ added in v65.7.0

func (m OssChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (OssChannel) MarshalJSON ¶ added in v65.7.0

func (m OssChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OssChannel) String ¶ added in v65.7.0

func (m OssChannel) String() string

func (OssChannel) ValidateEnumValue ¶ added in v65.7.0

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

type OsvcChannel ¶ added in v65.7.0

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"`
}

OsvcChannel The configuration for an OSVC channel.

func (OsvcChannel) GetCategory ¶ added in v65.7.0

func (m OsvcChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (OsvcChannel) GetDefinedTags ¶ added in v65.7.0

func (m OsvcChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (OsvcChannel) GetDescription ¶ added in v65.7.0

func (m OsvcChannel) GetDescription() *string

GetDescription returns Description

func (OsvcChannel) GetFreeformTags ¶ added in v65.7.0

func (m OsvcChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (OsvcChannel) GetId ¶ added in v65.7.0

func (m OsvcChannel) GetId() *string

GetId returns Id

func (OsvcChannel) GetLifecycleState ¶ added in v65.7.0

func (m OsvcChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (OsvcChannel) GetName ¶ added in v65.7.0

func (m OsvcChannel) GetName() *string

GetName returns Name

func (OsvcChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m OsvcChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (OsvcChannel) GetTimeCreated ¶ added in v65.7.0

func (m OsvcChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (OsvcChannel) GetTimeUpdated ¶ added in v65.7.0

func (m OsvcChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (OsvcChannel) MarshalJSON ¶ added in v65.7.0

func (m OsvcChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OsvcChannel) String ¶ added in v65.7.0

func (m OsvcChannel) String() string

func (OsvcChannel) ValidateEnumValue ¶ added in v65.7.0

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

type OsvcServiceTypeEnum ¶ added in v65.7.0

type OsvcServiceTypeEnum string

OsvcServiceTypeEnum Enum with underlying type: string

const (
	OsvcServiceTypeOsvc   OsvcServiceTypeEnum = "OSVC"
	OsvcServiceTypeFusion OsvcServiceTypeEnum = "FUSION"
)

Set of constants representing the allowable values for OsvcServiceTypeEnum

func GetMappingOsvcServiceTypeEnum ¶ added in v65.7.0

func GetMappingOsvcServiceTypeEnum(val string) (OsvcServiceTypeEnum, bool)

GetMappingOsvcServiceTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOsvcServiceTypeEnumValues ¶ added in v65.7.0

func GetOsvcServiceTypeEnumValues() []OsvcServiceTypeEnum

GetOsvcServiceTypeEnumValues Enumerates the set of values for OsvcServiceTypeEnum

type PackageSummary ¶ added in v65.7.0

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"`
}

PackageSummary Summary of `Package` object.

func (PackageSummary) String ¶ added in v65.7.0

func (m PackageSummary) String() string

func (PackageSummary) ValidateEnumValue ¶ added in v65.7.0

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

type Parameter ¶ added in v65.7.0

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"`
}

Parameter Metadata for a Parameter.

func (Parameter) String ¶ added in v65.7.0

func (m Parameter) String() string

func (Parameter) ValidateEnumValue ¶ added in v65.7.0

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

type ParameterDefinition ¶ added in v65.7.0

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"`
}

ParameterDefinition A parameter to a resource.

func (ParameterDefinition) String ¶ added in v65.7.0

func (m ParameterDefinition) String() string

func (ParameterDefinition) ValidateEnumValue ¶ added in v65.7.0

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

type ParameterDefinitionDirectionEnum ¶ added in v65.7.0

type ParameterDefinitionDirectionEnum string

ParameterDefinitionDirectionEnum Enum with underlying type: string

const (
	ParameterDefinitionDirectionInput  ParameterDefinitionDirectionEnum = "INPUT"
	ParameterDefinitionDirectionOutput ParameterDefinitionDirectionEnum = "OUTPUT"
)

Set of constants representing the allowable values for ParameterDefinitionDirectionEnum

func GetMappingParameterDefinitionDirectionEnum ¶ added in v65.7.0

func GetMappingParameterDefinitionDirectionEnum(val string) (ParameterDefinitionDirectionEnum, bool)

GetMappingParameterDefinitionDirectionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetParameterDefinitionDirectionEnumValues ¶ added in v65.7.0

func GetParameterDefinitionDirectionEnumValues() []ParameterDefinitionDirectionEnum

GetParameterDefinitionDirectionEnumValues Enumerates the set of values for ParameterDefinitionDirectionEnum

type ParameterDefinitionTypeEnum ¶ added in v65.7.0

type ParameterDefinitionTypeEnum string

ParameterDefinitionTypeEnum Enum with underlying type: string

const (
	ParameterDefinitionTypeString  ParameterDefinitionTypeEnum = "STRING"
	ParameterDefinitionTypeUri     ParameterDefinitionTypeEnum = "URI"
	ParameterDefinitionTypeUrl     ParameterDefinitionTypeEnum = "URL"
	ParameterDefinitionTypeNumber  ParameterDefinitionTypeEnum = "NUMBER"
	ParameterDefinitionTypeBoolean ParameterDefinitionTypeEnum = "BOOLEAN"
)

Set of constants representing the allowable values for ParameterDefinitionTypeEnum

func GetMappingParameterDefinitionTypeEnum ¶ added in v65.7.0

func GetMappingParameterDefinitionTypeEnum(val string) (ParameterDefinitionTypeEnum, bool)

GetMappingParameterDefinitionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetParameterDefinitionTypeEnumValues ¶ added in v65.7.0

func GetParameterDefinitionTypeEnumValues() []ParameterDefinitionTypeEnum

GetParameterDefinitionTypeEnumValues Enumerates the set of values for ParameterDefinitionTypeEnum

type ParameterTypeEnum ¶ added in v65.7.0

type ParameterTypeEnum string

ParameterTypeEnum Enum with underlying type: string

const (
	ParameterTypeString  ParameterTypeEnum = "STRING"
	ParameterTypeInteger ParameterTypeEnum = "INTEGER"
	ParameterTypeFloat   ParameterTypeEnum = "FLOAT"
	ParameterTypeBoolean ParameterTypeEnum = "BOOLEAN"
	ParameterTypeSecure  ParameterTypeEnum = "SECURE"
)

Set of constants representing the allowable values for ParameterTypeEnum

func GetMappingParameterTypeEnum ¶ added in v65.7.0

func GetMappingParameterTypeEnum(val string) (ParameterTypeEnum, bool)

GetMappingParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetParameterTypeEnumValues ¶ added in v65.7.0

func GetParameterTypeEnumValues() []ParameterTypeEnum

GetParameterTypeEnumValues Enumerates the set of values for ParameterTypeEnum

type PublishDigitalAssistantRequest ¶ added in v65.7.0

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
}

PublishDigitalAssistantRequest wrapper for the PublishDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishDigitalAssistant.go.html to see an example of how to use PublishDigitalAssistantRequest.

func (PublishDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request PublishDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (PublishDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request PublishDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PublishDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request PublishDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PublishDigitalAssistantRequest) String ¶ added in v65.7.0

func (request PublishDigitalAssistantRequest) String() string

func (PublishDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type PublishDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

PublishDigitalAssistantResponse wrapper for the PublishDigitalAssistant operation

func (PublishDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response PublishDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PublishDigitalAssistantResponse) String ¶ added in v65.7.0

func (response PublishDigitalAssistantResponse) String() string

type PublishSkillRequest ¶ added in v65.7.0

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
}

PublishSkillRequest wrapper for the PublishSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/PublishSkill.go.html to see an example of how to use PublishSkillRequest.

func (PublishSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request PublishSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (PublishSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request PublishSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PublishSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request PublishSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PublishSkillRequest) String ¶ added in v65.7.0

func (request PublishSkillRequest) String() string

func (PublishSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type PublishSkillResponse ¶ added in v65.7.0

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"`
}

PublishSkillResponse wrapper for the PublishSkill operation

func (PublishSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response PublishSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PublishSkillResponse) String ¶ added in v65.7.0

func (response PublishSkillResponse) String() string

type ResourceTypeDefaultParameterValues ¶ added in v65.7.0

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"`
}

ResourceTypeDefaultParameterValues Default values needed to import a resource type for a package.

func (ResourceTypeDefaultParameterValues) String ¶ added in v65.7.0

func (ResourceTypeDefaultParameterValues) ValidateEnumValue ¶ added in v65.7.0

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

type ResourceTypeImportContract ¶ added in v65.7.0

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"`
}

ResourceTypeImportContract The contract guiding the import experience for the consumer and behavior of the resource provider for a single resourceType.

func (ResourceTypeImportContract) String ¶ added in v65.7.0

func (ResourceTypeImportContract) ValidateEnumValue ¶ added in v65.7.0

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

type ResourceTypeMetadata ¶ added in v65.7.0

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"`
}

ResourceTypeMetadata Describes resources of a given type within a package.

func (ResourceTypeMetadata) String ¶ added in v65.7.0

func (m ResourceTypeMetadata) String() string

func (ResourceTypeMetadata) ValidateEnumValue ¶ added in v65.7.0

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

type RestrictedOperation ¶ added in v65.7.0

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"`
}

RestrictedOperation Summary of a restricted operation for a Digital Assistant instance.

func (RestrictedOperation) String ¶ added in v65.7.0

func (m RestrictedOperation) String() string

func (RestrictedOperation) ValidateEnumValue ¶ added in v65.7.0

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

type RotateChannelKeysRequest ¶ added in v65.7.0

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
}

RotateChannelKeysRequest wrapper for the RotateChannelKeys operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/RotateChannelKeys.go.html to see an example of how to use RotateChannelKeysRequest.

func (RotateChannelKeysRequest) BinaryRequestBody ¶ added in v65.7.0

func (request RotateChannelKeysRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (RotateChannelKeysRequest) HTTPRequest ¶ added in v65.7.0

func (request RotateChannelKeysRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (RotateChannelKeysRequest) RetryPolicy ¶ added in v65.7.0

func (request RotateChannelKeysRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (RotateChannelKeysRequest) String ¶ added in v65.7.0

func (request RotateChannelKeysRequest) String() string

func (RotateChannelKeysRequest) ValidateEnumValue ¶ added in v65.7.0

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

type RotateChannelKeysResponse ¶ added in v65.7.0

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"`
}

RotateChannelKeysResponse wrapper for the RotateChannelKeys operation

func (RotateChannelKeysResponse) HTTPResponse ¶ added in v65.7.0

func (response RotateChannelKeysResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (RotateChannelKeysResponse) String ¶ added in v65.7.0

func (response RotateChannelKeysResponse) String() string

type ScanListenerInfo ¶ added in v65.36.0

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"`
}

ScanListenerInfo Customer's Real Application Cluster (RAC)'s SCAN listener FQDN, port or list IPs and their ports.

func (ScanListenerInfo) String ¶ added in v65.36.0

func (m ScanListenerInfo) String() string

func (ScanListenerInfo) ValidateEnumValue ¶ added in v65.36.0

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

type ServiceCloudChannel ¶ added in v65.7.0

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"`
}

ServiceCloudChannel The configuration for a Service Cloud agent channel.

func (ServiceCloudChannel) GetCategory ¶ added in v65.7.0

func (m ServiceCloudChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (ServiceCloudChannel) GetDefinedTags ¶ added in v65.7.0

func (m ServiceCloudChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (ServiceCloudChannel) GetDescription ¶ added in v65.7.0

func (m ServiceCloudChannel) GetDescription() *string

GetDescription returns Description

func (ServiceCloudChannel) GetFreeformTags ¶ added in v65.7.0

func (m ServiceCloudChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (ServiceCloudChannel) GetId ¶ added in v65.7.0

func (m ServiceCloudChannel) GetId() *string

GetId returns Id

func (ServiceCloudChannel) GetLifecycleState ¶ added in v65.7.0

func (m ServiceCloudChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (ServiceCloudChannel) GetName ¶ added in v65.7.0

func (m ServiceCloudChannel) GetName() *string

GetName returns Name

func (ServiceCloudChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m ServiceCloudChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (ServiceCloudChannel) GetTimeCreated ¶ added in v65.7.0

func (m ServiceCloudChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (ServiceCloudChannel) GetTimeUpdated ¶ added in v65.7.0

func (m ServiceCloudChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (ServiceCloudChannel) MarshalJSON ¶ added in v65.7.0

func (m ServiceCloudChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ServiceCloudChannel) String ¶ added in v65.7.0

func (m ServiceCloudChannel) String() string

func (ServiceCloudChannel) ValidateEnumValue ¶ added in v65.7.0

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

type ServiceCloudClientTypeEnum ¶ added in v65.7.0

type ServiceCloudClientTypeEnum string

ServiceCloudClientTypeEnum Enum with underlying type: string

const (
	ServiceCloudClientTypeWsdl ServiceCloudClientTypeEnum = "WSDL"
	ServiceCloudClientTypeRest ServiceCloudClientTypeEnum = "REST"
)

Set of constants representing the allowable values for ServiceCloudClientTypeEnum

func GetMappingServiceCloudClientTypeEnum ¶ added in v65.7.0

func GetMappingServiceCloudClientTypeEnum(val string) (ServiceCloudClientTypeEnum, bool)

GetMappingServiceCloudClientTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetServiceCloudClientTypeEnumValues ¶ added in v65.7.0

func GetServiceCloudClientTypeEnumValues() []ServiceCloudClientTypeEnum

GetServiceCloudClientTypeEnumValues Enumerates the set of values for ServiceCloudClientTypeEnum

type Skill ¶ added in v65.7.0

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"`
}

Skill Skill metadata.

func (Skill) String ¶ added in v65.7.0

func (m Skill) String() string

func (Skill) ValidateEnumValue ¶ added in v65.7.0

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

type SkillCollection ¶ added in v65.7.0

type SkillCollection struct {

	// The Skill summaries.
	Items []SkillSummary `mandatory:"true" json:"items"`
}

SkillCollection A collection of Skill summaries.

func (SkillCollection) String ¶ added in v65.7.0

func (m SkillCollection) String() string

func (SkillCollection) ValidateEnumValue ¶ added in v65.7.0

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

type SkillParameter ¶ added in v65.7.0

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"`
}

SkillParameter Metadata for a Skill Parameter.

func (SkillParameter) String ¶ added in v65.7.0

func (m SkillParameter) String() string

func (SkillParameter) ValidateEnumValue ¶ added in v65.7.0

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

type SkillParameterCollection ¶ added in v65.7.0

type SkillParameterCollection struct {

	// The Skill Parameter summaries.
	Items []SkillParameterSummary `mandatory:"true" json:"items"`
}

SkillParameterCollection A collection of Skill Parameter summaries.

func (SkillParameterCollection) String ¶ added in v65.7.0

func (m SkillParameterCollection) String() string

func (SkillParameterCollection) ValidateEnumValue ¶ added in v65.7.0

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

type SkillParameterSummary ¶ added in v65.7.0

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"`
}

SkillParameterSummary Metadata for a Skill Parameter property.

func (SkillParameterSummary) String ¶ added in v65.7.0

func (m SkillParameterSummary) String() string

func (SkillParameterSummary) ValidateEnumValue ¶ added in v65.7.0

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

type SkillSummary ¶ added in v65.7.0

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"`
}

SkillSummary Summary of a Skill.

func (SkillSummary) String ¶ added in v65.7.0

func (m SkillSummary) String() string

func (SkillSummary) ValidateEnumValue ¶ added in v65.7.0

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

type SlackChannel ¶ added in v65.7.0

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"`
}

SlackChannel The configuration for a Slack channel.

func (SlackChannel) GetCategory ¶ added in v65.7.0

func (m SlackChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (SlackChannel) GetDefinedTags ¶ added in v65.7.0

func (m SlackChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (SlackChannel) GetDescription ¶ added in v65.7.0

func (m SlackChannel) GetDescription() *string

GetDescription returns Description

func (SlackChannel) GetFreeformTags ¶ added in v65.7.0

func (m SlackChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (SlackChannel) GetId ¶ added in v65.7.0

func (m SlackChannel) GetId() *string

GetId returns Id

func (SlackChannel) GetLifecycleState ¶ added in v65.7.0

func (m SlackChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (SlackChannel) GetName ¶ added in v65.7.0

func (m SlackChannel) GetName() *string

GetName returns Name

func (SlackChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m SlackChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (SlackChannel) GetTimeCreated ¶ added in v65.7.0

func (m SlackChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (SlackChannel) GetTimeUpdated ¶ added in v65.7.0

func (m SlackChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (SlackChannel) MarshalJSON ¶ added in v65.7.0

func (m SlackChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (SlackChannel) String ¶ added in v65.7.0

func (m SlackChannel) String() string

func (SlackChannel) ValidateEnumValue ¶ added in v65.7.0

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

type StartChannelRequest ¶ added in v65.7.0

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
}

StartChannelRequest wrapper for the StartChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartChannel.go.html to see an example of how to use StartChannelRequest.

func (StartChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request StartChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request StartChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request StartChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartChannelRequest) String ¶ added in v65.7.0

func (request StartChannelRequest) String() string

func (StartChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type StartChannelResponse ¶ added in v65.7.0

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"`
}

StartChannelResponse wrapper for the StartChannel operation

func (StartChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response StartChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartChannelResponse) String ¶ added in v65.7.0

func (response StartChannelResponse) String() string

type 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
}

StartOdaInstanceRequest wrapper for the StartOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StartOdaInstance.go.html to see an example of how to use StartOdaInstanceRequest.

func (StartOdaInstanceRequest) BinaryRequestBody ¶

func (request StartOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartOdaInstanceRequest) HTTPRequest ¶

func (request StartOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartOdaInstanceRequest) RetryPolicy ¶

func (request StartOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartOdaInstanceRequest) String ¶

func (request StartOdaInstanceRequest) String() string

func (StartOdaInstanceRequest) ValidateEnumValue ¶

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

type StartOdaInstanceResponse ¶

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"`
}

StartOdaInstanceResponse wrapper for the StartOdaInstance operation

func (StartOdaInstanceResponse) HTTPResponse ¶

func (response StartOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartOdaInstanceResponse) String ¶

func (response StartOdaInstanceResponse) String() string

type StaticEntityValue ¶ added in v65.60.0

type StaticEntityValue struct {

	// Value for a static entity.
	CanonicalName *string `mandatory:"true" json:"canonicalName"`

	NaturalLanguageMapping *StaticEntityValueNaturalLanguageMapping `mandatory:"false" json:"naturalLanguageMapping"`
}

StaticEntityValue Value in a static entity.

func (StaticEntityValue) String ¶ added in v65.60.0

func (m StaticEntityValue) String() string

func (StaticEntityValue) ValidateEnumValue ¶ added in v65.60.0

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

type StaticEntityValueNaturalLanguageMapping ¶ added in v65.60.0

type StaticEntityValueNaturalLanguageMapping struct {

	// List of natural language mapped values.
	Languages []LanguageMapping `mandatory:"true" json:"languages"`
}

StaticEntityValueNaturalLanguageMapping Natural language mapping of a static entity value.

func (StaticEntityValueNaturalLanguageMapping) String ¶ added in v65.60.0

func (StaticEntityValueNaturalLanguageMapping) ValidateEnumValue ¶ added in v65.60.0

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

type StopChannelRequest ¶ added in v65.7.0

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
}

StopChannelRequest wrapper for the StopChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopChannel.go.html to see an example of how to use StopChannelRequest.

func (StopChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request StopChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request StopChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request StopChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopChannelRequest) String ¶ added in v65.7.0

func (request StopChannelRequest) String() string

func (StopChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type StopChannelResponse ¶ added in v65.7.0

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"`
}

StopChannelResponse wrapper for the StopChannel operation

func (StopChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response StopChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopChannelResponse) String ¶ added in v65.7.0

func (response StopChannelResponse) String() string

type 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
}

StopOdaInstanceRequest wrapper for the StopOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/StopOdaInstance.go.html to see an example of how to use StopOdaInstanceRequest.

func (StopOdaInstanceRequest) BinaryRequestBody ¶

func (request StopOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopOdaInstanceRequest) HTTPRequest ¶

func (request StopOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopOdaInstanceRequest) RetryPolicy ¶

func (request StopOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopOdaInstanceRequest) String ¶

func (request StopOdaInstanceRequest) String() string

func (StopOdaInstanceRequest) ValidateEnumValue ¶

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

type StopOdaInstanceResponse ¶

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"`
}

StopOdaInstanceResponse wrapper for the StopOdaInstance operation

func (StopOdaInstanceResponse) HTTPResponse ¶

func (response StopOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopOdaInstanceResponse) String ¶

func (response StopOdaInstanceResponse) String() string

type StorageLocation ¶ added in v65.7.0

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"`
}

StorageLocation Properties that point to a specific object in Object Storage.

func (StorageLocation) String ¶ added in v65.7.0

func (m StorageLocation) String() string

func (StorageLocation) ValidateEnumValue ¶ added in v65.7.0

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

type TemporalPreferenceEnum ¶ added in v65.60.0

type TemporalPreferenceEnum string

TemporalPreferenceEnum Enum with underlying type: string

const (
	TemporalPreferencePast    TemporalPreferenceEnum = "PAST"
	TemporalPreferenceFuture  TemporalPreferenceEnum = "FUTURE"
	TemporalPreferenceNearest TemporalPreferenceEnum = "NEAREST"
)

Set of constants representing the allowable values for TemporalPreferenceEnum

func GetMappingTemporalPreferenceEnum ¶ added in v65.60.0

func GetMappingTemporalPreferenceEnum(val string) (TemporalPreferenceEnum, bool)

GetMappingTemporalPreferenceEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTemporalPreferenceEnumValues ¶ added in v65.60.0

func GetTemporalPreferenceEnumValues() []TemporalPreferenceEnum

GetTemporalPreferenceEnumValues Enumerates the set of values for TemporalPreferenceEnum

type TestChannel ¶ added in v65.7.0

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"`
}

TestChannel The configuration for the Test channel.

func (TestChannel) GetCategory ¶ added in v65.7.0

func (m TestChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (TestChannel) GetDefinedTags ¶ added in v65.7.0

func (m TestChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (TestChannel) GetDescription ¶ added in v65.7.0

func (m TestChannel) GetDescription() *string

GetDescription returns Description

func (TestChannel) GetFreeformTags ¶ added in v65.7.0

func (m TestChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (TestChannel) GetId ¶ added in v65.7.0

func (m TestChannel) GetId() *string

GetId returns Id

func (TestChannel) GetLifecycleState ¶ added in v65.7.0

func (m TestChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (TestChannel) GetName ¶ added in v65.7.0

func (m TestChannel) GetName() *string

GetName returns Name

func (TestChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m TestChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (TestChannel) GetTimeCreated ¶ added in v65.7.0

func (m TestChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (TestChannel) GetTimeUpdated ¶ added in v65.7.0

func (m TestChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (TestChannel) MarshalJSON ¶ added in v65.7.0

func (m TestChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TestChannel) String ¶ added in v65.7.0

func (m TestChannel) String() string

func (TestChannel) ValidateEnumValue ¶ added in v65.7.0

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

type TrainSkillDetails ¶ added in v65.60.0

type TrainSkillDetails struct {

	// List of parameters for training the skill.
	Items []TrainSkillParameter `mandatory:"true" json:"items"`
}

TrainSkillDetails Parameters for training the skill.

func (TrainSkillDetails) String ¶ added in v65.60.0

func (m TrainSkillDetails) String() string

func (*TrainSkillDetails) UnmarshalJSON ¶ added in v65.60.0

func (m *TrainSkillDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (TrainSkillDetails) ValidateEnumValue ¶ added in v65.60.0

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

type TrainSkillParameter ¶ added in v65.60.0

type TrainSkillParameter interface {
}

TrainSkillParameter Train skill parameter.

type TrainSkillParameterTypeEnum ¶ added in v65.60.0

type TrainSkillParameterTypeEnum string

TrainSkillParameterTypeEnum Enum with underlying type: string

const (
	TrainSkillParameterTypeQueryEntity TrainSkillParameterTypeEnum = "QUERY_ENTITY"
)

Set of constants representing the allowable values for TrainSkillParameterTypeEnum

func GetMappingTrainSkillParameterTypeEnum ¶ added in v65.60.0

func GetMappingTrainSkillParameterTypeEnum(val string) (TrainSkillParameterTypeEnum, bool)

GetMappingTrainSkillParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTrainSkillParameterTypeEnumValues ¶ added in v65.60.0

func GetTrainSkillParameterTypeEnumValues() []TrainSkillParameterTypeEnum

GetTrainSkillParameterTypeEnumValues Enumerates the set of values for TrainSkillParameterTypeEnum

type TrainSkillQueryEntityParameter ¶ added in v65.60.0

type TrainSkillQueryEntityParameter struct {
}

TrainSkillQueryEntityParameter Query entity parameter for training the skill.

func (TrainSkillQueryEntityParameter) MarshalJSON ¶ added in v65.60.0

func (m TrainSkillQueryEntityParameter) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TrainSkillQueryEntityParameter) String ¶ added in v65.60.0

func (TrainSkillQueryEntityParameter) ValidateEnumValue ¶ added in v65.60.0

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

type TrainSkillRequest ¶ added in v65.60.0

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
}

TrainSkillRequest wrapper for the TrainSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/TrainSkill.go.html to see an example of how to use TrainSkillRequest.

func (TrainSkillRequest) BinaryRequestBody ¶ added in v65.60.0

func (request TrainSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (TrainSkillRequest) HTTPRequest ¶ added in v65.60.0

func (request TrainSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (TrainSkillRequest) RetryPolicy ¶ added in v65.60.0

func (request TrainSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (TrainSkillRequest) String ¶ added in v65.60.0

func (request TrainSkillRequest) String() string

func (TrainSkillRequest) ValidateEnumValue ¶ added in v65.60.0

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

type TrainSkillResponse ¶ added in v65.60.0

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"`
}

TrainSkillResponse wrapper for the TrainSkill operation

func (TrainSkillResponse) HTTPResponse ¶ added in v65.60.0

func (response TrainSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (TrainSkillResponse) String ¶ added in v65.60.0

func (response TrainSkillResponse) String() string

type TranslationServiceEnum ¶ added in v65.7.0

type TranslationServiceEnum string

TranslationServiceEnum Enum with underlying type: string

const (
	TranslationServiceGoogle    TranslationServiceEnum = "GOOGLE"
	TranslationServiceMicrosoft TranslationServiceEnum = "MICROSOFT"
)

Set of constants representing the allowable values for TranslationServiceEnum

func GetMappingTranslationServiceEnum ¶ added in v65.7.0

func GetMappingTranslationServiceEnum(val string) (TranslationServiceEnum, bool)

GetMappingTranslationServiceEnum performs case Insensitive comparison on enum value and return the desired enum

func GetTranslationServiceEnumValues ¶ added in v65.7.0

func GetTranslationServiceEnumValues() []TranslationServiceEnum

GetTranslationServiceEnumValues Enumerates the set of values for TranslationServiceEnum

type Translator ¶ added in v65.7.0

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"`
}

Translator The properties for a Translator.

func (Translator) String ¶ added in v65.7.0

func (m Translator) String() string

func (Translator) ValidateEnumValue ¶ added in v65.7.0

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

type TranslatorCollection ¶ added in v65.7.0

type TranslatorCollection struct {

	// The Translator summaries.
	Items []TranslatorSummary `mandatory:"true" json:"items"`
}

TranslatorCollection A collection of Translator summaries.

func (TranslatorCollection) String ¶ added in v65.7.0

func (m TranslatorCollection) String() string

func (TranslatorCollection) ValidateEnumValue ¶ added in v65.7.0

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

type TranslatorSummary ¶ added in v65.7.0

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"`
}

TranslatorSummary Summary of the Translator.

func (TranslatorSummary) String ¶ added in v65.7.0

func (m TranslatorSummary) String() string

func (TranslatorSummary) ValidateEnumValue ¶ added in v65.7.0

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

type TwilioChannel ¶ added in v65.7.0

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"`
}

TwilioChannel The configuration for a Twilio channel.

func (TwilioChannel) GetCategory ¶ added in v65.7.0

func (m TwilioChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (TwilioChannel) GetDefinedTags ¶ added in v65.7.0

func (m TwilioChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (TwilioChannel) GetDescription ¶ added in v65.7.0

func (m TwilioChannel) GetDescription() *string

GetDescription returns Description

func (TwilioChannel) GetFreeformTags ¶ added in v65.7.0

func (m TwilioChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (TwilioChannel) GetId ¶ added in v65.7.0

func (m TwilioChannel) GetId() *string

GetId returns Id

func (TwilioChannel) GetLifecycleState ¶ added in v65.7.0

func (m TwilioChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (TwilioChannel) GetName ¶ added in v65.7.0

func (m TwilioChannel) GetName() *string

GetName returns Name

func (TwilioChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m TwilioChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (TwilioChannel) GetTimeCreated ¶ added in v65.7.0

func (m TwilioChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (TwilioChannel) GetTimeUpdated ¶ added in v65.7.0

func (m TwilioChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (TwilioChannel) MarshalJSON ¶ added in v65.7.0

func (m TwilioChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (TwilioChannel) String ¶ added in v65.7.0

func (m TwilioChannel) String() string

func (TwilioChannel) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateAndroidChannelDetails ¶ added in v65.7.0

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"`
}

UpdateAndroidChannelDetails Properties to update an Android channel.

func (UpdateAndroidChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateAndroidChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateAndroidChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateAndroidChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateAndroidChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateAndroidChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateAndroidChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateAndroidChannelDetails) GetName() *string

GetName returns Name

func (UpdateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateAndroidChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateAndroidChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateAndroidChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateAndroidChannelDetails) String ¶ added in v65.7.0

func (UpdateAndroidChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateAppEventChannelDetails ¶ added in v65.7.0

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"`
}

UpdateAppEventChannelDetails Properties to update an Application Event channel.

func (UpdateAppEventChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateAppEventChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateAppEventChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateAppEventChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateAppEventChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateAppEventChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateAppEventChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateAppEventChannelDetails) GetName() *string

GetName returns Name

func (UpdateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateAppEventChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateAppEventChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateAppEventChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateAppEventChannelDetails) String ¶ added in v65.7.0

func (UpdateAppEventChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateApplicationChannelDetails ¶ added in v65.7.0

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"`
}

UpdateApplicationChannelDetails Properties to update an Application channel.

func (UpdateApplicationChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateApplicationChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateApplicationChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateApplicationChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateApplicationChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateApplicationChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateApplicationChannelDetails) GetName ¶ added in v65.36.0

GetName returns Name

func (UpdateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateApplicationChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateApplicationChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateApplicationChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateApplicationChannelDetails) String ¶ added in v65.7.0

func (UpdateApplicationChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateAuthenticationProviderDetails ¶ added in v65.7.0

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"`
}

UpdateAuthenticationProviderDetails Properties to update an Authentication Provider.

func (UpdateAuthenticationProviderDetails) String ¶ added in v65.7.0

func (UpdateAuthenticationProviderDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateAuthenticationProviderRequest ¶ added in v65.7.0

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
}

UpdateAuthenticationProviderRequest wrapper for the UpdateAuthenticationProvider operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateAuthenticationProvider.go.html to see an example of how to use UpdateAuthenticationProviderRequest.

func (UpdateAuthenticationProviderRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateAuthenticationProviderRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateAuthenticationProviderRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateAuthenticationProviderRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateAuthenticationProviderRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateAuthenticationProviderRequest) String ¶ added in v65.7.0

func (UpdateAuthenticationProviderRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateAuthenticationProviderResponse ¶ added in v65.7.0

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"`
}

UpdateAuthenticationProviderResponse wrapper for the UpdateAuthenticationProvider operation

func (UpdateAuthenticationProviderResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateAuthenticationProviderResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateAuthenticationProviderResponse) String ¶ added in v65.7.0

func (response UpdateAuthenticationProviderResponse) String() string

type UpdateChannelDetails ¶ added in v65.7.0

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{}
}

UpdateChannelDetails Properties to update a Channel.

type UpdateChannelRequest ¶ added in v65.7.0

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
}

UpdateChannelRequest wrapper for the UpdateChannel operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateChannel.go.html to see an example of how to use UpdateChannelRequest.

func (UpdateChannelRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateChannelRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateChannelRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateChannelRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateChannelRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateChannelRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateChannelRequest) String ¶ added in v65.7.0

func (request UpdateChannelRequest) String() string

func (UpdateChannelRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateChannelResponse ¶ added in v65.7.0

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"`
}

UpdateChannelResponse wrapper for the UpdateChannel operation

func (UpdateChannelResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateChannelResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateChannelResponse) String ¶ added in v65.7.0

func (response UpdateChannelResponse) String() string

type UpdateCortanaChannelDetails ¶ added in v65.7.0

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"`
}

UpdateCortanaChannelDetails Properties to update a Cortana channel.

func (UpdateCortanaChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateCortanaChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateCortanaChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateCortanaChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateCortanaChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateCortanaChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateCortanaChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateCortanaChannelDetails) GetName() *string

GetName returns Name

func (UpdateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateCortanaChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateCortanaChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateCortanaChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateCortanaChannelDetails) String ¶ added in v65.7.0

func (UpdateCortanaChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateDigitalAssistantDetails ¶ added in v65.7.0

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"`
}

UpdateDigitalAssistantDetails Properties to update a Digital Assistant.

func (UpdateDigitalAssistantDetails) String ¶ added in v65.7.0

func (UpdateDigitalAssistantDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateDigitalAssistantParameterDetails ¶ added in v65.7.0

type UpdateDigitalAssistantParameterDetails struct {

	// The current value.  The value will be interpreted based on the `type`.
	Value *string `mandatory:"true" json:"value"`
}

UpdateDigitalAssistantParameterDetails Properties to update a Digital Assistant Parameter.

func (UpdateDigitalAssistantParameterDetails) String ¶ added in v65.7.0

func (UpdateDigitalAssistantParameterDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateDigitalAssistantParameterRequest ¶ added in v65.7.0

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
}

UpdateDigitalAssistantParameterRequest wrapper for the UpdateDigitalAssistantParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistantParameter.go.html to see an example of how to use UpdateDigitalAssistantParameterRequest.

func (UpdateDigitalAssistantParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateDigitalAssistantParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalAssistantParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateDigitalAssistantParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalAssistantParameterRequest) RetryPolicy ¶ added in v65.7.0

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDigitalAssistantParameterRequest) String ¶ added in v65.7.0

func (UpdateDigitalAssistantParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateDigitalAssistantParameterResponse ¶ added in v65.7.0

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"`
}

UpdateDigitalAssistantParameterResponse wrapper for the UpdateDigitalAssistantParameter operation

func (UpdateDigitalAssistantParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateDigitalAssistantParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalAssistantParameterResponse) String ¶ added in v65.7.0

type UpdateDigitalAssistantRequest ¶ added in v65.7.0

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
}

UpdateDigitalAssistantRequest wrapper for the UpdateDigitalAssistant operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateDigitalAssistant.go.html to see an example of how to use UpdateDigitalAssistantRequest.

func (UpdateDigitalAssistantRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateDigitalAssistantRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateDigitalAssistantRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateDigitalAssistantRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateDigitalAssistantRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateDigitalAssistantRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateDigitalAssistantRequest) String ¶ added in v65.7.0

func (request UpdateDigitalAssistantRequest) String() string

func (UpdateDigitalAssistantRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateDigitalAssistantResponse ¶ added in v65.7.0

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"`
}

UpdateDigitalAssistantResponse wrapper for the UpdateDigitalAssistant operation

func (UpdateDigitalAssistantResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateDigitalAssistantResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateDigitalAssistantResponse) String ¶ added in v65.7.0

func (response UpdateDigitalAssistantResponse) String() string

type UpdateFacebookChannelDetails ¶ added in v65.7.0

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"`
}

UpdateFacebookChannelDetails Properties to update a Facebook channel.

func (UpdateFacebookChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateFacebookChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateFacebookChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateFacebookChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateFacebookChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateFacebookChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateFacebookChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateFacebookChannelDetails) GetName() *string

GetName returns Name

func (UpdateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateFacebookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateFacebookChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateFacebookChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateFacebookChannelDetails) String ¶ added in v65.7.0

func (UpdateFacebookChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateImportedPackageDetails ¶ added in v65.7.0

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"`
}

UpdateImportedPackageDetails Payload for updating an imported package

func (UpdateImportedPackageDetails) String ¶ added in v65.7.0

func (UpdateImportedPackageDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateImportedPackageRequest ¶ added in v65.7.0

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
}

UpdateImportedPackageRequest wrapper for the UpdateImportedPackage operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateImportedPackage.go.html to see an example of how to use UpdateImportedPackageRequest.

func (UpdateImportedPackageRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateImportedPackageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateImportedPackageRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateImportedPackageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateImportedPackageRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateImportedPackageRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateImportedPackageRequest) String ¶ added in v65.7.0

func (request UpdateImportedPackageRequest) String() string

func (UpdateImportedPackageRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateImportedPackageResponse ¶ added in v65.7.0

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"`
}

UpdateImportedPackageResponse wrapper for the UpdateImportedPackage operation

func (UpdateImportedPackageResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateImportedPackageResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateImportedPackageResponse) String ¶ added in v65.7.0

func (response UpdateImportedPackageResponse) String() string

type UpdateIosChannelDetails ¶ added in v65.7.0

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"`
}

UpdateIosChannelDetails Properties to update an iOS channel.

func (UpdateIosChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateIosChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateIosChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateIosChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateIosChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateIosChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateIosChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateIosChannelDetails) GetName() *string

GetName returns Name

func (UpdateIosChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateIosChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateIosChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateIosChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateIosChannelDetails) String ¶ added in v65.7.0

func (m UpdateIosChannelDetails) String() string

func (UpdateIosChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateMsTeamsChannelDetails ¶ added in v65.7.0

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"`
}

UpdateMsTeamsChannelDetails Properties to update an MS Teams channel.

func (UpdateMsTeamsChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateMsTeamsChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateMsTeamsChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateMsTeamsChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateMsTeamsChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateMsTeamsChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateMsTeamsChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateMsTeamsChannelDetails) GetName() *string

GetName returns Name

func (UpdateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateMsTeamsChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateMsTeamsChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateMsTeamsChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateMsTeamsChannelDetails) String ¶ added in v65.7.0

func (UpdateMsTeamsChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateOdaInstanceAttachmentDetails ¶ added in v65.7.0

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"`
}

UpdateOdaInstanceAttachmentDetails ODA attachment details to be updated.

func (UpdateOdaInstanceAttachmentDetails) String ¶ added in v65.7.0

func (UpdateOdaInstanceAttachmentDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateOdaInstanceAttachmentRequest ¶ added in v65.7.0

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
}

UpdateOdaInstanceAttachmentRequest wrapper for the UpdateOdaInstanceAttachment operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstanceAttachment.go.html to see an example of how to use UpdateOdaInstanceAttachmentRequest.

func (UpdateOdaInstanceAttachmentRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateOdaInstanceAttachmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateOdaInstanceAttachmentRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateOdaInstanceAttachmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateOdaInstanceAttachmentRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateOdaInstanceAttachmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateOdaInstanceAttachmentRequest) String ¶ added in v65.7.0

func (request UpdateOdaInstanceAttachmentRequest) String() string

func (UpdateOdaInstanceAttachmentRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateOdaInstanceAttachmentResponse ¶ added in v65.7.0

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"`
}

UpdateOdaInstanceAttachmentResponse wrapper for the UpdateOdaInstanceAttachment operation

func (UpdateOdaInstanceAttachmentResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateOdaInstanceAttachmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateOdaInstanceAttachmentResponse) String ¶ added in v65.7.0

func (response UpdateOdaInstanceAttachmentResponse) String() string

type UpdateOdaInstanceDetails ¶

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"`
}

UpdateOdaInstanceDetails The Digital Assistant instance information to be updated.

func (UpdateOdaInstanceDetails) String ¶

func (m UpdateOdaInstanceDetails) String() string

func (UpdateOdaInstanceDetails) ValidateEnumValue ¶

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

type 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
}

UpdateOdaInstanceRequest wrapper for the UpdateOdaInstance operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaInstance.go.html to see an example of how to use UpdateOdaInstanceRequest.

func (UpdateOdaInstanceRequest) BinaryRequestBody ¶

func (request UpdateOdaInstanceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateOdaInstanceRequest) HTTPRequest ¶

func (request UpdateOdaInstanceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateOdaInstanceRequest) RetryPolicy ¶

func (request UpdateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateOdaInstanceRequest) String ¶

func (request UpdateOdaInstanceRequest) String() string

func (UpdateOdaInstanceRequest) ValidateEnumValue ¶

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

type UpdateOdaInstanceResponse ¶

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"`
}

UpdateOdaInstanceResponse wrapper for the UpdateOdaInstance operation

func (UpdateOdaInstanceResponse) HTTPResponse ¶

func (response UpdateOdaInstanceResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateOdaInstanceResponse) String ¶

func (response UpdateOdaInstanceResponse) String() string

type UpdateOdaPrivateEndpointDetails ¶ added in v65.36.0

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of network security groups (https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/networksecuritygroups.htm)
	NsgIds []string `mandatory:"false" json:"nsgIds"`

	// Simple key-value pair that is applied without any predefined name, type, or scope.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Usage of predefined tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateOdaPrivateEndpointDetails The ODA Private Endpoint information to be updated.

func (UpdateOdaPrivateEndpointDetails) String ¶ added in v65.36.0

func (UpdateOdaPrivateEndpointDetails) ValidateEnumValue ¶ added in v65.36.0

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

type UpdateOdaPrivateEndpointRequest ¶ added in v65.36.0

type UpdateOdaPrivateEndpointRequest struct {

	// Unique ODA Private Endpoint identifier which is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
	OdaPrivateEndpointId *string `mandatory:"true" contributesTo:"path" name:"odaPrivateEndpointId"`

	// The 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
}

UpdateOdaPrivateEndpointRequest wrapper for the UpdateOdaPrivateEndpoint operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateOdaPrivateEndpoint.go.html to see an example of how to use UpdateOdaPrivateEndpointRequest.

func (UpdateOdaPrivateEndpointRequest) BinaryRequestBody ¶ added in v65.36.0

func (request UpdateOdaPrivateEndpointRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateOdaPrivateEndpointRequest) HTTPRequest ¶ added in v65.36.0

func (request UpdateOdaPrivateEndpointRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateOdaPrivateEndpointRequest) RetryPolicy ¶ added in v65.36.0

func (request UpdateOdaPrivateEndpointRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateOdaPrivateEndpointRequest) String ¶ added in v65.36.0

func (request UpdateOdaPrivateEndpointRequest) String() string

func (UpdateOdaPrivateEndpointRequest) ValidateEnumValue ¶ added in v65.36.0

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

type UpdateOdaPrivateEndpointResponse ¶ added in v65.36.0

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"`
}

UpdateOdaPrivateEndpointResponse wrapper for the UpdateOdaPrivateEndpoint operation

func (UpdateOdaPrivateEndpointResponse) HTTPResponse ¶ added in v65.36.0

func (response UpdateOdaPrivateEndpointResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateOdaPrivateEndpointResponse) String ¶ added in v65.36.0

func (response UpdateOdaPrivateEndpointResponse) String() string

type UpdateOssChannelDetails ¶ added in v65.7.0

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"`
}

UpdateOssChannelDetails Properties to update an Oracle Streaming Service (OSS) channel.

func (UpdateOssChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateOssChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateOssChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateOssChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateOssChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateOssChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateOssChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateOssChannelDetails) GetName() *string

GetName returns Name

func (UpdateOssChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateOssChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateOssChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateOssChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateOssChannelDetails) String ¶ added in v65.7.0

func (m UpdateOssChannelDetails) String() string

func (UpdateOssChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateOsvcChannelDetails ¶ added in v65.7.0

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"`
}

UpdateOsvcChannelDetails Properties required to update an OSVC channel.

func (UpdateOsvcChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateOsvcChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateOsvcChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateOsvcChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateOsvcChannelDetails) GetName() *string

GetName returns Name

func (UpdateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateOsvcChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateOsvcChannelDetails) String ¶ added in v65.7.0

func (m UpdateOsvcChannelDetails) String() string

func (UpdateOsvcChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateServiceCloudChannelDetails ¶ added in v65.7.0

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"`
}

UpdateServiceCloudChannelDetails Properties to update a Service Cloud agent channel.

func (UpdateServiceCloudChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateServiceCloudChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateServiceCloudChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateServiceCloudChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateServiceCloudChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateServiceCloudChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateServiceCloudChannelDetails) GetName ¶ added in v65.36.0

GetName returns Name

func (UpdateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateServiceCloudChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateServiceCloudChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateServiceCloudChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateServiceCloudChannelDetails) String ¶ added in v65.7.0

func (UpdateServiceCloudChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateSkillDetails ¶ added in v65.7.0

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"`
}

UpdateSkillDetails Properties to update a Skill.

func (UpdateSkillDetails) String ¶ added in v65.7.0

func (m UpdateSkillDetails) String() string

func (UpdateSkillDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateSkillParameterDetails ¶ added in v65.7.0

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"`
}

UpdateSkillParameterDetails Properties to update a Skill Parameter.

func (UpdateSkillParameterDetails) String ¶ added in v65.7.0

func (UpdateSkillParameterDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateSkillParameterRequest ¶ added in v65.7.0

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
}

UpdateSkillParameterRequest wrapper for the UpdateSkillParameter operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkillParameter.go.html to see an example of how to use UpdateSkillParameterRequest.

func (UpdateSkillParameterRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateSkillParameterRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSkillParameterRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateSkillParameterRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSkillParameterRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateSkillParameterRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSkillParameterRequest) String ¶ added in v65.7.0

func (request UpdateSkillParameterRequest) String() string

func (UpdateSkillParameterRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateSkillParameterResponse ¶ added in v65.7.0

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"`
}

UpdateSkillParameterResponse wrapper for the UpdateSkillParameter operation

func (UpdateSkillParameterResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateSkillParameterResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSkillParameterResponse) String ¶ added in v65.7.0

func (response UpdateSkillParameterResponse) String() string

type UpdateSkillRequest ¶ added in v65.7.0

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
}

UpdateSkillRequest wrapper for the UpdateSkill operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateSkill.go.html to see an example of how to use UpdateSkillRequest.

func (UpdateSkillRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateSkillRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateSkillRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateSkillRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateSkillRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateSkillRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateSkillRequest) String ¶ added in v65.7.0

func (request UpdateSkillRequest) String() string

func (UpdateSkillRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateSkillResponse ¶ added in v65.7.0

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"`
}

UpdateSkillResponse wrapper for the UpdateSkill operation

func (UpdateSkillResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateSkillResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateSkillResponse) String ¶ added in v65.7.0

func (response UpdateSkillResponse) String() string

type UpdateSlackChannelDetails ¶ added in v65.7.0

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"`
}

UpdateSlackChannelDetails Properties to update a Slack channel.

func (UpdateSlackChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateSlackChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateSlackChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateSlackChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateSlackChannelDetails) GetName() *string

GetName returns Name

func (UpdateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateSlackChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateSlackChannelDetails) String ¶ added in v65.7.0

func (m UpdateSlackChannelDetails) String() string

func (UpdateSlackChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateTranslatorDetails ¶ added in v65.7.0

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"`
}

UpdateTranslatorDetails Properties to update a Translator.

func (UpdateTranslatorDetails) String ¶ added in v65.7.0

func (m UpdateTranslatorDetails) String() string

func (UpdateTranslatorDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateTranslatorRequest ¶ added in v65.7.0

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
}

UpdateTranslatorRequest wrapper for the UpdateTranslator operation

See also ¶

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/oda/UpdateTranslator.go.html to see an example of how to use UpdateTranslatorRequest.

func (UpdateTranslatorRequest) BinaryRequestBody ¶ added in v65.7.0

func (request UpdateTranslatorRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateTranslatorRequest) HTTPRequest ¶ added in v65.7.0

func (request UpdateTranslatorRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateTranslatorRequest) RetryPolicy ¶ added in v65.7.0

func (request UpdateTranslatorRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateTranslatorRequest) String ¶ added in v65.7.0

func (request UpdateTranslatorRequest) String() string

func (UpdateTranslatorRequest) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateTranslatorResponse ¶ added in v65.7.0

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"`
}

UpdateTranslatorResponse wrapper for the UpdateTranslator operation

func (UpdateTranslatorResponse) HTTPResponse ¶ added in v65.7.0

func (response UpdateTranslatorResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateTranslatorResponse) String ¶ added in v65.7.0

func (response UpdateTranslatorResponse) String() string

type UpdateTwilioChannelDetails ¶ added in v65.7.0

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"`
}

UpdateTwilioChannelDetails Properties to update a Twilio channel.

func (UpdateTwilioChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateTwilioChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateTwilioChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateTwilioChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateTwilioChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateTwilioChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateTwilioChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateTwilioChannelDetails) GetName() *string

GetName returns Name

func (UpdateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateTwilioChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateTwilioChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateTwilioChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateTwilioChannelDetails) String ¶ added in v65.7.0

func (UpdateTwilioChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateWebChannelDetails ¶ added in v65.7.0

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"`
}

UpdateWebChannelDetails Properties to update a Web channel.

func (UpdateWebChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateWebChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateWebChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateWebChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateWebChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateWebChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateWebChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateWebChannelDetails) GetName() *string

GetName returns Name

func (UpdateWebChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateWebChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateWebChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateWebChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateWebChannelDetails) String ¶ added in v65.7.0

func (m UpdateWebChannelDetails) String() string

func (UpdateWebChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type UpdateWebhookChannelDetails ¶ added in v65.7.0

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"`
}

UpdateWebhookChannelDetails Properties to update a Webhook channel.

func (UpdateWebhookChannelDetails) GetDefinedTags ¶ added in v65.7.0

func (m UpdateWebhookChannelDetails) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (UpdateWebhookChannelDetails) GetDescription ¶ added in v65.7.0

func (m UpdateWebhookChannelDetails) GetDescription() *string

GetDescription returns Description

func (UpdateWebhookChannelDetails) GetFreeformTags ¶ added in v65.7.0

func (m UpdateWebhookChannelDetails) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (UpdateWebhookChannelDetails) GetName ¶ added in v65.36.0

func (m UpdateWebhookChannelDetails) GetName() *string

GetName returns Name

func (UpdateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m UpdateWebhookChannelDetails) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (UpdateWebhookChannelDetails) MarshalJSON ¶ added in v65.7.0

func (m UpdateWebhookChannelDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateWebhookChannelDetails) String ¶ added in v65.7.0

func (UpdateWebhookChannelDetails) ValidateEnumValue ¶ added in v65.7.0

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

type ValueListEntity ¶ added in v65.60.0

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"`
}

ValueListEntity Metadata for a value list entity.

func (ValueListEntity) GetId ¶ added in v65.60.0

func (m ValueListEntity) GetId() *string

GetId returns Id

func (ValueListEntity) GetName ¶ added in v65.60.0

func (m ValueListEntity) GetName() *string

GetName returns Name

func (ValueListEntity) MarshalJSON ¶ added in v65.60.0

func (m ValueListEntity) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ValueListEntity) String ¶ added in v65.60.0

func (m ValueListEntity) String() string

func (ValueListEntity) ValidateEnumValue ¶ added in v65.60.0

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

type WebChannel ¶ added in v65.7.0

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"`
}

WebChannel The configuration for a Web channel.

func (WebChannel) GetCategory ¶ added in v65.7.0

func (m WebChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (WebChannel) GetDefinedTags ¶ added in v65.7.0

func (m WebChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (WebChannel) GetDescription ¶ added in v65.7.0

func (m WebChannel) GetDescription() *string

GetDescription returns Description

func (WebChannel) GetFreeformTags ¶ added in v65.7.0

func (m WebChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (WebChannel) GetId ¶ added in v65.7.0

func (m WebChannel) GetId() *string

GetId returns Id

func (WebChannel) GetLifecycleState ¶ added in v65.7.0

func (m WebChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (WebChannel) GetName ¶ added in v65.7.0

func (m WebChannel) GetName() *string

GetName returns Name

func (WebChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m WebChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (WebChannel) GetTimeCreated ¶ added in v65.7.0

func (m WebChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (WebChannel) GetTimeUpdated ¶ added in v65.7.0

func (m WebChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (WebChannel) MarshalJSON ¶ added in v65.7.0

func (m WebChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (WebChannel) String ¶ added in v65.7.0

func (m WebChannel) String() string

func (WebChannel) ValidateEnumValue ¶ added in v65.7.0

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

type WebhookChannel ¶ added in v65.7.0

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"`
}

WebhookChannel The configuration for a Webhook channel.

func (WebhookChannel) GetCategory ¶ added in v65.7.0

func (m WebhookChannel) GetCategory() ChannelCategoryEnum

GetCategory returns Category

func (WebhookChannel) GetDefinedTags ¶ added in v65.7.0

func (m WebhookChannel) GetDefinedTags() map[string]map[string]interface{}

GetDefinedTags returns DefinedTags

func (WebhookChannel) GetDescription ¶ added in v65.7.0

func (m WebhookChannel) GetDescription() *string

GetDescription returns Description

func (WebhookChannel) GetFreeformTags ¶ added in v65.7.0

func (m WebhookChannel) GetFreeformTags() map[string]string

GetFreeformTags returns FreeformTags

func (WebhookChannel) GetId ¶ added in v65.7.0

func (m WebhookChannel) GetId() *string

GetId returns Id

func (WebhookChannel) GetLifecycleState ¶ added in v65.7.0

func (m WebhookChannel) GetLifecycleState() LifecycleStateEnum

GetLifecycleState returns LifecycleState

func (WebhookChannel) GetName ¶ added in v65.7.0

func (m WebhookChannel) GetName() *string

GetName returns Name

func (WebhookChannel) GetSessionExpiryDurationInMilliseconds ¶ added in v65.7.0

func (m WebhookChannel) GetSessionExpiryDurationInMilliseconds() *int64

GetSessionExpiryDurationInMilliseconds returns SessionExpiryDurationInMilliseconds

func (WebhookChannel) GetTimeCreated ¶ added in v65.7.0

func (m WebhookChannel) GetTimeCreated() *common.SDKTime

GetTimeCreated returns TimeCreated

func (WebhookChannel) GetTimeUpdated ¶ added in v65.7.0

func (m WebhookChannel) GetTimeUpdated() *common.SDKTime

GetTimeUpdated returns TimeUpdated

func (WebhookChannel) MarshalJSON ¶ added in v65.7.0

func (m WebhookChannel) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (WebhookChannel) String ¶ added in v65.7.0

func (m WebhookChannel) String() string

func (WebhookChannel) ValidateEnumValue ¶ added in v65.7.0

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

type WebhookPayloadVersionEnum ¶ added in v65.7.0

type WebhookPayloadVersionEnum string

WebhookPayloadVersionEnum Enum with underlying type: string

const (
	WebhookPayloadVersion10 WebhookPayloadVersionEnum = "1.0"
	WebhookPayloadVersion11 WebhookPayloadVersionEnum = "1.1"
)

Set of constants representing the allowable values for WebhookPayloadVersionEnum

func GetMappingWebhookPayloadVersionEnum ¶ added in v65.7.0

func GetMappingWebhookPayloadVersionEnum(val string) (WebhookPayloadVersionEnum, bool)

GetMappingWebhookPayloadVersionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWebhookPayloadVersionEnumValues ¶ added in v65.7.0

func GetWebhookPayloadVersionEnumValues() []WebhookPayloadVersionEnum

GetWebhookPayloadVersionEnumValues Enumerates the set of values for WebhookPayloadVersionEnum

type WorkRequest ¶

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"`
}

WorkRequest The description of work request, including its status.

func (WorkRequest) String ¶

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue ¶

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

type WorkRequestError ¶

type WorkRequestError struct {

	// A machine-usable code for the error that occurred. Error codes are listed at
	// (https://docs.cloud.oracle.com/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"`
}

WorkRequestError Description of the unexpected error that prevented completion of the request.

func (WorkRequestError) String ¶

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue ¶

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

type WorkRequestLogEntry ¶

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"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String ¶

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue ¶

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

type WorkRequestRequestActionEnum ¶

type WorkRequestRequestActionEnum string

WorkRequestRequestActionEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for WorkRequestRequestActionEnum

func GetMappingWorkRequestRequestActionEnum ¶

func GetMappingWorkRequestRequestActionEnum(val string) (WorkRequestRequestActionEnum, bool)

GetMappingWorkRequestRequestActionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestRequestActionEnumValues ¶

func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum

GetWorkRequestRequestActionEnumValues Enumerates the set of values for WorkRequestRequestActionEnum

type WorkRequestResource ¶

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"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String ¶

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue ¶

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

type WorkRequestResourceResourceActionEnum ¶

type WorkRequestResourceResourceActionEnum string

WorkRequestResourceResourceActionEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for WorkRequestResourceResourceActionEnum

func GetMappingWorkRequestResourceResourceActionEnum ¶

func GetMappingWorkRequestResourceResourceActionEnum(val string) (WorkRequestResourceResourceActionEnum, bool)

GetMappingWorkRequestResourceResourceActionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceResourceActionEnumValues ¶

func GetWorkRequestResourceResourceActionEnumValues() []WorkRequestResourceResourceActionEnum

GetWorkRequestResourceResourceActionEnumValues Enumerates the set of values for WorkRequestResourceResourceActionEnum

type WorkRequestResourceStatusEnum ¶

type WorkRequestResourceStatusEnum string

WorkRequestResourceStatusEnum Enum with underlying type: string

const (
	WorkRequestResourceStatusAccepted   WorkRequestResourceStatusEnum = "ACCEPTED"
	WorkRequestResourceStatusInProgress WorkRequestResourceStatusEnum = "IN_PROGRESS"
	WorkRequestResourceStatusSucceeded  WorkRequestResourceStatusEnum = "SUCCEEDED"
	WorkRequestResourceStatusFailed     WorkRequestResourceStatusEnum = "FAILED"
	WorkRequestResourceStatusCanceling  WorkRequestResourceStatusEnum = "CANCELING"
	WorkRequestResourceStatusCanceled   WorkRequestResourceStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestResourceStatusEnum

func GetMappingWorkRequestResourceStatusEnum ¶

func GetMappingWorkRequestResourceStatusEnum(val string) (WorkRequestResourceStatusEnum, bool)

GetMappingWorkRequestResourceStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceStatusEnumValues ¶

func GetWorkRequestResourceStatusEnumValues() []WorkRequestResourceStatusEnum

GetWorkRequestResourceStatusEnumValues Enumerates the set of values for WorkRequestResourceStatusEnum

type WorkRequestStatusEnum ¶

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
	WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
	WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
	WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
	WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
	WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
	WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum ¶

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

GetMappingWorkRequestStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestStatusEnumValues ¶

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary ¶

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"`
}

WorkRequestSummary A description of the work request's status.

func (WorkRequestSummary) String ¶

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue ¶

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

type WorkRequestSummaryRequestActionEnum ¶

type WorkRequestSummaryRequestActionEnum string

WorkRequestSummaryRequestActionEnum Enum with underlying type: string

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"
)

Set of constants representing the allowable values for WorkRequestSummaryRequestActionEnum

func GetMappingWorkRequestSummaryRequestActionEnum ¶

func GetMappingWorkRequestSummaryRequestActionEnum(val string) (WorkRequestSummaryRequestActionEnum, bool)

GetMappingWorkRequestSummaryRequestActionEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSummaryRequestActionEnumValues ¶

func GetWorkRequestSummaryRequestActionEnumValues() []WorkRequestSummaryRequestActionEnum

GetWorkRequestSummaryRequestActionEnumValues Enumerates the set of values for WorkRequestSummaryRequestActionEnum

type WorkRequestSummaryStatusEnum ¶

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string

const (
	WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
	WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
	WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
	WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
	WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
	WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetMappingWorkRequestSummaryStatusEnum ¶

func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)

GetMappingWorkRequestSummaryStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSummaryStatusEnumValues ¶

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Source Files ¶

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL