ChangeOdaInstanceCompartmentDetails Properties required to move a Digital Assistant instance from one compartment to another.
type ChangeOdaInstanceCompartmentDetails struct { // Identifier of the compartment into which the Digital Assistant instance should be moved. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeOdaInstanceCompartmentDetails) String() string
ChangeOdaInstanceCompartmentRequest wrapper for the ChangeOdaInstanceCompartment operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ChangeOdaInstanceCompartment.go.html to see an example of how to use ChangeOdaInstanceCompartmentRequest.
type ChangeOdaInstanceCompartmentRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // The compartment to which the Digital Assistant instance should be moved. ChangeOdaInstanceCompartmentDetails `contributesTo:"body"` // For optimistic concurrency control in a PUT or DELETE call for // a Digital Assistant instance, set the `if-match` query parameter // to the value of the `ETAG` header from a previous GET or POST // response for that instance. The service updates or deletes the // instance only if the etag that you provide matches the instance's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so that you can retry the request if there's // a timeout or server error without the risk of executing that same action again. // Retry tokens expire after 24 hours, but they can become invalid before then if there are // conflicting operations. For example, if an instance was deleted and purged from the system, // then the service might reject a retry of the original creation request. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeOdaInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeOdaInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeOdaInstanceCompartmentRequest) String() string
ChangeOdaInstanceCompartmentResponse wrapper for the ChangeOdaInstanceCompartment operation
type ChangeOdaInstanceCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of // the operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. 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"` }
func (response ChangeOdaInstanceCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeOdaInstanceCompartmentResponse) String() string
CreateOdaInstanceDetails Properties that are required to create a Digital Assistant instance.
type CreateOdaInstanceDetails struct { // Identifier of the compartment. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Shape or size of the instance. ShapeName CreateOdaInstanceDetailsShapeNameEnum `mandatory:"true" json:"shapeName"` // User-friendly name for the instance. Avoid entering confidential information. You can change this value anytime. DisplayName *string `mandatory:"false" json:"displayName"` // Description of the Digital Assistant instance. Description *string `mandatory:"false" json:"description"` // Simple key-value pair that is applied without any predefined name, type or scope. 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"` }
func (m CreateOdaInstanceDetails) String() string
CreateOdaInstanceDetailsShapeNameEnum Enum with underlying type: string
type CreateOdaInstanceDetailsShapeNameEnum string
Set of constants representing the allowable values for CreateOdaInstanceDetailsShapeNameEnum
const ( CreateOdaInstanceDetailsShapeNameDevelopment CreateOdaInstanceDetailsShapeNameEnum = "DEVELOPMENT" CreateOdaInstanceDetailsShapeNameProduction CreateOdaInstanceDetailsShapeNameEnum = "PRODUCTION" )
func GetCreateOdaInstanceDetailsShapeNameEnumValues() []CreateOdaInstanceDetailsShapeNameEnum
GetCreateOdaInstanceDetailsShapeNameEnumValues Enumerates the set of values for CreateOdaInstanceDetailsShapeNameEnum
CreateOdaInstanceRequest wrapper for the CreateOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/CreateOdaInstance.go.html to see an example of how to use CreateOdaInstanceRequest.
type CreateOdaInstanceRequest struct { // Details for the new Digital Assistant instance. CreateOdaInstanceDetails `contributesTo:"body"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so that you can retry the request if there's // a timeout or server error without the risk of executing that same action again. // Retry tokens expire after 24 hours, but they can become invalid before then if there are // conflicting operations. For example, if an instance was deleted and purged from the system, // then the service might reject a retry of the original creation request. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateOdaInstanceRequest) String() string
CreateOdaInstanceResponse wrapper for the CreateOdaInstance operation
type CreateOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // The OdaInstance instance OdaInstance `presentIn:"body"` // Fully qualified URL for the newly created instance. Location *string `presentIn:"header" name:"location"` // For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status // of the 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"` }
func (response CreateOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateOdaInstanceResponse) String() string
DeleteOdaInstanceRequest wrapper for the DeleteOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/DeleteOdaInstance.go.html to see an example of how to use DeleteOdaInstanceRequest.
type DeleteOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // For optimistic concurrency control in a PUT or DELETE call for // a Digital Assistant instance, set the `if-match` query parameter // to the value of the `ETAG` header from a previous GET or POST // response for that instance. The service updates or deletes the // instance only if the etag that you provide matches the instance's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteOdaInstanceRequest) String() string
DeleteOdaInstanceResponse wrapper for the DeleteOdaInstance operation
type DeleteOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to // query status of the 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"` }
func (response DeleteOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteOdaInstanceResponse) String() string
ErrorBody Error Information.
type ErrorBody struct { // A short error code that defines the error, which is useful for programmatic parsing. Code *string `mandatory:"true" json:"code"` // A human-readable error string. Message *string `mandatory:"true" json:"message"` }
func (m ErrorBody) String() string
GetOdaInstanceRequest wrapper for the GetOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/GetOdaInstance.go.html to see an example of how to use GetOdaInstanceRequest.
type GetOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetOdaInstanceRequest) String() string
GetOdaInstanceResponse wrapper for the GetOdaInstance operation
type GetOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // The OdaInstance instance OdaInstance `presentIn:"body"` // For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetOdaInstanceResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct { // The identifier of the asynchronous work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct { // The underlying http response RawResponse *http.Response // The WorkRequest instance WorkRequest `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you 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"` }
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ListOdaInstancesLifecycleStateEnum Enum with underlying type: string
type ListOdaInstancesLifecycleStateEnum string
Set of constants representing the allowable values for ListOdaInstancesLifecycleStateEnum
const ( ListOdaInstancesLifecycleStateCreating ListOdaInstancesLifecycleStateEnum = "CREATING" ListOdaInstancesLifecycleStateUpdating ListOdaInstancesLifecycleStateEnum = "UPDATING" ListOdaInstancesLifecycleStateActive ListOdaInstancesLifecycleStateEnum = "ACTIVE" ListOdaInstancesLifecycleStateInactive ListOdaInstancesLifecycleStateEnum = "INACTIVE" ListOdaInstancesLifecycleStateDeleting ListOdaInstancesLifecycleStateEnum = "DELETING" ListOdaInstancesLifecycleStateDeleted ListOdaInstancesLifecycleStateEnum = "DELETED" ListOdaInstancesLifecycleStateFailed ListOdaInstancesLifecycleStateEnum = "FAILED" )
func GetListOdaInstancesLifecycleStateEnumValues() []ListOdaInstancesLifecycleStateEnum
GetListOdaInstancesLifecycleStateEnumValues Enumerates the set of values for ListOdaInstancesLifecycleStateEnum
ListOdaInstancesRequest wrapper for the ListOdaInstances operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListOdaInstances.go.html to see an example of how to use ListOdaInstancesRequest.
type ListOdaInstancesRequest struct { // List the Digital Assistant instances that belong to this compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change. // Example: `My new resource` DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // List only the Digital Assistant instances that are in this lifecycle state. LifecycleState ListOdaInstancesLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // The maximum number of items to return per page. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The page at which to start retrieving results. // You get this value from the `opc-next-page` header in a previous list request. // To retireve the first page, omit this query parameter. // Example: `MToxMA==` Page *string `mandatory:"false" contributesTo:"query" name:"page"` // Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). SortOrder ListOdaInstancesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Sort on this field. You can specify one sort order only. The default sort field is `TIMECREATED`. // The default sort order for `TIMECREATED` is descending, and the default sort order for `DISPLAYNAME` is ascending. SortBy ListOdaInstancesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListOdaInstancesRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOdaInstancesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOdaInstancesRequest) String() string
ListOdaInstancesResponse wrapper for the ListOdaInstances operation
type ListOdaInstancesResponse struct { // The underlying http response RawResponse *http.Response // A list of []OdaInstanceSummary instances Items []OdaInstanceSummary `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you 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"` }
func (response ListOdaInstancesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOdaInstancesResponse) String() string
ListOdaInstancesSortByEnum Enum with underlying type: string
type ListOdaInstancesSortByEnum string
Set of constants representing the allowable values for ListOdaInstancesSortByEnum
const ( ListOdaInstancesSortByTimecreated ListOdaInstancesSortByEnum = "TIMECREATED" ListOdaInstancesSortByDisplayname ListOdaInstancesSortByEnum = "DISPLAYNAME" )
func GetListOdaInstancesSortByEnumValues() []ListOdaInstancesSortByEnum
GetListOdaInstancesSortByEnumValues Enumerates the set of values for ListOdaInstancesSortByEnum
ListOdaInstancesSortOrderEnum Enum with underlying type: string
type ListOdaInstancesSortOrderEnum string
Set of constants representing the allowable values for ListOdaInstancesSortOrderEnum
const ( ListOdaInstancesSortOrderAsc ListOdaInstancesSortOrderEnum = "ASC" ListOdaInstancesSortOrderDesc ListOdaInstancesSortOrderEnum = "DESC" )
func GetListOdaInstancesSortOrderEnumValues() []ListOdaInstancesSortOrderEnum
GetListOdaInstancesSortOrderEnumValues Enumerates the set of values for ListOdaInstancesSortOrderEnum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct { // The identifier of the asynchronous work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The page at which to start retrieving results. // You get this value from the `opc-next-page` header in a previous list request. // To retireve the first page, omit this query parameter. // Example: `MToxMA==` Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The maximum number of items to return per page. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`. // The default sort order for both `TIMESTAMP` and `CODE` is ascending. SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct { // The underlying http response RawResponse *http.Response // A list of []WorkRequestError instances Items []WorkRequestError `presentIn:"body"` // 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"` }
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const ( ListWorkRequestErrorsSortByCode ListWorkRequestErrorsSortByEnum = "CODE" ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "TIMESTAMP" )
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const ( ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC" ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC" )
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct { // The identifier of the asynchronous work request. WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // The page at which to start retrieving results. // You get this value from the `opc-next-page` header in a previous list request. // To retireve the first page, omit this query parameter. // Example: `MToxMA==` Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The maximum number of items to return per page. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`. // The default sort order for both `TIMESTAMP` and `MESSAGE` is ascending. SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct { // The underlying http response RawResponse *http.Response // A list of []WorkRequestLogEntry instances Items []WorkRequestLogEntry `presentIn:"body"` // 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"` }
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const ( ListWorkRequestLogsSortByMessage ListWorkRequestLogsSortByEnum = "MESSAGE" ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "TIMESTAMP" )
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const ( ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC" ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC" )
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct { // List the Digital Assistant instances that belong to this compartment. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // List only the information for this Digital Assistant instance. OdaInstanceId *string `mandatory:"false" contributesTo:"query" name:"odaInstanceId"` // The page at which to start retrieving results. // You get this value from the `opc-next-page` header in a previous list request. // To retireve the first page, omit this query parameter. // Example: `MToxMA==` Page *string `mandatory:"false" contributesTo:"query" name:"page"` // The maximum number of items to return per page. Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIME_ACCEPTED`. // The default sort order for the time fields is descending. The default order for `DISPLAYNAME` and `STATUS` is ascending.default: TIME_ACCEPTED SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending). SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct { // The underlying http response RawResponse *http.Response // A list of []WorkRequestSummary instances Items []WorkRequestSummary `presentIn:"body"` // Unique Oracle-assigned identifier for the request. If you 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"` }
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const ( ListWorkRequestsSortByOperationType ListWorkRequestsSortByEnum = "OPERATION_TYPE" ListWorkRequestsSortByStatus ListWorkRequestsSortByEnum = "STATUS" ListWorkRequestsSortByTimeAccepted ListWorkRequestsSortByEnum = "TIME_ACCEPTED" ListWorkRequestsSortByTimeStarted ListWorkRequestsSortByEnum = "TIME_STARTED" ListWorkRequestsSortByTimeFinished ListWorkRequestsSortByEnum = "TIME_FINISHED" )
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const ( ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC" ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC" )
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
OdaClient a client for Oda
type OdaClient struct { common.BaseClient // contains filtered or unexported fields }
func NewOdaClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OdaClient, err error)
NewOdaClientWithConfigurationProvider Creates a new default Oda client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOdaClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OdaClient, err error)
NewOdaClientWithOboToken Creates a new default Oda client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client OdaClient) ChangeOdaInstanceCompartment(ctx context.Context, request ChangeOdaInstanceCompartmentRequest) (response ChangeOdaInstanceCompartmentResponse, err error)
ChangeOdaInstanceCompartment Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ChangeOdaInstanceCompartment.go.html to see an example of how to use ChangeOdaInstanceCompartment API.
func (client *OdaClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OdaClient) CreateOdaInstance(ctx context.Context, request CreateOdaInstanceRequest) (response CreateOdaInstanceResponse, err error)
CreateOdaInstance Starts an asynchronous job to create a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/CreateOdaInstance.go.html to see an example of how to use CreateOdaInstance API.
func (client OdaClient) DeleteOdaInstance(ctx context.Context, request DeleteOdaInstanceRequest) (response DeleteOdaInstanceResponse, err error)
DeleteOdaInstance Starts an asynchronous job to delete the specified Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/DeleteOdaInstance.go.html to see an example of how to use DeleteOdaInstance API.
func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)
GetOdaInstance Gets the specified Digital Assistant instance.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/GetOdaInstance.go.html to see an example of how to use GetOdaInstance API.
func (client OdaClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client OdaClient) ListOdaInstances(ctx context.Context, request ListOdaInstancesRequest) (response ListOdaInstancesResponse, err error)
ListOdaInstances Returns a page of Digital Assistant instances that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListOdaInstances.go.html to see an example of how to use ListOdaInstances API.
func (client OdaClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Returns a page of errors for the specified work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client OdaClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Returns a page of of log messages for a given work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client OdaClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Returns a page of work requests for the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *OdaClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client OdaClient) StartOdaInstance(ctx context.Context, request StartOdaInstanceRequest) (response StartOdaInstanceResponse, err error)
StartOdaInstance Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/StartOdaInstance.go.html to see an example of how to use StartOdaInstance API.
func (client OdaClient) StopOdaInstance(ctx context.Context, request StopOdaInstanceRequest) (response StopOdaInstanceResponse, err error)
StopOdaInstance Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/StopOdaInstance.go.html to see an example of how to use StopOdaInstance API.
func (client OdaClient) UpdateOdaInstance(ctx context.Context, request UpdateOdaInstanceRequest) (response UpdateOdaInstanceResponse, err error)
UpdateOdaInstance Updates the specified Digital Assistant instance with the information in the request body.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/UpdateOdaInstance.go.html to see an example of how to use UpdateOdaInstance API.
OdaInstance Description of `OdaServiceInstance` object.
type OdaInstance struct { // Unique immutable identifier that was assigned when the instance was created. Id *string `mandatory:"true" json:"id"` // Identifier of the compartment that the instance belongs to. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Shape or size of the instance. ShapeName OdaInstanceShapeNameEnum `mandatory:"true" json:"shapeName"` // User-defined name for the Digital Assistant instance. Avoid entering confidential information. // You can change this value. DisplayName *string `mandatory:"false" json:"displayName"` // Description of the Digital Assistant instance. Description *string `mandatory:"false" json:"description"` // URL for the Digital Assistant web application that's associated with the instance. WebAppUrl *string `mandatory:"false" json:"webAppUrl"` // URL for the connector's endpoint. ConnectorUrl *string `mandatory:"false" json:"connectorUrl"` // When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // When the Digital Assistance instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current state of the Digital Assistant instance. LifecycleState OdaInstanceLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"` // The current sub-state of the Digital Assistant instance. LifecycleSubState OdaInstanceLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"` // A message that describes the current state in more detail. // For example, actionable information about an instance that's in the `FAILED` state. StateMessage *string `mandatory:"false" json:"stateMessage"` // Simple key-value pair that is applied without any predefined name, type, or scope. // Example: `{"bar-key": "value"}` FreeformTags map[string]string `mandatory:"false" json:"freeformTags"` // Usage of predefined tag keys. These predefined keys are scoped to namespaces. // Example: `{"foo-namespace": {"bar-key": "value"}}` DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"` }
func (m OdaInstance) String() string
OdaInstanceLifecycleStateEnum Enum with underlying type: string
type OdaInstanceLifecycleStateEnum string
Set of constants representing the allowable values for OdaInstanceLifecycleStateEnum
const ( OdaInstanceLifecycleStateCreating OdaInstanceLifecycleStateEnum = "CREATING" OdaInstanceLifecycleStateUpdating OdaInstanceLifecycleStateEnum = "UPDATING" OdaInstanceLifecycleStateActive OdaInstanceLifecycleStateEnum = "ACTIVE" OdaInstanceLifecycleStateInactive OdaInstanceLifecycleStateEnum = "INACTIVE" OdaInstanceLifecycleStateDeleting OdaInstanceLifecycleStateEnum = "DELETING" OdaInstanceLifecycleStateDeleted OdaInstanceLifecycleStateEnum = "DELETED" OdaInstanceLifecycleStateFailed OdaInstanceLifecycleStateEnum = "FAILED" )
func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum
GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum
OdaInstanceLifecycleSubStateEnum Enum with underlying type: string
type OdaInstanceLifecycleSubStateEnum string
Set of constants representing the allowable values for OdaInstanceLifecycleSubStateEnum
const ( OdaInstanceLifecycleSubStateCreating OdaInstanceLifecycleSubStateEnum = "CREATING" OdaInstanceLifecycleSubStateStarting OdaInstanceLifecycleSubStateEnum = "STARTING" OdaInstanceLifecycleSubStateStopping OdaInstanceLifecycleSubStateEnum = "STOPPING" OdaInstanceLifecycleSubStateChangingCompartment OdaInstanceLifecycleSubStateEnum = "CHANGING_COMPARTMENT" OdaInstanceLifecycleSubStateDeleting OdaInstanceLifecycleSubStateEnum = "DELETING" OdaInstanceLifecycleSubStateDeletePending OdaInstanceLifecycleSubStateEnum = "DELETE_PENDING" OdaInstanceLifecycleSubStateRecovering OdaInstanceLifecycleSubStateEnum = "RECOVERING" OdaInstanceLifecycleSubStatePurging OdaInstanceLifecycleSubStateEnum = "PURGING" OdaInstanceLifecycleSubStateQueued OdaInstanceLifecycleSubStateEnum = "QUEUED" )
func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum
GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum
OdaInstanceShapeNameEnum Enum with underlying type: string
type OdaInstanceShapeNameEnum string
Set of constants representing the allowable values for OdaInstanceShapeNameEnum
const ( OdaInstanceShapeNameDevelopment OdaInstanceShapeNameEnum = "DEVELOPMENT" OdaInstanceShapeNameProduction OdaInstanceShapeNameEnum = "PRODUCTION" )
func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum
GetOdaInstanceShapeNameEnumValues Enumerates the set of values for OdaInstanceShapeNameEnum
OdaInstanceSummary Summary of the Digital Assistant instance.
type OdaInstanceSummary struct { // Unique identifier of the Digital Assistant instance. Id *string `mandatory:"true" json:"id"` // Identifier of the compartment that the instance belongs to. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The current state of the instance. LifecycleState OdaInstanceSummaryLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // User-defined name for the Digital Assistant instance. You can change this value. DisplayName *string `mandatory:"false" json:"displayName"` // Description of the Digital Assistant instance. Description *string `mandatory:"false" json:"description"` // Shape or size of the instance. ShapeName OdaInstanceSummaryShapeNameEnum `mandatory:"false" json:"shapeName,omitempty"` // When the Digital Assistant instance was created. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"` // When the Digital Assistant instance was last updated. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"` // The current sub-state of the Digital Assistant instance. LifecycleSubState OdaInstanceSummaryLifecycleSubStateEnum `mandatory:"false" json:"lifecycleSubState,omitempty"` // A message describing the current state in more detail. For example, actionable // information about an instance that's in the `FAILED` state. StateMessage *string `mandatory:"false" json:"stateMessage"` // Simple key-value pair that is applied without any predefined name, type or scope. 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"` }
func (m OdaInstanceSummary) String() string
OdaInstanceSummaryLifecycleStateEnum Enum with underlying type: string
type OdaInstanceSummaryLifecycleStateEnum string
Set of constants representing the allowable values for OdaInstanceSummaryLifecycleStateEnum
const ( OdaInstanceSummaryLifecycleStateCreating OdaInstanceSummaryLifecycleStateEnum = "CREATING" OdaInstanceSummaryLifecycleStateUpdating OdaInstanceSummaryLifecycleStateEnum = "UPDATING" OdaInstanceSummaryLifecycleStateActive OdaInstanceSummaryLifecycleStateEnum = "ACTIVE" OdaInstanceSummaryLifecycleStateInactive OdaInstanceSummaryLifecycleStateEnum = "INACTIVE" OdaInstanceSummaryLifecycleStateDeleting OdaInstanceSummaryLifecycleStateEnum = "DELETING" OdaInstanceSummaryLifecycleStateDeleted OdaInstanceSummaryLifecycleStateEnum = "DELETED" OdaInstanceSummaryLifecycleStateFailed OdaInstanceSummaryLifecycleStateEnum = "FAILED" )
func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum
GetOdaInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleStateEnum
OdaInstanceSummaryLifecycleSubStateEnum Enum with underlying type: string
type OdaInstanceSummaryLifecycleSubStateEnum string
Set of constants representing the allowable values for OdaInstanceSummaryLifecycleSubStateEnum
const ( OdaInstanceSummaryLifecycleSubStateCreating OdaInstanceSummaryLifecycleSubStateEnum = "CREATING" OdaInstanceSummaryLifecycleSubStateStarting OdaInstanceSummaryLifecycleSubStateEnum = "STARTING" OdaInstanceSummaryLifecycleSubStateStopping OdaInstanceSummaryLifecycleSubStateEnum = "STOPPING" OdaInstanceSummaryLifecycleSubStateChangingCompartment OdaInstanceSummaryLifecycleSubStateEnum = "CHANGING_COMPARTMENT" OdaInstanceSummaryLifecycleSubStateDeleting OdaInstanceSummaryLifecycleSubStateEnum = "DELETING" OdaInstanceSummaryLifecycleSubStateDeletePending OdaInstanceSummaryLifecycleSubStateEnum = "DELETE_PENDING" OdaInstanceSummaryLifecycleSubStateRecovering OdaInstanceSummaryLifecycleSubStateEnum = "RECOVERING" OdaInstanceSummaryLifecycleSubStatePurging OdaInstanceSummaryLifecycleSubStateEnum = "PURGING" OdaInstanceSummaryLifecycleSubStateQueued OdaInstanceSummaryLifecycleSubStateEnum = "QUEUED" )
func GetOdaInstanceSummaryLifecycleSubStateEnumValues() []OdaInstanceSummaryLifecycleSubStateEnum
GetOdaInstanceSummaryLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleSubStateEnum
OdaInstanceSummaryShapeNameEnum Enum with underlying type: string
type OdaInstanceSummaryShapeNameEnum string
Set of constants representing the allowable values for OdaInstanceSummaryShapeNameEnum
const ( OdaInstanceSummaryShapeNameDevelopment OdaInstanceSummaryShapeNameEnum = "DEVELOPMENT" OdaInstanceSummaryShapeNameProduction OdaInstanceSummaryShapeNameEnum = "PRODUCTION" )
func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum
GetOdaInstanceSummaryShapeNameEnumValues Enumerates the set of values for OdaInstanceSummaryShapeNameEnum
StartOdaInstanceRequest wrapper for the StartOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/StartOdaInstance.go.html to see an example of how to use StartOdaInstanceRequest.
type StartOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For optimistic concurrency control in a PUT or DELETE call for // a Digital Assistant instance, set the `if-match` query parameter // to the value of the `ETAG` header from a previous GET or POST // response for that instance. The service updates or deletes the // instance only if the etag that you provide matches the instance's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // A token that uniquely identifies a request so that you can retry the request if there's // a timeout or server error without the risk of executing that same action again. // Retry tokens expire after 24 hours, but they can become invalid before then if there are // conflicting operations. For example, if an instance was deleted and purged from the system, // then the service might reject a retry of the original creation request. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request StartOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartOdaInstanceRequest) String() string
StartOdaInstanceResponse wrapper for the StartOdaInstance operation
type StartOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of // the operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. 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"` }
func (response StartOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartOdaInstanceResponse) String() string
StopOdaInstanceRequest wrapper for the StopOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/StopOdaInstance.go.html to see an example of how to use StopOdaInstanceRequest.
type StopOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // For optimistic concurrency control in a PUT or DELETE call for // a Digital Assistant instance, set the `if-match` query parameter // to the value of the `ETAG` header from a previous GET or POST // response for that instance. The service updates or deletes the // instance only if the etag that you provide matches the instance's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // A token that uniquely identifies a request so that you can retry the request if there's // a timeout or server error without the risk of executing that same action again. // Retry tokens expire after 24 hours, but they can become invalid before then if there are // conflicting operations. For example, if an instance was deleted and purged from the system, // then the service might reject a retry of the original creation request. OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request StopOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopOdaInstanceRequest) String() string
StopOdaInstanceResponse wrapper for the StopOdaInstance operation
type StopOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of // the operation. OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"` // Unique Oracle-assigned identifier for the request. 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"` }
func (response StopOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopOdaInstanceResponse) String() string
UpdateOdaInstanceDetails The Digital Assistant instance information to be updated.
type UpdateOdaInstanceDetails struct { // User-friendly name for the Digital Assistant instance. DisplayName *string `mandatory:"false" json:"displayName"` // Description of the Digital Assistant instance. Description *string `mandatory:"false" json:"description"` // Simple key-value pair that is applied without any predefined name, type or scope. 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"` }
func (m UpdateOdaInstanceDetails) String() string
UpdateOdaInstanceRequest wrapper for the UpdateOdaInstance operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/36.1.0/oda/UpdateOdaInstance.go.html to see an example of how to use UpdateOdaInstanceRequest.
type UpdateOdaInstanceRequest struct { // Unique Digital Assistant instance identifier. OdaInstanceId *string `mandatory:"true" contributesTo:"path" name:"odaInstanceId"` // The information to update. UpdateOdaInstanceDetails `contributesTo:"body"` // For optimistic concurrency control in a PUT or DELETE call for // a Digital Assistant instance, set the `if-match` query parameter // to the value of the `ETAG` header from a previous GET or POST // response for that instance. The service updates or deletes the // instance only if the etag that you provide matches the instance's // current etag value. IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"` // The client request ID for tracing. This value is included in the opc-request-id response header. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateOdaInstanceRequest) String() string
UpdateOdaInstanceResponse wrapper for the UpdateOdaInstance operation
type UpdateOdaInstanceResponse struct { // The underlying http response RawResponse *http.Response // The OdaInstance instance OdaInstance `presentIn:"body"` // For use in a PUT or DELETE `if-match` query parameter for optimistic concurrency control. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you contact Oracle // about this request, provide this request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateOdaInstanceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateOdaInstanceResponse) String() string
WorkRequest The description of work request, including its status.
type WorkRequest struct { // The identifier of the work request. Id *string `mandatory:"true" json:"id"` // The identifier of the compartment that contains the work request. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The identifier of the Digital Assistant instance to which this work request pertains. OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"` // The type of the operation that's associated with the work request. RequestAction WorkRequestRequestActionEnum `mandatory:"true" json:"requestAction"` // The status of current work request. Status WorkRequestStatusEnum `mandatory:"true" json:"status"` // The resources that this work request affects. Resources []WorkRequestResource `mandatory:"true" json:"resources"` // Percentage of the request completed. PercentComplete *float32 `mandatory:"true" json:"percentComplete"` // The date and time that the request was created, as described in // RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"` // A short message that provides more detail about the current status. // For example, if a work request fails, then this may include information // about why it failed. StatusMessage *string `mandatory:"false" json:"statusMessage"` // The date and time that the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), CKQ // section 14.29. TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"` // The date and time that the object finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339). CKQ TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"` }
func (m WorkRequest) String() string
WorkRequestError Description of the unexpected error that prevented completion of the request.
type WorkRequestError struct { // A machine-usable code for the error that occurred. Error codes are listed at // (https://docs.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"` }
func (m WorkRequestError) String() string
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct { // Human-readable log message. Message *string `mandatory:"true" json:"message"` // When the log message was written. A date-time string as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29. TimeStamp *common.SDKTime `mandatory:"true" json:"timeStamp"` }
func (m WorkRequestLogEntry) String() string
WorkRequestRequestActionEnum Enum with underlying type: string
type WorkRequestRequestActionEnum string
Set of constants representing the allowable values for WorkRequestRequestActionEnum
const ( WorkRequestRequestActionCreateOdaInstance WorkRequestRequestActionEnum = "CREATE_ODA_INSTANCE" WorkRequestRequestActionUpgradeOdaInstance WorkRequestRequestActionEnum = "UPGRADE_ODA_INSTANCE" WorkRequestRequestActionDeleteOdaInstance WorkRequestRequestActionEnum = "DELETE_ODA_INSTANCE" WorkRequestRequestActionPurgeOdaInstance WorkRequestRequestActionEnum = "PURGE_ODA_INSTANCE" WorkRequestRequestActionRecoverOdaInstance WorkRequestRequestActionEnum = "RECOVER_ODA_INSTANCE" WorkRequestRequestActionStopOdaInstance WorkRequestRequestActionEnum = "STOP_ODA_INSTANCE" WorkRequestRequestActionStartOdaInstance WorkRequestRequestActionEnum = "START_ODA_INSTANCE" WorkRequestRequestActionChangeOdaInstanceCompartment WorkRequestRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT" WorkRequestRequestActionCreateAssociation WorkRequestRequestActionEnum = "CREATE_ASSOCIATION" WorkRequestRequestActionDeleteAssociation WorkRequestRequestActionEnum = "DELETE_ASSOCIATION" WorkRequestRequestActionUpdateEntitlementsForCacct WorkRequestRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" WorkRequestRequestActionLookupOdaInstancesForCacct WorkRequestRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT" )
func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum
GetWorkRequestRequestActionEnumValues Enumerates the set of values for WorkRequestRequestActionEnum
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct { // The action to take against the 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"` }
func (m WorkRequestResource) String() string
WorkRequestResourceResourceActionEnum Enum with underlying type: string
type WorkRequestResourceResourceActionEnum string
Set of constants representing the allowable values for WorkRequestResourceResourceActionEnum
const ( WorkRequestResourceResourceActionCreate WorkRequestResourceResourceActionEnum = "CREATE" WorkRequestResourceResourceActionDelete WorkRequestResourceResourceActionEnum = "DELETE" WorkRequestResourceResourceActionPurge WorkRequestResourceResourceActionEnum = "PURGE" WorkRequestResourceResourceActionRecover WorkRequestResourceResourceActionEnum = "RECOVER" WorkRequestResourceResourceActionStop WorkRequestResourceResourceActionEnum = "STOP" WorkRequestResourceResourceActionStart WorkRequestResourceResourceActionEnum = "START" WorkRequestResourceResourceActionChangeCompartment WorkRequestResourceResourceActionEnum = "CHANGE_COMPARTMENT" WorkRequestResourceResourceActionCreateAssociation WorkRequestResourceResourceActionEnum = "CREATE_ASSOCIATION" WorkRequestResourceResourceActionDeleteAssociation WorkRequestResourceResourceActionEnum = "DELETE_ASSOCIATION" WorkRequestResourceResourceActionUpdateEntitlementsForCacct WorkRequestResourceResourceActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" )
func GetWorkRequestResourceResourceActionEnumValues() []WorkRequestResourceResourceActionEnum
GetWorkRequestResourceResourceActionEnumValues Enumerates the set of values for WorkRequestResourceResourceActionEnum
WorkRequestResourceStatusEnum Enum with underlying type: string
type WorkRequestResourceStatusEnum string
Set of constants representing the allowable values for WorkRequestResourceStatusEnum
const ( WorkRequestResourceStatusAccepted WorkRequestResourceStatusEnum = "ACCEPTED" WorkRequestResourceStatusInProgress WorkRequestResourceStatusEnum = "IN_PROGRESS" WorkRequestResourceStatusSucceeded WorkRequestResourceStatusEnum = "SUCCEEDED" WorkRequestResourceStatusFailed WorkRequestResourceStatusEnum = "FAILED" WorkRequestResourceStatusCanceling WorkRequestResourceStatusEnum = "CANCELING" WorkRequestResourceStatusCanceled WorkRequestResourceStatusEnum = "CANCELED" )
func GetWorkRequestResourceStatusEnumValues() []WorkRequestResourceStatusEnum
GetWorkRequestResourceStatusEnumValues Enumerates the set of values for WorkRequestResourceStatusEnum
WorkRequestStatusEnum Enum with underlying type: string
type WorkRequestStatusEnum string
Set of constants representing the allowable values for WorkRequestStatusEnum
const ( WorkRequestStatusAccepted WorkRequestStatusEnum = "ACCEPTED" WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS" WorkRequestStatusSucceeded WorkRequestStatusEnum = "SUCCEEDED" WorkRequestStatusFailed WorkRequestStatusEnum = "FAILED" WorkRequestStatusCanceling WorkRequestStatusEnum = "CANCELING" WorkRequestStatusCanceled WorkRequestStatusEnum = "CANCELED" )
func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum
WorkRequestSummary A description of the work request's status.
type WorkRequestSummary struct { // The identifier of the work request. Id *string `mandatory:"true" json:"id"` // The identifier of the compartment that contains the work request. CompartmentId *string `mandatory:"true" json:"compartmentId"` // The identifier of the Digital Assistant instance to which this work request pertains. OdaInstanceId *string `mandatory:"true" json:"odaInstanceId"` // The type of the operation that's associated with the work request. RequestAction WorkRequestSummaryRequestActionEnum `mandatory:"true" json:"requestAction"` // The status of current work request. Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"` // The resources that this work request affects. Resources []WorkRequestResource `mandatory:"true" json:"resources"` }
func (m WorkRequestSummary) String() string
WorkRequestSummaryRequestActionEnum Enum with underlying type: string
type WorkRequestSummaryRequestActionEnum string
Set of constants representing the allowable values for WorkRequestSummaryRequestActionEnum
const ( WorkRequestSummaryRequestActionCreateOdaInstance WorkRequestSummaryRequestActionEnum = "CREATE_ODA_INSTANCE" WorkRequestSummaryRequestActionUpgradeOdaInstance WorkRequestSummaryRequestActionEnum = "UPGRADE_ODA_INSTANCE" WorkRequestSummaryRequestActionDeleteOdaInstance WorkRequestSummaryRequestActionEnum = "DELETE_ODA_INSTANCE" WorkRequestSummaryRequestActionPurgeOdaInstance WorkRequestSummaryRequestActionEnum = "PURGE_ODA_INSTANCE" WorkRequestSummaryRequestActionRecoverOdaInstance WorkRequestSummaryRequestActionEnum = "RECOVER_ODA_INSTANCE" WorkRequestSummaryRequestActionStopOdaInstance WorkRequestSummaryRequestActionEnum = "STOP_ODA_INSTANCE" WorkRequestSummaryRequestActionStartOdaInstance WorkRequestSummaryRequestActionEnum = "START_ODA_INSTANCE" WorkRequestSummaryRequestActionChangeOdaInstanceCompartment WorkRequestSummaryRequestActionEnum = "CHANGE_ODA_INSTANCE_COMPARTMENT" WorkRequestSummaryRequestActionCreateAssociation WorkRequestSummaryRequestActionEnum = "CREATE_ASSOCIATION" WorkRequestSummaryRequestActionDeleteAssociation WorkRequestSummaryRequestActionEnum = "DELETE_ASSOCIATION" WorkRequestSummaryRequestActionUpdateEntitlementsForCacct WorkRequestSummaryRequestActionEnum = "UPDATE_ENTITLEMENTS_FOR_CACCT" WorkRequestSummaryRequestActionLookupOdaInstancesForCacct WorkRequestSummaryRequestActionEnum = "LOOKUP_ODA_INSTANCES_FOR_CACCT" )
func GetWorkRequestSummaryRequestActionEnumValues() []WorkRequestSummaryRequestActionEnum
GetWorkRequestSummaryRequestActionEnumValues Enumerates the set of values for WorkRequestSummaryRequestActionEnum
WorkRequestSummaryStatusEnum Enum with underlying type: string
type WorkRequestSummaryStatusEnum string
Set of constants representing the allowable values for WorkRequestSummaryStatusEnum
const ( WorkRequestSummaryStatusAccepted WorkRequestSummaryStatusEnum = "ACCEPTED" WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS" WorkRequestSummaryStatusSucceeded WorkRequestSummaryStatusEnum = "SUCCEEDED" WorkRequestSummaryStatusFailed WorkRequestSummaryStatusEnum = "FAILED" WorkRequestSummaryStatusCanceling WorkRequestSummaryStatusEnum = "CANCELING" WorkRequestSummaryStatusCanceled WorkRequestSummaryStatusEnum = "CANCELED" )
func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum
GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum