Documentation
¶
Index ¶
- func GetActionTypeEnumStringValues() []string
- func GetCreateScheduleDetailsActionEnumStringValues() []string
- func GetCreateScheduleDetailsRecurrenceTypeEnumStringValues() []string
- func GetListSchedulesSortByEnumStringValues() []string
- func GetListSchedulesSortOrderEnumStringValues() []string
- func GetListWorkRequestErrorsSortByEnumStringValues() []string
- func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
- func GetListWorkRequestLogsSortByEnumStringValues() []string
- func GetListWorkRequestLogsSortOrderEnumStringValues() []string
- func GetListWorkRequestsSortByEnumStringValues() []string
- func GetListWorkRequestsSortOrderEnumStringValues() []string
- func GetListWorkRequestsStatusEnumStringValues() []string
- func GetOperationStatusEnumStringValues() []string
- func GetOperationTypeEnumStringValues() []string
- func GetParameterParameterTypeEnumStringValues() []string
- func GetResourceFilterAttributeEnumStringValues() []string
- func GetScheduleActionEnumStringValues() []string
- func GetScheduleLifecycleStateEnumStringValues() []string
- func GetScheduleRecurrenceTypeEnumStringValues() []string
- func GetScheduleSummaryActionEnumStringValues() []string
- func GetScheduleSummaryRecurrenceTypeEnumStringValues() []string
- func GetSortOrderEnumStringValues() []string
- func GetTimeCreatedResourceFilterConditionEnumStringValues() []string
- func GetUpdateScheduleDetailsActionEnumStringValues() []string
- func GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues() []string
- type ActionTypeEnum
- type ActivateScheduleRequest
- func (request ActivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ActivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ActivateScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request ActivateScheduleRequest) String() string
- func (request ActivateScheduleRequest) ValidateEnumValue() (bool, error)
- type ActivateScheduleResponse
- type BodyParameter
- type CancelWorkRequestRequest
- func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
- func (request CancelWorkRequestRequest) String() string
- func (request CancelWorkRequestRequest) ValidateEnumValue() (bool, error)
- type CancelWorkRequestResponse
- type ChangeScheduleCompartmentDetails
- type ChangeScheduleCompartmentRequest
- func (request ChangeScheduleCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ChangeScheduleCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ChangeScheduleCompartmentRequest) RetryPolicy() *common.RetryPolicy
- func (request ChangeScheduleCompartmentRequest) String() string
- func (request ChangeScheduleCompartmentRequest) ValidateEnumValue() (bool, error)
- type ChangeScheduleCompartmentResponse
- type CompartmentIdResourceFilter
- type CreateScheduleDetails
- type CreateScheduleDetailsActionEnum
- type CreateScheduleDetailsRecurrenceTypeEnum
- type CreateScheduleRequest
- func (request CreateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request CreateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request CreateScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request CreateScheduleRequest) String() string
- func (request CreateScheduleRequest) ValidateEnumValue() (bool, error)
- type CreateScheduleResponse
- type DeactivateScheduleRequest
- func (request DeactivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request DeactivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request DeactivateScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request DeactivateScheduleRequest) String() string
- func (request DeactivateScheduleRequest) ValidateEnumValue() (bool, error)
- type DeactivateScheduleResponse
- type DefinedTagFilterValue
- type DefinedTagsResourceFilter
- type DeleteScheduleRequest
- func (request DeleteScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request DeleteScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request DeleteScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request DeleteScheduleRequest) String() string
- func (request DeleteScheduleRequest) ValidateEnumValue() (bool, error)
- type DeleteScheduleResponse
- type GetScheduleRequest
- func (request GetScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request GetScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request GetScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request GetScheduleRequest) String() string
- func (request GetScheduleRequest) ValidateEnumValue() (bool, error)
- type GetScheduleResponse
- type GetWorkRequestRequest
- func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
- func (request GetWorkRequestRequest) String() string
- func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
- type GetWorkRequestResponse
- type HeaderParameter
- type LifecycleStateResourceFilter
- type ListResourceTypesRequest
- func (request ListResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ListResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ListResourceTypesRequest) RetryPolicy() *common.RetryPolicy
- func (request ListResourceTypesRequest) String() string
- func (request ListResourceTypesRequest) ValidateEnumValue() (bool, error)
- type ListResourceTypesResponse
- type ListSchedulesRequest
- func (request ListSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ListSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ListSchedulesRequest) RetryPolicy() *common.RetryPolicy
- func (request ListSchedulesRequest) String() string
- func (request ListSchedulesRequest) ValidateEnumValue() (bool, error)
- type ListSchedulesResponse
- type ListSchedulesSortByEnum
- type ListSchedulesSortOrderEnum
- type ListWorkRequestErrorsRequest
- func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
- func (request ListWorkRequestErrorsRequest) String() string
- func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
- type ListWorkRequestErrorsResponse
- type ListWorkRequestErrorsSortByEnum
- type ListWorkRequestErrorsSortOrderEnum
- type ListWorkRequestLogsRequest
- func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
- func (request ListWorkRequestLogsRequest) String() string
- func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
- type ListWorkRequestLogsResponse
- type ListWorkRequestLogsSortByEnum
- type ListWorkRequestLogsSortOrderEnum
- type ListWorkRequestsRequest
- func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
- func (request ListWorkRequestsRequest) String() string
- func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
- type ListWorkRequestsResponse
- type ListWorkRequestsSortByEnum
- type ListWorkRequestsSortOrderEnum
- type ListWorkRequestsStatusEnum
- type OperationStatusEnum
- type OperationTypeEnum
- type Parameter
- type ParameterParameterTypeEnum
- type PathParameter
- type QueryParameter
- type Resource
- type ResourceFilter
- type ResourceFilterAttributeEnum
- type ResourceType
- type ResourceTypeCollection
- type ResourceTypeResourceFilter
- type Schedule
- type ScheduleActionEnum
- type ScheduleClient
- func (client ScheduleClient) ActivateSchedule(ctx context.Context, request ActivateScheduleRequest) (response ActivateScheduleResponse, err error)
- func (client ScheduleClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
- func (client ScheduleClient) ChangeScheduleCompartment(ctx context.Context, request ChangeScheduleCompartmentRequest) (response ChangeScheduleCompartmentResponse, err error)
- func (client *ScheduleClient) ConfigurationProvider() *common.ConfigurationProvider
- func (client ScheduleClient) CreateSchedule(ctx context.Context, request CreateScheduleRequest) (response CreateScheduleResponse, err error)
- func (client ScheduleClient) DeactivateSchedule(ctx context.Context, request DeactivateScheduleRequest) (response DeactivateScheduleResponse, err error)
- func (client ScheduleClient) DeleteSchedule(ctx context.Context, request DeleteScheduleRequest) (response DeleteScheduleResponse, err error)
- func (client ScheduleClient) GetSchedule(ctx context.Context, request GetScheduleRequest) (response GetScheduleResponse, err error)
- func (client ScheduleClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
- func (client ScheduleClient) ListResourceTypes(ctx context.Context, request ListResourceTypesRequest) (response ListResourceTypesResponse, err error)
- func (client ScheduleClient) ListSchedules(ctx context.Context, request ListSchedulesRequest) (response ListSchedulesResponse, err error)
- func (client ScheduleClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
- func (client ScheduleClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
- func (client ScheduleClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
- func (client *ScheduleClient) SetRegion(region string)
- func (client ScheduleClient) UpdateSchedule(ctx context.Context, request UpdateScheduleRequest) (response UpdateScheduleResponse, err error)
- type ScheduleCollection
- type ScheduleLifecycleStateEnum
- type ScheduleRecurrenceTypeEnum
- type ScheduleSummary
- type ScheduleSummaryActionEnum
- type ScheduleSummaryRecurrenceTypeEnum
- type SortOrderEnum
- type TimeCreatedResourceFilter
- type TimeCreatedResourceFilterConditionEnum
- type UpdateScheduleDetails
- type UpdateScheduleDetailsActionEnum
- type UpdateScheduleDetailsRecurrenceTypeEnum
- type UpdateScheduleRequest
- func (request UpdateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
- func (request UpdateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, ...) (http.Request, error)
- func (request UpdateScheduleRequest) RetryPolicy() *common.RetryPolicy
- func (request UpdateScheduleRequest) String() string
- func (request UpdateScheduleRequest) ValidateEnumValue() (bool, error)
- type UpdateScheduleResponse
- type WorkRequest
- type WorkRequestError
- type WorkRequestErrorCollection
- type WorkRequestLogEntry
- type WorkRequestLogEntryCollection
- type WorkRequestResource
- type WorkRequestSummary
- type WorkRequestSummaryCollection
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetActionTypeEnumStringValues ¶
func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetCreateScheduleDetailsActionEnumStringValues ¶
func GetCreateScheduleDetailsActionEnumStringValues() []string
GetCreateScheduleDetailsActionEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsActionEnum
func GetCreateScheduleDetailsRecurrenceTypeEnumStringValues ¶
func GetCreateScheduleDetailsRecurrenceTypeEnumStringValues() []string
GetCreateScheduleDetailsRecurrenceTypeEnumStringValues Enumerates the set of values in String for CreateScheduleDetailsRecurrenceTypeEnum
func GetListSchedulesSortByEnumStringValues ¶
func GetListSchedulesSortByEnumStringValues() []string
GetListSchedulesSortByEnumStringValues Enumerates the set of values in String for ListSchedulesSortByEnum
func GetListSchedulesSortOrderEnumStringValues ¶
func GetListSchedulesSortOrderEnumStringValues() []string
GetListSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListSchedulesSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues ¶
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues ¶
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues ¶
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues ¶
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues ¶
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues ¶
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues ¶
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetOperationStatusEnumStringValues ¶
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues ¶
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetParameterParameterTypeEnumStringValues ¶ added in v65.89.3
func GetParameterParameterTypeEnumStringValues() []string
GetParameterParameterTypeEnumStringValues Enumerates the set of values in String for ParameterParameterTypeEnum
func GetResourceFilterAttributeEnumStringValues ¶
func GetResourceFilterAttributeEnumStringValues() []string
GetResourceFilterAttributeEnumStringValues Enumerates the set of values in String for ResourceFilterAttributeEnum
func GetScheduleActionEnumStringValues ¶
func GetScheduleActionEnumStringValues() []string
GetScheduleActionEnumStringValues Enumerates the set of values in String for ScheduleActionEnum
func GetScheduleLifecycleStateEnumStringValues ¶
func GetScheduleLifecycleStateEnumStringValues() []string
GetScheduleLifecycleStateEnumStringValues Enumerates the set of values in String for ScheduleLifecycleStateEnum
func GetScheduleRecurrenceTypeEnumStringValues ¶
func GetScheduleRecurrenceTypeEnumStringValues() []string
GetScheduleRecurrenceTypeEnumStringValues Enumerates the set of values in String for ScheduleRecurrenceTypeEnum
func GetScheduleSummaryActionEnumStringValues ¶
func GetScheduleSummaryActionEnumStringValues() []string
GetScheduleSummaryActionEnumStringValues Enumerates the set of values in String for ScheduleSummaryActionEnum
func GetScheduleSummaryRecurrenceTypeEnumStringValues ¶
func GetScheduleSummaryRecurrenceTypeEnumStringValues() []string
GetScheduleSummaryRecurrenceTypeEnumStringValues Enumerates the set of values in String for ScheduleSummaryRecurrenceTypeEnum
func GetSortOrderEnumStringValues ¶
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTimeCreatedResourceFilterConditionEnumStringValues ¶
func GetTimeCreatedResourceFilterConditionEnumStringValues() []string
GetTimeCreatedResourceFilterConditionEnumStringValues Enumerates the set of values in String for TimeCreatedResourceFilterConditionEnum
func GetUpdateScheduleDetailsActionEnumStringValues ¶
func GetUpdateScheduleDetailsActionEnumStringValues() []string
GetUpdateScheduleDetailsActionEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsActionEnum
func GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues ¶
func GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues() []string
GetUpdateScheduleDetailsRecurrenceTypeEnumStringValues Enumerates the set of values in String for UpdateScheduleDetailsRecurrenceTypeEnum
Types ¶
type ActionTypeEnum ¶
type ActionTypeEnum string
ActionTypeEnum Enum with underlying type: string
const ( ActionTypeCreated ActionTypeEnum = "CREATED" ActionTypeUpdated ActionTypeEnum = "UPDATED" ActionTypeDeleted ActionTypeEnum = "DELETED" ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS" ActionTypeRelated ActionTypeEnum = "RELATED" ActionTypeFailed ActionTypeEnum = "FAILED" )
Set of constants representing the allowable values for ActionTypeEnum
func GetActionTypeEnumValues ¶
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum ¶
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
type ActivateScheduleRequest ¶
type ActivateScheduleRequest struct {
// This is the OCID (https://docs.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
}
ActivateScheduleRequest wrapper for the ActivateSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ActivateSchedule.go.html to see an example of how to use ActivateScheduleRequest.
func (ActivateScheduleRequest) BinaryRequestBody ¶
func (request ActivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ActivateScheduleRequest) HTTPRequest ¶
func (request ActivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ActivateScheduleRequest) RetryPolicy ¶
func (request ActivateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ActivateScheduleRequest) String ¶
func (request ActivateScheduleRequest) String() string
func (ActivateScheduleRequest) ValidateEnumValue ¶
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
type ActivateScheduleResponse ¶
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"`
}
ActivateScheduleResponse wrapper for the ActivateSchedule operation
func (ActivateScheduleResponse) HTTPResponse ¶
func (response ActivateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ActivateScheduleResponse) String ¶
func (response ActivateScheduleResponse) String() string
type BodyParameter ¶ added in v65.89.3
type BodyParameter struct {
// This is the body parameter value.
Value *interface{} `mandatory:"false" json:"value"`
}
BodyParameter This is an input parameter that will be passed as HTTP request body parameter.
func (BodyParameter) MarshalJSON ¶ added in v65.89.3
func (m BodyParameter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (BodyParameter) String ¶ added in v65.89.3
func (m BodyParameter) String() string
func (BodyParameter) ValidateEnumValue ¶ added in v65.89.3
func (m BodyParameter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type CancelWorkRequestRequest ¶
type CancelWorkRequestRequest struct {
// This is the OCID (https://docs.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
}
CancelWorkRequestRequest wrapper for the CancelWorkRequest operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequestRequest.
func (CancelWorkRequestRequest) BinaryRequestBody ¶
func (request CancelWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (CancelWorkRequestRequest) HTTPRequest ¶
func (request CancelWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CancelWorkRequestRequest) RetryPolicy ¶
func (request CancelWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CancelWorkRequestRequest) String ¶
func (request CancelWorkRequestRequest) String() string
func (CancelWorkRequestRequest) ValidateEnumValue ¶
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
type CancelWorkRequestResponse ¶
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"`
}
CancelWorkRequestResponse wrapper for the CancelWorkRequest operation
func (CancelWorkRequestResponse) HTTPResponse ¶
func (response CancelWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CancelWorkRequestResponse) String ¶
func (response CancelWorkRequestResponse) String() string
type ChangeScheduleCompartmentDetails ¶ added in v65.89.3
type ChangeScheduleCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the schedule to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
ChangeScheduleCompartmentDetails This is the configuration details for the move operation.
func (ChangeScheduleCompartmentDetails) String ¶ added in v65.89.3
func (m ChangeScheduleCompartmentDetails) String() string
func (ChangeScheduleCompartmentDetails) ValidateEnumValue ¶ added in v65.89.3
func (m ChangeScheduleCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ChangeScheduleCompartmentRequest ¶ added in v65.89.3
type ChangeScheduleCompartmentRequest struct {
// This is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule.
ScheduleId *string `mandatory:"true" contributesTo:"path" name:"scheduleId"`
// This is the change schedule compartment details that will be updated.
ChangeScheduleCompartmentDetails `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"`
// 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
}
ChangeScheduleCompartmentRequest wrapper for the ChangeScheduleCompartment operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ChangeScheduleCompartment.go.html to see an example of how to use ChangeScheduleCompartmentRequest.
func (ChangeScheduleCompartmentRequest) BinaryRequestBody ¶ added in v65.89.3
func (request ChangeScheduleCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ChangeScheduleCompartmentRequest) HTTPRequest ¶ added in v65.89.3
func (request ChangeScheduleCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ChangeScheduleCompartmentRequest) RetryPolicy ¶ added in v65.89.3
func (request ChangeScheduleCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ChangeScheduleCompartmentRequest) String ¶ added in v65.89.3
func (request ChangeScheduleCompartmentRequest) String() string
func (ChangeScheduleCompartmentRequest) ValidateEnumValue ¶ added in v65.89.3
func (request ChangeScheduleCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ChangeScheduleCompartmentResponse ¶ added in v65.89.3
type ChangeScheduleCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.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"`
}
ChangeScheduleCompartmentResponse wrapper for the ChangeScheduleCompartment operation
func (ChangeScheduleCompartmentResponse) HTTPResponse ¶ added in v65.89.3
func (response ChangeScheduleCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ChangeScheduleCompartmentResponse) String ¶ added in v65.89.3
func (response ChangeScheduleCompartmentResponse) String() string
type CompartmentIdResourceFilter ¶
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"`
}
CompartmentIdResourceFilter This is a resource filter for filtering resource based on compartment OCID.
func (CompartmentIdResourceFilter) MarshalJSON ¶
func (m CompartmentIdResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (CompartmentIdResourceFilter) String ¶
func (m CompartmentIdResourceFilter) String() string
func (CompartmentIdResourceFilter) ValidateEnumValue ¶
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
type CreateScheduleDetails ¶
type CreateScheduleDetails struct {
// The OCID (https://docs.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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
CreateScheduleDetails This is the data to create a schedule.
func (CreateScheduleDetails) String ¶
func (m CreateScheduleDetails) String() string
func (*CreateScheduleDetails) UnmarshalJSON ¶
func (m *CreateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (CreateScheduleDetails) ValidateEnumValue ¶
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
type CreateScheduleDetailsActionEnum ¶
type CreateScheduleDetailsActionEnum string
CreateScheduleDetailsActionEnum Enum with underlying type: string
const ( CreateScheduleDetailsActionStartResource CreateScheduleDetailsActionEnum = "START_RESOURCE" CreateScheduleDetailsActionStopResource CreateScheduleDetailsActionEnum = "STOP_RESOURCE" )
Set of constants representing the allowable values for CreateScheduleDetailsActionEnum
func GetCreateScheduleDetailsActionEnumValues ¶
func GetCreateScheduleDetailsActionEnumValues() []CreateScheduleDetailsActionEnum
GetCreateScheduleDetailsActionEnumValues Enumerates the set of values for CreateScheduleDetailsActionEnum
func GetMappingCreateScheduleDetailsActionEnum ¶
func GetMappingCreateScheduleDetailsActionEnum(val string) (CreateScheduleDetailsActionEnum, bool)
GetMappingCreateScheduleDetailsActionEnum performs case Insensitive comparison on enum value and return the desired enum
type CreateScheduleDetailsRecurrenceTypeEnum ¶
type CreateScheduleDetailsRecurrenceTypeEnum string
CreateScheduleDetailsRecurrenceTypeEnum Enum with underlying type: string
const ( CreateScheduleDetailsRecurrenceTypeCron CreateScheduleDetailsRecurrenceTypeEnum = "CRON" CreateScheduleDetailsRecurrenceTypeIcal CreateScheduleDetailsRecurrenceTypeEnum = "ICAL" )
Set of constants representing the allowable values for CreateScheduleDetailsRecurrenceTypeEnum
func GetCreateScheduleDetailsRecurrenceTypeEnumValues ¶
func GetCreateScheduleDetailsRecurrenceTypeEnumValues() []CreateScheduleDetailsRecurrenceTypeEnum
GetCreateScheduleDetailsRecurrenceTypeEnumValues Enumerates the set of values for CreateScheduleDetailsRecurrenceTypeEnum
func GetMappingCreateScheduleDetailsRecurrenceTypeEnum ¶
func GetMappingCreateScheduleDetailsRecurrenceTypeEnum(val string) (CreateScheduleDetailsRecurrenceTypeEnum, bool)
GetMappingCreateScheduleDetailsRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
type 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
}
CreateScheduleRequest wrapper for the CreateSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/CreateSchedule.go.html to see an example of how to use CreateScheduleRequest.
func (CreateScheduleRequest) BinaryRequestBody ¶
func (request CreateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (CreateScheduleRequest) HTTPRequest ¶
func (request CreateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (CreateScheduleRequest) RetryPolicy ¶
func (request CreateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (CreateScheduleRequest) String ¶
func (request CreateScheduleRequest) String() string
func (CreateScheduleRequest) ValidateEnumValue ¶
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
type CreateScheduleResponse ¶
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.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"`
}
CreateScheduleResponse wrapper for the CreateSchedule operation
func (CreateScheduleResponse) HTTPResponse ¶
func (response CreateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (CreateScheduleResponse) String ¶
func (response CreateScheduleResponse) String() string
type DeactivateScheduleRequest ¶
type DeactivateScheduleRequest struct {
// This is the OCID (https://docs.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
}
DeactivateScheduleRequest wrapper for the DeactivateSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/DeactivateSchedule.go.html to see an example of how to use DeactivateScheduleRequest.
func (DeactivateScheduleRequest) BinaryRequestBody ¶
func (request DeactivateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (DeactivateScheduleRequest) HTTPRequest ¶
func (request DeactivateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeactivateScheduleRequest) RetryPolicy ¶
func (request DeactivateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeactivateScheduleRequest) String ¶
func (request DeactivateScheduleRequest) String() string
func (DeactivateScheduleRequest) ValidateEnumValue ¶
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
type DeactivateScheduleResponse ¶
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"`
}
DeactivateScheduleResponse wrapper for the DeactivateSchedule operation
func (DeactivateScheduleResponse) HTTPResponse ¶
func (response DeactivateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeactivateScheduleResponse) String ¶
func (response DeactivateScheduleResponse) String() string
type DefinedTagFilterValue ¶
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"`
}
DefinedTagFilterValue This is a defined tag filter value.
func (DefinedTagFilterValue) String ¶
func (m DefinedTagFilterValue) String() string
func (DefinedTagFilterValue) ValidateEnumValue ¶
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
type DefinedTagsResourceFilter ¶
type DefinedTagsResourceFilter struct {
// This is a defined tag filter value.
Value []DefinedTagFilterValue `mandatory:"false" json:"value"`
}
DefinedTagsResourceFilter This is a resource filter for filtering resource based on a defined tag.
func (DefinedTagsResourceFilter) MarshalJSON ¶
func (m DefinedTagsResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (DefinedTagsResourceFilter) String ¶
func (m DefinedTagsResourceFilter) String() string
func (DefinedTagsResourceFilter) ValidateEnumValue ¶
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
type DeleteScheduleRequest ¶
type DeleteScheduleRequest struct {
// This is the OCID (https://docs.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
}
DeleteScheduleRequest wrapper for the DeleteSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/DeleteSchedule.go.html to see an example of how to use DeleteScheduleRequest.
func (DeleteScheduleRequest) BinaryRequestBody ¶
func (request DeleteScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (DeleteScheduleRequest) HTTPRequest ¶
func (request DeleteScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (DeleteScheduleRequest) RetryPolicy ¶
func (request DeleteScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (DeleteScheduleRequest) String ¶
func (request DeleteScheduleRequest) String() string
func (DeleteScheduleRequest) ValidateEnumValue ¶
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
type DeleteScheduleResponse ¶
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"`
}
DeleteScheduleResponse wrapper for the DeleteSchedule operation
func (DeleteScheduleResponse) HTTPResponse ¶
func (response DeleteScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (DeleteScheduleResponse) String ¶
func (response DeleteScheduleResponse) String() string
type GetScheduleRequest ¶
type GetScheduleRequest struct {
// This is the OCID (https://docs.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
}
GetScheduleRequest wrapper for the GetSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/GetSchedule.go.html to see an example of how to use GetScheduleRequest.
func (GetScheduleRequest) BinaryRequestBody ¶
func (request GetScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (GetScheduleRequest) HTTPRequest ¶
func (request GetScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetScheduleRequest) RetryPolicy ¶
func (request GetScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetScheduleRequest) String ¶
func (request GetScheduleRequest) String() string
func (GetScheduleRequest) ValidateEnumValue ¶
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
type GetScheduleResponse ¶
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"`
}
GetScheduleResponse wrapper for the GetSchedule operation
func (GetScheduleResponse) HTTPResponse ¶
func (response GetScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetScheduleResponse) String ¶
func (response GetScheduleResponse) String() string
type GetWorkRequestRequest ¶
type GetWorkRequestRequest struct {
// This is the OCID (https://docs.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
}
GetWorkRequestRequest wrapper for the GetWorkRequest operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
func (GetWorkRequestRequest) BinaryRequestBody ¶
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (GetWorkRequestRequest) HTTPRequest ¶
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (GetWorkRequestRequest) RetryPolicy ¶
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (GetWorkRequestRequest) String ¶
func (request GetWorkRequestRequest) String() string
func (GetWorkRequestRequest) ValidateEnumValue ¶
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type GetWorkRequestResponse ¶
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"`
}
GetWorkRequestResponse wrapper for the GetWorkRequest operation
func (GetWorkRequestResponse) HTTPResponse ¶
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (GetWorkRequestResponse) String ¶
func (response GetWorkRequestResponse) String() string
type HeaderParameter ¶ added in v65.89.3
type HeaderParameter struct {
// This is the HTTP request header value.
Value map[string]string `mandatory:"false" json:"value"`
}
HeaderParameter This is an input parameter that will be passed as HTTP request header.
func (HeaderParameter) MarshalJSON ¶ added in v65.89.3
func (m HeaderParameter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (HeaderParameter) String ¶ added in v65.89.3
func (m HeaderParameter) String() string
func (HeaderParameter) ValidateEnumValue ¶ added in v65.89.3
func (m HeaderParameter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type LifecycleStateResourceFilter ¶
type LifecycleStateResourceFilter struct {
// This is a collection of resource lifecycle state values.
Value []string `mandatory:"false" json:"value"`
}
LifecycleStateResourceFilter This is a resource filter for filtering resources based on their lifecycle state.
func (LifecycleStateResourceFilter) MarshalJSON ¶
func (m LifecycleStateResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (LifecycleStateResourceFilter) String ¶
func (m LifecycleStateResourceFilter) String() string
func (LifecycleStateResourceFilter) ValidateEnumValue ¶
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
type ListResourceTypesRequest ¶
type ListResourceTypesRequest struct {
// This is the OCID (https://docs.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.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.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
}
ListResourceTypesRequest wrapper for the ListResourceTypes operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListResourceTypes.go.html to see an example of how to use ListResourceTypesRequest.
func (ListResourceTypesRequest) BinaryRequestBody ¶
func (request ListResourceTypesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ListResourceTypesRequest) HTTPRequest ¶
func (request ListResourceTypesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListResourceTypesRequest) RetryPolicy ¶
func (request ListResourceTypesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListResourceTypesRequest) String ¶
func (request ListResourceTypesRequest) String() string
func (ListResourceTypesRequest) ValidateEnumValue ¶
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
type ListResourceTypesResponse ¶
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
ListResourceTypesResponse wrapper for the ListResourceTypes operation
func (ListResourceTypesResponse) HTTPResponse ¶
func (response ListResourceTypesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListResourceTypesResponse) String ¶
func (response ListResourceTypesResponse) String() string
type ListSchedulesRequest ¶
type ListSchedulesRequest struct {
// This is the OCID (https://docs.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.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.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.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"`
// This is the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`
// 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
}
ListSchedulesRequest wrapper for the ListSchedules operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListSchedules.go.html to see an example of how to use ListSchedulesRequest.
func (ListSchedulesRequest) BinaryRequestBody ¶
func (request ListSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ListSchedulesRequest) HTTPRequest ¶
func (request ListSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListSchedulesRequest) RetryPolicy ¶
func (request ListSchedulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListSchedulesRequest) String ¶
func (request ListSchedulesRequest) String() string
func (ListSchedulesRequest) ValidateEnumValue ¶
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
type ListSchedulesResponse ¶
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
ListSchedulesResponse wrapper for the ListSchedules operation
func (ListSchedulesResponse) HTTPResponse ¶
func (response ListSchedulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListSchedulesResponse) String ¶
func (response ListSchedulesResponse) String() string
type ListSchedulesSortByEnum ¶
type ListSchedulesSortByEnum string
ListSchedulesSortByEnum Enum with underlying type: string
const ( ListSchedulesSortByTimecreated ListSchedulesSortByEnum = "timeCreated" ListSchedulesSortByDisplayname ListSchedulesSortByEnum = "displayName" ListSchedulesSortByLifecyclestate ListSchedulesSortByEnum = "lifecycleState" ListSchedulesSortByState ListSchedulesSortByEnum = "state" )
Set of constants representing the allowable values for ListSchedulesSortByEnum
func GetListSchedulesSortByEnumValues ¶
func GetListSchedulesSortByEnumValues() []ListSchedulesSortByEnum
GetListSchedulesSortByEnumValues Enumerates the set of values for ListSchedulesSortByEnum
func GetMappingListSchedulesSortByEnum ¶
func GetMappingListSchedulesSortByEnum(val string) (ListSchedulesSortByEnum, bool)
GetMappingListSchedulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
type ListSchedulesSortOrderEnum ¶
type ListSchedulesSortOrderEnum string
ListSchedulesSortOrderEnum Enum with underlying type: string
const ( ListSchedulesSortOrderAsc ListSchedulesSortOrderEnum = "ASC" ListSchedulesSortOrderDesc ListSchedulesSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListSchedulesSortOrderEnum
func GetListSchedulesSortOrderEnumValues ¶
func GetListSchedulesSortOrderEnumValues() []ListSchedulesSortOrderEnum
GetListSchedulesSortOrderEnumValues Enumerates the set of values for ListSchedulesSortOrderEnum
func GetMappingListSchedulesSortOrderEnum ¶
func GetMappingListSchedulesSortOrderEnum(val string) (ListSchedulesSortOrderEnum, bool)
GetMappingListSchedulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestErrorsRequest ¶
type ListWorkRequestErrorsRequest struct {
// This is the OCID (https://docs.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.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.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
}
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
func (ListWorkRequestErrorsRequest) BinaryRequestBody ¶
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ListWorkRequestErrorsRequest) HTTPRequest ¶
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListWorkRequestErrorsRequest) RetryPolicy ¶
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListWorkRequestErrorsRequest) String ¶
func (request ListWorkRequestErrorsRequest) String() string
func (ListWorkRequestErrorsRequest) ValidateEnumValue ¶
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ListWorkRequestErrorsResponse ¶
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.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"`
}
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
func (ListWorkRequestErrorsResponse) HTTPResponse ¶
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListWorkRequestErrorsResponse) String ¶
func (response ListWorkRequestErrorsResponse) String() string
type ListWorkRequestErrorsSortByEnum ¶
type ListWorkRequestErrorsSortByEnum string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
const (
ListWorkRequestErrorsSortByTimestamp ListWorkRequestErrorsSortByEnum = "timestamp"
)
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortByEnumValues ¶
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum ¶
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestErrorsSortOrderEnum ¶
type ListWorkRequestErrorsSortOrderEnum string
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
const ( ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC" ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestErrorsSortOrderEnumValues ¶
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum ¶
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestLogsRequest ¶
type ListWorkRequestLogsRequest struct {
// This is the OCID (https://docs.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.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.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
}
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
func (ListWorkRequestLogsRequest) BinaryRequestBody ¶
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ListWorkRequestLogsRequest) HTTPRequest ¶
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListWorkRequestLogsRequest) RetryPolicy ¶
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListWorkRequestLogsRequest) String ¶
func (request ListWorkRequestLogsRequest) String() string
func (ListWorkRequestLogsRequest) ValidateEnumValue ¶
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ListWorkRequestLogsResponse ¶
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.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"`
}
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
func (ListWorkRequestLogsResponse) HTTPResponse ¶
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListWorkRequestLogsResponse) String ¶
func (response ListWorkRequestLogsResponse) String() string
type ListWorkRequestLogsSortByEnum ¶
type ListWorkRequestLogsSortByEnum string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
const (
ListWorkRequestLogsSortByTimestamp ListWorkRequestLogsSortByEnum = "timestamp"
)
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortByEnumValues ¶
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum ¶
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestLogsSortOrderEnum ¶
type ListWorkRequestLogsSortOrderEnum string
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
const ( ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC" ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestLogsSortOrderEnumValues ¶
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum ¶
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestsRequest ¶
type ListWorkRequestsRequest struct {
// This is the OCID (https://docs.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.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.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.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.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.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
}
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
func (ListWorkRequestsRequest) BinaryRequestBody ¶
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (ListWorkRequestsRequest) HTTPRequest ¶
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (ListWorkRequestsRequest) RetryPolicy ¶
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (ListWorkRequestsRequest) String ¶
func (request ListWorkRequestsRequest) String() string
func (ListWorkRequestsRequest) ValidateEnumValue ¶
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ListWorkRequestsResponse ¶
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.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
func (ListWorkRequestsResponse) HTTPResponse ¶
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (ListWorkRequestsResponse) String ¶
func (response ListWorkRequestsResponse) String() string
type ListWorkRequestsSortByEnum ¶
type ListWorkRequestsSortByEnum string
ListWorkRequestsSortByEnum Enum with underlying type: string
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortByEnumValues ¶
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum ¶
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestsSortOrderEnum ¶
type ListWorkRequestsSortOrderEnum string
ListWorkRequestsSortOrderEnum Enum with underlying type: string
const ( ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC" ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC" )
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsSortOrderEnumValues ¶
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum ¶
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
type ListWorkRequestsStatusEnum ¶
type ListWorkRequestsStatusEnum string
ListWorkRequestsStatusEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
func GetListWorkRequestsStatusEnumValues ¶
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum ¶
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
type OperationStatusEnum ¶
type OperationStatusEnum string
OperationStatusEnum Enum with underlying type: string
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" )
Set of constants representing the allowable values for OperationStatusEnum
func GetMappingOperationStatusEnum ¶
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues ¶
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
type OperationTypeEnum ¶
type OperationTypeEnum string
OperationTypeEnum Enum with underlying type: string
const ( OperationTypeStartResource OperationTypeEnum = "START_RESOURCE" OperationTypeStopResource OperationTypeEnum = "STOP_RESOURCE" OperationTypeChangeScheduleCompartment OperationTypeEnum = "CHANGE_SCHEDULE_COMPARTMENT" OperationTypeCreateSchedule OperationTypeEnum = "CREATE_SCHEDULE" OperationTypeUpdateSchedule OperationTypeEnum = "UPDATE_SCHEDULE" )
Set of constants representing the allowable values for OperationTypeEnum
func GetMappingOperationTypeEnum ¶
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues ¶
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
type Parameter ¶ added in v65.89.3
type Parameter interface {
}
Parameter This is a generic input parameter to use when acting on the resource.
type ParameterParameterTypeEnum ¶ added in v65.89.3
type ParameterParameterTypeEnum string
ParameterParameterTypeEnum Enum with underlying type: string
const ( ParameterParameterTypeHeader ParameterParameterTypeEnum = "HEADER" ParameterParameterTypeBody ParameterParameterTypeEnum = "BODY" ParameterParameterTypePath ParameterParameterTypeEnum = "PATH" ParameterParameterTypeQuery ParameterParameterTypeEnum = "QUERY" )
Set of constants representing the allowable values for ParameterParameterTypeEnum
func GetMappingParameterParameterTypeEnum ¶ added in v65.89.3
func GetMappingParameterParameterTypeEnum(val string) (ParameterParameterTypeEnum, bool)
GetMappingParameterParameterTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetParameterParameterTypeEnumValues ¶ added in v65.89.3
func GetParameterParameterTypeEnumValues() []ParameterParameterTypeEnum
GetParameterParameterTypeEnumValues Enumerates the set of values for ParameterParameterTypeEnum
type PathParameter ¶ added in v65.89.3
type PathParameter struct {
// This is the path parameter value.
Value map[string]string `mandatory:"false" json:"value"`
}
PathParameter This is an input parameter that will be passed as URL path parameter.
func (PathParameter) MarshalJSON ¶ added in v65.89.3
func (m PathParameter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (PathParameter) String ¶ added in v65.89.3
func (m PathParameter) String() string
func (PathParameter) ValidateEnumValue ¶ added in v65.89.3
func (m PathParameter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type QueryParameter ¶ added in v65.89.3
type QueryParameter struct {
// This is the query parameter value.
Value map[string]string `mandatory:"false" json:"value"`
}
QueryParameter This is an input parameter that will be passed as URL query parameter.
func (QueryParameter) MarshalJSON ¶ added in v65.89.3
func (m QueryParameter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (QueryParameter) String ¶ added in v65.89.3
func (m QueryParameter) String() string
func (QueryParameter) ValidateEnumValue ¶ added in v65.89.3
func (m QueryParameter) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type Resource ¶
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"`
// This is the user input parameters to use when acting on the resource.
// {
// "parameters": [
// {
// "parameterType": "BODY",
// "value": {
// "ip": "192.168.44.44",
// "memory": "1024",
// "synced_folders": [
// {
// "host_path": "data/",
// "guest_path": "/var/www",
// "type": "default"
// }
// ],
// "forwarded_ports": []
// }
// },
// {
// "parameterType": "PATH",
// "value": {
// "compartmentId": "ocid1.compartment.oc1..xxxxx",
// "instanceId": "ocid1.vcn.oc1..yyyy"
// }
// },
// {
// "parameterType": "QUERY",
// "value": {
// "limit": "10",
// "tenantId": "ocid1.tenant.oc1..zzzz"
// }
// },
// {
// "parameterType": "HEADER",
// "value": {
// "token": "xxxx"
// }
// }
// ]
// }
Parameters []Parameter `mandatory:"false" json:"parameters"`
}
Resource This is the schedule resource entity.
func (*Resource) UnmarshalJSON ¶ added in v65.89.3
UnmarshalJSON unmarshals from json
func (Resource) ValidateEnumValue ¶
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ResourceFilter ¶
type ResourceFilter interface {
}
ResourceFilter This is a generic filter used to decide which resources that the schedule be applied to.
type ResourceFilterAttributeEnum ¶
type ResourceFilterAttributeEnum string
ResourceFilterAttributeEnum Enum with underlying type: string
const ( ResourceFilterAttributeCompartmentId ResourceFilterAttributeEnum = "COMPARTMENT_ID" ResourceFilterAttributeResourceType ResourceFilterAttributeEnum = "RESOURCE_TYPE" ResourceFilterAttributeDefinedTags ResourceFilterAttributeEnum = "DEFINED_TAGS" ResourceFilterAttributeTimeCreated ResourceFilterAttributeEnum = "TIME_CREATED" ResourceFilterAttributeLifecycleState ResourceFilterAttributeEnum = "LIFECYCLE_STATE" )
Set of constants representing the allowable values for ResourceFilterAttributeEnum
func GetMappingResourceFilterAttributeEnum ¶
func GetMappingResourceFilterAttributeEnum(val string) (ResourceFilterAttributeEnum, bool)
GetMappingResourceFilterAttributeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetResourceFilterAttributeEnumValues ¶
func GetResourceFilterAttributeEnumValues() []ResourceFilterAttributeEnum
GetResourceFilterAttributeEnumValues Enumerates the set of values for ResourceFilterAttributeEnum
type ResourceType ¶
type ResourceType struct {
// This is a resource type supported by resource scheduler.
Name *string `mandatory:"true" json:"name"`
}
ResourceType This is a resource type supported by resource scheduler.
func (ResourceType) String ¶
func (m ResourceType) String() string
func (ResourceType) ValidateEnumValue ¶
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
type ResourceTypeCollection ¶
type ResourceTypeCollection struct {
// This is the collection of resource types supported by resource scheduler.
Items []ResourceType `mandatory:"true" json:"items"`
}
ResourceTypeCollection This is the collection of resource types supported by resource scheduler.
func (ResourceTypeCollection) String ¶
func (m ResourceTypeCollection) String() string
func (ResourceTypeCollection) ValidateEnumValue ¶
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
type ResourceTypeResourceFilter ¶
type ResourceTypeResourceFilter struct {
// This is a collection of resource types.
Value []string `mandatory:"false" json:"value"`
}
ResourceTypeResourceFilter This is a resource filter for filtering resource based on resource type.
func (ResourceTypeResourceFilter) MarshalJSON ¶
func (m ResourceTypeResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (ResourceTypeResourceFilter) String ¶
func (m ResourceTypeResourceFilter) String() string
func (ResourceTypeResourceFilter) ValidateEnumValue ¶
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
type Schedule ¶
type Schedule struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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.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.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"`
// This is the status of the last work request.
LastRunStatus OperationStatusEnum `mandatory:"false" json:"lastRunStatus,omitempty"`
// 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"`
}
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.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
func (*Schedule) UnmarshalJSON ¶
UnmarshalJSON unmarshals from json
func (Schedule) ValidateEnumValue ¶
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type ScheduleActionEnum ¶
type ScheduleActionEnum string
ScheduleActionEnum Enum with underlying type: string
const ( ScheduleActionStartResource ScheduleActionEnum = "START_RESOURCE" ScheduleActionStopResource ScheduleActionEnum = "STOP_RESOURCE" )
Set of constants representing the allowable values for ScheduleActionEnum
func GetMappingScheduleActionEnum ¶
func GetMappingScheduleActionEnum(val string) (ScheduleActionEnum, bool)
GetMappingScheduleActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleActionEnumValues ¶
func GetScheduleActionEnumValues() []ScheduleActionEnum
GetScheduleActionEnumValues Enumerates the set of values for ScheduleActionEnum
type ScheduleClient ¶
type ScheduleClient struct {
common.BaseClient
// contains filtered or unexported fields
}
ScheduleClient a client for Schedule
func NewScheduleClientWithConfigurationProvider ¶
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 ¶
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 (ScheduleClient) ActivateSchedule ¶
func (client ScheduleClient) ActivateSchedule(ctx context.Context, request ActivateScheduleRequest) (response ActivateScheduleResponse, err error)
ActivateSchedule This API activates a schedule.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ActivateSchedule.go.html to see an example of how to use ActivateSchedule API. A default retry strategy applies to this operation ActivateSchedule()
func (ScheduleClient) CancelWorkRequest ¶
func (client ScheduleClient) CancelWorkRequest(ctx context.Context, request CancelWorkRequestRequest) (response CancelWorkRequestResponse, err error)
CancelWorkRequest This API cancels a work request.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/CancelWorkRequest.go.html to see an example of how to use CancelWorkRequest API. A default retry strategy applies to this operation CancelWorkRequest()
func (ScheduleClient) ChangeScheduleCompartment ¶ added in v65.89.3
func (client ScheduleClient) ChangeScheduleCompartment(ctx context.Context, request ChangeScheduleCompartmentRequest) (response ChangeScheduleCompartmentResponse, err error)
ChangeScheduleCompartment This API) moves a schedule into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ChangeScheduleCompartment.go.html to see an example of how to use ChangeScheduleCompartment API. A default retry strategy applies to this operation ChangeScheduleCompartment()
func (*ScheduleClient) ConfigurationProvider ¶
func (client *ScheduleClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (ScheduleClient) CreateSchedule ¶
func (client ScheduleClient) CreateSchedule(ctx context.Context, request CreateScheduleRequest) (response CreateScheduleResponse, err error)
CreateSchedule This API creates a schedule. You must provide either resources or resourceFilters.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/CreateSchedule.go.html to see an example of how to use CreateSchedule API. A default retry strategy applies to this operation CreateSchedule()
func (ScheduleClient) DeactivateSchedule ¶
func (client ScheduleClient) DeactivateSchedule(ctx context.Context, request DeactivateScheduleRequest) (response DeactivateScheduleResponse, err error)
DeactivateSchedule This API deactivates a schedule.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/DeactivateSchedule.go.html to see an example of how to use DeactivateSchedule API. A default retry strategy applies to this operation DeactivateSchedule()
func (ScheduleClient) DeleteSchedule ¶
func (client ScheduleClient) DeleteSchedule(ctx context.Context, request DeleteScheduleRequest) (response DeleteScheduleResponse, err error)
DeleteSchedule This API deletes a schedule.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/DeleteSchedule.go.html to see an example of how to use DeleteSchedule API. A default retry strategy applies to this operation DeleteSchedule()
func (ScheduleClient) GetSchedule ¶
func (client ScheduleClient) GetSchedule(ctx context.Context, request GetScheduleRequest) (response GetScheduleResponse, err error)
GetSchedule This API gets information about a schedule.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/GetSchedule.go.html to see an example of how to use GetSchedule API. A default retry strategy applies to this operation GetSchedule()
func (ScheduleClient) GetWorkRequest ¶
func (client ScheduleClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest This API gets the details of a work request.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (ScheduleClient) ListResourceTypes ¶
func (client ScheduleClient) ListResourceTypes(ctx context.Context, request ListResourceTypesRequest) (response ListResourceTypesResponse, err error)
ListResourceTypes This API gets a list of schedule resource types.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListResourceTypes.go.html to see an example of how to use ListResourceTypes API. A default retry strategy applies to this operation ListResourceTypes()
func (ScheduleClient) ListSchedules ¶
func (client ScheduleClient) ListSchedules(ctx context.Context, request ListSchedulesRequest) (response ListSchedulesResponse, err error)
ListSchedules This API gets a list of schedules. You must provide either a compartmentId or a scheduleId or both. You can list resources in this compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This is required unless a specific schedule ID is passed.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListSchedules.go.html to see an example of how to use ListSchedules API. A default retry strategy applies to this operation ListSchedules()
func (ScheduleClient) ListWorkRequestErrors ¶
func (client ScheduleClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors This API lists the errors for a work request.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (ScheduleClient) ListWorkRequestLogs ¶
func (client ScheduleClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (ScheduleClient) ListWorkRequests ¶
func (client ScheduleClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests This API gets a list of work requests. You must provide either a compartmentId or a workRequestId or both. You can list work requests in this compartment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This is required unless a specific workRequestId is passed.
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (*ScheduleClient) SetRegion ¶
func (client *ScheduleClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (ScheduleClient) UpdateSchedule ¶
func (client ScheduleClient) UpdateSchedule(ctx context.Context, request UpdateScheduleRequest) (response UpdateScheduleResponse, err error)
UpdateSchedule The API updates a schedule
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/UpdateSchedule.go.html to see an example of how to use UpdateSchedule API. A default retry strategy applies to this operation UpdateSchedule()
type ScheduleCollection ¶
type ScheduleCollection struct {
// This is the list of schedule items.
Items []ScheduleSummary `mandatory:"true" json:"items"`
}
ScheduleCollection This is the list of schedule items.
func (ScheduleCollection) String ¶
func (m ScheduleCollection) String() string
func (ScheduleCollection) ValidateEnumValue ¶
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
type ScheduleLifecycleStateEnum ¶
type ScheduleLifecycleStateEnum string
ScheduleLifecycleStateEnum Enum with underlying type: string
const ( ScheduleLifecycleStateActive ScheduleLifecycleStateEnum = "ACTIVE" ScheduleLifecycleStateInactive ScheduleLifecycleStateEnum = "INACTIVE" ScheduleLifecycleStateCreating ScheduleLifecycleStateEnum = "CREATING" ScheduleLifecycleStateUpdating ScheduleLifecycleStateEnum = "UPDATING" ScheduleLifecycleStateDeleting ScheduleLifecycleStateEnum = "DELETING" ScheduleLifecycleStateDeleted ScheduleLifecycleStateEnum = "DELETED" ScheduleLifecycleStateFailed ScheduleLifecycleStateEnum = "FAILED" )
Set of constants representing the allowable values for ScheduleLifecycleStateEnum
func GetMappingScheduleLifecycleStateEnum ¶
func GetMappingScheduleLifecycleStateEnum(val string) (ScheduleLifecycleStateEnum, bool)
GetMappingScheduleLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleLifecycleStateEnumValues ¶
func GetScheduleLifecycleStateEnumValues() []ScheduleLifecycleStateEnum
GetScheduleLifecycleStateEnumValues Enumerates the set of values for ScheduleLifecycleStateEnum
type ScheduleRecurrenceTypeEnum ¶
type ScheduleRecurrenceTypeEnum string
ScheduleRecurrenceTypeEnum Enum with underlying type: string
const ( ScheduleRecurrenceTypeCron ScheduleRecurrenceTypeEnum = "CRON" ScheduleRecurrenceTypeIcal ScheduleRecurrenceTypeEnum = "ICAL" )
Set of constants representing the allowable values for ScheduleRecurrenceTypeEnum
func GetMappingScheduleRecurrenceTypeEnum ¶
func GetMappingScheduleRecurrenceTypeEnum(val string) (ScheduleRecurrenceTypeEnum, bool)
GetMappingScheduleRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleRecurrenceTypeEnumValues ¶
func GetScheduleRecurrenceTypeEnumValues() []ScheduleRecurrenceTypeEnum
GetScheduleRecurrenceTypeEnumValues Enumerates the set of values for ScheduleRecurrenceTypeEnum
type ScheduleSummary ¶
type ScheduleSummary struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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.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.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"`
}
ScheduleSummary This is the summary information about a schedule.
func (ScheduleSummary) String ¶
func (m ScheduleSummary) String() string
func (*ScheduleSummary) UnmarshalJSON ¶
func (m *ScheduleSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (ScheduleSummary) ValidateEnumValue ¶
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
type ScheduleSummaryActionEnum ¶
type ScheduleSummaryActionEnum string
ScheduleSummaryActionEnum Enum with underlying type: string
const ( ScheduleSummaryActionStartResource ScheduleSummaryActionEnum = "START_RESOURCE" ScheduleSummaryActionStopResource ScheduleSummaryActionEnum = "STOP_RESOURCE" )
Set of constants representing the allowable values for ScheduleSummaryActionEnum
func GetMappingScheduleSummaryActionEnum ¶
func GetMappingScheduleSummaryActionEnum(val string) (ScheduleSummaryActionEnum, bool)
GetMappingScheduleSummaryActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleSummaryActionEnumValues ¶
func GetScheduleSummaryActionEnumValues() []ScheduleSummaryActionEnum
GetScheduleSummaryActionEnumValues Enumerates the set of values for ScheduleSummaryActionEnum
type ScheduleSummaryRecurrenceTypeEnum ¶
type ScheduleSummaryRecurrenceTypeEnum string
ScheduleSummaryRecurrenceTypeEnum Enum with underlying type: string
const ( ScheduleSummaryRecurrenceTypeCron ScheduleSummaryRecurrenceTypeEnum = "CRON" ScheduleSummaryRecurrenceTypeIcal ScheduleSummaryRecurrenceTypeEnum = "ICAL" )
Set of constants representing the allowable values for ScheduleSummaryRecurrenceTypeEnum
func GetMappingScheduleSummaryRecurrenceTypeEnum ¶
func GetMappingScheduleSummaryRecurrenceTypeEnum(val string) (ScheduleSummaryRecurrenceTypeEnum, bool)
GetMappingScheduleSummaryRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetScheduleSummaryRecurrenceTypeEnumValues ¶
func GetScheduleSummaryRecurrenceTypeEnumValues() []ScheduleSummaryRecurrenceTypeEnum
GetScheduleSummaryRecurrenceTypeEnumValues Enumerates the set of values for ScheduleSummaryRecurrenceTypeEnum
type SortOrderEnum ¶
type SortOrderEnum string
SortOrderEnum Enum with underlying type: string
const ( SortOrderAsc SortOrderEnum = "ASC" SortOrderDesc SortOrderEnum = "DESC" )
Set of constants representing the allowable values for SortOrderEnum
func GetMappingSortOrderEnum ¶
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues ¶
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
type TimeCreatedResourceFilter ¶
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"`
}
TimeCreatedResourceFilter This is a resource filter for filtering resources based on their creation time.
func (TimeCreatedResourceFilter) MarshalJSON ¶
func (m TimeCreatedResourceFilter) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (TimeCreatedResourceFilter) String ¶
func (m TimeCreatedResourceFilter) String() string
func (TimeCreatedResourceFilter) ValidateEnumValue ¶
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
type TimeCreatedResourceFilterConditionEnum ¶
type TimeCreatedResourceFilterConditionEnum string
TimeCreatedResourceFilterConditionEnum Enum with underlying type: string
const ( TimeCreatedResourceFilterConditionEqual TimeCreatedResourceFilterConditionEnum = "EQUAL" TimeCreatedResourceFilterConditionBefore TimeCreatedResourceFilterConditionEnum = "BEFORE" TimeCreatedResourceFilterConditionAfter TimeCreatedResourceFilterConditionEnum = "AFTER" )
Set of constants representing the allowable values for TimeCreatedResourceFilterConditionEnum
func GetMappingTimeCreatedResourceFilterConditionEnum ¶
func GetMappingTimeCreatedResourceFilterConditionEnum(val string) (TimeCreatedResourceFilterConditionEnum, bool)
GetMappingTimeCreatedResourceFilterConditionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTimeCreatedResourceFilterConditionEnumValues ¶
func GetTimeCreatedResourceFilterConditionEnumValues() []TimeCreatedResourceFilterConditionEnum
GetTimeCreatedResourceFilterConditionEnumValues Enumerates the set of values for TimeCreatedResourceFilterConditionEnum
type UpdateScheduleDetails ¶
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.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.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
// Example: `{"Operations": {"CostCenter": "42"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
UpdateScheduleDetails This is the data to update a schedule.
func (UpdateScheduleDetails) String ¶
func (m UpdateScheduleDetails) String() string
func (*UpdateScheduleDetails) UnmarshalJSON ¶
func (m *UpdateScheduleDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (UpdateScheduleDetails) ValidateEnumValue ¶
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
type UpdateScheduleDetailsActionEnum ¶
type UpdateScheduleDetailsActionEnum string
UpdateScheduleDetailsActionEnum Enum with underlying type: string
const ( UpdateScheduleDetailsActionStartResource UpdateScheduleDetailsActionEnum = "START_RESOURCE" UpdateScheduleDetailsActionStopResource UpdateScheduleDetailsActionEnum = "STOP_RESOURCE" )
Set of constants representing the allowable values for UpdateScheduleDetailsActionEnum
func GetMappingUpdateScheduleDetailsActionEnum ¶
func GetMappingUpdateScheduleDetailsActionEnum(val string) (UpdateScheduleDetailsActionEnum, bool)
GetMappingUpdateScheduleDetailsActionEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateScheduleDetailsActionEnumValues ¶
func GetUpdateScheduleDetailsActionEnumValues() []UpdateScheduleDetailsActionEnum
GetUpdateScheduleDetailsActionEnumValues Enumerates the set of values for UpdateScheduleDetailsActionEnum
type UpdateScheduleDetailsRecurrenceTypeEnum ¶
type UpdateScheduleDetailsRecurrenceTypeEnum string
UpdateScheduleDetailsRecurrenceTypeEnum Enum with underlying type: string
const ( UpdateScheduleDetailsRecurrenceTypeCron UpdateScheduleDetailsRecurrenceTypeEnum = "CRON" UpdateScheduleDetailsRecurrenceTypeIcal UpdateScheduleDetailsRecurrenceTypeEnum = "ICAL" )
Set of constants representing the allowable values for UpdateScheduleDetailsRecurrenceTypeEnum
func GetMappingUpdateScheduleDetailsRecurrenceTypeEnum ¶
func GetMappingUpdateScheduleDetailsRecurrenceTypeEnum(val string) (UpdateScheduleDetailsRecurrenceTypeEnum, bool)
GetMappingUpdateScheduleDetailsRecurrenceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetUpdateScheduleDetailsRecurrenceTypeEnumValues ¶
func GetUpdateScheduleDetailsRecurrenceTypeEnumValues() []UpdateScheduleDetailsRecurrenceTypeEnum
GetUpdateScheduleDetailsRecurrenceTypeEnumValues Enumerates the set of values for UpdateScheduleDetailsRecurrenceTypeEnum
type UpdateScheduleRequest ¶
type UpdateScheduleRequest struct {
// This is the OCID (https://docs.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
}
UpdateScheduleRequest wrapper for the UpdateSchedule operation
See also ¶
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/resourcescheduler/UpdateSchedule.go.html to see an example of how to use UpdateScheduleRequest.
func (UpdateScheduleRequest) BinaryRequestBody ¶
func (request UpdateScheduleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (UpdateScheduleRequest) HTTPRequest ¶
func (request UpdateScheduleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (UpdateScheduleRequest) RetryPolicy ¶
func (request UpdateScheduleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (UpdateScheduleRequest) String ¶
func (request UpdateScheduleRequest) String() string
func (UpdateScheduleRequest) ValidateEnumValue ¶
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
type UpdateScheduleResponse ¶
type UpdateScheduleResponse struct {
// The underlying http response
RawResponse *http.Response
// The OCID (https://docs.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"`
}
UpdateScheduleResponse wrapper for the UpdateSchedule operation
func (UpdateScheduleResponse) HTTPResponse ¶
func (response UpdateScheduleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (UpdateScheduleResponse) String ¶
func (response UpdateScheduleResponse) String() string
type WorkRequest ¶
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.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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"`
}
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.
func (WorkRequest) String ¶
func (m WorkRequest) String() string
func (WorkRequest) ValidateEnumValue ¶
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type WorkRequestError ¶
type WorkRequestError struct {
// A machine-usable code for the error that occurred. For a list of error codes, see
// API Errors (https://docs.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"`
}
WorkRequestError This is an error encountered while performing an operation that is tracked by a work request.
func (WorkRequestError) String ¶
func (m WorkRequestError) String() string
func (WorkRequestError) ValidateEnumValue ¶
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type WorkRequestErrorCollection ¶
type WorkRequestErrorCollection struct {
// This is a list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
WorkRequestErrorCollection This is a list of work request errors. Can contain both errors and other information, such as metadata.
func (WorkRequestErrorCollection) String ¶
func (m WorkRequestErrorCollection) String() string
func (WorkRequestErrorCollection) ValidateEnumValue ¶
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
type WorkRequestLogEntry ¶
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"`
}
WorkRequestLogEntry This is a log message from performing an operation that is tracked by a work request.
func (WorkRequestLogEntry) String ¶
func (m WorkRequestLogEntry) String() string
func (WorkRequestLogEntry) ValidateEnumValue ¶
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type WorkRequestLogEntryCollection ¶
type WorkRequestLogEntryCollection struct {
// This is a list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
WorkRequestLogEntryCollection This is a list of work request logs. Can contain both logs and other information, such as metadata.
func (WorkRequestLogEntryCollection) String ¶
func (m WorkRequestLogEntryCollection) String() string
func (WorkRequestLogEntryCollection) ValidateEnumValue ¶
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
type WorkRequestResource ¶
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.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"`
}
WorkRequestResource This is a resource created or operated on by a work request.
func (WorkRequestResource) String ¶
func (m WorkRequestResource) String() string
func (WorkRequestResource) ValidateEnumValue ¶
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type WorkRequestSummary ¶
type WorkRequestSummary struct {
// This is the status of the work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
Id *string `mandatory:"true" json:"id"`
// The OCID (https://docs.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"`
}
WorkRequestSummary This is the summary information about an asynchronous work request.
func (WorkRequestSummary) String ¶
func (m WorkRequestSummary) String() string
func (WorkRequestSummary) ValidateEnumValue ¶
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
type WorkRequestSummaryCollection ¶
type WorkRequestSummaryCollection struct {
// This is a list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
WorkRequestSummaryCollection This is a list of work requests. Can contain both work requests and other information, such as metadata.
func (WorkRequestSummaryCollection) String ¶
func (m WorkRequestSummaryCollection) String() string
func (WorkRequestSummaryCollection) ValidateEnumValue ¶
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
Source Files
¶
- action_type.go
- activate_schedule_request_response.go
- body_parameter.go
- cancel_work_request_request_response.go
- change_schedule_compartment_details.go
- change_schedule_compartment_request_response.go
- compartment_id_resource_filter.go
- create_schedule_details.go
- create_schedule_request_response.go
- deactivate_schedule_request_response.go
- defined_tag_filter_value.go
- defined_tags_resource_filter.go
- delete_schedule_request_response.go
- get_schedule_request_response.go
- get_work_request_request_response.go
- header_parameter.go
- lifecycle_state_resource_filter.go
- list_resource_types_request_response.go
- list_schedules_request_response.go
- list_work_request_errors_request_response.go
- list_work_request_logs_request_response.go
- list_work_requests_request_response.go
- operation_status.go
- operation_type.go
- parameter.go
- path_parameter.go
- query_parameter.go
- resource.go
- resource_filter.go
- resource_type.go
- resource_type_collection.go
- resource_type_resource_filter.go
- resourcescheduler_schedule_client.go
- schedule.go
- schedule_collection.go
- schedule_summary.go
- sort_order.go
- time_created_resource_filter.go
- update_schedule_details.go
- update_schedule_request_response.go
- work_request.go
- work_request_error.go
- work_request_error_collection.go
- work_request_log_entry.go
- work_request_log_entry_collection.go
- work_request_resource.go
- work_request_summary.go
- work_request_summary_collection.go