Documentation ¶
Index ¶
- type ChangeOdaInstanceCompartmentDetails
- type ChangeOdaInstanceCompartmentRequest
- type ChangeOdaInstanceCompartmentResponse
- type CreateOdaInstanceDetails
- type CreateOdaInstanceDetailsShapeNameEnum
- type CreateOdaInstanceRequest
- type CreateOdaInstanceResponse
- type DeleteOdaInstanceRequest
- type DeleteOdaInstanceResponse
- type ErrorBody
- type GetOdaInstanceRequest
- type GetOdaInstanceResponse
- type GetWorkRequestRequest
- type GetWorkRequestResponse
- type ListOdaInstancesLifecycleStateEnum
- type ListOdaInstancesRequest
- type ListOdaInstancesResponse
- type ListOdaInstancesSortByEnum
- type ListOdaInstancesSortOrderEnum
- type ListWorkRequestErrorsRequest
- type ListWorkRequestErrorsResponse
- type ListWorkRequestErrorsSortByEnum
- type ListWorkRequestErrorsSortOrderEnum
- type ListWorkRequestLogsRequest
- type ListWorkRequestLogsResponse
- type ListWorkRequestLogsSortByEnum
- type ListWorkRequestLogsSortOrderEnum
- type ListWorkRequestsRequest
- type ListWorkRequestsResponse
- type ListWorkRequestsSortByEnum
- type ListWorkRequestsSortOrderEnum
- type OdaClient
- func (client OdaClient) ChangeOdaInstanceCompartment(ctx context.Context, request ChangeOdaInstanceCompartmentRequest) (response ChangeOdaInstanceCompartmentResponse, err error)
- func (client *OdaClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client OdaClient) CreateOdaInstance(ctx context.Context, request CreateOdaInstanceRequest) (response CreateOdaInstanceResponse, err error)
- func (client OdaClient) DeleteOdaInstance(ctx context.Context, request DeleteOdaInstanceRequest) (response DeleteOdaInstanceResponse, err error)
- func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)
- func (client OdaClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
- func (client OdaClient) ListOdaInstances(ctx context.Context, request ListOdaInstancesRequest) (response ListOdaInstancesResponse, err error)
- func (client OdaClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
- func (client OdaClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
- func (client OdaClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
- func (client *OdaClient) SetRegion(region string)
- func (client OdaClient) UpdateOdaInstance(ctx context.Context, request UpdateOdaInstanceRequest) (response UpdateOdaInstanceResponse, err error)
- type OdaInstance
- type OdaInstanceLifecycleStateEnum
- type OdaInstanceLifecycleSubStateEnum
- type OdaInstanceShapeNameEnum
- type OdaInstanceSummary
- type OdaInstanceSummaryLifecycleStateEnum
- type OdaInstanceSummaryLifecycleSubStateEnum
- type OdaInstanceSummaryShapeNameEnum
- type UpdateOdaInstanceDetails
- type UpdateOdaInstanceRequest
- type UpdateOdaInstanceResponse
- type WorkRequest
- type WorkRequestError
- type WorkRequestLogEntry
- type WorkRequestRequestActionEnum
- type WorkRequestResource
- type WorkRequestResourceResourceActionEnum
- type WorkRequestResourceStatusEnum
- type WorkRequestStatusEnum
- type WorkRequestSummary
- type WorkRequestSummaryRequestActionEnum
- type WorkRequestSummaryStatusEnum
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 (m ChangeOdaInstanceCompartmentDetails) String() string
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
func (ChangeOdaInstanceCompartmentRequest) HTTPRequest ¶
func (request ChangeOdaInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ChangeOdaInstanceCompartmentRequest) RetryPolicy ¶
func (request ChangeOdaInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ChangeOdaInstanceCompartmentRequest) String ¶
func (request ChangeOdaInstanceCompartmentRequest) String() string
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. The request id consists of 3 components. // The first is the request ID provided by the client in the request headers and the remaining 2 are // generated for tracing requests. // 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 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. Exists for // cross-compatibility only. // 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"` }
CreateOdaInstanceDetails Properties that are required to create a Digital Assistant instance.
func (CreateOdaInstanceDetails) String ¶
func (m CreateOdaInstanceDetails) String() string
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
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
func (CreateOdaInstanceRequest) HTTPRequest ¶
func (request CreateOdaInstanceRequest) HTTPRequest(method, path 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
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 asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this 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 DeleteOdaInstanceRequest ¶
type DeleteOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // 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
func (DeleteOdaInstanceRequest) HTTPRequest ¶
func (request DeleteOdaInstanceRequest) HTTPRequest(method, path 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
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 asynchronous operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this 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 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.
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
func (GetOdaInstanceRequest) HTTPRequest ¶
func (request GetOdaInstanceRequest) HTTPRequest(method, path 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
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 contact Oracle // about this request, provide this 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 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
func (GetWorkRequestRequest) HTTPRequest ¶
func (request GetWorkRequestRequest) HTTPRequest(method, path 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
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 contact Oracle // about this request, provide this 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 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
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
func (ListOdaInstancesRequest) HTTPRequest ¶
func (request ListOdaInstancesRequest) HTTPRequest(method, path 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
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 contact // Oracle about this request, provide this 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"` }
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
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
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
func (ListWorkRequestErrorsRequest) HTTPRequest ¶
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path 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
type ListWorkRequestErrorsResponse ¶
type ListWorkRequestErrorsResponse struct { // The underlying http response RawResponse *http.Response // A list of []WorkRequestError instances Items []WorkRequestError `presentIn:"body"` // 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"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
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
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
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
func (ListWorkRequestLogsRequest) HTTPRequest ¶
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path 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
type ListWorkRequestLogsResponse ¶
type ListWorkRequestLogsResponse struct { // The underlying http response RawResponse *http.Response // A list of []WorkRequestLogEntry instances Items []WorkRequestLogEntry `presentIn:"body"` // 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"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
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
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
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"` // 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
func (ListWorkRequestsRequest) HTTPRequest ¶
func (request ListWorkRequestsRequest) HTTPRequest(method, path 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
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 contact Oracle // about this request, provide this 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"` }
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
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
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 (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.
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}`.
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}`.
func (OdaClient) GetOdaInstance ¶
func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)
GetOdaInstance Gets the specified Digital Assistant instance.
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.
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.
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.
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.
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.
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.
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"` }
OdaInstance Description of `OdaServiceInstance` object.
func (OdaInstance) String ¶
func (m OdaInstance) String() string
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 GetOdaInstanceLifecycleStateEnumValues ¶
func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum
GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum
type OdaInstanceLifecycleSubStateEnum ¶
type OdaInstanceLifecycleSubStateEnum string
OdaInstanceLifecycleSubStateEnum Enum with underlying type: string
const ( OdaInstanceLifecycleSubStateDeletePending OdaInstanceLifecycleSubStateEnum = "DELETE_PENDING" OdaInstanceLifecycleSubStatePurging OdaInstanceLifecycleSubStateEnum = "PURGING" OdaInstanceLifecycleSubStateQueued OdaInstanceLifecycleSubStateEnum = "QUEUED" )
Set of constants representing the allowable values for OdaInstanceLifecycleSubStateEnum
func GetOdaInstanceLifecycleSubStateEnumValues ¶
func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum
GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum
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 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. Exists for cross-compatibility only. // 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"` }
OdaInstanceSummary Summary of the Digital Assistant instance.
func (OdaInstanceSummary) String ¶
func (m OdaInstanceSummary) String() string
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 GetOdaInstanceSummaryLifecycleStateEnumValues ¶
func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum
GetOdaInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleStateEnum
type OdaInstanceSummaryLifecycleSubStateEnum ¶
type OdaInstanceSummaryLifecycleSubStateEnum string
OdaInstanceSummaryLifecycleSubStateEnum Enum with underlying type: string
const ( OdaInstanceSummaryLifecycleSubStateDeletePending OdaInstanceSummaryLifecycleSubStateEnum = "DELETE_PENDING" OdaInstanceSummaryLifecycleSubStatePurging OdaInstanceSummaryLifecycleSubStateEnum = "PURGING" OdaInstanceSummaryLifecycleSubStateQueued OdaInstanceSummaryLifecycleSubStateEnum = "QUEUED" )
Set of constants representing the allowable values for OdaInstanceSummaryLifecycleSubStateEnum
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 GetOdaInstanceSummaryShapeNameEnumValues ¶
func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum
GetOdaInstanceSummaryShapeNameEnumValues Enumerates the set of values for OdaInstanceSummaryShapeNameEnum
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. Exists for // cross-compatibility only. // 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
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
func (UpdateOdaInstanceRequest) HTTPRequest ¶
func (request UpdateOdaInstanceRequest) HTTPRequest(method, path 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
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 contact Oracle // about this request, provide this 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 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 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
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
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
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" WorkRequestRequestActionChangeOdaInstanceCompartment WorkRequestRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT" WorkRequestRequestActionCreateAssociation WorkRequestRequestActionEnum = "CREATE_ASSOCIATION" WorkRequestRequestActionDeleteAssociation WorkRequestRequestActionEnum = "DELETE_ASSOCIATION" WorkRequestRequestActionUpdateEntitlementsForCacct WorkRequestRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" WorkRequestRequestActionLookupOdaInstancesForCacct WorkRequestRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT" )
Set of constants representing the allowable values for WorkRequestRequestActionEnum
func GetWorkRequestRequestActionEnumValues ¶
func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum
GetWorkRequestRequestActionEnumValues Enumerates the set of values for WorkRequestRequestActionEnum
type WorkRequestResource ¶
type WorkRequestResource struct { // The action to take against the Digital Assistant instance. ResourceAction WorkRequestResourceResourceActionEnum `mandatory:"true" json:"resourceAction"` // The resource type that the work request affects. ResourceType *string `mandatory:"true" json:"resourceType"` // The identifier of the Digital Assistant instance 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
type WorkRequestResourceResourceActionEnum ¶
type WorkRequestResourceResourceActionEnum string
WorkRequestResourceResourceActionEnum Enum with underlying type: string
const ( WorkRequestResourceResourceActionCreate WorkRequestResourceResourceActionEnum = "CREATE" WorkRequestResourceResourceActionDelete WorkRequestResourceResourceActionEnum = "DELETE" WorkRequestResourceResourceActionPurge WorkRequestResourceResourceActionEnum = "PURGE" WorkRequestResourceResourceActionRecover WorkRequestResourceResourceActionEnum = "RECOVER" WorkRequestResourceResourceActionChangeCompartment WorkRequestResourceResourceActionEnum = "CHANGE_COMPARTMENT" WorkRequestResourceResourceActionCreateAssociation WorkRequestResourceResourceActionEnum = "CREATE_ASSOCIATION" WorkRequestResourceResourceActionDeleteAssociation WorkRequestResourceResourceActionEnum = "DELETE_ASSOCIATION" WorkRequestResourceResourceActionUpdateEntitlementsForCacct WorkRequestResourceResourceActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" )
Set of constants representing the allowable values for WorkRequestResourceResourceActionEnum
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 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 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 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
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" WorkRequestSummaryRequestActionChangeOdaInstanceCompartment WorkRequestSummaryRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT" WorkRequestSummaryRequestActionCreateAssociation WorkRequestSummaryRequestActionEnum = "CREATE_ASSOCIATION" WorkRequestSummaryRequestActionDeleteAssociation WorkRequestSummaryRequestActionEnum = "DELETE_ASSOCIATION" WorkRequestSummaryRequestActionUpdateEntitlementsForCacct WorkRequestSummaryRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" WorkRequestSummaryRequestActionLookupOdaInstancesForCacct WorkRequestSummaryRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT" )
Set of constants representing the allowable values for WorkRequestSummaryRequestActionEnum
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 GetWorkRequestSummaryStatusEnumValues ¶
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum
Source Files ¶
- change_oda_instance_compartment_details.go
- change_oda_instance_compartment_request_response.go
- create_oda_instance_details.go
- create_oda_instance_request_response.go
- delete_oda_instance_request_response.go
- error_body.go
- get_oda_instance_request_response.go
- get_work_request_request_response.go
- list_oda_instances_request_response.go
- list_work_request_errors_request_response.go
- list_work_request_logs_request_response.go
- list_work_requests_request_response.go
- oda_client.go
- oda_instance.go
- oda_instance_summary.go
- update_oda_instance_details.go
- update_oda_instance_request_response.go
- work_request.go
- work_request_error.go
- work_request_log_entry.go
- work_request_resource.go
- work_request_summary.go