func GetActionActionTypeEnumStringValues() []string
GetActionActionTypeEnumStringValues Enumerates the set of values in String for ActionActionTypeEnum
func GetActionDetailsActionTypeEnumStringValues() []string
GetActionDetailsActionTypeEnumStringValues Enumerates the set of values in String for ActionDetailsActionTypeEnum
func GetActionLifecycleStateEnumStringValues() []string
GetActionLifecycleStateEnumStringValues Enumerates the set of values in String for ActionLifecycleStateEnum
func GetListRulesSortByEnumStringValues() []string
GetListRulesSortByEnumStringValues Enumerates the set of values in String for ListRulesSortByEnum
func GetListRulesSortOrderEnumStringValues() []string
GetListRulesSortOrderEnumStringValues Enumerates the set of values in String for ListRulesSortOrderEnum
func GetRuleLifecycleStateEnumStringValues() []string
GetRuleLifecycleStateEnumStringValues Enumerates the set of values in String for RuleLifecycleStateEnum
Action An object that represents an action to trigger for events that match a rule.
type Action interface { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the action. GetId() *string // A message generated by the Events service about the current state of this action. GetLifecycleMessage() *string // The current state of the rule. GetLifecycleState() ActionLifecycleStateEnum // Whether or not this action is currently enabled. // Example: `true` GetIsEnabled() *bool // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. GetDescription() *string }
ActionActionTypeEnum Enum with underlying type: string
type ActionActionTypeEnum string
Set of constants representing the allowable values for ActionActionTypeEnum
const ( ActionActionTypeOns ActionActionTypeEnum = "ONS" ActionActionTypeOss ActionActionTypeEnum = "OSS" ActionActionTypeFaas ActionActionTypeEnum = "FAAS" )
func GetActionActionTypeEnumValues() []ActionActionTypeEnum
GetActionActionTypeEnumValues Enumerates the set of values for ActionActionTypeEnum
func GetMappingActionActionTypeEnum(val string) (ActionActionTypeEnum, bool)
GetMappingActionActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActionDetails Object used to create an action.
type ActionDetails interface { // Whether or not this action is currently enabled. // Example: `true` GetIsEnabled() *bool // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. GetDescription() *string }
ActionDetailsActionTypeEnum Enum with underlying type: string
type ActionDetailsActionTypeEnum string
Set of constants representing the allowable values for ActionDetailsActionTypeEnum
const ( ActionDetailsActionTypeOns ActionDetailsActionTypeEnum = "ONS" ActionDetailsActionTypeOss ActionDetailsActionTypeEnum = "OSS" ActionDetailsActionTypeFaas ActionDetailsActionTypeEnum = "FAAS" )
func GetActionDetailsActionTypeEnumValues() []ActionDetailsActionTypeEnum
GetActionDetailsActionTypeEnumValues Enumerates the set of values for ActionDetailsActionTypeEnum
func GetMappingActionDetailsActionTypeEnum(val string) (ActionDetailsActionTypeEnum, bool)
GetMappingActionDetailsActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ActionDetailsList A list of ActionDetails objects to create for a rule.
type ActionDetailsList struct { // A list of one or more ActionDetails objects. Actions []ActionDetails `mandatory:"true" json:"actions"` }
func (m ActionDetailsList) String() string
func (m *ActionDetailsList) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ActionDetailsList) 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
ActionLifecycleStateEnum Enum with underlying type: string
type ActionLifecycleStateEnum string
Set of constants representing the allowable values for ActionLifecycleStateEnum
const ( ActionLifecycleStateCreating ActionLifecycleStateEnum = "CREATING" ActionLifecycleStateActive ActionLifecycleStateEnum = "ACTIVE" ActionLifecycleStateInactive ActionLifecycleStateEnum = "INACTIVE" ActionLifecycleStateUpdating ActionLifecycleStateEnum = "UPDATING" ActionLifecycleStateDeleting ActionLifecycleStateEnum = "DELETING" ActionLifecycleStateDeleted ActionLifecycleStateEnum = "DELETED" ActionLifecycleStateFailed ActionLifecycleStateEnum = "FAILED" )
func GetActionLifecycleStateEnumValues() []ActionLifecycleStateEnum
GetActionLifecycleStateEnumValues Enumerates the set of values for ActionLifecycleStateEnum
func GetMappingActionLifecycleStateEnum(val string) (ActionLifecycleStateEnum, bool)
GetMappingActionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ActionList A list of Action objects associated with a rule.
type ActionList struct { // A list of one or more Action objects. Actions []Action `mandatory:"true" json:"actions"` }
func (m ActionList) String() string
func (m *ActionList) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ActionList) 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
ChangeRuleCompartmentDetails Specifies which compartment to move a rule to when changing a rule's compartment.
type ChangeRuleCompartmentDetails struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment // into which the resource should be moved. CompartmentId *string `mandatory:"true" json:"compartmentId"` }
func (m ChangeRuleCompartmentDetails) String() string
func (m ChangeRuleCompartmentDetails) 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
ChangeRuleCompartmentRequest wrapper for the ChangeRuleCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/ChangeRuleCompartment.go.html to see an example of how to use ChangeRuleCompartmentRequest.
type ChangeRuleCompartmentRequest struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. RuleId *string `mandatory:"true" contributesTo:"path" name:"ruleId"` ChangeRuleCompartmentDetails `contributesTo:"body"` // 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"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing 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 purged from the system, then a retry of the original creation request // may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ChangeRuleCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeRuleCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeRuleCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeRuleCompartmentRequest) String() string
func (request ChangeRuleCompartmentRequest) 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
ChangeRuleCompartmentResponse wrapper for the ChangeRuleCompartment operation
type ChangeRuleCompartmentResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ChangeRuleCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeRuleCompartmentResponse) String() string
CreateFaaSActionDetails Create an action that delivers to an Oracle Functions Service endpoint.
type CreateFaaSActionDetails struct { // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. FunctionId *string `mandatory:"false" json:"functionId"` }
func (m CreateFaaSActionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateFaaSActionDetails) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m CreateFaaSActionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateFaaSActionDetails) String() string
func (m CreateFaaSActionDetails) 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
CreateNotificationServiceActionDetails Create an action that delivers to an Oracle Notification Service topic.
type CreateNotificationServiceActionDetails struct { // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. TopicId *string `mandatory:"false" json:"topicId"` }
func (m CreateNotificationServiceActionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateNotificationServiceActionDetails) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m CreateNotificationServiceActionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateNotificationServiceActionDetails) String() string
func (m CreateNotificationServiceActionDetails) 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
CreateRuleDetails Object used to create a rule.
type CreateRuleDetails struct { // A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. DisplayName *string `mandatory:"true" json:"displayName"` // Whether or not this rule is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` // A filter that specifies the event that will trigger actions associated with this rule. A few // important things to remember about filters: // * Fields not mentioned in the condition are ignored. You can create a valid filter that matches // all events with two curly brackets: `{}` // For more examples, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). // * For a condition with fields to match an event, the event must contain all the field names // listed in the condition. Field names must appear in the condition with the same nesting // structure used in the event. // For a list of reference events, see // Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). // * Rules apply to events in the compartment in which you create them and any child compartments. // This means that a condition specified by a rule only matches events emitted from resources in // the compartment or any of its child compartments. // * Wildcard matching is supported with the asterisk (*) character. // For examples of wildcard matching, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) // Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` Condition *string `mandatory:"true" json:"condition"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. CompartmentId *string `mandatory:"true" json:"compartmentId"` Actions *ActionDetailsList `mandatory:"true" json:"actions"` // A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. // 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"` // 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"` }
func (m CreateRuleDetails) String() string
func (m CreateRuleDetails) 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
CreateRuleRequest wrapper for the CreateRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/CreateRule.go.html to see an example of how to use CreateRuleRequest.
type CreateRuleRequest struct { // Specification of the rule to create CreateRuleDetails `contributesTo:"body"` // A token that uniquely identifies a request so it can be retried in case of a timeout or // server error without risk of executing 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 purged from the system, then a retry of the original creation request // may be rejected). OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request CreateRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateRuleRequest) String() string
func (request CreateRuleRequest) 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
CreateRuleResponse wrapper for the CreateRule operation
type CreateRuleResponse struct { // The underlying http response RawResponse *http.Response // The Rule instance Rule `presentIn:"body"` // For optimistic concurrency control. Add this value to the `if-match` parameter // in a PUT or DELETE operation. The resource will be updated only if the value you // provide matches the `etag` on the resource. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response CreateRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateRuleResponse) String() string
CreateStreamingServiceActionDetails Create an action that delivers to an Oracle Stream Service stream.
type CreateStreamingServiceActionDetails struct { // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. StreamId *string `mandatory:"true" json:"streamId"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` }
func (m CreateStreamingServiceActionDetails) GetDescription() *string
GetDescription returns Description
func (m CreateStreamingServiceActionDetails) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m CreateStreamingServiceActionDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateStreamingServiceActionDetails) String() string
func (m CreateStreamingServiceActionDetails) 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
DeleteRuleRequest wrapper for the DeleteRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/DeleteRule.go.html to see an example of how to use DeleteRuleRequest.
type DeleteRuleRequest struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. RuleId *string `mandatory:"true" contributesTo:"path" name:"ruleId"` // 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"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request DeleteRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteRuleRequest) String() string
func (request DeleteRuleRequest) 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
DeleteRuleResponse wrapper for the DeleteRule operation
type DeleteRuleResponse struct { // The underlying http response RawResponse *http.Response // Unique Oracle-assigned identifier for the request. If you need to contact Oracle // about a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response DeleteRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteRuleResponse) String() string
EventsClient a client for Events
type EventsClient struct { common.BaseClient // contains filtered or unexported fields }
func NewEventsClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client EventsClient, err error)
NewEventsClientWithConfigurationProvider Creates a new default Events client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewEventsClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client EventsClient, err error)
NewEventsClientWithOboToken Creates a new default Events client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client EventsClient) ChangeRuleCompartment(ctx context.Context, request ChangeRuleCompartmentRequest) (response ChangeRuleCompartmentResponse, err error)
ChangeRuleCompartment Moves a rule 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).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/ChangeRuleCompartment.go.html to see an example of how to use ChangeRuleCompartment API.
func (client *EventsClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client EventsClient) CreateRule(ctx context.Context, request CreateRuleRequest) (response CreateRuleResponse, err error)
CreateRule Creates a new rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/CreateRule.go.html to see an example of how to use CreateRule API.
func (client EventsClient) DeleteRule(ctx context.Context, request DeleteRuleRequest) (response DeleteRuleResponse, err error)
DeleteRule Deletes a rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/DeleteRule.go.html to see an example of how to use DeleteRule API.
func (client EventsClient) GetRule(ctx context.Context, request GetRuleRequest) (response GetRuleResponse, err error)
GetRule Retrieves a rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/GetRule.go.html to see an example of how to use GetRule API.
func (client EventsClient) ListRules(ctx context.Context, request ListRulesRequest) (response ListRulesResponse, err error)
ListRules Lists rules for this compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/ListRules.go.html to see an example of how to use ListRules API.
func (client *EventsClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client EventsClient) UpdateRule(ctx context.Context, request UpdateRuleRequest) (response UpdateRuleResponse, err error)
UpdateRule Updates a rule.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/UpdateRule.go.html to see an example of how to use UpdateRule API.
FaaSAction An action that delivers to an Oracle Functions endpoint.
type FaaSAction struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the action. Id *string `mandatory:"true" json:"id"` // A message generated by the Events service about the current state of this action. LifecycleMessage *string `mandatory:"true" json:"lifecycleMessage"` // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"false" json:"isEnabled"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. FunctionId *string `mandatory:"false" json:"functionId"` // The current state of the rule. LifecycleState ActionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` }
func (m FaaSAction) GetDescription() *string
GetDescription returns Description
func (m FaaSAction) GetId() *string
GetId returns Id
func (m FaaSAction) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m FaaSAction) GetLifecycleMessage() *string
GetLifecycleMessage returns LifecycleMessage
func (m FaaSAction) GetLifecycleState() ActionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m FaaSAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FaaSAction) String() string
func (m FaaSAction) 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
GetRuleRequest wrapper for the GetRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/GetRule.go.html to see an example of how to use GetRuleRequest.
type GetRuleRequest struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. RuleId *string `mandatory:"true" contributesTo:"path" name:"ruleId"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request GetRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetRuleRequest) String() string
func (request GetRuleRequest) 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
GetRuleResponse wrapper for the GetRule operation
type GetRuleResponse struct { // The underlying http response RawResponse *http.Response // The Rule instance Rule `presentIn:"body"` // For optimistic concurrency control. Add this value to the `if-match` parameter // in a PUT or DELETE operation. The resource will be updated only if the value you // provide matches the `etag` on the resource. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response GetRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetRuleResponse) String() string
ListRulesRequest wrapper for the ListRules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/ListRules.go.html to see an example of how to use ListRulesRequest.
type ListRulesRequest struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"` // The maximum number of items to return. 1 is the minimum, 50 is the maximum. // Default: 10 Limit *int `mandatory:"false" contributesTo:"query" name:"limit"` // For list pagination. The value of the opc-next-page response header from the previous // "List" call. For important details about how pagination works, see // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). Page *string `mandatory:"false" contributesTo:"query" name:"page"` // A filter to return only rules that match the lifecycle state in this parameter. // Example: `Creating` LifecycleState RuleLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"` // A filter to return only rules with descriptions that match the displayName string // in this parameter. // Example: `"This rule sends a notification upon completion of DbaaS backup."` DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"` // Specifies the attribute with which to sort the rules. // Default: `timeCreated` // * **TIME_CREATED:** Sorts by timeCreated. // * **DISPLAY_NAME:** Sorts by displayName. // * **ID:** Sorts by id. SortBy ListRulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"` // Specifies sort order. // * **ASC:** Ascending sort order. // * **DESC:** Descending sort order. SortOrder ListRulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request ListRulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRulesRequest) String() string
func (request ListRulesRequest) 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
ListRulesResponse wrapper for the ListRules operation
type ListRulesResponse struct { // The underlying http response RawResponse *http.Response // A list of []RuleSummary instances Items []RuleSummary `presentIn:"body"` // For list pagination. When this header appears in the response, additional pages of // results remain. For important details about how pagination works, see // List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine). OpcNextPage *string `presentIn:"header" name:"opc-next-page"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response ListRulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRulesResponse) String() string
ListRulesSortByEnum Enum with underlying type: string
type ListRulesSortByEnum string
Set of constants representing the allowable values for ListRulesSortByEnum
const ( ListRulesSortByTimeCreated ListRulesSortByEnum = "TIME_CREATED" ListRulesSortById ListRulesSortByEnum = "ID" ListRulesSortByDisplayName ListRulesSortByEnum = "DISPLAY_NAME" )
func GetListRulesSortByEnumValues() []ListRulesSortByEnum
GetListRulesSortByEnumValues Enumerates the set of values for ListRulesSortByEnum
func GetMappingListRulesSortByEnum(val string) (ListRulesSortByEnum, bool)
GetMappingListRulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRulesSortOrderEnum Enum with underlying type: string
type ListRulesSortOrderEnum string
Set of constants representing the allowable values for ListRulesSortOrderEnum
const ( ListRulesSortOrderAsc ListRulesSortOrderEnum = "ASC" ListRulesSortOrderDesc ListRulesSortOrderEnum = "DESC" )
func GetListRulesSortOrderEnumValues() []ListRulesSortOrderEnum
GetListRulesSortOrderEnumValues Enumerates the set of values for ListRulesSortOrderEnum
func GetMappingListRulesSortOrderEnum(val string) (ListRulesSortOrderEnum, bool)
GetMappingListRulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
NotificationServiceAction An action that delivers to an Oracle Notification Service topic.
type NotificationServiceAction struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the action. Id *string `mandatory:"true" json:"id"` // A message generated by the Events service about the current state of this action. LifecycleMessage *string `mandatory:"true" json:"lifecycleMessage"` // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"false" json:"isEnabled"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. TopicId *string `mandatory:"false" json:"topicId"` // The current state of the rule. LifecycleState ActionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` }
func (m NotificationServiceAction) GetDescription() *string
GetDescription returns Description
func (m NotificationServiceAction) GetId() *string
GetId returns Id
func (m NotificationServiceAction) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m NotificationServiceAction) GetLifecycleMessage() *string
GetLifecycleMessage returns LifecycleMessage
func (m NotificationServiceAction) GetLifecycleState() ActionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m NotificationServiceAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NotificationServiceAction) String() string
func (m NotificationServiceAction) 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
Rule The configuration details of an Events rule. For more information, see Managing Rules for Events (https://docs.oracle.com/iaas/Content/Events/Task/managingrules.htm).
type Rule struct { // A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. // Example: `"This rule sends a notification upon completion of DbaaS backup."` DisplayName *string `mandatory:"true" json:"displayName"` // The current state of the rule. LifecycleState RuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // A filter that specifies the event that will trigger actions associated with this rule. A few // important things to remember about filters: // * Fields not mentioned in the condition are ignored. You can create a valid filter that matches // all events with two curly brackets: `{}` // For more examples, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). // * For a condition with fields to match an event, the event must contain all the field names // listed in the condition. Field names must appear in the condition with the same nesting // structure used in the event. // For a list of reference events, see // Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). // * Rules apply to events in the compartment in which you create them and any child compartments. // This means that a condition specified by a rule only matches events emitted from resources in // the compartment or any of its child compartments. // * Wildcard matching is supported with the asterisk (*) character. // For examples of wildcard matching, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) // Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` Condition *string `mandatory:"true" json:"condition"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Whether or not this rule is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` Actions *ActionList `mandatory:"true" json:"actions"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. Id *string `mandatory:"true" json:"id"` // The time this rule was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) // timestamp format. // Example: `2018-09-12T22:47:12.613Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. // 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"` // 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"` // A message generated by the Events service about the current state of this rule. LifecycleMessage *string `mandatory:"false" json:"lifecycleMessage"` }
func (m Rule) String() string
func (m Rule) 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
RuleLifecycleStateEnum Enum with underlying type: string
type RuleLifecycleStateEnum string
Set of constants representing the allowable values for RuleLifecycleStateEnum
const ( RuleLifecycleStateCreating RuleLifecycleStateEnum = "CREATING" RuleLifecycleStateActive RuleLifecycleStateEnum = "ACTIVE" RuleLifecycleStateInactive RuleLifecycleStateEnum = "INACTIVE" RuleLifecycleStateUpdating RuleLifecycleStateEnum = "UPDATING" RuleLifecycleStateDeleting RuleLifecycleStateEnum = "DELETING" RuleLifecycleStateDeleted RuleLifecycleStateEnum = "DELETED" RuleLifecycleStateFailed RuleLifecycleStateEnum = "FAILED" )
func GetMappingRuleLifecycleStateEnum(val string) (RuleLifecycleStateEnum, bool)
GetMappingRuleLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetRuleLifecycleStateEnumValues() []RuleLifecycleStateEnum
GetRuleLifecycleStateEnumValues Enumerates the set of values for RuleLifecycleStateEnum
RuleSummary The summary details of rules for Events. For more information, see Managing Rules for Events (https://docs.oracle.com/iaas/Content/Events/Task/managingrules.htm).
type RuleSummary struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. Id *string `mandatory:"true" json:"id"` // A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. // Example: `"This rule sends a notification upon completion of DbaaS backup."` DisplayName *string `mandatory:"true" json:"displayName"` LifecycleState RuleLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` // A filter that specifies the event that will trigger actions associated with this rule. A few // important things to remember about filters: // * Fields not mentioned in the condition are ignored. You can create a valid filter that matches // all events with two curly brackets: `{}` // For more examples, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). // * For a condition with fields to match an event, the event must contain all the field names // listed in the condition. Field names must appear in the condition with the same nesting // structure used in the event. // For a list of reference events, see // Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). // * Rules apply to events in the compartment in which you create them and any child compartments. // This means that a condition specified by a rule only matches events emitted from resources in // the compartment or any of its child compartments. // * Wildcard matching is supported with the asterisk (*) character. // For examples of wildcard matching, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) // Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` Condition *string `mandatory:"true" json:"condition"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. CompartmentId *string `mandatory:"true" json:"compartmentId"` // Whether or not this rule is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"true" json:"isEnabled"` // The time this rule was created, expressed in RFC 3339 (https://tools.ietf.org/html/rfc3339) // timestamp format. // Example: `2018-09-12T22:47:12.613Z` TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"` // A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. // 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"` // 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"` }
func (m RuleSummary) String() string
func (m RuleSummary) 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
StreamingServiceAction An action that delivers to an Oracle Stream Service stream.
type StreamingServiceAction struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the action. Id *string `mandatory:"true" json:"id"` // A message generated by the Events service about the current state of this action. LifecycleMessage *string `mandatory:"true" json:"lifecycleMessage"` // Whether or not this action is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"false" json:"isEnabled"` // A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. StreamId *string `mandatory:"false" json:"streamId"` // The current state of the rule. LifecycleState ActionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"` }
func (m StreamingServiceAction) GetDescription() *string
GetDescription returns Description
func (m StreamingServiceAction) GetId() *string
GetId returns Id
func (m StreamingServiceAction) GetIsEnabled() *bool
GetIsEnabled returns IsEnabled
func (m StreamingServiceAction) GetLifecycleMessage() *string
GetLifecycleMessage returns LifecycleMessage
func (m StreamingServiceAction) GetLifecycleState() ActionLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m StreamingServiceAction) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m StreamingServiceAction) String() string
func (m StreamingServiceAction) 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
UpdateRuleDetails The rule attributes that you can update.
type UpdateRuleDetails struct { // A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. DisplayName *string `mandatory:"false" json:"displayName"` // A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering // confidential information. Description *string `mandatory:"false" json:"description"` // Whether or not this rule is currently enabled. // Example: `true` IsEnabled *bool `mandatory:"false" json:"isEnabled"` // A filter that specifies the event that will trigger actions associated with this rule. A few // important things to remember about filters: // * Fields not mentioned in the condition are ignored. You can create a valid filter that matches // all events with two curly brackets: `{}` // For more examples, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm). // * For a condition with fields to match an event, the event must contain all the field names // listed in the condition. Field names must appear in the condition with the same nesting // structure used in the event. // For a list of reference events, see // Services that Produce Events (https://docs.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm). // * Rules apply to events in the compartment in which you create them and any child compartments. // This means that a condition specified by a rule only matches events emitted from resources in // the compartment or any of its child compartments. // * Wildcard matching is supported with the asterisk (*) character. // For examples of wildcard matching, see // Matching Events with Filters (https://docs.oracle.com/iaas/Content/Events/Concepts/filterevents.htm) // Example: `\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"` Condition *string `mandatory:"false" json:"condition"` Actions *ActionDetailsList `mandatory:"false" json:"actions"` // Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. // 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"` // 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"` }
func (m UpdateRuleDetails) String() string
func (m UpdateRuleDetails) 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
UpdateRuleRequest wrapper for the UpdateRule operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/events/UpdateRule.go.html to see an example of how to use UpdateRuleRequest.
type UpdateRuleRequest struct { // The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule. RuleId *string `mandatory:"true" contributesTo:"path" name:"ruleId"` // The new rule spec to apply UpdateRuleDetails `contributesTo:"body"` // 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"` // The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a // particular request, please provide the request ID. OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"` // Metadata about the request. This information will not be transmitted to the service, but // represents information that the SDK will consume to drive retry behavior. RequestMetadata common.RequestMetadata }
func (request UpdateRuleRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateRuleRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateRuleRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateRuleRequest) String() string
func (request UpdateRuleRequest) 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
UpdateRuleResponse wrapper for the UpdateRule operation
type UpdateRuleResponse struct { // The underlying http response RawResponse *http.Response // The Rule instance Rule `presentIn:"body"` // For optimistic concurrency control. Add this value to the `if-match` parameter // in a PUT or DELETE operation. The resource will be updated only if the value you // provide matches the `etag` on the resource. Etag *string `presentIn:"header" name:"etag"` // Unique Oracle-assigned identifier for the request. If you need to contact Oracle about // a particular request, please provide the request ID. OpcRequestId *string `presentIn:"header" name:"opc-request-id"` }
func (response UpdateRuleResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateRuleResponse) String() string