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

package events

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

Index

Package Files

action.go action_details.go action_details_list.go action_list.go change_rule_compartment_details.go change_rule_compartment_request_response.go create_faa_s_action_details.go create_notification_service_action_details.go create_rule_details.go create_rule_request_response.go create_streaming_service_action_details.go delete_rule_request_response.go events_client.go faa_s_action.go get_rule_request_response.go list_rules_request_response.go notification_service_action.go rule.go rule_summary.go streaming_service_action.go update_rule_details.go update_rule_request_response.go

type Action Uses

type Action interface {

    // The OCID (https://docs.cloud.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
}

Action An object that represents an action to trigger for events that match a rule.

type ActionActionTypeEnum Uses

type ActionActionTypeEnum string

ActionActionTypeEnum Enum with underlying type: string

const (
    ActionActionTypeOns  ActionActionTypeEnum = "ONS"
    ActionActionTypeOss  ActionActionTypeEnum = "OSS"
    ActionActionTypeFaas ActionActionTypeEnum = "FAAS"
)

Set of constants representing the allowable values for ActionActionTypeEnum

func GetActionActionTypeEnumValues Uses

func GetActionActionTypeEnumValues() []ActionActionTypeEnum

GetActionActionTypeEnumValues Enumerates the set of values for ActionActionTypeEnum

type ActionDetails Uses

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
}

ActionDetails Object used to create an action.

type ActionDetailsActionTypeEnum Uses

type ActionDetailsActionTypeEnum string

ActionDetailsActionTypeEnum Enum with underlying type: string

const (
    ActionDetailsActionTypeOns  ActionDetailsActionTypeEnum = "ONS"
    ActionDetailsActionTypeOss  ActionDetailsActionTypeEnum = "OSS"
    ActionDetailsActionTypeFaas ActionDetailsActionTypeEnum = "FAAS"
)

Set of constants representing the allowable values for ActionDetailsActionTypeEnum

func GetActionDetailsActionTypeEnumValues Uses

func GetActionDetailsActionTypeEnumValues() []ActionDetailsActionTypeEnum

GetActionDetailsActionTypeEnumValues Enumerates the set of values for ActionDetailsActionTypeEnum

type ActionDetailsList Uses

type ActionDetailsList struct {

    // A list of one or more ActionDetails objects.
    Actions []ActionDetails `mandatory:"true" json:"actions"`
}

ActionDetailsList A list of ActionDetails objects to create for a rule.

func (ActionDetailsList) String Uses

func (m ActionDetailsList) String() string

func (*ActionDetailsList) UnmarshalJSON Uses

func (m *ActionDetailsList) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type ActionLifecycleStateEnum Uses

type ActionLifecycleStateEnum string

ActionLifecycleStateEnum Enum with underlying type: string

const (
    ActionLifecycleStateCreating ActionLifecycleStateEnum = "CREATING"
    ActionLifecycleStateActive   ActionLifecycleStateEnum = "ACTIVE"
    ActionLifecycleStateInactive ActionLifecycleStateEnum = "INACTIVE"
    ActionLifecycleStateUpdating ActionLifecycleStateEnum = "UPDATING"
    ActionLifecycleStateDeleting ActionLifecycleStateEnum = "DELETING"
    ActionLifecycleStateDeleted  ActionLifecycleStateEnum = "DELETED"
    ActionLifecycleStateFailed   ActionLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for ActionLifecycleStateEnum

func GetActionLifecycleStateEnumValues Uses

func GetActionLifecycleStateEnumValues() []ActionLifecycleStateEnum

GetActionLifecycleStateEnumValues Enumerates the set of values for ActionLifecycleStateEnum

type ActionList Uses

type ActionList struct {

    // A list of one or more Action objects.
    Actions []Action `mandatory:"true" json:"actions"`
}

ActionList A list of Action objects associated with a rule.

func (ActionList) String Uses

func (m ActionList) String() string

func (*ActionList) UnmarshalJSON Uses

func (m *ActionList) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

type ChangeRuleCompartmentDetails Uses

type ChangeRuleCompartmentDetails struct {

    // The OCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment
    // into which the resource should be moved.
    CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeRuleCompartmentDetails Specifies which compartment to move a rule to when changing a rule's compartment.

func (ChangeRuleCompartmentDetails) String Uses

func (m ChangeRuleCompartmentDetails) String() string

type ChangeRuleCompartmentRequest Uses

type ChangeRuleCompartmentRequest struct {

    // The OCID (https://docs.cloud.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
}

ChangeRuleCompartmentRequest wrapper for the ChangeRuleCompartment operation

func (ChangeRuleCompartmentRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ChangeRuleCompartmentRequest) RetryPolicy Uses

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

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

func (ChangeRuleCompartmentRequest) String Uses

func (request ChangeRuleCompartmentRequest) String() string

type ChangeRuleCompartmentResponse Uses

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

ChangeRuleCompartmentResponse wrapper for the ChangeRuleCompartment operation

func (ChangeRuleCompartmentResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ChangeRuleCompartmentResponse) String Uses

func (response ChangeRuleCompartmentResponse) String() string

type CreateFaaSActionDetails Uses

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service.
    FunctionId *string `mandatory:"false" json:"functionId"`
}

CreateFaaSActionDetails Create an action that delivers to an Oracle Functions Service endpoint.

func (CreateFaaSActionDetails) GetDescription Uses

func (m CreateFaaSActionDetails) GetDescription() *string

GetDescription returns Description

func (CreateFaaSActionDetails) GetIsEnabled Uses

func (m CreateFaaSActionDetails) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (CreateFaaSActionDetails) MarshalJSON Uses

func (m CreateFaaSActionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateFaaSActionDetails) String Uses

func (m CreateFaaSActionDetails) String() string

type CreateNotificationServiceActionDetails Uses

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.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered.
    TopicId *string `mandatory:"false" json:"topicId"`
}

