func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetCreateScheduleDetailsActionEnumStringValues() []string
GetCreateScheduleDetailsActionEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsActionEnum
func GetCreateScheduleDetailsRecurrenceTypeEnumStringValues() []string
GetCreateScheduleDetailsRecurrenceTypeEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsRecurrenceTypeEnum
func GetListSchedulesSortByEnumStringValues() []string
GetListSchedulesSortByEnumStringValues Enumerates the set of values in String for ListSchedulesSortByEnum
func GetListSchedulesSortOrderEnumStringValues() []string
GetListSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListSchedulesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetResourceFilterAttributeEnumStringValues() []string
GetResourceFilterAttributeEnumStringValues Enumerates the set of values in String for ResourceFilterAttributeEnum
func GetScheduleActionEnumStringValues() []string
GetScheduleActionEnumStringValues Enumerates the set of values in String for ScheduleActionEnum
func GetScheduleLifecycleStateEnumStringValues() []string
GetScheduleLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduleLifecycleStateEnum
func GetScheduleRecurrenceTypeEnumStringValues() []string
GetScheduleRecurrenceTypeEnumStringValues Enumerates the set of values in String for ScheduleRecurrenceTypeEnum
func GetScheduleSummaryActionEnumStringValues() []string
GetScheduleSummaryActionEnumStringValues Enumerates the set of values in String for ScheduleSummaryActionEnum
func GetScheduleSummaryRecurrenceTypeEnumStringValues() []string
GetScheduleSummaryRecurrenceTypeEnumStringValues Enumerates the set of values in String for ScheduleSummaryRecurrenceTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTimeCreatedResourceFilterConditionEnumStringValues() []string
GetTimeCreatedResourceFilterConditionEnumStringValues Enumerates the set of values in String for TimeCreatedResourceFilterConditionEnum
func GetUpdateScheduleDetailsActionEnumStringValues() []string
GetUpdateScheduleDetailsActionEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsActionEnum
func GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues() []string
GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsRecurrenceTypeEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActivateScheduleRequest wrapper for the ActivateSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ActivateSchedule.go.html to see an example of how to use ActivateScheduleRequest.
type ActivateScheduleRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// This is used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// This is a token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ActivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ActivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ActivateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ActivateScheduleRequest) String() string
func (request ActivateScheduleRequest) 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
ActivateScheduleResponse wrapper for the ActivateSchedule operation
type ActivateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `presentIn:"body"`
// This is a 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response ActivateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ActivateScheduleResponse) String() string
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
type CancelWorkRequestRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// This is used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelWorkRequestRequest) String() string
func (request CancelWorkRequestRequest) 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
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
type CancelWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// This is a 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 (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelWorkRequestResponse) String() string
CompartmentIdResourceFilter This is a resource filter for filtering resource based on compartment OCID.
type CompartmentIdResourceFilter struct {
// This is the compartment used for filtering.
Value *string `mandatory:"false" json:"value"`
// This sets whether to include child compartments.
ShouldIncludeChildCompartments *bool `mandatory:"false" json:"shouldIncludeChildCompartments"`
}
func (m CompartmentIdResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CompartmentIdResourceFilter) String() string
func (m CompartmentIdResourceFilter) 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
CreateScheduleDetails This is the data to create a schedule.
type CreateScheduleDetails struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the schedule is created
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// This is the action that will be executed by the schedule.
Action CreateScheduleDetailsActionEnum `mandatory:"true" json:"action"`
// This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
// or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
RecurrenceDetails *string `mandatory:"true" json:"recurrenceDetails"`
// Type of recurrence of a schedule
RecurrenceType CreateScheduleDetailsRecurrenceTypeEnum `mandatory:"true" json:"recurrenceType"`
// This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// This is the description of the schedule.
Description *string `mandatory:"false" json:"description"`
// This is a list of resources filters. The schedule will be applied to resources matching all of them.
ResourceFilters []ResourceFilter `mandatory:"false" json:"resourceFilters"`
// This is the list of resources to which the scheduled operation is applied.
Resources []Resource `mandatory:"false" json:"resources"`
// This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeStarts *common.SDKTime `mandatory:"false" json:"timeStarts"`
// This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeEnds *common.SDKTime `mandatory:"false" json:"timeEnds"`
// These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// These are defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateScheduleDetails) String() string
func (m *CreateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateScheduleDetails) 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
CreateScheduleDetailsActionEnum Enum with underlying type: string
type CreateScheduleDetailsActionEnum string
Set of constants representing the allowable values for CreateScheduleDetailsActionEnum
const (
CreateScheduleDetailsActionStartResource CreateScheduleDetailsActionEnum = "START_RESOURCE"
CreateScheduleDetailsActionStopResource CreateScheduleDetailsActionEnum = "STOP_RESOURCE"
)
func GetCreateScheduleDetailsActionEnumValues() []CreateScheduleDetailsActionEnum
GetCreateScheduleDetailsActionEnumValues Enumerates the set of values for CreateScheduleDetailsActionEnum
func GetMappingCreateScheduleDetailsActionEnum(val string) (CreateScheduleDetailsActionEnum, bool)
GetMappingCreateScheduleDetailsActionEnum performs case Insensitive comparison on enum value and return the desired enum
CreateScheduleDetailsRecurrenceTypeEnum Enum with underlying type: string
type CreateScheduleDetailsRecurrenceTypeEnum string
Set of constants representing the allowable values for CreateScheduleDetailsRecurrenceTypeEnum
const (
CreateScheduleDetailsRecurrenceTypeCron CreateScheduleDetailsRecurrenceTypeEnum = "CRON"
CreateScheduleDetailsRecurrenceTypeIcal CreateScheduleDetailsRecurrenceTypeEnum = "ICAL"
)
func GetCreateScheduleDetailsRecurrenceTypeEnumValues() []CreateScheduleDetailsRecurrenceTypeEnum
GetCreateScheduleDetailsRecurrenceTypeEnumValues Enumerates the set of values for CreateScheduleDetailsRecurrenceTypeEnum
func GetMappingCreateScheduleDetailsRecurrenceTypeEnum(val string) (CreateScheduleDetailsRecurrenceTypeEnum, bool)
GetMappingCreateScheduleDetailsRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateScheduleRequest wrapper for the CreateSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/CreateSchedule.go.html to see an example of how to use CreateScheduleRequest.
type CreateScheduleRequest struct {
// This API shows the details of the new schedule
CreateScheduleDetails `contributesTo:"body"`
// This is a token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateScheduleRequest) String() string
func (request CreateScheduleRequest) 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
CreateScheduleResponse wrapper for the CreateSchedule operation
type CreateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `presentIn:"body"`
// This is the URL for the created schedule. The schedule OCID is generated after this request is sent.
Location *string `presentIn:"header" name:"location"`
// This is the same as location
ContentLocation *string `presentIn:"header" name:"content-location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// This is a 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 (response CreateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateScheduleResponse) String() string
DeactivateScheduleRequest wrapper for the DeactivateSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/DeactivateSchedule.go.html to see an example of how to use DeactivateScheduleRequest.
type DeactivateScheduleRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// This is used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// This is a token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of running that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and removed from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeactivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeactivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeactivateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeactivateScheduleRequest) String() string
func (request DeactivateScheduleRequest) 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
DeactivateScheduleResponse wrapper for the DeactivateSchedule operation
type DeactivateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `presentIn:"body"`
// This is a 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"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response DeactivateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeactivateScheduleResponse) String() string
DefinedTagFilterValue This is a defined tag filter value.
type DefinedTagFilterValue struct {
// This is the namespace of the defined tag.
Namespace *string `mandatory:"false" json:"namespace"`
// This is the key of the defined tag.
TagKey *string `mandatory:"false" json:"tagKey"`
// This is the value of the defined tag.
Value *string `mandatory:"false" json:"value"`
}
func (m DefinedTagFilterValue) String() string
func (m DefinedTagFilterValue) 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
DefinedTagsResourceFilter This is a resource filter for filtering resource based on a defined tag.
type DefinedTagsResourceFilter struct {
// This is a defined tag filter value.
Value []DefinedTagFilterValue `mandatory:"false" json:"value"`
}
func (m DefinedTagsResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DefinedTagsResourceFilter) String() string
func (m DefinedTagsResourceFilter) 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
DeleteScheduleRequest wrapper for the DeleteSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/DeleteSchedule.go.html to see an example of how to use DeleteScheduleRequest.
type DeleteScheduleRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// This is used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteScheduleRequest) String() string
func (request DeleteScheduleRequest) 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
DeleteScheduleResponse wrapper for the DeleteSchedule operation
type DeleteScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// This is a 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 (response DeleteScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteScheduleResponse) String() string
GetScheduleRequest wrapper for the GetSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/GetSchedule.go.html to see an example of how to use GetScheduleRequest.
type GetScheduleRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetScheduleRequest) String() string
func (request GetScheduleRequest) 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
GetScheduleResponse wrapper for the GetSchedule operation
type GetScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The Schedule instance
Schedule `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// This is a 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 (response GetScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetScheduleResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// This is a 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"`
// This is a decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *int `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
LifecycleStateResourceFilter This is a resource filter for filtering resources based on their lifecycle state.
type LifecycleStateResourceFilter struct {
// This is a collection of resource lifecycle state values.
Value []string `mandatory:"false" json:"value"`
}
func (m LifecycleStateResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m LifecycleStateResourceFilter) String() string
func (m LifecycleStateResourceFilter) 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
ListResourceTypesRequest wrapper for the ListResourceTypes operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListResourceTypes.go.html to see an example of how to use ListResourceTypesRequest.
type ListResourceTypesRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// 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"`
// This used 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"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListResourceTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListResourceTypesRequest) String() string
func (request ListResourceTypesRequest) 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
ListResourceTypesResponse wrapper for the ListResourceTypes operation
type ListResourceTypesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ResourceTypeCollection instances
ResourceTypeCollection `presentIn:"body"`
// This is a 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"`
// When this header appears in the list pagination response, there are additional results pages to view. 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"`
}
func (response ListResourceTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListResourceTypesResponse) String() string
ListSchedulesRequest wrapper for the ListSchedules operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListSchedules.go.html to see an example of how to use ListSchedulesRequest.
type ListSchedulesRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// This is a filter to return only resources that match the given lifecycle state. The
// state value is case-insensitive.
LifecycleState ScheduleLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// This is a filter to return only resources that match the given display name exactly.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"false" contributesTo:"query" name:"scheduleId"`
// 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"`
// This used 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"`
// This is the field to sort by. You can provide only one sort order. The default order for `timeCreated`
// is descending. The default order for `displayName` is ascending.
SortBy ListSchedulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// This is the sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListSchedulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSchedulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSchedulesRequest) String() string
func (request ListSchedulesRequest) 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
ListSchedulesResponse wrapper for the ListSchedules operation
type ListSchedulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of ScheduleCollection instances
ScheduleCollection `presentIn:"body"`
// This is a 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"`
// When this header appears in the list pagination response, there are additional results pages to view. 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"`
}
func (response ListSchedulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSchedulesResponse) String() string
ListSchedulesSortByEnum Enum with underlying type: string
type ListSchedulesSortByEnum string
Set of constants representing the allowable values for ListSchedulesSortByEnum
const (
ListSchedulesSortByTimecreated ListSchedulesSortByEnum = "timeCreated"
ListSchedulesSortByDisplayname ListSchedulesSortByEnum = "displayName"
ListSchedulesSortByLifecyclestate ListSchedulesSortByEnum = "lifecycleState"
ListSchedulesSortByState ListSchedulesSortByEnum = "state"
)
func GetListSchedulesSortByEnumValues() []ListSchedulesSortByEnum
GetListSchedulesSortByEnumValues Enumerates the set of values for ListSchedulesSortByEnum
func GetMappingListSchedulesSortByEnum(val string) (ListSchedulesSortByEnum, bool)
GetMappingListSchedulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSchedulesSortOrderEnum Enum with underlying type: string
type ListSchedulesSortOrderEnum string
Set of constants representing the allowable values for ListSchedulesSortOrderEnum
const (
ListSchedulesSortOrderAsc ListSchedulesSortOrderEnum = "ASC"
ListSchedulesSortOrderDesc ListSchedulesSortOrderEnum = "DESC"
)
func GetListSchedulesSortOrderEnumValues() []ListSchedulesSortOrderEnum
GetListSchedulesSortOrderEnumValues Enumerates the set of values for ListSchedulesSortOrderEnum
func GetMappingListSchedulesSortOrderEnum(val string) (ListSchedulesSortOrderEnum, bool)
GetMappingListSchedulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// This used 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"`
// 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"`
// This is the field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// This is the sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestErrorCollection instances
WorkRequestErrorCollection `presentIn:"body"`
// When this header appears in the list pagination response, there are additional results pages to view. 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"`
// This is a 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 (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// This used 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"`
// 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"`
// This is the field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.
SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// This is the sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestLogEntryCollection instances
WorkRequestLogEntryCollection `presentIn:"body"`
// When this header appears in the list pagination response, there are additional results pages to view. 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"`
// This is a 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 (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// This is a filter to return only the resources that match the given lifecycle state.
Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// This used 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"`
// 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"`
// This is the sort order to use, either ascending (`ASC`) or descending (`DESC`).
SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// This is the field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"false" contributesTo:"query" name:"scheduleId"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of WorkRequestSummaryCollection instances
WorkRequestSummaryCollection `presentIn:"body"`
// This is a 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"`
// When this header appears in the list pagination response, there are additional results pages to view. 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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
const (
ListWorkRequestsStatusAccepted ListWorkRequestsStatusEnum = "ACCEPTED"
ListWorkRequestsStatusInProgress ListWorkRequestsStatusEnum = "IN_PROGRESS"
ListWorkRequestsStatusWaiting ListWorkRequestsStatusEnum = "WAITING"
ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
ListWorkRequestsStatusFailed ListWorkRequestsStatusEnum = "FAILED"
ListWorkRequestsStatusSucceeded ListWorkRequestsStatusEnum = "SUCCEEDED"
ListWorkRequestsStatusCanceling ListWorkRequestsStatusEnum = "CANCELING"
ListWorkRequestsStatusCanceled ListWorkRequestsStatusEnum = "CANCELED"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusWaiting OperationStatusEnum = "WAITING"
OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeStartResource OperationTypeEnum = "START_RESOURCE"
OperationTypeStopResource OperationTypeEnum = "STOP_RESOURCE"
OperationTypeChangeScheduleCompartment OperationTypeEnum = "CHANGE_SCHEDULE_COMPARTMENT"
OperationTypeCreateSchedule OperationTypeEnum = "CREATE_SCHEDULE"
OperationTypeUpdateSchedule OperationTypeEnum = "UPDATE_SCHEDULE"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
Resource This is the schedule resource entity.
type Resource struct {
// This is the resource OCID.
Id *string `mandatory:"true" json:"id"`
// This is additional information that helps to identity the resource for the schedule.
// {
// "id": "<OCID_of_bucket>"
// "metadata":
// {
// "namespaceName": "sampleNamespace",
// "bucketName": "sampleBucket"
// }
// }
Metadata map[string]string `mandatory:"false" json:"metadata"`
}
func (m Resource) String() string
func (m Resource) 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
ResourceFilter This is a generic filter used to decide which resources that the schedule be applied to.
type ResourceFilter interface {
}
ResourceFilterAttributeEnum Enum with underlying type: string
type ResourceFilterAttributeEnum string
Set of constants representing the allowable values for ResourceFilterAttributeEnum
const (
ResourceFilterAttributeCompartmentId ResourceFilterAttributeEnum = "COMPARTMENT_ID"
ResourceFilterAttributeResourceType ResourceFilterAttributeEnum = "RESOURCE_TYPE"
ResourceFilterAttributeDefinedTags ResourceFilterAttributeEnum = "DEFINED_TAGS"
ResourceFilterAttributeTimeCreated ResourceFilterAttributeEnum = "TIME_CREATED"
ResourceFilterAttributeLifecycleState ResourceFilterAttributeEnum = "LIFECYCLE_STATE"
)
func GetMappingResourceFilterAttributeEnum(val string) (ResourceFilterAttributeEnum, bool)
GetMappingResourceFilterAttributeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceFilterAttributeEnumValues() []ResourceFilterAttributeEnum
GetResourceFilterAttributeEnumValues Enumerates the set of values for ResourceFilterAttributeEnum
ResourceType This is a resource type supported by resource scheduler.
type ResourceType struct {
// This is a resource type supported by resource scheduler.
Name *string `mandatory:"true" json:"name"`
}
func (m ResourceType) String() string
func (m ResourceType) 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
ResourceTypeCollection This is the collection of resource types supported by resource scheduler.
type ResourceTypeCollection struct {
// This is the collection of resource types supported by resource scheduler.
Items []ResourceType `mandatory:"true" json:"items"`
}
func (m ResourceTypeCollection) String() string
func (m ResourceTypeCollection) 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
ResourceTypeResourceFilter This is a resource filter for filtering resource based on resource type.
type ResourceTypeResourceFilter struct {
// This is a collection of resource types.
Value []string `mandatory:"false" json:"value"`
}
func (m ResourceTypeResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ResourceTypeResourceFilter) String() string
func (m ResourceTypeResourceFilter) 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
Schedule A Schedule describes the date and time when an operation will be or has been applied to a set of resources. You must specify either the resources directly or provide a set of resource filters to select the resources. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, contact your administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies (https://docs.cloud.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
type Schedule struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the schedule is created
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// This is the action that will be executed by the schedule.
Action ScheduleActionEnum `mandatory:"true" json:"action"`
// This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
// or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
RecurrenceDetails *string `mandatory:"true" json:"recurrenceDetails"`
// Type of recurrence of a schedule
RecurrenceType ScheduleRecurrenceTypeEnum `mandatory:"true" json:"recurrenceType"`
// This is the date and time the schedule was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// This is the current state of a schedule.
LifecycleState ScheduleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`
// These are defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`
// This is the description of the schedule.
Description *string `mandatory:"false" json:"description"`
// This is a list of resources filters. The schedule will be applied to resources matching all of them.
ResourceFilters []ResourceFilter `mandatory:"false" json:"resourceFilters"`
// This is the list of resources to which the scheduled operation is applied.
Resources []Resource `mandatory:"false" json:"resources"`
// This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeStarts *common.SDKTime `mandatory:"false" json:"timeStarts"`
// This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeEnds *common.SDKTime `mandatory:"false" json:"timeEnds"`
// This is the date and time the schedule was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// This is the date and time the schedule runs last time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeLastRun *common.SDKTime `mandatory:"false" json:"timeLastRun"`
// This is the date and time the schedule run the next time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeNextRun *common.SDKTime `mandatory:"false" json:"timeNextRun"`
// These are system tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Schedule) String() string
func (m *Schedule) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Schedule) 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
ScheduleActionEnum Enum with underlying type: string
type ScheduleActionEnum string
Set of constants representing the allowable values for ScheduleActionEnum
const (
ScheduleActionStartResource ScheduleActionEnum = "START_RESOURCE"
ScheduleActionStopResource ScheduleActionEnum = "STOP_RESOURCE"
)
func GetMappingScheduleActionEnum(val string) (ScheduleActionEnum, bool)
GetMappingScheduleActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleActionEnumValues() []ScheduleActionEnum
GetScheduleActionEnumValues Enumerates the set of values for ScheduleActionEnum
ScheduleClient a client for Schedule
type ScheduleClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewScheduleClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ScheduleClient, err error)
NewScheduleClientWithConfigurationProvider Creates a new default Schedule client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewScheduleClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ScheduleClient, err error)
NewScheduleClientWithOboToken Creates a new default Schedule client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client ScheduleClient) ActivateSchedule(ctx context.Context, request ActivateScheduleRequest) (response ActivateScheduleResponse, err error)
ActivateSchedule This API activates a schedule.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ActivateSchedule.go.html to see an example of how to use ActivateSchedule API. A default retry strategy applies to this operation ActivateSchedule()
func (client ScheduleClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest This API cancels a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (client *ScheduleClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ScheduleClient) CreateSchedule(ctx context.Context, request CreateScheduleRequest) (response CreateScheduleResponse, err error)
CreateSchedule Creates a Schedule
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/CreateSchedule.go.html to see an example of how to use CreateSchedule API. A default retry strategy applies to this operation CreateSchedule()
func (client ScheduleClient) DeactivateSchedule(ctx context.Context, request DeactivateScheduleRequest) (response DeactivateScheduleResponse, err error)
DeactivateSchedule This API deactivates a schedule.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/DeactivateSchedule.go.html to see an example of how to use DeactivateSchedule API. A default retry strategy applies to this operation DeactivateSchedule()
func (client ScheduleClient) DeleteSchedule(ctx context.Context, request DeleteScheduleRequest) (response DeleteScheduleResponse, err error)
DeleteSchedule This API deletes a schedule.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/DeleteSchedule.go.html to see an example of how to use DeleteSchedule API. A default retry strategy applies to this operation DeleteSchedule()
func (client ScheduleClient) GetSchedule(ctx context.Context, request GetScheduleRequest) (response GetScheduleResponse, err error)
GetSchedule This API gets information about a schedule.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/GetSchedule.go.html to see an example of how to use GetSchedule API. A default retry strategy applies to this operation GetSchedule()
func (client ScheduleClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest This API gets the details of a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client ScheduleClient) ListResourceTypes(ctx context.Context, request ListResourceTypesRequest) (response ListResourceTypesResponse, err error)
ListResourceTypes This API gets a list of schedule resource types.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListResourceTypes.go.html to see an example of how to use ListResourceTypes API. A default retry strategy applies to this operation ListResourceTypes()
func (client ScheduleClient) ListSchedules(ctx context.Context, request ListSchedulesRequest) (response ListSchedulesResponse, err error)
ListSchedules This API gets a list of schedules
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListSchedules.go.html to see an example of how to use ListSchedules API. A default retry strategy applies to this operation ListSchedules()
func (client ScheduleClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors This API lists the errors for a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client ScheduleClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client ScheduleClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the cloud scheduler work requests in a compartment.
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client *ScheduleClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client ScheduleClient) UpdateSchedule(ctx context.Context, request UpdateScheduleRequest) (response UpdateScheduleResponse, err error)
UpdateSchedule The API updates a schedule
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/UpdateSchedule.go.html to see an example of how to use UpdateSchedule API. A default retry strategy applies to this operation UpdateSchedule()
ScheduleCollection This is the list of schedule items.
type ScheduleCollection struct {
// This is the list of schedule items.
Items []ScheduleSummary `mandatory:"true" json:"items"`
}
func (m ScheduleCollection) String() string
func (m ScheduleCollection) 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
ScheduleLifecycleStateEnum Enum with underlying type: string
type ScheduleLifecycleStateEnum string
Set of constants representing the allowable values for ScheduleLifecycleStateEnum
const (
ScheduleLifecycleStateActive ScheduleLifecycleStateEnum = "ACTIVE"
ScheduleLifecycleStateInactive ScheduleLifecycleStateEnum = "INACTIVE"
ScheduleLifecycleStateCreating ScheduleLifecycleStateEnum = "CREATING"
ScheduleLifecycleStateUpdating ScheduleLifecycleStateEnum = "UPDATING"
ScheduleLifecycleStateDeleting ScheduleLifecycleStateEnum = "DELETING"
ScheduleLifecycleStateDeleted ScheduleLifecycleStateEnum = "DELETED"
ScheduleLifecycleStateFailed ScheduleLifecycleStateEnum = "FAILED"
)
func GetMappingScheduleLifecycleStateEnum(val string) (ScheduleLifecycleStateEnum, bool)
GetMappingScheduleLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleLifecycleStateEnumValues() []ScheduleLifecycleStateEnum
GetScheduleLifecycleStateEnumValues Enumerates the set of values for ScheduleLifecycleStateEnum
ScheduleRecurrenceTypeEnum Enum with underlying type: string
type ScheduleRecurrenceTypeEnum string
Set of constants representing the allowable values for ScheduleRecurrenceTypeEnum
const (
ScheduleRecurrenceTypeCron ScheduleRecurrenceTypeEnum = "CRON"
ScheduleRecurrenceTypeIcal ScheduleRecurrenceTypeEnum = "ICAL"
)
func GetMappingScheduleRecurrenceTypeEnum(val string) (ScheduleRecurrenceTypeEnum, bool)
GetMappingScheduleRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleRecurrenceTypeEnumValues() []ScheduleRecurrenceTypeEnum
GetScheduleRecurrenceTypeEnumValues Enumerates the set of values for ScheduleRecurrenceTypeEnum
ScheduleSummary This is the summary information about a schedule.
type ScheduleSummary struct {
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the schedule is created
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"true" json:"displayName"`
// This is the action that will be executed by the schedule.
Action ScheduleSummaryActionEnum `mandatory:"true" json:"action"`
// This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
// or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
RecurrenceDetails *string `mandatory:"true" json:"recurrenceDetails"`
// Type of recurrence of a schedule
RecurrenceType ScheduleSummaryRecurrenceTypeEnum `mandatory:"true" json:"recurrenceType"`
// This is the current state of the schedule.
LifecycleState ScheduleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// This is the description of the schedule.
Description *string `mandatory:"false" json:"description"`
// This is a list of resources filters. The schedule will be applied to resources matching all of them.
ResourceFilters []ResourceFilter `mandatory:"false" json:"resourceFilters"`
// This is the list of resources to which the scheduled operation is applied.
Resources []Resource `mandatory:"false" json:"resources"`
// This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeStarts *common.SDKTime `mandatory:"false" json:"timeStarts"`
// This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeEnds *common.SDKTime `mandatory:"false" json:"timeEnds"`
// This is the date and time the schedule was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// This is the date and time the schedule was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// This is the date and time the schedule runs last time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeLastRun *common.SDKTime `mandatory:"false" json:"timeLastRun"`
// This is the date and time the schedule run the next time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
// Example: `2016-08-25T21:10:29.600Z`
TimeNextRun *common.SDKTime `mandatory:"false" json:"timeNextRun"`
// This is the status of the last work request.
LastRunStatus OperationStatusEnum `mandatory:"false" json:"lastRunStatus,omitempty"`
// These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// These are defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// These are system tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m ScheduleSummary) String() string
func (m *ScheduleSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ScheduleSummary) 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
ScheduleSummaryActionEnum Enum with underlying type: string
type ScheduleSummaryActionEnum string
Set of constants representing the allowable values for ScheduleSummaryActionEnum
const (
ScheduleSummaryActionStartResource ScheduleSummaryActionEnum = "START_RESOURCE"
ScheduleSummaryActionStopResource ScheduleSummaryActionEnum = "STOP_RESOURCE"
)
func GetMappingScheduleSummaryActionEnum(val string) (ScheduleSummaryActionEnum, bool)
GetMappingScheduleSummaryActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleSummaryActionEnumValues() []ScheduleSummaryActionEnum
GetScheduleSummaryActionEnumValues Enumerates the set of values for ScheduleSummaryActionEnum
ScheduleSummaryRecurrenceTypeEnum Enum with underlying type: string
type ScheduleSummaryRecurrenceTypeEnum string
Set of constants representing the allowable values for ScheduleSummaryRecurrenceTypeEnum
const (
ScheduleSummaryRecurrenceTypeCron ScheduleSummaryRecurrenceTypeEnum = "CRON"
ScheduleSummaryRecurrenceTypeIcal ScheduleSummaryRecurrenceTypeEnum = "ICAL"
)
func GetMappingScheduleSummaryRecurrenceTypeEnum(val string) (ScheduleSummaryRecurrenceTypeEnum, bool)
GetMappingScheduleSummaryRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleSummaryRecurrenceTypeEnumValues() []ScheduleSummaryRecurrenceTypeEnum
GetScheduleSummaryRecurrenceTypeEnumValues Enumerates the set of values for ScheduleSummaryRecurrenceTypeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
TimeCreatedResourceFilter This is a resource filter for filtering resources based on their creation time.
type TimeCreatedResourceFilter struct {
// This is the date and time as the value of the filter.
Value *string `mandatory:"false" json:"value"`
// This is the condition for the filter in comparison to its creation time.
Condition TimeCreatedResourceFilterConditionEnum `mandatory:"false" json:"condition,omitempty"`
}
func (m TimeCreatedResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TimeCreatedResourceFilter) String() string
func (m TimeCreatedResourceFilter) 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
TimeCreatedResourceFilterConditionEnum Enum with underlying type: string
type TimeCreatedResourceFilterConditionEnum string
Set of constants representing the allowable values for TimeCreatedResourceFilterConditionEnum
const (
TimeCreatedResourceFilterConditionEqual TimeCreatedResourceFilterConditionEnum = "EQUAL"
TimeCreatedResourceFilterConditionBefore TimeCreatedResourceFilterConditionEnum = "BEFORE"
TimeCreatedResourceFilterConditionAfter TimeCreatedResourceFilterConditionEnum = "AFTER"
)
func GetMappingTimeCreatedResourceFilterConditionEnum(val string) (TimeCreatedResourceFilterConditionEnum, bool)
GetMappingTimeCreatedResourceFilterConditionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTimeCreatedResourceFilterConditionEnumValues() []TimeCreatedResourceFilterConditionEnum
GetTimeCreatedResourceFilterConditionEnumValues Enumerates the set of values for TimeCreatedResourceFilterConditionEnum
UpdateScheduleDetails This is the data to update a schedule.
type UpdateScheduleDetails struct {
// This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
DisplayName *string `mandatory:"false" json:"displayName"`
// This is the description of the schedule.
Description *string `mandatory:"false" json:"description"`
// This is the action that will be executed by the schedule.
Action UpdateScheduleDetailsActionEnum `mandatory:"false" json:"action,omitempty"`
// This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting
// or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
RecurrenceDetails *string `mandatory:"false" json:"recurrenceDetails"`
// Type of recurrence of a schedule
RecurrenceType UpdateScheduleDetailsRecurrenceTypeEnum `mandatory:"false" json:"recurrenceType,omitempty"`
// This is a list of resources filters. The schedule will be applied to resources matching all of them.
ResourceFilters []ResourceFilter `mandatory:"false" json:"resourceFilters"`
// This is the list of resources to which the scheduled operation is applied.
Resources []Resource `mandatory:"false" json:"resources"`
// This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeStarts *common.SDKTime `mandatory:"false" json:"timeStarts"`
// This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339)
// Example: `2016-08-25T21:10:29.600Z`
TimeEnds *common.SDKTime `mandatory:"false" json:"timeEnds"`
// These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Department": "Finance"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// These are defined tags for this resource. Each key is predefined and scoped to a namespace.
// For more information, see Resource Tags (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateScheduleDetails) String() string
func (m *UpdateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m UpdateScheduleDetails) 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
UpdateScheduleDetailsActionEnum Enum with underlying type: string
type UpdateScheduleDetailsActionEnum string
Set of constants representing the allowable values for UpdateScheduleDetailsActionEnum
const (
UpdateScheduleDetailsActionStartResource UpdateScheduleDetailsActionEnum = "START_RESOURCE"
UpdateScheduleDetailsActionStopResource UpdateScheduleDetailsActionEnum = "STOP_RESOURCE"
)
func GetMappingUpdateScheduleDetailsActionEnum(val string) (UpdateScheduleDetailsActionEnum, bool)
GetMappingUpdateScheduleDetailsActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateScheduleDetailsActionEnumValues() []UpdateScheduleDetailsActionEnum
GetUpdateScheduleDetailsActionEnumValues Enumerates the set of values for UpdateScheduleDetailsActionEnum
UpdateScheduleDetailsRecurrenceTypeEnum Enum with underlying type: string
type UpdateScheduleDetailsRecurrenceTypeEnum string
Set of constants representing the allowable values for UpdateScheduleDetailsRecurrenceTypeEnum
const (
UpdateScheduleDetailsRecurrenceTypeCron UpdateScheduleDetailsRecurrenceTypeEnum = "CRON"
UpdateScheduleDetailsRecurrenceTypeIcal UpdateScheduleDetailsRecurrenceTypeEnum = "ICAL"
)
func GetMappingUpdateScheduleDetailsRecurrenceTypeEnum(val string) (UpdateScheduleDetailsRecurrenceTypeEnum, bool)
GetMappingUpdateScheduleDetailsRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateScheduleDetailsRecurrenceTypeEnumValues() []UpdateScheduleDetailsRecurrenceTypeEnum
GetUpdateScheduleDetailsRecurrenceTypeEnumValues Enumerates the set of values for UpdateScheduleDetailsRecurrenceTypeEnum
UpdateScheduleRequest wrapper for the UpdateSchedule operation
Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/65.68.0/resourcescheduler/UpdateSchedule.go.html to see an example of how to use UpdateScheduleRequest.
type UpdateScheduleRequest struct {
// This is the OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// The information about a schedule that will be updated.
UpdateScheduleDetails `contributesTo:"body"`
// This is used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the
// `if-match` parameter to the value of the etag from a previous GET or POST response for
// that resource. The resource will be updated or deleted only if the etag you provide
// matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// This is a unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
// The only valid characters for request IDs are letters, numbers,
// underscore, and dash.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateScheduleRequest) String() string
func (request UpdateScheduleRequest) 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
UpdateScheduleResponse wrapper for the UpdateSchedule operation
type UpdateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
// Use GetWorkRequest with this ID to track the status of the request.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// This is a 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 (response UpdateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateScheduleResponse) String() string
WorkRequest This is an asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
type WorkRequest struct {
// The asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// This is the status of the work request.
Status OperationStatusEnum `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"`
// This is the resources that are affected by the work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// This is the date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// This is the date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// This is the date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// This is the date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequest) String() string
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
WorkRequestError This is an error encountered while performing an operation that is tracked by a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).
Code *string `mandatory:"true" json:"code"`
// This is a human-readable error message.
Message *string `mandatory:"true" json:"message"`
// This is the date and time the error occurred, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
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
WorkRequestErrorCollection This is a list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// This is a list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
func (m WorkRequestErrorCollection) 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
WorkRequestLogEntry This is a log message from performing an operation that is tracked by a work request.
type WorkRequestLogEntry struct {
// This is a human-readable log message.
Message *string `mandatory:"true" json:"message"`
// This is the date and time the log message was written, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
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
WorkRequestLogEntryCollection This is a list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// This is a list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
func (m WorkRequestLogEntryCollection) 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
WorkRequestResource This is a resource created or operated on by a work request.
type WorkRequestResource struct {
// This is the resource type that the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the operation tracked in the work request.
// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// This is 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"`
// This is the URI path that you can use for a GET request to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
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
WorkRequestSummary This is the summary information about an asynchronous work request.
type WorkRequestSummary struct {
// This is the status of the work request.
Status OperationStatusEnum `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"`
// Shows the progress of the operation tracked by the work request, as a percentage of the total work
// that must be performed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// This is the date and time the work request was created, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// This is the asynchronous operation tracked by this work request.
OperationType OperationTypeEnum `mandatory:"false" json:"operationType,omitempty"`
// This is the date and time the work request was started, in the format defined by
// RFC 3339 (https://tools.ietf.org/html/rfc3339).
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// This is the date and time the work request was finished, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
// This is the date and time the work request was updated, in the format defined by
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection This is a list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// This is a list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
func (m WorkRequestSummaryCollection) 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