...

Package oda

import "github.com/oracle/oci-go-sdk/oda"
Overview
Index

Overview ▾

Index ▾

type ChangeOdaInstanceCompartmentDetails
    func (m ChangeOdaInstanceCompartmentDetails) String() string
type ChangeOdaInstanceCompartmentRequest
    func (request ChangeOdaInstanceCompartmentRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ChangeOdaInstanceCompartmentRequest) RetryPolicy() *common.RetryPolicy
    func (request ChangeOdaInstanceCompartmentRequest) String() string
type ChangeOdaInstanceCompartmentResponse
    func (response ChangeOdaInstanceCompartmentResponse) HTTPResponse() *http.Response
    func (response ChangeOdaInstanceCompartmentResponse) String() string
type CreateOdaInstanceDetails
    func (m CreateOdaInstanceDetails) String() string
type CreateOdaInstanceDetailsShapeNameEnum
    func GetCreateOdaInstanceDetailsShapeNameEnumValues() []CreateOdaInstanceDetailsShapeNameEnum
type CreateOdaInstanceRequest
    func (request CreateOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request CreateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request CreateOdaInstanceRequest) String() string
type CreateOdaInstanceResponse
    func (response CreateOdaInstanceResponse) HTTPResponse() *http.Response
    func (response CreateOdaInstanceResponse) String() string
type DeleteOdaInstanceRequest
    func (request DeleteOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request DeleteOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request DeleteOdaInstanceRequest) String() string
type DeleteOdaInstanceResponse
    func (response DeleteOdaInstanceResponse) HTTPResponse() *http.Response
    func (response DeleteOdaInstanceResponse) String() string
type ErrorBody
    func (m ErrorBody) String() string
type GetOdaInstanceRequest
    func (request GetOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request GetOdaInstanceRequest) String() string
type GetOdaInstanceResponse
    func (response GetOdaInstanceResponse) HTTPResponse() *http.Response
    func (response GetOdaInstanceResponse) String() string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type ListOdaInstancesLifecycleStateEnum
    func GetListOdaInstancesLifecycleStateEnumValues() []ListOdaInstancesLifecycleStateEnum
type ListOdaInstancesRequest
    func (request ListOdaInstancesRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListOdaInstancesRequest) RetryPolicy() *common.RetryPolicy
    func (request ListOdaInstancesRequest) String() string
type ListOdaInstancesResponse
    func (response ListOdaInstancesResponse) HTTPResponse() *http.Response
    func (response ListOdaInstancesResponse) String() string
type ListOdaInstancesSortByEnum
    func GetListOdaInstancesSortByEnumValues() []ListOdaInstancesSortByEnum
type ListOdaInstancesSortOrderEnum
    func GetListOdaInstancesSortOrderEnumValues() []ListOdaInstancesSortOrderEnum
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum
    func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum
    func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum
    func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
type ListWorkRequestsSortOrderEnum
    func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
type OdaClient
    func NewOdaClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OdaClient, err error)
    func NewOdaClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OdaClient, err error)
    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) StartOdaInstance(ctx context.Context, request StartOdaInstanceRequest) (response StartOdaInstanceResponse, err error)
    func (client OdaClient) StopOdaInstance(ctx context.Context, request StopOdaInstanceRequest) (response StopOdaInstanceResponse, err error)
    func (client OdaClient) UpdateOdaInstance(ctx context.Context, request UpdateOdaInstanceRequest) (response UpdateOdaInstanceResponse, err error)
type OdaInstance
    func (m OdaInstance) String() string
type OdaInstanceLifecycleStateEnum
    func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum
type OdaInstanceLifecycleSubStateEnum
    func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum
type OdaInstanceShapeNameEnum
    func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum
type OdaInstanceSummary
    func (m OdaInstanceSummary) String() string
type OdaInstanceSummaryLifecycleStateEnum
    func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum
type OdaInstanceSummaryLifecycleSubStateEnum
    func GetOdaInstanceSummaryLifecycleSubStateEnumValues() []OdaInstanceSummaryLifecycleSubStateEnum
type OdaInstanceSummaryShapeNameEnum
    func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum
type StartOdaInstanceRequest
    func (request StartOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request StartOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request StartOdaInstanceRequest) String() string
type StartOdaInstanceResponse
    func (response StartOdaInstanceResponse) HTTPResponse() *http.Response
    func (response StartOdaInstanceResponse) String() string
type StopOdaInstanceRequest
    func (request StopOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request StopOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request StopOdaInstanceRequest) String() string
type StopOdaInstanceResponse
    func (response StopOdaInstanceResponse) HTTPResponse() *http.Response
    func (response StopOdaInstanceResponse) String() string
type UpdateOdaInstanceDetails
    func (m UpdateOdaInstanceDetails) String() string
type UpdateOdaInstanceRequest
    func (request UpdateOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)
    func (request UpdateOdaInstanceRequest) RetryPolicy() *common.RetryPolicy
    func (request UpdateOdaInstanceRequest) String() string
type UpdateOdaInstanceResponse
    func (response UpdateOdaInstanceResponse) HTTPResponse() *http.Response
    func (response UpdateOdaInstanceResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
type WorkRequestError
    func (m WorkRequestError) String() string
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
type WorkRequestRequestActionEnum
    func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum
type WorkRequestResource
    func (m WorkRequestResource) String() string
type WorkRequestResourceResourceActionEnum
    func GetWorkRequestResourceResourceActionEnumValues() []WorkRequestResourceResourceActionEnum
type WorkRequestResourceStatusEnum
    func GetWorkRequestResourceStatusEnumValues() []WorkRequestResourceStatusEnum
type WorkRequestStatusEnum
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
type WorkRequestSummaryRequestActionEnum
    func GetWorkRequestSummaryRequestActionEnumValues() []WorkRequestSummaryRequestActionEnum
type WorkRequestSummaryStatusEnum
    func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

Package 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 start_oda_instance_request_response.go stop_oda_instance_request_response.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

type ChangeOdaInstanceCompartmentDetails

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 (ChangeOdaInstanceCompartmentDetails) String

func (m ChangeOdaInstanceCompartmentDetails) String() string

type ChangeOdaInstanceCompartmentRequest

ChangeOdaInstanceCompartmentRequest wrapper for the ChangeOdaInstanceCompartment operation

See also

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 (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

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 (ChangeOdaInstanceCompartmentResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ChangeOdaInstanceCompartmentResponse) String

func (response ChangeOdaInstanceCompartmentResponse) String() string

type CreateOdaInstanceDetails

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 (CreateOdaInstanceDetails) String

func (m CreateOdaInstanceDetails) String() string

type CreateOdaInstanceDetailsShapeNameEnum

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

func GetCreateOdaInstanceDetailsShapeNameEnumValues() []CreateOdaInstanceDetailsShapeNameEnum

GetCreateOdaInstanceDetailsShapeNameEnumValues Enumerates the set of values for CreateOdaInstanceDetailsShapeNameEnum

type CreateOdaInstanceRequest

CreateOdaInstanceRequest wrapper for the CreateOdaInstance operation

See also

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 (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

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 (CreateOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (CreateOdaInstanceResponse) String

func (response CreateOdaInstanceResponse) String() string

type DeleteOdaInstanceRequest

DeleteOdaInstanceRequest wrapper for the DeleteOdaInstance operation

See also

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 (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

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 (DeleteOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (DeleteOdaInstanceResponse) String

func (response DeleteOdaInstanceResponse) String() string

type ErrorBody

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 (ErrorBody) String

func (m ErrorBody) String() string

type GetOdaInstanceRequest

GetOdaInstanceRequest wrapper for the GetOdaInstance operation

See also

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 (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

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 (GetOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetOdaInstanceResponse) String

func (response GetOdaInstanceResponse) String() string

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

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 (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

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 (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type ListOdaInstancesLifecycleStateEnum

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

func GetListOdaInstancesLifecycleStateEnumValues() []ListOdaInstancesLifecycleStateEnum

GetListOdaInstancesLifecycleStateEnumValues Enumerates the set of values for ListOdaInstancesLifecycleStateEnum

type ListOdaInstancesRequest

ListOdaInstancesRequest wrapper for the ListOdaInstances operation

See also

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 (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

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 (ListOdaInstancesResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListOdaInstancesResponse) String

func (response ListOdaInstancesResponse) String() string

type ListOdaInstancesSortByEnum

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

func GetListOdaInstancesSortByEnumValues() []ListOdaInstancesSortByEnum

GetListOdaInstancesSortByEnumValues Enumerates the set of values for ListOdaInstancesSortByEnum

type ListOdaInstancesSortOrderEnum

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

func GetListOdaInstancesSortOrderEnumValues() []ListOdaInstancesSortOrderEnum

GetListOdaInstancesSortOrderEnumValues Enumerates the set of values for ListOdaInstancesSortOrderEnum

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

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 (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

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 (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

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

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortOrderEnum

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

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

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 (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

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 (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

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

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortOrderEnum

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

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

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 (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

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 (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

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

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

type ListWorkRequestsSortOrderEnum

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

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

type OdaClient

OdaClient a client for Oda

type OdaClient struct {
    common.BaseClient
    // contains filtered or unexported fields
}

func NewOdaClientWithConfigurationProvider

func NewOdaClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OdaClient, err error)

NewOdaClientWithConfigurationProvider Creates a new default Oda client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewOdaClientWithOboToken

func NewOdaClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OdaClient, err error)

NewOdaClientWithOboToken Creates a new default Oda client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (OdaClient) ChangeOdaInstanceCompartment

func (client OdaClient) ChangeOdaInstanceCompartment(ctx context.Context, request ChangeOdaInstanceCompartmentRequest) (response ChangeOdaInstanceCompartmentResponse, err error)

ChangeOdaInstanceCompartment Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against ETag values of the resource.

See also

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

func (*OdaClient) ConfigurationProvider

func (client *OdaClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (OdaClient) CreateOdaInstance

func (client OdaClient) CreateOdaInstance(ctx context.Context, request CreateOdaInstanceRequest) (response CreateOdaInstanceResponse, err error)

CreateOdaInstance Starts an asynchronous job to create a Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

See also

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

func (OdaClient) DeleteOdaInstance

func (client OdaClient) DeleteOdaInstance(ctx context.Context, request DeleteOdaInstanceRequest) (response DeleteOdaInstanceResponse, err error)

DeleteOdaInstance Starts an asynchronous job to delete the specified Digital Assistant instance. To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestID}`.

See also

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

func (OdaClient) GetOdaInstance

func (client OdaClient) GetOdaInstance(ctx context.Context, request GetOdaInstanceRequest) (response GetOdaInstanceResponse, err error)

GetOdaInstance Gets the specified Digital Assistant instance.

See also

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

func (OdaClient) GetWorkRequest

func (client OdaClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets information about the work request with the specified ID, including its status. You can use this operation to monitor the status of jobs that you requested to create, delete, and update instances.

See also

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

func (OdaClient) ListOdaInstances

func (client OdaClient) ListOdaInstances(ctx context.Context, request ListOdaInstancesRequest) (response ListOdaInstancesResponse, err error)

ListOdaInstances Returns a page of Digital Assistant instances that belong to the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

See also

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

func (OdaClient) ListWorkRequestErrors

func (client OdaClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Returns a page of errors for the specified work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

See also

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

func (OdaClient) ListWorkRequestLogs

func (client OdaClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Returns a page of of log messages for a given work request. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

See also

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

func (OdaClient) ListWorkRequests

func (client OdaClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Returns a page of work requests for the specified compartment. If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

See also

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

func (*OdaClient) SetRegion

func (client *OdaClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (OdaClient) StartOdaInstance

func (client OdaClient) StartOdaInstance(ctx context.Context, request StartOdaInstanceRequest) (response StartOdaInstanceResponse, err error)

StartOdaInstance Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering of requests will be started again.

See also

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

func (OdaClient) StopOdaInstance

func (client OdaClient) StopOdaInstance(ctx context.Context, request StopOdaInstanceRequest) (response StopOdaInstanceResponse, err error)

StopOdaInstance Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering of requests will be stopped until the instance is started again. Data associated with the instance is not affected.

See also

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

func (OdaClient) UpdateOdaInstance

func (client OdaClient) UpdateOdaInstance(ctx context.Context, request UpdateOdaInstanceRequest) (response UpdateOdaInstanceResponse, err error)

UpdateOdaInstance Updates the specified Digital Assistant instance with the information in the request body.

See also

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

type OdaInstance

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 (OdaInstance) String

func (m OdaInstance) String() string

type OdaInstanceLifecycleStateEnum

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

func GetOdaInstanceLifecycleStateEnumValues() []OdaInstanceLifecycleStateEnum

GetOdaInstanceLifecycleStateEnumValues Enumerates the set of values for OdaInstanceLifecycleStateEnum

type OdaInstanceLifecycleSubStateEnum

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

func GetOdaInstanceLifecycleSubStateEnumValues() []OdaInstanceLifecycleSubStateEnum

GetOdaInstanceLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceLifecycleSubStateEnum

type OdaInstanceShapeNameEnum

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

func GetOdaInstanceShapeNameEnumValues() []OdaInstanceShapeNameEnum

GetOdaInstanceShapeNameEnumValues Enumerates the set of values for OdaInstanceShapeNameEnum

type OdaInstanceSummary

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 (OdaInstanceSummary) String

func (m OdaInstanceSummary) String() string

type OdaInstanceSummaryLifecycleStateEnum

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

func GetOdaInstanceSummaryLifecycleStateEnumValues() []OdaInstanceSummaryLifecycleStateEnum

GetOdaInstanceSummaryLifecycleStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleStateEnum

type OdaInstanceSummaryLifecycleSubStateEnum

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

func GetOdaInstanceSummaryLifecycleSubStateEnumValues() []OdaInstanceSummaryLifecycleSubStateEnum

GetOdaInstanceSummaryLifecycleSubStateEnumValues Enumerates the set of values for OdaInstanceSummaryLifecycleSubStateEnum

type OdaInstanceSummaryShapeNameEnum

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

func GetOdaInstanceSummaryShapeNameEnumValues() []OdaInstanceSummaryShapeNameEnum

GetOdaInstanceSummaryShapeNameEnumValues Enumerates the set of values for OdaInstanceSummaryShapeNameEnum

type StartOdaInstanceRequest

StartOdaInstanceRequest wrapper for the StartOdaInstance operation

See also

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 (StartOdaInstanceRequest) HTTPRequest

func (request StartOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartOdaInstanceRequest) RetryPolicy

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

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

func (StartOdaInstanceRequest) String

func (request StartOdaInstanceRequest) String() string

type StartOdaInstanceResponse

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 (StartOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (StartOdaInstanceResponse) String

func (response StartOdaInstanceResponse) String() string

type StopOdaInstanceRequest

StopOdaInstanceRequest wrapper for the StopOdaInstance operation

See also

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 (StopOdaInstanceRequest) HTTPRequest

func (request StopOdaInstanceRequest) HTTPRequest(method, path string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopOdaInstanceRequest) RetryPolicy

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

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

func (StopOdaInstanceRequest) String

func (request StopOdaInstanceRequest) String() string

type StopOdaInstanceResponse

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 (StopOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (StopOdaInstanceResponse) String

func (response StopOdaInstanceResponse) String() string

type UpdateOdaInstanceDetails

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 (UpdateOdaInstanceDetails) String

func (m UpdateOdaInstanceDetails) String() string

type UpdateOdaInstanceRequest

UpdateOdaInstanceRequest wrapper for the UpdateOdaInstance operation

See also

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 (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

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 (UpdateOdaInstanceResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (UpdateOdaInstanceResponse) String

func (response UpdateOdaInstanceResponse) String() string

type WorkRequest

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 (WorkRequest) String

func (m WorkRequest) String() string

type WorkRequestError

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 (WorkRequestError) String

func (m WorkRequestError) String() string

type WorkRequestLogEntry

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 (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

type WorkRequestRequestActionEnum

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

func GetWorkRequestRequestActionEnumValues() []WorkRequestRequestActionEnum

GetWorkRequestRequestActionEnumValues Enumerates the set of values for WorkRequestRequestActionEnum

type WorkRequestResource

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 (WorkRequestResource) String

func (m WorkRequestResource) String() string

type WorkRequestResourceResourceActionEnum

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

func GetWorkRequestResourceResourceActionEnumValues() []WorkRequestResourceResourceActionEnum

GetWorkRequestResourceResourceActionEnumValues Enumerates the set of values for WorkRequestResourceResourceActionEnum

type WorkRequestResourceStatusEnum

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

func GetWorkRequestResourceStatusEnumValues() []WorkRequestResourceStatusEnum

GetWorkRequestResourceStatusEnumValues Enumerates the set of values for WorkRequestResourceStatusEnum

type WorkRequestStatusEnum

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

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

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 (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

type WorkRequestSummaryRequestActionEnum

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

func GetWorkRequestSummaryRequestActionEnumValues() []WorkRequestSummaryRequestActionEnum

GetWorkRequestSummaryRequestActionEnumValues Enumerates the set of values for WorkRequestSummaryRequestActionEnum

type WorkRequestSummaryStatusEnum

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

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum