oci-go-sdk: github.com/oracle/oci-go-sdk/workrequests Index | Files

package workrequests

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

Index

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

type GetWorkRequestRequest Uses

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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

func (GetWorkRequestRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy Uses

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

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

func (GetWorkRequestRequest) String Uses

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse Uses

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

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String Uses

func (response GetWorkRequestResponse) String() string

type ListWorkRequestErrorsRequest Uses

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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestErrorsRequest) String Uses

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse Uses

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String Uses

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortOrderEnum Uses

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
    ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
    ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues Uses

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestLogsRequest Uses

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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestLogsRequest) String Uses

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse Uses

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String Uses

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortOrderEnum Uses

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
    ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
    ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues Uses

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

type ListWorkRequestsRequest Uses

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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

func (ListWorkRequestsRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy Uses

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

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

func (ListWorkRequestsRequest) String Uses

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse Uses

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

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String Uses

func (response ListWorkRequestsResponse) String() string

type WorkRequest Uses

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

WorkRequest An asynchronous work request.

func (WorkRequest) String Uses

func (m WorkRequest) String() string

type WorkRequestClient Uses

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

WorkRequestClient a client for WorkRequest

func NewWorkRequestClientWithConfigurationProvider Uses

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 Uses

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 Uses

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

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

func (WorkRequestClient) GetWorkRequest Uses

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

GetWorkRequest Gets the details of a work request.

func (WorkRequestClient) ListWorkRequestErrors Uses

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

ListWorkRequestErrors Gets the errors for a work request.

func (WorkRequestClient) ListWorkRequestLogs Uses

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

ListWorkRequestLogs Gets the logs for a work request.

func (WorkRequestClient) ListWorkRequests Uses

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.

func (*WorkRequestClient) SetRegion Uses

func (client *WorkRequestClient) SetRegion(region string)

SetRegion overrides the region of this client.

type WorkRequestError Uses

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

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

func (WorkRequestError) String Uses

func (m WorkRequestError) String() string

type WorkRequestLogEntry Uses

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

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

func (WorkRequestLogEntry) String Uses

func (m WorkRequestLogEntry) String() string

type WorkRequestResource Uses

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

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

func (WorkRequestResource) String Uses

func (m WorkRequestResource) String() string

type WorkRequestResourceActionTypeEnum Uses

type WorkRequestResourceActionTypeEnum string

WorkRequestResourceActionTypeEnum Enum with underlying type: string

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

Set of constants representing the allowable values for WorkRequestResourceActionTypeEnum

func GetWorkRequestResourceActionTypeEnumValues Uses

func GetWorkRequestResourceActionTypeEnumValues() []WorkRequestResourceActionTypeEnum

GetWorkRequestResourceActionTypeEnumValues Enumerates the set of values for WorkRequestResourceActionTypeEnum

type WorkRequestStatusEnum Uses

type WorkRequestStatusEnum string

WorkRequestStatusEnum Enum with underlying type: string

const (
    WorkRequestStatusAccepted   WorkRequestStatusEnum = "ACCEPTED"
    WorkRequestStatusInProgress WorkRequestStatusEnum = "IN_PROGRESS"
    WorkRequestStatusFailed     WorkRequestStatusEnum = "FAILED"
    WorkRequestStatusSucceeded  WorkRequestStatusEnum = "SUCCEEDED"
    WorkRequestStatusCanceling  WorkRequestStatusEnum = "CANCELING"
    WorkRequestStatusCanceled   WorkRequestStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestStatusEnum

func GetWorkRequestStatusEnumValues Uses

func GetWorkRequestStatusEnumValues() []WorkRequestStatusEnum

GetWorkRequestStatusEnumValues Enumerates the set of values for WorkRequestStatusEnum

type WorkRequestSummary Uses

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

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String Uses

func (m WorkRequestSummary) String() string

type WorkRequestSummaryStatusEnum Uses

type WorkRequestSummaryStatusEnum string

WorkRequestSummaryStatusEnum Enum with underlying type: string

const (
    WorkRequestSummaryStatusAccepted   WorkRequestSummaryStatusEnum = "ACCEPTED"
    WorkRequestSummaryStatusInProgress WorkRequestSummaryStatusEnum = "IN_PROGRESS"
    WorkRequestSummaryStatusFailed     WorkRequestSummaryStatusEnum = "FAILED"
    WorkRequestSummaryStatusSucceeded  WorkRequestSummaryStatusEnum = "SUCCEEDED"
    WorkRequestSummaryStatusCanceling  WorkRequestSummaryStatusEnum = "CANCELING"
    WorkRequestSummaryStatusCanceled   WorkRequestSummaryStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for WorkRequestSummaryStatusEnum

func GetWorkRequestSummaryStatusEnumValues Uses

func GetWorkRequestSummaryStatusEnumValues() []WorkRequestSummaryStatusEnum

GetWorkRequestSummaryStatusEnumValues Enumerates the set of values for WorkRequestSummaryStatusEnum

Package workrequests imports 4 packages (graph) and is imported by 2 packages. Updated 2020-04-27. Refresh now. Tools for package owners.