CreateNotificationServiceActionDetails Create an action that delivers to an Oracle Notification Service topic.

func (CreateNotificationServiceActionDetails) GetDescription Uses

func (m CreateNotificationServiceActionDetails) GetDescription() *string

GetDescription returns Description

func (CreateNotificationServiceActionDetails) GetIsEnabled Uses

func (m CreateNotificationServiceActionDetails) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (CreateNotificationServiceActionDetails) MarshalJSON Uses

func (m CreateNotificationServiceActionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateNotificationServiceActionDetails) String Uses

func (m CreateNotificationServiceActionDetails) String() string

type CreateRuleDetails Uses

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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

CreateRuleDetails Object used to create a rule.

func (CreateRuleDetails) String Uses

func (m CreateRuleDetails) String() string

type CreateRuleRequest Uses

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
}

CreateRuleRequest wrapper for the CreateRule operation

func (CreateRuleRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (CreateRuleRequest) RetryPolicy Uses

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

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

func (CreateRuleRequest) String Uses

func (request CreateRuleRequest) String() string

type CreateRuleResponse Uses

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

CreateRuleResponse wrapper for the CreateRule operation

func (CreateRuleResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (CreateRuleResponse) String Uses

func (response CreateRuleResponse) String() string

type CreateStreamingServiceActionDetails Uses

type CreateStreamingServiceActionDetails struct {

    // Whether or not this action is currently enabled.
    // Example: `true`
    IsEnabled *bool `mandatory:"true" json:"isEnabled"`

    // The OCID (https://docs.cloud.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"`
}

CreateStreamingServiceActionDetails Create an action that delivers to an Oracle Stream Service stream.

func (CreateStreamingServiceActionDetails) GetDescription Uses

func (m CreateStreamingServiceActionDetails) GetDescription() *string

GetDescription returns Description

func (CreateStreamingServiceActionDetails) GetIsEnabled Uses

func (m CreateStreamingServiceActionDetails) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (CreateStreamingServiceActionDetails) MarshalJSON Uses

func (m CreateStreamingServiceActionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateStreamingServiceActionDetails) String Uses

func (m CreateStreamingServiceActionDetails) String() string

type DeleteRuleRequest Uses

type DeleteRuleRequest struct {

    // The OCID (https://docs.cloud.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
}

DeleteRuleRequest wrapper for the DeleteRule operation

func (DeleteRuleRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (DeleteRuleRequest) RetryPolicy Uses

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

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

func (DeleteRuleRequest) String Uses

func (request DeleteRuleRequest) String() string

type DeleteRuleResponse Uses

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

DeleteRuleResponse wrapper for the DeleteRule operation

func (DeleteRuleResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (DeleteRuleResponse) String Uses

func (response DeleteRuleResponse) String() string

type EventsClient Uses

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

EventsClient a client for Events

func NewEventsClientWithConfigurationProvider Uses

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 Uses

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 (EventsClient) ChangeRuleCompartment Uses

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.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

func (*EventsClient) ConfigurationProvider Uses

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

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

func (EventsClient) CreateRule Uses

func (client EventsClient) CreateRule(ctx context.Context, request CreateRuleRequest) (response CreateRuleResponse, err error)

CreateRule Creates a new rule.

func (EventsClient) DeleteRule Uses

func (client EventsClient) DeleteRule(ctx context.Context, request DeleteRuleRequest) (response DeleteRuleResponse, err error)

DeleteRule Deletes a rule.

func (EventsClient) GetRule Uses

func (client EventsClient) GetRule(ctx context.Context, request GetRuleRequest) (response GetRuleResponse, err error)

GetRule Retrieves a rule.

func (EventsClient) ListRules Uses

func (client EventsClient) ListRules(ctx context.Context, request ListRulesRequest) (response ListRulesResponse, err error)

ListRules Lists rules for this compartment.

func (*EventsClient) SetRegion Uses

func (client *EventsClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (EventsClient) UpdateRule Uses

func (client EventsClient) UpdateRule(ctx context.Context, request UpdateRuleRequest) (response UpdateRuleResponse, err error)

UpdateRule Updates a rule.

type FaaSAction Uses

type FaaSAction struct {

    // The OCID (https://docs.cloud.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.cloud.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"`
}

FaaSAction An action that delivers to an Oracle Functions endpoint.

func (FaaSAction) GetDescription Uses

func (m FaaSAction) GetDescription() *string

GetDescription returns Description

func (FaaSAction) GetId Uses

func (m FaaSAction) GetId() *string

GetId returns Id

func (FaaSAction) GetIsEnabled Uses

func (m FaaSAction) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (FaaSAction) GetLifecycleMessage Uses

func (m FaaSAction) GetLifecycleMessage() *string

GetLifecycleMessage returns LifecycleMessage

func (FaaSAction) GetLifecycleState Uses

func (m FaaSAction) GetLifecycleState() ActionLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (FaaSAction) MarshalJSON Uses

func (m FaaSAction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (FaaSAction) String Uses

func (m FaaSAction) String() string

type GetRuleRequest Uses

type GetRuleRequest struct {

    // The OCID (https://docs.cloud.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
}

GetRuleRequest wrapper for the GetRule operation

func (GetRuleRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (GetRuleRequest) RetryPolicy Uses

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

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

func (GetRuleRequest) String Uses

func (request GetRuleRequest) String() string

type GetRuleResponse Uses

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

GetRuleResponse wrapper for the GetRule operation

func (GetRuleResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (GetRuleResponse) String Uses

func (response GetRuleResponse) String() string

type ListRulesRequest Uses

type ListRulesRequest struct {

    // The OCID (https://docs.cloud.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.cloud.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
}

ListRulesRequest wrapper for the ListRules operation

func (ListRulesRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (ListRulesRequest) RetryPolicy Uses

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

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

func (ListRulesRequest) String Uses

func (request ListRulesRequest) String() string

type ListRulesResponse Uses

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.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
    OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

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

ListRulesResponse wrapper for the ListRules operation

func (ListRulesResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (ListRulesResponse) String Uses

func (response ListRulesResponse) String() string

type ListRulesSortByEnum Uses

type ListRulesSortByEnum string

ListRulesSortByEnum Enum with underlying type: string

const (
    ListRulesSortByTimeCreated ListRulesSortByEnum = "TIME_CREATED"
    ListRulesSortById          ListRulesSortByEnum = "ID"
    ListRulesSortByDisplayName ListRulesSortByEnum = "DISPLAY_NAME"
)

Set of constants representing the allowable values for ListRulesSortByEnum

func GetListRulesSortByEnumValues Uses

func GetListRulesSortByEnumValues() []ListRulesSortByEnum

GetListRulesSortByEnumValues Enumerates the set of values for ListRulesSortByEnum

type ListRulesSortOrderEnum Uses

type ListRulesSortOrderEnum string

ListRulesSortOrderEnum Enum with underlying type: string

const (
    ListRulesSortOrderAsc  ListRulesSortOrderEnum = "ASC"
    ListRulesSortOrderDesc ListRulesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRulesSortOrderEnum

func GetListRulesSortOrderEnumValues Uses

func GetListRulesSortOrderEnumValues() []ListRulesSortOrderEnum

GetListRulesSortOrderEnumValues Enumerates the set of values for ListRulesSortOrderEnum

type NotificationServiceAction Uses

type NotificationServiceAction struct {

    // The OCID (https://docs.cloud.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.cloud.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"`
}

NotificationServiceAction An action that delivers to an Oracle Notification Service topic.

func (NotificationServiceAction) GetDescription Uses

func (m NotificationServiceAction) GetDescription() *string

GetDescription returns Description

func (NotificationServiceAction) GetId Uses

func (m NotificationServiceAction) GetId() *string

GetId returns Id

func (NotificationServiceAction) GetIsEnabled Uses

func (m NotificationServiceAction) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (NotificationServiceAction) GetLifecycleMessage Uses

func (m NotificationServiceAction) GetLifecycleMessage() *string

GetLifecycleMessage returns LifecycleMessage

func (NotificationServiceAction) GetLifecycleState Uses

func (m NotificationServiceAction) GetLifecycleState() ActionLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (NotificationServiceAction) MarshalJSON Uses

func (m NotificationServiceAction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (NotificationServiceAction) String Uses

func (m NotificationServiceAction) String() string

type Rule Uses

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

Rule The configuration details of an Events rule. For more information, see Managing Rules for Events (https://docs.cloud.oracle.com/iaas/Content/Events/Task/managingrules.htm).

func (Rule) String Uses

func (m Rule) String() string

type RuleLifecycleStateEnum Uses

type RuleLifecycleStateEnum string

RuleLifecycleStateEnum Enum with underlying type: string

const (
    RuleLifecycleStateCreating RuleLifecycleStateEnum = "CREATING"
    RuleLifecycleStateActive   RuleLifecycleStateEnum = "ACTIVE"
    RuleLifecycleStateInactive RuleLifecycleStateEnum = "INACTIVE"
    RuleLifecycleStateUpdating RuleLifecycleStateEnum = "UPDATING"
    RuleLifecycleStateDeleting RuleLifecycleStateEnum = "DELETING"
    RuleLifecycleStateDeleted  RuleLifecycleStateEnum = "DELETED"
    RuleLifecycleStateFailed   RuleLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for RuleLifecycleStateEnum

func GetRuleLifecycleStateEnumValues Uses

func GetRuleLifecycleStateEnumValues() []RuleLifecycleStateEnum

GetRuleLifecycleStateEnumValues Enumerates the set of values for RuleLifecycleStateEnum

type RuleSummary Uses

type RuleSummary struct {

    // The OCID (https://docs.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

RuleSummary The summary details of rules for Events. For more information, see Managing Rules for Events (https://docs.cloud.oracle.com/iaas/Content/Events/Task/managingrules.htm).

func (RuleSummary) String Uses

func (m RuleSummary) String() string

type StreamingServiceAction Uses

type StreamingServiceAction struct {

    // The OCID (https://docs.cloud.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.cloud.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"`
}

StreamingServiceAction An action that delivers to an Oracle Stream Service stream.

func (StreamingServiceAction) GetDescription Uses

func (m StreamingServiceAction) GetDescription() *string

GetDescription returns Description

func (StreamingServiceAction) GetId Uses

func (m StreamingServiceAction) GetId() *string

GetId returns Id

func (StreamingServiceAction) GetIsEnabled Uses

func (m StreamingServiceAction) GetIsEnabled() *bool

GetIsEnabled returns IsEnabled

func (StreamingServiceAction) GetLifecycleMessage Uses

func (m StreamingServiceAction) GetLifecycleMessage() *string

GetLifecycleMessage returns LifecycleMessage

func (StreamingServiceAction) GetLifecycleState Uses

func (m StreamingServiceAction) GetLifecycleState() ActionLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (StreamingServiceAction) MarshalJSON Uses

func (m StreamingServiceAction) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (StreamingServiceAction) String Uses

func (m StreamingServiceAction) String() string

type UpdateRuleDetails Uses

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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
    // Example: `{"Operations": {"CostCenter": "42"}}`
    DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

UpdateRuleDetails The rule attributes that you can update.

func (UpdateRuleDetails) String Uses

func (m UpdateRuleDetails) String() string

type UpdateRuleRequest Uses

type UpdateRuleRequest struct {

    // The OCID (https://docs.cloud.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
}

UpdateRuleRequest wrapper for the UpdateRule operation

func (UpdateRuleRequest) HTTPRequest Uses

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

HTTPRequest implements the OCIRequest interface

func (UpdateRuleRequest) RetryPolicy Uses

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

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

func (UpdateRuleRequest) String Uses

func (request UpdateRuleRequest) String() string

type UpdateRuleResponse Uses

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

UpdateRuleResponse wrapper for the UpdateRule operation

func (UpdateRuleResponse) HTTPResponse Uses

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

HTTPResponse implements the OCIResponse interface

func (UpdateRuleResponse) String Uses

func (response UpdateRuleResponse) String() string

Package events imports 5 packages (graph) and is imported by 2 packages. Updated 2020-04-08. Refresh now. Tools for package owners.