basePath: /20181201 definitions: Action: description: 'An object that represents an action to trigger for events that match a rule. ' discriminator: actionType properties: actionType: description: 'The action to perform if the condition in the rule matches an event. * **ONS:** Send to an Oracle Notification Service topic. * **OSS:** Send to a stream from Oracle Streaming Service. * **FAAS:** Send to an Oracle Functions Service endpoint. ' enum: - ONS - OSS - FAAS type: string description: description: '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. ' maxLength: 1024 minLength: 0 type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the action. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this action is currently enabled. Example: `true` ' type: boolean lifecycleMessage: description: 'A message generated by the Events service about the current state of this action. ' type: string lifecycleState: description: 'The current state of the rule. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string required: - actionType - id - lifecycleState - lifecycleMessage type: object x-example: "{\n \"actions\": [\n {\n \"actionType\": \"ONS\",\n \ \ \"id\": \"ocid.action.oc1..<unique_ID>\",\n \"lifecycleMessage\"\ :null,\n \"lifecycleState\": \"CREATING\"\n }\n ]\n} \n" ActionDetails: description: 'Object used to create an action. ' discriminator: actionType properties: actionType: description: 'The action to perform if the condition in the rule matches an event. * **ONS:** Send to an Oracle Notification Service topic. * **OSS:** Send to a stream from Oracle Streaming Service. * **FAAS:** Send to an Oracle Functions Service endpoint. ' enum: - ONS - OSS - FAAS type: string description: description: '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. ' maxLength: 1024 minLength: 0 type: string isEnabled: default: true description: 'Whether or not this action is currently enabled. Example: `true` ' type: boolean required: - actionType - isEnabled type: object x-example: "{\n \"actionType\": \"ONS\",\n \"isEnabled\": true,\n \"description\"\ : \"Notification action\" \n}\n" ActionDetailsList: description: A list of ActionDetails objects to create for a rule. properties: actions: description: 'A list of one or more ActionDetails objects. ' items: $ref: '#/definitions/ActionDetails' maxItems: 10 minItems: 1 type: array required: - actions type: object x-example: "{\n \"actions\": [ ]\n}\n" ActionList: description: 'A list of Action objects associated with a rule. ' properties: actions: description: 'A list of one or more Action objects. ' items: $ref: '#/definitions/Action' maxItems: 10 minItems: 1 type: array required: - actions type: object x-example: "{\n \"actions\": { }\n}\n" ChangeRuleCompartmentDetails: description: 'Specifies which compartment to move a rule to when changing a rule''s compartment. ' properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "{\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ \n}\n" CreateFaaSActionDetails: allOf: - $ref: '#/definitions/ActionDetails' - discriminator: FAAS properties: functionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. ' maxLength: 1024 minLength: 1 type: string description: Create an action that delivers to an Oracle Functions Service endpoint. required: - functionId x-example: "{\n \"actionType\": \"FAAS\",\n \"description\": \"Function action\"\ ,\n \"functionId\": \"ocid1.fnfunc.oc1.phx.<unique_ID>\",\n\ \ \"isEnabled\": true\n}\n" CreateManagedRuleDetails: description: Object used to create an events2.0 managed rule. properties: actions: $ref: '#/definitions/ActionDetailsList' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean required: - displayName - isEnabled - condition - actions - compartmentId type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" CreateNotificationServiceActionDetails: allOf: - $ref: '#/definitions/ActionDetails' - discriminator: ONS properties: topicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. ' maxLength: 1024 minLength: 1 type: string description: Create an action that delivers to an Oracle Notification Service topic. x-example: "{\n \"actionType\": \"ONS\",\n \"description\": \"Notification action\"\ ,\n \"isEnabled\": true,\n \"topicId\": \"ocid1.onstopic.oc1.phx.<unique_ID>\"\ \n} \n" CreateRuleDetails: description: Object used to create an events1.0 rule and events2.0 system rule. properties: actions: $ref: '#/definitions/ActionDetailsList' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few \nimportant things to remember about\ \ filters:\n\n* Fields not mentioned in the condition are ignored. You can\ \ create a valid filter that matches\nall events with two curly brackets:\ \ `{}` \n\n For more examples, see \n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\ \ \n* For a condition with fields to match an event, the event must\ \ contain all the field names \nlisted in the condition. Field names must\ \ appear in the condition with the same nesting \nstructure used in the\ \ event. \n\n For a list of reference events, see \n[Services that Produce\ \ Events](/iaas/Content/Events/Reference/eventsproducers.htm). \n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments. \nThis means that a condition specified by a rule\ \ only matches events emitted from resources in \nthe compartment or any\ \ of its child compartments. \n* Wildcard matching is supported with the\ \ asterisk (*) character. \n\n For examples of wildcard matching, see \n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean required: - displayName - isEnabled - condition - actions - compartmentId type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" CreateStreamingServiceActionDetails: allOf: - $ref: '#/definitions/ActionDetails' - discriminator: OSS properties: streamId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. ' maxLength: 1024 minLength: 1 type: string required: - streamId description: Create an action that delivers to an Oracle Stream Service stream. x-example: "{\n \"actionType\": \"OSS\",\n \"description\": \"Streaming action\"\ ,\n \"isEnabled\": true,\n \"streamId\": \"ocid1.stream.oc1.phx.<unique_ID>\"\ \n}\n" CreateSystemRuleDetails: description: Object used to create an events2.0 system rule. properties: actions: $ref: '#/definitions/ActionDetailsList' compartmentIds: description: 'An array of compartment OCIDs to which this rule applies. ' items: maxLength: 1024 minLength: 1 type: string maxItems: 30 minItems: 1 type: array condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean required: - displayName - isEnabled - compartmentIds - condition - actions type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentIds\": [\n \"ocid.compartment.oc1..<unique_ID>\"\ \n ],\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"\ Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" Error: description: Error details. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: 'A human-readable error string. ' type: string required: - code - message type: object x-example: "{\n \"code\" : \"400\",\n \"message\" : \"Bad Request\"\n}\n" FaaSAction: allOf: - $ref: '#/definitions/Action' - discriminator: FAAS properties: functionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a Function hosted by Oracle Functions Service. ' maxLength: 1024 minLength: 1 type: string description: An action that delivers to an Oracle Functions endpoint. required: - functionId x-example: "{\n \"actionType\": \"FAAS\",\n \"id\": \"ocid1.eventaction.oc1.phx.<unique_ID>\"\ ,\n \"lifecycle-message\": null,\n \"lifecycle-state\": \"ACTIVE\",\n \"\ description\": \"Function action\",\n \"functionId\": \"ocid1.fnfunc.oc1.phx.<unique_ID>\"\ \n}\n" ManagedRule: description: 'The configuration details of an Events 2.0 Managed rule. ' properties: actions: $ref: '#/definitions/ActionList' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleMessage: description: 'A message generated by the Events service about the current state of this rule. ' type: string lifecycleState: description: 'The current state of the rule. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string managedBy: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy who managed this rule. ' maxLength: 1024 minLength: 1 type: string timeCreated: description: '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` ' format: date-time type: string required: - displayName - lifecycleState - condition - actions - id - timeCreated - compartmentId - managedBy - isEnabled type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"managedBy\": \"ocid.tenancy.oc1..<unique_ID>\",\n \"\ isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\n\ \ },\n \"definedTags\": {\n Operations\": {\n \"CostCenter\": \"\ 42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"actionType\"\ : \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n },\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"lifecycleMessage\"\ :null\n}\n" ManagedRuleSummary: description: 'The summary details of rules for Events. For more information, see [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleState: type: string x-obmcs-enumref: '#/definitions/Rule/lifecycleState' managedBy: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy who managed this rule. ' maxLength: 1024 minLength: 1 type: string timeCreated: description: '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` ' format: date-time type: string required: - id - displayName - lifecycleState - condition - compartmentId - managedBy - isEnabled - timeCreated type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"managedBy\": \"ocid.tenancy.oc1..<unique_ID>\",\n \"\ isEnabled\": true,\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"freeformTags\": {\n\ \ \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\"\ : {\n \"CostCenter\": \"42\"\n },\n}\n" NotificationServiceAction: allOf: - $ref: '#/definitions/Action' - discriminator: ONS properties: topicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the topic to which messages are delivered. ' maxLength: 1024 minLength: 1 type: string description: 'An action that delivers to an Oracle Notification Service topic. ' required: - topicId x-example: "{\n \"actionType\": \"ONS\",\n \"id\": \"ocid1.eventaction.oc1.phx.<unique_ID>\"\ ,\n \"lifecycle-message\": null,\n \"lifecycle-state\": \"ACTIVE\",\n \"\ description\": \"Notification action\",\n \"topicId\": \"ocid1.onstopic.oc1.phx.<unique_ID>\"\ \n}\n" Rule: description: 'The configuration details of an Events rule. For more information, see [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). ' properties: actions: $ref: '#/definitions/ActionList' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few \nimportant things to remember about\ \ filters:\n\n* Fields not mentioned in the condition are ignored. You can\ \ create a valid filter that matches\nall events with two curly brackets:\ \ `{}` \n\n For more examples, see \n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\ \ \n* For a condition with fields to match an event, the event must\ \ contain all the field names \nlisted in the condition. Field names must\ \ appear in the condition with the same nesting \nstructure used in the\ \ event. \n\n For a list of reference events, see \n[Services that Produce\ \ Events](/iaas/Content/Events/Reference/eventsproducers.htm). \n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments. \nThis means that a condition specified by a rule\ \ only matches events emitted from resources in \nthe compartment or any\ \ of its child compartments. \n* Wildcard matching is supported with the\ \ asterisk (*) character. \n\n For examples of wildcard matching, see \n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleMessage: description: 'A message generated by the Events service about the current state of this rule. ' type: string lifecycleState: description: 'The current state of the rule. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string timeCreated: description: '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` ' format: date-time type: string required: - displayName - lifecycleState - condition - actions - id - timeCreated - compartmentId - isEnabled type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n Operations\": {\n \"CostCenter\": \"\ 42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"actionType\"\ : \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n },\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"lifecycleMessage\"\ :null\n}\n" RuleSummary: description: 'The summary details of rules for Events. For more information, see [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few \nimportant things to remember about\ \ filters:\n\n* Fields not mentioned in the condition are ignored. You can\ \ create a valid filter that matches\nall events with two curly brackets:\ \ `{}` \n\n For more examples, see \n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\ \ \n* For a condition with fields to match an event, the event must\ \ contain all the field names \nlisted in the condition. Field names must\ \ appear in the condition with the same nesting \nstructure used in the\ \ event. \n\n For a list of reference events, see \n[Services that Produce\ \ Events](/iaas/Content/Events/Reference/eventsproducers.htm). \n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments. \nThis means that a condition specified by a rule\ \ only matches events emitted from resources in \nthe compartment or any\ \ of its child compartments. \n* Wildcard matching is supported with the\ \ asterisk (*) character. \n\n For examples of wildcard matching, see \n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleState: type: string x-obmcs-enumref: '#/definitions/Rule/lifecycleState' timeCreated: description: '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` ' format: date-time type: string required: - id - displayName - lifecycleState - condition - compartmentId - isEnabled - timeCreated type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"freeformTags\": {\n\ \ \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\"\ : {\n \"CostCenter\": \"42\"\n },\n}\n" StreamingServiceAction: allOf: - $ref: '#/definitions/Action' - discriminator: OSS properties: streamId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the stream to which messages are delivered. ' maxLength: 1024 minLength: 1 type: string description: An action that delivers to an Oracle Stream Service stream. required: - streamId x-example: "{\n \"actionType\": \"OSS\",\n \"id\": \"ocid1.eventaction.oc1.phx.<unique_ID>\"\ ,\n \"lifecycle-message\": null,\n \"lifecycle-state\": \"ACTIVE\",\n \"\ description\": \"Streaming action\",\n \"streamId\": \"ocid1.stream.oc1.phx.<unique_ID>\"\ \n}\n" SystemRule: description: 'The configuration details of an Events 2.0 System rule. ' properties: actions: $ref: '#/definitions/ActionList' compartmentIds: description: 'An array of compartment OCIDs to which this rule applies. ' items: maxLength: 1024 minLength: 1 type: string maxItems: 30 minItems: 1 type: array condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleMessage: description: 'A message generated by the Events service about the current state of this rule. ' type: string lifecycleState: description: 'The current state of the rule. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string ownerTenancyId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy who owns this rule. ' maxLength: 1024 minLength: 1 type: string timeCreated: description: '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` ' format: date-time type: string required: - displayName - lifecycleState - ownerTenancyId - compartmentIds - condition - actions - id - timeCreated - isEnabled type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentIds\": [\n \"ocid.compartment.oc1..<unique_ID>\"\ \n ],\n \"ownerTenancyId\": \"ocid.tenancy.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n Operations\": {\n \"CostCenter\": \"\ 42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"actionType\"\ : \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n },\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"lifecycleMessage\"\ :null\n}\n" SystemRuleSummary: description: 'The summary details of rules for Events. For more information, see [Managing Rules for Events](/iaas/Content/Events/Task/managingrules.htm). ' properties: compartmentIds: description: 'An array of compartment OCIDs to which this rule applies. ' items: maxLength: 1024 minLength: 1 type: string maxItems: 30 minItems: 1 type: array condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: '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."` ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' maxLength: 1024 minLength: 1 type: string isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean lifecycleState: type: string x-obmcs-enumref: '#/definitions/Rule/lifecycleState' ownerTenancyId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenancy who owns this rule. ' maxLength: 1024 minLength: 1 type: string timeCreated: description: '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` ' format: date-time type: string required: - id - displayName - lifecycleState - condition - ownerTenancyId - compartmentIds - isEnabled - timeCreated type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"lifecycleState\": \"CREATING\",\n \"condition\":\ \ \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"ownerTenancyId\": \"ocid.tenancy.oc1..<unique_ID>\"\ ,\n \"compartmentIds\": [\n \"ocid.compartment.oc1..<unique_ID>\"\ \n ],\n \"isEnabled\": true,\n \"id\": \"ocid.rule.oc1..<unique_ID>\"\ ,\n \"timeCreated\": \"2018-09-12T22:47:12.613Z\",\n \"freeformTags\": {\n\ \ \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"Operations\"\ : {\n \"CostCenter\": \"42\"\n },\n}\n" UpdateManagedRuleDetails: description: Object used to update an events2.0 managed rule. properties: actions: $ref: '#/definitions/ActionDetailsList' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' maxLength: 1024 minLength: 1 type: string condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" UpdateRuleDetails: description: The rule attributes that you can update. properties: actions: $ref: '#/definitions/ActionDetailsList' condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few \nimportant things to remember about\ \ filters:\n\n* Fields not mentioned in the condition are ignored. You can\ \ create a valid filter that matches\nall events with two curly brackets:\ \ `{}` \n\n For more examples, see \n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\ \ \n* For a condition with fields to match an event, the event must\ \ contain all the field names \nlisted in the condition. Field names must\ \ appear in the condition with the same nesting \nstructure used in the\ \ event. \n\n For a list of reference events, see \n[Services that Produce\ \ Events](/iaas/Content/Events/Reference/eventsproducers.htm). \n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments. \nThis means that a condition specified by a rule\ \ only matches events emitted from resources in \nthe compartment or any\ \ of its child compartments. \n* Wildcard matching is supported with the\ \ asterisk (*) character. \n\n For examples of wildcard matching, see \n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\"\ : \"Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"\ CostCenter\": \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n\ \ \"actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" UpdateSystemRuleDetails: description: Object used to update an events2.0 system rule. properties: actions: $ref: '#/definitions/ActionDetailsList' compartmentIds: description: 'An array of compartment OCIDs to which this rule applies. ' items: maxLength: 1024 minLength: 1 type: string maxItems: 30 minItems: 1 type: array condition: description: "A filter that specifies the event that will trigger actions\ \ associated with this rule. A few\nimportant things to remember about filters:\n\ \n* Fields not mentioned in the condition are ignored. You can create a\ \ valid filter that matches\nall events with two curly brackets: `{}`\n\n\ \ For more examples, see\n[Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm).\n\ * For a condition with fields to match an event, the event must contain\ \ all the field names\nlisted in the condition. Field names must appear\ \ in the condition with the same nesting\nstructure used in the event.\n\ \n For a list of reference events, see\n[Services that Produce Events](/iaas/Content/Events/Reference/eventsproducers.htm).\n\ * Rules apply to events in the compartment in which you create them and\ \ any child compartments.\nThis means that a condition specified by a rule\ \ only matches events emitted from resources in\nthe compartment or any\ \ of its child compartments.\n* Wildcard matching is supported with the\ \ asterisk (*) character.\n\n For examples of wildcard matching, see\n\ [Matching Events with Filters](/iaas/Content/Events/Concepts/filterevents.htm)\n\ \nExample: `\\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"`\n" type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}'' ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: '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. ' maxLength: 1024 minLength: 0 type: string displayName: description: 'A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string 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](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: default: true description: 'Whether or not this rule is currently enabled. Example: `true` ' type: boolean type: object x-example: "{\n \"displayName\": \"This rule sends a notification upon completion\ \ of DbaaS backup\",\n \"condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentIds\": [\n \"ocid.compartment.oc1..<unique_ID>\"\ \n ],\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"\ Finance\"\n },\n \"definedTags\": {\n \"Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" host: events.$region.oraclecloud.com info: description: "API for the Events Service. Use this API to manage rules and actions\ \ that create automation \nin your tenancy. For more information, see [Overview\ \ of Events](/iaas/Content/Events/Concepts/eventsoverview.htm).\n" title: Events API version: '20181201' parameters: CompartmentIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs. ' in: query maxLength: 1024 minLength: 1 name: compartmentId required: true type: string IfMatchHeader: description: '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. ' in: header name: if-match type: string ListRulesFilterByLifecycleStateQueryParam: description: 'A filter to return only rules that match the lifecycle state in this parameter. Example: `Creating` ' in: query name: lifecycleState required: false type: string x-obmcs-enumref: '#/definitions/Rule/lifecycleState' OpcRequestIdHeaderParam: description: 'The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false type: string PaginationLimitQueryParam: default: 5 description: 'The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10 ' in: query maximum: 50 minimum: 1 name: limit required: false type: integer PaginationTokenQueryParam: description: '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](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query maxLength: 1024 minLength: 1 name: page required: false type: string RetryTokenHeader: description: '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). ' in: header maxLength: 64 minLength: 1 name: opc-retry-token type: string RuleIdPathParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this rule. ' in: path name: ruleId required: true type: string ServiceIdPathParam: description: 'The manager/owner service ID - the tenancy OCID. ' in: path name: serviceId required: true type: string SortOrderQueryParam: description: 'Specifies sort order. * **ASC:** Ascending sort order. * **DESC:** Descending sort order. ' enum: - ASC - DESC in: query name: sortOrder required: false type: string paths: /rules: get: description: 'Lists rules for this compartment. ' operationId: ListRules parameters: - $ref: '#/parameters/CompartmentIdQueryParam' - $ref: '#/parameters/PaginationLimitQueryParam' - $ref: '#/parameters/PaginationTokenQueryParam' - $ref: '#/parameters/ListRulesFilterByLifecycleStateQueryParam' - description: '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."` ' in: query maxLength: 1024 minLength: 1 name: displayName required: false type: string - description: '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. ' enum: - TIME_CREATED - ID - DISPLAY_NAME in: query name: sortBy required: false type: string - $ref: '#/parameters/SortOrderQueryParam' - $ref: '#/parameters/OpcRequestIdHeaderParam' responses: 200: description: Succesfully retrieved summary of rules. headers: opc-next-page: description: '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](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: items: $ref: '#/definitions/RuleSummary' type: array 400: $ref: '#/responses/400' 401: $ref: '#/responses/401' 403: $ref: '#/responses/403' 404: $ref: '#/responses/404' 429: $ref: '#/responses/429' 500: $ref: '#/responses/500' default: $ref: '#/responses/DefaultError' summary: Lists rules for this compartment. tags: - events x-example: 'GET /20181201/rules?compartmentId=<compartment_OCID> Host: events.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a new rule. ' operationId: CreateRule parameters: - description: Specification of the rule to create in: body name: CreateRuleDetails required: true schema: $ref: '#/definitions/CreateRuleDetails' - $ref: '#/parameters/RetryTokenHeader' - $ref: '#/parameters/OpcRequestIdHeaderParam' responses: 200: description: Succesfully created rule. headers: etag: description: '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. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Rule' 400: $ref: '#/responses/400' 401: $ref: '#/responses/401' 403: $ref: '#/responses/403' 404: $ref: '#/responses/404' 429: $ref: '#/responses/429' 500: $ref: '#/responses/500' default: $ref: '#/responses/DefaultError' summary: Creates a new rule tags: - events x-example: "POST /20181201/rules\nHost: events.us-phoenix-1.oraclecloud.com\n\ <authorization and other headers>\n\n{\n \"displayName\"\ : \"This rule sends a notification upon completion of DbaaS backup\",\n \"\ condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"compartmentId\": \"ocid.compartment.oc1..<unique_ID>\"\ ,\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\": \"Finance\"\ \n },\n \"definedTags\": {\n Operations\": {\n \"CostCenter\"\ : \"42\"\n },\n \"actions\": {\n \"actions\": [\n {\n \"\ actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" /rules/{ruleId}: delete: description: Deletes a rule. operationId: DeleteRule parameters: - $ref: '#/parameters/RuleIdPathParam' - $ref: '#/parameters/IfMatchHeader' - $ref: '#/parameters/OpcRequestIdHeaderParam' responses: 204: description: Rule deleted successfully. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string 400: $ref: '#/responses/400' 401: $ref: '#/responses/401' 403: $ref: '#/responses/403' 404: $ref: '#/responses/404' 429: $ref: '#/responses/429' 500: $ref: '#/responses/500' default: $ref: '#/responses/DefaultError' summary: Deletes a rule tags: - events x-example: 'DELETE /20181201/rules/<rule_OCID> Host: events.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/Rule' get: description: Retrieves a rule. operationId: GetRule parameters: - $ref: '#/parameters/RuleIdPathParam' - $ref: '#/parameters/OpcRequestIdHeaderParam' responses: 200: description: Succesfully retrieved rule. headers: etag: description: '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. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Rule' 400: $ref: '#/responses/400' 401: $ref: '#/responses/401' 403: $ref: '#/responses/403' 404: $ref: '#/responses/404' 429: $ref: '#/responses/429' 500: $ref: '#/responses/500' default: $ref: '#/responses/DefaultError' summary: Retrieves a rule tags: - events x-example: 'GET /20181201/rules/<rule_OCID> Host: events.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates a rule. ' operationId: UpdateRule parameters: - $ref: '#/parameters/RuleIdPathParam' - $ref: '#/parameters/IfMatchHeader' - description: The new rule spec to apply in: body name: UpdateRuleDetails required: true schema: $ref: '#/definitions/UpdateRuleDetails' - $ref: '#/parameters/OpcRequestIdHeaderParam' responses: 200: description: 'Succesfully updated rule. ' headers: etag: description: '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. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Rule' 400: $ref: '#/responses/400' 401: $ref: '#/responses/401' 403: $ref: '#/responses/403' 404: $ref: '#/responses/404' 412: $ref: '#/responses/412' 429: $ref: '#/responses/429' 500: $ref: '#/responses/500' default: $ref: '#/responses/DefaultError' summary: Updates a rule tags: - events x-example: "PUT /20181201/rules/<rule_OCID>\nHost: events.us-phoenix-1.oraclecloud.com\n\ <authorization and other headers>\n\n{\n \"displayName\"\ : \"This rule sends a notification upon completion of DbaaS backup\",\n \"\ condition\": \"{\n \\\"eventType\\\": \\\"com.oraclecloud.databaseservice.autonomous.database.backup.end\\\ \"\n }\",\n \"isEnabled\": true,\n \"freeformTags\": {\n \"Department\"\ : \"Finance\"\n },\n \"definedTags\": {\n Operations\": {\n \"\ CostCenter\": \"42\"\n },\n \"actions\": {\n \"actions\": [\n \ \ {\n \"actionType\": \"ONS\",\n \"id\": \"ocid.action.oc1..<unique_ID>\"\ ,\n \"lifecycleMessage\":null,\n \"lifecycleState\": \"CREATING\"\ \n }\n ]\n }\n}\n" /rules/{ruleId}/actions/changeCompartment: post: description: "Moves a rule into a different compartment within the same tenancy.\ \ For information about moving \nresources between compartments, see [Moving\ \ Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" operationId: ChangeRuleCompartment parameters: - $ref: '#/parameters/IfMatchHeader' - $ref: '#/parameters/OpcRequestIdHeaderParam' - $ref: '#/parameters/RetryTokenHeader' - $ref: '#/parameters/RuleIdPathParam' - in: body name: ChangeRuleCompartmentDetails required: true schema: $ref: '#/definitions/ChangeRuleCompartmentDetails' responses: 204: description: Response returned for a successful change compartment request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string 401: $ref: '#/responses/401' 404: $ref: '#/responses/404' 409: $ref: '#/responses/409' 500: $ref: '#/responses/500' summary: Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource. tags: - events x-related-resource: '#/definitions/Rule' produces: - application/json responses: 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 401: description: Unauthorized (Unauthenticated) headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 403: description: Forbidden headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 404: description: Not found or not authorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 409: description: Invalid state. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 429: description: Too Many Requests headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' 412: description: NoEtagMatch headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string schema: $ref: '#/definitions/Error' schemes: - https swagger: '2.0' x-oracle-package: com.oracle.pic.events.control