func GetCompletionModeEnumStringValues() []string
GetCompletionModeEnumStringValues Enumerates the set of values in String for CompletionModeEnum
func GetDatabaseObjectTypeEnumStringValues() []string
GetDatabaseObjectTypeEnumStringValues Enumerates the set of values in String for DatabaseObjectTypeEnum
func GetEnrichmentJobTypeEnumStringValues() []string
GetEnrichmentJobTypeEnumStringValues Enumerates the set of values in String for EnrichmentJobTypeEnum
func GetJobOutputLocationEnumStringValues() []string
GetJobOutputLocationEnumStringValues Enumerates the set of values in String for JobOutputLocationEnum
func GetLifecycleStateEnumStringValues() []string
GetLifecycleStateEnumStringValues Enumerates the set of values in String for LifecycleStateEnum
func GetListEnrichmentJobsLifecycleStateEnumStringValues() []string
GetListEnrichmentJobsLifecycleStateEnumStringValues Enumerates the set of values in String for ListEnrichmentJobsLifecycleStateEnum
func GetListEnrichmentJobsSortByEnumStringValues() []string
GetListEnrichmentJobsSortByEnumStringValues Enumerates the set of values in String for ListEnrichmentJobsSortByEnum
func GetListEnrichmentJobsSortOrderEnumStringValues() []string
GetListEnrichmentJobsSortOrderEnumStringValues Enumerates the set of values in String for ListEnrichmentJobsSortOrderEnum
func GetSortOrdersEnumStringValues() []string
GetSortOrdersEnumStringValues Enumerates the set of values in String for SortOrdersEnum
CancelEnrichmentJobRequest wrapper for the CancelEnrichmentJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/CancelEnrichmentJob.go.html to see an example of how to use CancelEnrichmentJobRequest.
type CancelEnrichmentJobRequest struct {
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The OCID of the enrichment job
EnrichmentJobId *string `mandatory:"true" contributesTo:"path" name:"enrichmentJobId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelEnrichmentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelEnrichmentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelEnrichmentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelEnrichmentJobRequest) String() string
func (request CancelEnrichmentJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CancelEnrichmentJobResponse wrapper for the CancelEnrichmentJob operation
type CancelEnrichmentJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnrichmentJob instance
EnrichmentJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
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 work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response CancelEnrichmentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelEnrichmentJobResponse) String() string
CompletionModeEnum Enum with underlying type: string
type CompletionModeEnum string
Set of constants representing the allowable values for CompletionModeEnum
const (
CompletionModeWaitForCompletion CompletionModeEnum = "WAIT_FOR_COMPLETION"
CompletionModeBackgroundJob CompletionModeEnum = "BACKGROUND_JOB"
)
func GetCompletionModeEnumValues() []CompletionModeEnum
GetCompletionModeEnumValues Enumerates the set of values for CompletionModeEnum
func GetMappingCompletionModeEnum(val string) (CompletionModeEnum, bool)
GetMappingCompletionModeEnum performs case Insensitive comparison on enum value and return the desired enum
DatabaseObject The type of database object
type DatabaseObject struct {
// The type of the database object (e.g., table, view, procedure).
Type DatabaseObjectTypeEnum `mandatory:"true" json:"type"`
// The fully qualified name of the database object.
Name *string `mandatory:"true" json:"name"`
// An optional description of the DatabaseObject.
Description *string `mandatory:"false" json:"description"`
}
func (m DatabaseObject) String() string
func (m DatabaseObject) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DatabaseObjectTypeEnum Enum with underlying type: string
type DatabaseObjectTypeEnum string
Set of constants representing the allowable values for DatabaseObjectTypeEnum
const (
DatabaseObjectTypeView DatabaseObjectTypeEnum = "VIEW"
DatabaseObjectTypeTable DatabaseObjectTypeEnum = "TABLE"
DatabaseObjectTypeAnnotation DatabaseObjectTypeEnum = "ANNOTATION"
DatabaseObjectTypeComment DatabaseObjectTypeEnum = "COMMENT"
)
func GetDatabaseObjectTypeEnumValues() []DatabaseObjectTypeEnum
GetDatabaseObjectTypeEnumValues Enumerates the set of values for DatabaseObjectTypeEnum
func GetMappingDatabaseObjectTypeEnum(val string) (DatabaseObjectTypeEnum, bool)
GetMappingDatabaseObjectTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DeltaRefreshEnrichmentJobConfiguration A DeltaRefreshEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under `allOf`, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the delta refresh enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under `allOf`]. deltaRefreshSchedule is optional, is not used by the service, and is retained only for backward compatibility. It should be treated as deprecated.
type DeltaRefreshEnrichmentJobConfiguration struct {
// Name of the DB Schema to be enriched
SchemaName *string `mandatory:"true" json:"schemaName"`
// Deprecated schedule for occurrences of Delta Refresh jobs. This value is not used by the service.
DeltaRefreshSchedule *interface{} `mandatory:"false" json:"deltaRefreshSchedule"`
}
func (m DeltaRefreshEnrichmentJobConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DeltaRefreshEnrichmentJobConfiguration) String() string
func (m DeltaRefreshEnrichmentJobConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EnrichmentJob Object representing to EnrichmentJob. ocidEntityType: generativeaisemanticstorejob adLocality: regional
type EnrichmentJob struct {
// The OCID of the Semantic Store job.
Id *string `mandatory:"true" json:"id"`
// Owning SemanticStore OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for an EnrichmentJob.
SemanticStoreId *string `mandatory:"true" json:"semanticStoreId"`
// Enrichment job type. Supported values are Full Build (all supported objects in a given schema), Partial Build (selected tables and/or supported objects in a given schema), and Delta Refresh (objects in a given schema that have changed since the previous enrichment job).
EnrichmentJobType EnrichmentJobTypeEnum `mandatory:"true" json:"enrichmentJobType"`
EnrichmentJobConfiguration EnrichmentJobConfiguration `mandatory:"true" json:"enrichmentJobConfiguration"`
// The generative AI modelId used for Enrichment. You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels
ModelId *string `mandatory:"true" json:"modelId"`
// The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
// The lifecycle state of the EnrichmentJob.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// An optional description of the EnrichmentJob.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time that the enrichment job was started in the format of an RFC3339 datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time that the enrichment job was finished in the format of an RFC3339 datetime string.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// The percentage of the enrichment job that has been completed.
PercentComplete *float32 `mandatory:"false" json:"percentComplete"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EnrichmentJob) String() string
func (m *EnrichmentJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m EnrichmentJob) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EnrichmentJobClient a client for EnrichmentJob
type EnrichmentJobClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewEnrichmentJobClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EnrichmentJobClient, err error)
NewEnrichmentJobClientWithConfigurationProvider Creates a new default EnrichmentJob client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewEnrichmentJobClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EnrichmentJobClient, err error)
NewEnrichmentJobClientWithOboToken Creates a new default EnrichmentJob client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client EnrichmentJobClient) CancelEnrichmentJob(ctx context.Context, request CancelEnrichmentJobRequest) (response CancelEnrichmentJobResponse, err error)
CancelEnrichmentJob Cancels an EnrichmentJob resource by identifier. The returned job includes the modelId used for enrichment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/CancelEnrichmentJob.go.html to see an example of how to use CancelEnrichmentJob API. A default retry strategy applies to this operation CancelEnrichmentJob()
func (client *EnrichmentJobClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EnrichmentJobClient) GenerateEnrichmentJob(ctx context.Context, request GenerateEnrichmentJobRequest) (response GenerateEnrichmentJobResponse, err error)
GenerateEnrichmentJob Creates a new asynchronous EnrichmentJob. The returned job includes the modelId used for enrichment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GenerateEnrichmentJob.go.html to see an example of how to use GenerateEnrichmentJob API. A default retry strategy applies to this operation GenerateEnrichmentJob()
func (client EnrichmentJobClient) GetEnrichmentJob(ctx context.Context, request GetEnrichmentJobRequest) (response GetEnrichmentJobResponse, err error)
GetEnrichmentJob Gets an EnrichmentJob by identifier. The returned job includes the modelId used for enrichment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GetEnrichmentJob.go.html to see an example of how to use GetEnrichmentJob API. A default retry strategy applies to this operation GetEnrichmentJob()
func (client EnrichmentJobClient) ListEnrichmentJobs(ctx context.Context, request ListEnrichmentJobsRequest) (response ListEnrichmentJobsResponse, err error)
ListEnrichmentJobs Lists EnrichmentJobs in a semantic store. Each returned job summary includes the modelId used for enrichment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/ListEnrichmentJobs.go.html to see an example of how to use ListEnrichmentJobs API. A default retry strategy applies to this operation ListEnrichmentJobs()
func (client *EnrichmentJobClient) SetRegion(region string)
SetRegion overrides the region of this client.
EnrichmentJobCollection Object representing list of EnrichmentJobSummaries.
type EnrichmentJobCollection struct {
// List of EnrichmentJobSummary objects.
Items []EnrichmentJobSummary `mandatory:"true" json:"items"`
}
func (m EnrichmentJobCollection) String() string
func (m EnrichmentJobCollection) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EnrichmentJobConfiguration An EnrichmentJobConfiguration describes the database objects that will be targeted by an EnrichmentJob, as described by the job's type.
type EnrichmentJobConfiguration interface {
}
EnrichmentJobSummary Object representing EnrichmentJobSummary resource.
type EnrichmentJobSummary struct {
// The OCID of the Semantic Store job.
Id *string `mandatory:"true" json:"id"`
// Owning SemanticStore OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the EnrichmentJob.
SemanticStoreId *string `mandatory:"true" json:"semanticStoreId"`
// Enrichment job type. Supported values are Full Build (all supported objects in a given schema), Partial Build (selected tables and/or supported objects in a given schema), and Delta Refresh (objects in a given schema that have changed since the previous enrichment job).
EnrichmentJobType EnrichmentJobTypeEnum `mandatory:"true" json:"enrichmentJobType"`
// The generative AI modelId used for Enrichment. You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels
ModelId *string `mandatory:"true" json:"modelId"`
// The date and time that the enrichment job was accepted in the format of an RFC3339 datetime string.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The lifecycle state of the EnrichmentJob.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m EnrichmentJobSummary) String() string
func (m EnrichmentJobSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
EnrichmentJobTypeEnum Enum with underlying type: string
type EnrichmentJobTypeEnum string
Set of constants representing the allowable values for EnrichmentJobTypeEnum
const (
EnrichmentJobTypeFullBuild EnrichmentJobTypeEnum = "FULL_BUILD"
EnrichmentJobTypePartialBuild EnrichmentJobTypeEnum = "PARTIAL_BUILD"
EnrichmentJobTypeDeltaRefresh EnrichmentJobTypeEnum = "DELTA_REFRESH"
)
func GetEnrichmentJobTypeEnumValues() []EnrichmentJobTypeEnum
GetEnrichmentJobTypeEnumValues Enumerates the set of values for EnrichmentJobTypeEnum
func GetMappingEnrichmentJobTypeEnum(val string) (EnrichmentJobTypeEnum, bool)
GetMappingEnrichmentJobTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FullBuildEnrichmentJobConfiguration A FullBuildEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under `allOf`, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under `allOf`].
type FullBuildEnrichmentJobConfiguration struct {
// Name of the DB Schema to be enriched
SchemaName *string `mandatory:"true" json:"schemaName"`
}
func (m FullBuildEnrichmentJobConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FullBuildEnrichmentJobConfiguration) String() string
func (m FullBuildEnrichmentJobConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateEnrichmentJobDetails The details required to create an EnrichmentJob.
type GenerateEnrichmentJobDetails struct {
EnrichmentJobConfiguration EnrichmentJobConfiguration `mandatory:"true" json:"enrichmentJobConfiguration"`
// An optional description of the EnrichmentJob.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// Deprecated. Use EnrichmentJobConfiguration.enrichmentJobType instead.
EnrichmentJobType EnrichmentJobTypeEnum `mandatory:"false" json:"enrichmentJobType,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m GenerateEnrichmentJobDetails) String() string
func (m *GenerateEnrichmentJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m GenerateEnrichmentJobDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateEnrichmentJobRequest wrapper for the GenerateEnrichmentJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GenerateEnrichmentJob.go.html to see an example of how to use GenerateEnrichmentJobRequest.
type GenerateEnrichmentJobRequest struct {
// Details for the new EnrichmentJob.
GenerateEnrichmentJobDetails `contributesTo:"body"`
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateEnrichmentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateEnrichmentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateEnrichmentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateEnrichmentJobRequest) String() string
func (request GenerateEnrichmentJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateEnrichmentJobResponse wrapper for the GenerateEnrichmentJob operation
type GenerateEnrichmentJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnrichmentJob instance
EnrichmentJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
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 work. You can use this to query its status.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response GenerateEnrichmentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateEnrichmentJobResponse) String() string
GenerateSqlClient a client for GenerateSql
type GenerateSqlClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewGenerateSqlClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client GenerateSqlClient, err error)
NewGenerateSqlClientWithConfigurationProvider Creates a new default GenerateSql client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewGenerateSqlClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client GenerateSqlClient, err error)
NewGenerateSqlClientWithOboToken Creates a new default GenerateSql client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *GenerateSqlClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client GenerateSqlClient) GenerateSqlFromNl(ctx context.Context, request GenerateSqlFromNlRequest) (response GenerateSqlFromNlResponse, err error)
GenerateSqlFromNl Generates a SQL query from a natural language input for the specified SemanticStore. This operation creates a GenerateSqlFromNlJob. The request can either be processed as a background job or wait for completion, depending on completionMode. If modelId is provided, the service validates it and uses it for schema-linking in table selection, SQL generation, and SQL refinement. If modelId is omitted, the service default model is used. The response includes the modelId used for generation. Clients should inspect lifecycleState in the response: - If lifecycleState is SUCCEEDED, SQL generation is complete and the result is available in jobOutput. - If lifecycleState is ACCEPTED or IN_PROGRESS, poll GetGenerateSqlFromNlJob using the returned job id. - If lifecycleState is FAILED or CANCELED, SQL generation did not complete. See lifecycleDetails for more information. The GetGenerateSqlFromNlJob endpoint is the source of truth for final job state and result availability.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GenerateSqlFromNl.go.html to see an example of how to use GenerateSqlFromNl API. A default retry strategy applies to this operation GenerateSqlFromNl()
func (client GenerateSqlClient) GetGenerateSqlFromNlJob(ctx context.Context, request GetGenerateSqlFromNlJobRequest) (response GetGenerateSqlFromNlJobResponse, err error)
GetGenerateSqlFromNlJob Retrieves the current state of a GenerateSqlFromNlJob. Clients should poll this endpoint until lifecycleState is SUCCEEDED or FAILED. When lifecycleState is SUCCEEDED, the result is available in jobOutput. The returned job includes the modelId used for generation.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GetGenerateSqlFromNlJob.go.html to see an example of how to use GetGenerateSqlFromNlJob API. A default retry strategy applies to this operation GetGenerateSqlFromNlJob()
func (client *GenerateSqlClient) SetRegion(region string)
SetRegion overrides the region of this client.
GenerateSqlFromNlDetails The data to create a GenerateSqlFromNlJob.
type GenerateSqlFromNlDetails struct {
// A user-provided query or instruction written in plain, conversational language.
// This input is intended to capture the user's intent, question, or command without requiring technical syntax or structured formatting.
// The query should clearly express what the user wants to know or accomplish, allowing the system to interpret and respond appropriately.
InputNaturalLanguageQuery *string `mandatory:"true" json:"inputNaturalLanguageQuery"`
// An optional description of the GenerateSqlFromNlJob.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The generative AI modelId to use for Generate SQL. You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels
ModelId *string `mandatory:"false" json:"modelId"`
// Controls whether GenerateSqlFromNl should be accepted as a background job or wait for completion.
// BACKGROUND_JOB accepts the request for background processing and returns a pollable job.
// WAIT_FOR_COMPLETION waits for completion within the service-defined timeout.
CompletionMode CompletionModeEnum `mandatory:"false" json:"completionMode,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m GenerateSqlFromNlDetails) String() string
func (m GenerateSqlFromNlDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateSqlFromNlJob Object representing to GenerateSqlFromNlJob. ocidEntityType: generativeaisemanticstorejob adLocality: regional
type GenerateSqlFromNlJob struct {
// The OCID of the Semantic Store job.
Id *string `mandatory:"true" json:"id"`
// Owning SemanticStore OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for a GenerateSqlFromNlJob.
SemanticStoreId *string `mandatory:"true" json:"semanticStoreId"`
// The date and time that the GenerateSqlFromNlJob was accepted in the format of an RFC3339 datetime string.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The current state of GenerateSqlFromNlJob.
// - ACCEPTED: Job has been created but not yet started.
// - IN_PROGRESS: Job is currently running.
// - SUCCEEDED: Job completed successfully. The result is available in jobOutput.
// - FAILED: Job failed. See lifecycleDetails for error information.
LifecycleState LifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// A message describing the current state in more detail that can provide actionable information.
LifecycleDetails *string `mandatory:"true" json:"lifecycleDetails"`
// The generative AI modelId used for Generate SQL. You can use the ListModels API to list the available models. https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/ModelCollection/ListModels
ModelId *string `mandatory:"true" json:"modelId"`
// An optional description of the GenerateSqlFromNlJob.
Description *string `mandatory:"false" json:"description"`
// A user-friendly display name. It does not have to be unique and can be modified. Avoid entering confidential information.
DisplayName *string `mandatory:"false" json:"displayName"`
// The date and time that the GenerateSqlFromNlJob was started in the format of an RFC3339 datetime string.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time that the GenerateSqlFromNlJob was finished in the format of an RFC3339 datetime string.
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// A user-provided query or instruction written in plain, conversational language.
// This input is intended to capture the user's intent, question, or command without requiring technical syntax or structured formatting.
// The query should clearly express what the user wants to know or accomplish, allowing the system to interpret and respond appropriately.
InputNaturalLanguageQuery *string `mandatory:"false" json:"inputNaturalLanguageQuery"`
JobOutput JobOutput `mandatory:"false" json:"jobOutput"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// System tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m GenerateSqlFromNlJob) String() string
func (m *GenerateSqlFromNlJob) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m GenerateSqlFromNlJob) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateSqlFromNlRequest wrapper for the GenerateSqlFromNl operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GenerateSqlFromNl.go.html to see an example of how to use GenerateSqlFromNlRequest.
type GenerateSqlFromNlRequest struct {
// Details for generating SQL from natural language.
GenerateSqlFromNlDetails `contributesTo:"body"`
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GenerateSqlFromNlRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateSqlFromNlRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateSqlFromNlRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateSqlFromNlRequest) String() string
func (request GenerateSqlFromNlRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GenerateSqlFromNlResponse wrapper for the GenerateSqlFromNl operation
type GenerateSqlFromNlResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerateSqlFromNlJob instance
GenerateSqlFromNlJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
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"`
// Not used when `200` status is returned
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
}
func (response GenerateSqlFromNlResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateSqlFromNlResponse) String() string
GetEnrichmentJobRequest wrapper for the GetEnrichmentJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GetEnrichmentJob.go.html to see an example of how to use GetEnrichmentJobRequest.
type GetEnrichmentJobRequest struct {
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The OCID of the enrichment job
EnrichmentJobId *string `mandatory:"true" contributesTo:"path" name:"enrichmentJobId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetEnrichmentJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetEnrichmentJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetEnrichmentJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetEnrichmentJobRequest) String() string
func (request GetEnrichmentJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetEnrichmentJobResponse wrapper for the GetEnrichmentJob operation
type GetEnrichmentJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The EnrichmentJob instance
EnrichmentJob `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetEnrichmentJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetEnrichmentJobResponse) String() string
GetGenerateSqlFromNlJobRequest wrapper for the GetGenerateSqlFromNlJob operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/GetGenerateSqlFromNlJob.go.html to see an example of how to use GetGenerateSqlFromNlJobRequest.
type GetGenerateSqlFromNlJobRequest struct {
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The OCID of the Semantic Store job for a GenerateSqlFromNl job.
GenerateSqlFromNlJobId *string `mandatory:"true" contributesTo:"path" name:"generateSqlFromNlJobId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetGenerateSqlFromNlJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetGenerateSqlFromNlJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetGenerateSqlFromNlJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetGenerateSqlFromNlJobRequest) String() string
func (request GetGenerateSqlFromNlJobRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetGenerateSqlFromNlJobResponse wrapper for the GetGenerateSqlFromNlJob operation
type GetGenerateSqlFromNlJobResponse struct {
// The underlying http response
RawResponse *http.Response
// The GenerateSqlFromNlJob instance
GenerateSqlFromNlJob `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetGenerateSqlFromNlJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetGenerateSqlFromNlJobResponse) String() string
InlineJobOutput An InlineJobOutput is a JobOutput [indicated by the first item under `allOf`, which is a reference to JobOutput] that delivers results of the GenerateSQLJob in the body of the job itself. As distinguished by jobOutputLocation [with specific characteristics defined by the second item under `allOf`].
type InlineJobOutput struct {
// SQL statement generated from the natural language query.
Content *string `mandatory:"true" json:"content"`
}
func (m InlineJobOutput) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m InlineJobOutput) String() string
func (m InlineJobOutput) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
JobOutput A JobOutput delivers content generated by the GenerateSQLJob to a given location, which corresponds with type-specific characteristics. This field is present on GenerateSqlFromNlJob only when lifecycleState is SUCCEEDED. It is omitted for all other lifecycle states.
type JobOutput interface {
}
JobOutputLocationEnum Enum with underlying type: string
type JobOutputLocationEnum string
Set of constants representing the allowable values for JobOutputLocationEnum
const (
JobOutputLocationInline JobOutputLocationEnum = "INLINE"
)
func GetJobOutputLocationEnumValues() []JobOutputLocationEnum
GetJobOutputLocationEnumValues Enumerates the set of values for JobOutputLocationEnum
func GetMappingJobOutputLocationEnum(val string) (JobOutputLocationEnum, bool)
GetMappingJobOutputLocationEnum performs case Insensitive comparison on enum value and return the desired enum
LifecycleStateEnum Enum with underlying type: string
type LifecycleStateEnum string
Set of constants representing the allowable values for LifecycleStateEnum
const (
LifecycleStateAccepted LifecycleStateEnum = "ACCEPTED"
LifecycleStateInProgress LifecycleStateEnum = "IN_PROGRESS"
LifecycleStateFailed LifecycleStateEnum = "FAILED"
LifecycleStateSucceeded LifecycleStateEnum = "SUCCEEDED"
LifecycleStateCanceling LifecycleStateEnum = "CANCELING"
LifecycleStateCanceled LifecycleStateEnum = "CANCELED"
)
func GetLifecycleStateEnumValues() []LifecycleStateEnum
GetLifecycleStateEnumValues Enumerates the set of values for LifecycleStateEnum
func GetMappingLifecycleStateEnum(val string) (LifecycleStateEnum, bool)
GetMappingLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrichmentJobsLifecycleStateEnum Enum with underlying type: string
type ListEnrichmentJobsLifecycleStateEnum string
Set of constants representing the allowable values for ListEnrichmentJobsLifecycleStateEnum
const (
ListEnrichmentJobsLifecycleStateAccepted ListEnrichmentJobsLifecycleStateEnum = "ACCEPTED"
ListEnrichmentJobsLifecycleStateInProgress ListEnrichmentJobsLifecycleStateEnum = "IN_PROGRESS"
ListEnrichmentJobsLifecycleStateFailed ListEnrichmentJobsLifecycleStateEnum = "FAILED"
ListEnrichmentJobsLifecycleStateSucceeded ListEnrichmentJobsLifecycleStateEnum = "SUCCEEDED"
ListEnrichmentJobsLifecycleStateCanceling ListEnrichmentJobsLifecycleStateEnum = "CANCELING"
ListEnrichmentJobsLifecycleStateCanceled ListEnrichmentJobsLifecycleStateEnum = "CANCELED"
)
func GetListEnrichmentJobsLifecycleStateEnumValues() []ListEnrichmentJobsLifecycleStateEnum
GetListEnrichmentJobsLifecycleStateEnumValues Enumerates the set of values for ListEnrichmentJobsLifecycleStateEnum
func GetMappingListEnrichmentJobsLifecycleStateEnum(val string) (ListEnrichmentJobsLifecycleStateEnum, bool)
GetMappingListEnrichmentJobsLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrichmentJobsRequest wrapper for the ListEnrichmentJobs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/generativeaidata/ListEnrichmentJobs.go.html to see an example of how to use ListEnrichmentJobsRequest.
type ListEnrichmentJobsRequest struct {
// The OCID of the semantic store
SemanticStoreId *string `mandatory:"true" contributesTo:"path" name:"semanticStoreId"`
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
LifecycleState ListEnrichmentJobsLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
SortBy ListEnrichmentJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The sort order to use, either 'ASC' or 'DESC'.
SortOrder ListEnrichmentJobsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListEnrichmentJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListEnrichmentJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListEnrichmentJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListEnrichmentJobsRequest) String() string
func (request ListEnrichmentJobsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListEnrichmentJobsResponse wrapper for the ListEnrichmentJobs operation
type ListEnrichmentJobsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of EnrichmentJobCollection instances
EnrichmentJobCollection `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// For list pagination. When this header appears in the response, previous pages of results remain. For
// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcPrevPage *string `presentIn:"header" name:"opc-prev-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListEnrichmentJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListEnrichmentJobsResponse) String() string
ListEnrichmentJobsSortByEnum Enum with underlying type: string
type ListEnrichmentJobsSortByEnum string
Set of constants representing the allowable values for ListEnrichmentJobsSortByEnum
const (
ListEnrichmentJobsSortByTimecreated ListEnrichmentJobsSortByEnum = "timeCreated"
ListEnrichmentJobsSortByDisplayname ListEnrichmentJobsSortByEnum = "displayName"
)
func GetListEnrichmentJobsSortByEnumValues() []ListEnrichmentJobsSortByEnum
GetListEnrichmentJobsSortByEnumValues Enumerates the set of values for ListEnrichmentJobsSortByEnum
func GetMappingListEnrichmentJobsSortByEnum(val string) (ListEnrichmentJobsSortByEnum, bool)
GetMappingListEnrichmentJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListEnrichmentJobsSortOrderEnum Enum with underlying type: string
type ListEnrichmentJobsSortOrderEnum string
Set of constants representing the allowable values for ListEnrichmentJobsSortOrderEnum
const (
ListEnrichmentJobsSortOrderAsc ListEnrichmentJobsSortOrderEnum = "ASC"
ListEnrichmentJobsSortOrderDesc ListEnrichmentJobsSortOrderEnum = "DESC"
)
func GetListEnrichmentJobsSortOrderEnumValues() []ListEnrichmentJobsSortOrderEnum
GetListEnrichmentJobsSortOrderEnumValues Enumerates the set of values for ListEnrichmentJobsSortOrderEnum
func GetMappingListEnrichmentJobsSortOrderEnum(val string) (ListEnrichmentJobsSortOrderEnum, bool)
GetMappingListEnrichmentJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
PartialBuildEnrichmentJobConfiguration A PartialBuildEnrichmentJobConfiguration is an EnrichmentJobConfiguration [indicated by the first item under `allOf`, which is a reference to EnrichmentJobConfiguration] that describes the database schema that will be the scope of the enrichment job. As distinguished by enrichmentJobType [with specific characteristics defined by the second item under `allOf`].
type PartialBuildEnrichmentJobConfiguration struct {
// Name of the DB Schema to be enriched
SchemaName *string `mandatory:"true" json:"schemaName"`
// Collection of the DatabaseObjects to be enriched for the given schema.
DatabaseObjects []DatabaseObject `mandatory:"true" json:"databaseObjects"`
}
func (m PartialBuildEnrichmentJobConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PartialBuildEnrichmentJobConfiguration) String() string
func (m PartialBuildEnrichmentJobConfiguration) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SortOrdersEnum Enum with underlying type: string
type SortOrdersEnum string
Set of constants representing the allowable values for SortOrdersEnum
const (
SortOrdersAsc SortOrdersEnum = "ASC"
SortOrdersDesc SortOrdersEnum = "DESC"
)
func GetMappingSortOrdersEnum(val string) (SortOrdersEnum, bool)
GetMappingSortOrdersEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrdersEnumValues() []SortOrdersEnum
GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum