...

Package workrequests

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

Overview ▾

Index ▾

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
func GetWorkRequestResourceActionTypeEnumStringValues() []string
func GetWorkRequestStatusEnumStringValues() []string
func GetWorkRequestSummaryStatusEnumStringValues() []string
type GetWorkRequestRequest
    func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
    func (request GetWorkRequestRequest) String() string
    func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
type GetWorkRequestResponse
    func (response GetWorkRequestResponse) HTTPResponse() *http.Response
    func (response GetWorkRequestResponse) String() string
type ListWorkRequestErrorsRequest
    func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestErrorsRequest) String() string
    func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestErrorsResponse
    func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortOrderEnum
    func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
    func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
type ListWorkRequestLogsRequest
    func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestLogsRequest) String() string
    func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestLogsResponse
    func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortOrderEnum
    func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
    func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
type ListWorkRequestsRequest
    func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
    func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
    func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
    func (request ListWorkRequestsRequest) String() string
    func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
type ListWorkRequestsResponse
    func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
    func (response ListWorkRequestsResponse) String() string
type WorkRequest
    func (m WorkRequest) String() string
    func (m WorkRequest) ValidateEnumValue() (bool, error)
type WorkRequestClient
    func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)
    func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)
    func (client *WorkRequestClient) ConfigurationProvider() *common.ConfigurationProvider
    func (client WorkRequestClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
    func (client WorkRequestClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
    func (client WorkRequestClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
    func (client WorkRequestClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
    func (client *WorkRequestClient) SetRegion(region string)
type WorkRequestError
    func (m WorkRequestError) String() string
    func (m WorkRequestError) ValidateEnumValue() (bool, error)
type WorkRequestLogEntry
    func (m WorkRequestLogEntry) String() string
    func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
type WorkRequestResource
    func (m WorkRequestResource) String() string
    func (m WorkRequestResource) ValidateEnumValue() (bool, error)
type WorkRequestResourceActionTypeEnum
    func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)
    func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum
type WorkRequestStatusEnum
    func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)
    func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum
type WorkRequestSummary
    func (m WorkRequestSummary) String() string
    func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
type WorkRequestSummaryStatusEnum
    func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)
    func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

Package files

get_work_request_request_response.go list_work_request_errors_request_response.go list_work_request_logs_request_response.go list_work_requests_request_response.go work_request.go work_request_error.go work_request_log_entry.go work_request_resource.go work_request_summary.go workrequests_workrequest_client.go

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetWorkRequestResourceActionTypeEnumStringValues

func GetWorkRequestResourceActionTypeEnumStringValues() []string

GetWorkRequestResourceActionTypeEnumStringValues Enumerates the set of values in String for WorkRequestResourceActionTypeEnum

func GetWorkRequestStatusEnumStringValues

func GetWorkRequestStatusEnumStringValues() []string

GetWorkRequestStatusEnumStringValues Enumerates the set of values in String for WorkRequestStatusEnum

func GetWorkRequestSummaryStatusEnumStringValues

func GetWorkRequestSummaryStatusEnumStringValues() []string

GetWorkRequestSummaryStatusEnumStringValues Enumerates the set of values in String for WorkRequestSummaryStatusEnum

type GetWorkRequestRequest

GetWorkRequestRequest wrapper for the GetWorkRequest operation

# See also

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

type GetWorkRequestRequest struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    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) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

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

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

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse

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 need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (GetWorkRequestResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type ListWorkRequestErrorsRequest

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

# See also

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

type ListWorkRequestErrorsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the
    // previous "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    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 (ListWorkRequestErrorsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

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

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

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse

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

    // For list pagination. When this header appears in the response, additional pages of
    // results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestErrorsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

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

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

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

type ListWorkRequestLogsRequest

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

# See also

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

type ListWorkRequestLogsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the
    // previous "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // The sort order to use, either ascending (`ASC`) or descending (`DESC`).
    SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    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 (ListWorkRequestLogsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

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

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

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse

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

    // For list pagination. When this header appears in the response, additional pages of
    // results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestLogsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

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

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

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

type ListWorkRequestsRequest

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

# See also

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

type ListWorkRequestsRequest struct {

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
    CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.
    ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

    // For list pagination. The maximum number of results per page, or items to return in a
    // paginated "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

    // For list pagination. The value of the `opc-next-page` response header from the
    // previous "List" call. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    Page *string `mandatory:"false" contributesTo:"query" name:"page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `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 (ListWorkRequestsRequest) BinaryRequestBody

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

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

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

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResponse

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

    // For list pagination. When this header appears in the response, additional pages of
    // results remain. For important details about how pagination works, see
    // List Pagination (https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

    // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
    // particular request, please provide the request ID.
    OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

func (ListWorkRequestsResponse) HTTPResponse

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type WorkRequest

WorkRequest An asynchronous work request.

type WorkRequest struct {

    // The asynchronous operation tracked by this work request.
    OperationType *string `mandatory:"true" json:"operationType"`

    // The status of the work request.
    Status WorkRequestStatusEnum `mandatory:"true" json:"status"`

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment
    // that contains the work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The resources that are affected by this work request.
    Resources []WorkRequestResource `mandatory:"true" json:"resources"`

    // The percentage complete of the operation tracked by this work request.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the work request was created, in the format defined by RFC3339.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,
    // in the format defined by RFC3339.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.
    // Format is defined by RFC3339.
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestClient

WorkRequestClient a client for WorkRequest

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

func NewWorkRequestClientWithConfigurationProvider

func NewWorkRequestClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client WorkRequestClient, err error)

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

func NewWorkRequestClientWithOboToken

func NewWorkRequestClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client WorkRequestClient, err error)

NewWorkRequestClientWithOboToken Creates a new default WorkRequest 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 (*WorkRequestClient) ConfigurationProvider

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

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

func (WorkRequestClient) GetWorkRequest

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

GetWorkRequest Gets the details of a work request.

# See also

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

func (WorkRequestClient) ListWorkRequestErrors

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

ListWorkRequestErrors Gets the errors for a work request.

# See also

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

func (WorkRequestClient) ListWorkRequestLogs

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

ListWorkRequestLogs Gets the logs for a work request.

# See also

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

func (WorkRequestClient) ListWorkRequests

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

ListWorkRequests Lists the work requests in a compartment or for a specified resource.

# See also

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

func (*WorkRequestClient) SetRegion

func (client *WorkRequestClient) SetRegion(region string)

SetRegion overrides the region of this client.

type WorkRequestError

WorkRequestError An error encountered while executing an operation that is tracked by a work request.

type WorkRequestError struct {

    // A machine-usable code for the error that occured.
    Code *string `mandatory:"true" json:"code"`

    // A human-readable error string.
    Message *string `mandatory:"true" json:"message"`

    // The date and time the error occurred.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntry

WorkRequestLogEntry A log message from executing an operation that is tracked by a work request.

type WorkRequestLogEntry struct {

    // A human-readable log message.
    Message *string `mandatory:"true" json:"message"`

    // The date and time the log message was written.
    Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResource

WorkRequestResource A resource that is created or operated on by an asynchronous operation that is tracked by a work request.

type WorkRequestResource struct {

    // The way in which this resource was affected by the operation that spawned the work
    // request.
    ActionType WorkRequestResourceActionTypeEnum `mandatory:"true" json:"actionType"`

    // The resource type the work request affects.
    EntityType *string `mandatory:"true" json:"entityType"`

    // An OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the
    // resource.
    Identifier *string `mandatory:"true" json:"identifier"`

    // The URI path that you can use for a GET request to access the resource metadata.
    EntityUri *string `mandatory:"false" json:"entityUri"`
}

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceActionTypeEnum

WorkRequestResourceActionTypeEnum Enum with underlying type: string

type WorkRequestResourceActionTypeEnum string

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

const (
    WorkRequestResourceActionTypeCreated    WorkRequestResourceActionTypeEnum = "CREATED"
    WorkRequestResourceActionTypeUpdated    WorkRequestResourceActionTypeEnum = "UPDATED"
    WorkRequestResourceActionTypeDeleted    WorkRequestResourceActionTypeEnum = "DELETED"
    WorkRequestResourceActionTypeRelated    WorkRequestResourceActionTypeEnum = "RELATED"
    WorkRequestResourceActionTypeInProgress WorkRequestResourceActionTypeEnum = "IN_PROGRESS"
)

func GetMappingWorkRequestResourceActionTypeEnum

func GetMappingWorkRequestResourceActionTypeEnum(val string) (WorkRequestResourceActionTypeEnum, bool)

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

func GetWorkRequestResourceActionTypeEnumValues

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

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"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
    WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
    WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

func GetMappingWorkRequestStatusEnum

func GetMappingWorkRequestStatusEnum(val string) (WorkRequestStatusEnum, bool)

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

func GetWorkRequestStatusEnumValues

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary

WorkRequestSummary A summary of the status of a work request.

type WorkRequestSummary struct {

    // The asynchronous operation tracked by this work request.
    OperationType *string `mandatory:"true" json:"operationType"`

    // The status of the work request.
    Status WorkRequestSummaryStatusEnum `mandatory:"true" json:"status"`

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
    Id *string `mandatory:"true" json:"id"`

    // The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing
    // this work request.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`

    // The percentage complete of the operation tracked by this work request.
    PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

    // The date and time the work request was created, in the format defined by RFC3339.
    TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

    // The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in
    // the format defined by RFC3339.
    TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

    // The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.
    // Format is defined by RFC3339.
    TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type 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"
    WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
    WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
    WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
    WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

func GetMappingWorkRequestSummaryStatusEnum

func GetMappingWorkRequestSummaryStatusEnum(val string) (WorkRequestSummaryStatusEnum, bool)

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

func GetWorkRequestSummaryStatusEnumValues

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum