oci 2.5.3 → 2.5.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/oci/dns/dns_client.rb +21 -12
  4. data/lib/oci/dns/models/create_steering_policy_attachment_details.rb +4 -7
  5. data/lib/oci/dns/models/create_steering_policy_details.rb +63 -52
  6. data/lib/oci/dns/models/create_zone_details.rb +10 -5
  7. data/lib/oci/dns/models/record.rb +3 -1
  8. data/lib/oci/dns/models/record_operation.rb +4 -0
  9. data/lib/oci/dns/models/steering_policy.rb +64 -54
  10. data/lib/oci/dns/models/steering_policy_answer.rb +55 -8
  11. data/lib/oci/dns/models/steering_policy_attachment.rb +8 -7
  12. data/lib/oci/dns/models/steering_policy_attachment_summary.rb +2 -3
  13. data/lib/oci/dns/models/steering_policy_filter_answer_data.rb +3 -1
  14. data/lib/oci/dns/models/steering_policy_filter_rule.rb +12 -3
  15. data/lib/oci/dns/models/steering_policy_filter_rule_case.rb +8 -0
  16. data/lib/oci/dns/models/steering_policy_health_rule.rb +9 -0
  17. data/lib/oci/dns/models/steering_policy_health_rule_case.rb +7 -0
  18. data/lib/oci/dns/models/steering_policy_limit_rule.rb +11 -1
  19. data/lib/oci/dns/models/steering_policy_limit_rule_case.rb +12 -1
  20. data/lib/oci/dns/models/steering_policy_priority_answer_data.rb +6 -0
  21. data/lib/oci/dns/models/steering_policy_priority_rule.rb +11 -2
  22. data/lib/oci/dns/models/steering_policy_priority_rule_case.rb +8 -0
  23. data/lib/oci/dns/models/steering_policy_rule.rb +28 -24
  24. data/lib/oci/dns/models/steering_policy_summary.rb +62 -53
  25. data/lib/oci/dns/models/steering_policy_weighted_answer_data.rb +5 -0
  26. data/lib/oci/dns/models/steering_policy_weighted_rule.rb +11 -2
  27. data/lib/oci/dns/models/steering_policy_weighted_rule_case.rb +8 -0
  28. data/lib/oci/dns/models/update_steering_policy_attachment_details.rb +5 -1
  29. data/lib/oci/dns/models/update_steering_policy_details.rb +64 -52
  30. data/lib/oci/dns/models/update_zone_details.rb +10 -5
  31. data/lib/oci/dns/models/zone.rb +10 -5
  32. data/lib/oci/dns/models/zone_summary.rb +10 -5
  33. data/lib/oci/object_storage/models/bucket.rb +12 -11
  34. data/lib/oci/object_storage/models/bucket_summary.rb +4 -4
  35. data/lib/oci/object_storage/models/commit_multipart_upload_details.rb +3 -3
  36. data/lib/oci/object_storage/models/commit_multipart_upload_part_details.rb +3 -3
  37. data/lib/oci/object_storage/models/copy_object_details.rb +22 -13
  38. data/lib/oci/object_storage/models/create_bucket_details.rb +5 -5
  39. data/lib/oci/object_storage/models/create_multipart_upload_details.rb +2 -2
  40. data/lib/oci/object_storage/models/create_preauthenticated_request_details.rb +6 -3
  41. data/lib/oci/object_storage/models/list_objects.rb +2 -2
  42. data/lib/oci/object_storage/models/multipart_upload.rb +4 -4
  43. data/lib/oci/object_storage/models/multipart_upload_part_summary.rb +5 -4
  44. data/lib/oci/object_storage/models/namespace_metadata.rb +4 -4
  45. data/lib/oci/object_storage/models/object_lifecycle_rule.rb +3 -3
  46. data/lib/oci/object_storage/models/object_name_filter.rb +76 -6
  47. data/lib/oci/object_storage/models/object_summary.rb +2 -2
  48. data/lib/oci/object_storage/models/pattern_details.rb +208 -0
  49. data/lib/oci/object_storage/models/preauthenticated_request.rb +9 -7
  50. data/lib/oci/object_storage/models/preauthenticated_request_summary.rb +3 -1
  51. data/lib/oci/object_storage/models/rename_object_details.rb +5 -5
  52. data/lib/oci/object_storage/models/restore_objects_details.rb +2 -2
  53. data/lib/oci/object_storage/models/update_bucket_details.rb +5 -5
  54. data/lib/oci/object_storage/models/update_namespace_metadata_details.rb +4 -4
  55. data/lib/oci/object_storage/models/work_request.rb +11 -10
  56. data/lib/oci/object_storage/models/work_request_error.rb +4 -4
  57. data/lib/oci/object_storage/models/work_request_log_entry.rb +3 -1
  58. data/lib/oci/object_storage/models/work_request_resource.rb +4 -4
  59. data/lib/oci/object_storage/models/work_request_summary.rb +11 -10
  60. data/lib/oci/object_storage/object_storage.rb +1 -0
  61. data/lib/oci/object_storage/object_storage_client.rb +117 -93
  62. data/lib/oci/object_storage/object_storage_client_composite_operations.rb +2 -2
  63. data/lib/oci/version.rb +1 -1
  64. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e50aec53657bc50fd4f4a486a9c9271162ee5ca8359b122826daaf9ba84cebae
4
- data.tar.gz: d55e454f869a09abb01e1b8999ed92c357af9af1c5f624f33526e292c2749a26
3
+ metadata.gz: 9eacad662893aaafea6e5c3364a1303cff336b9333263b447dee38537b5fe669
4
+ data.tar.gz: ae519c919e675327ce111c60203e8b1fabe9d49583dc48f9a4dc9c7f0fbd0ec8
5
5
  SHA512:
6
- metadata.gz: 521e46b9785d4abb0293bd312f7163a4f4277ef251b39c7ff44cf768bd242df89ad9d513ee693f1af0a8bcb7e454bce3f9004c82d19f914d0bcd739ffbdcdab7
7
- data.tar.gz: 975fd8d0735c0a0e9fbf291ca3cdd8884879ae9e5125b69ede5bf8132cc3d8fec108f3bdc5ad21d6ac2307e811dc7933b8cacd0ccb5338dac0cf4373a4928527
6
+ metadata.gz: '0929254b79d4b39f5105b828b3cf226cca77201d5eabd2261160feaa2553c8454fb683d6d585492ed106c7c0c6d62767baabb2989c6c08560f0fe1f76c6ce321'
7
+ data.tar.gz: 55fccd1687e793019bd66d0d2d12da9738c02b193e1f484043829efaa2d60132dd1a0c11c7721958a32a71b2eb136280525d5dc0915d9bc5572b895ddc171e69
data/README.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # Oracle Cloud Infrastructure Ruby SDK
2
- **Version 2.5.3**
2
+ **Version 2.5.4**
3
3
 
4
4
  This topic describes how to install, configure, and use the Oracle Cloud Infrastructure Ruby SDK.
5
5
 
@@ -109,7 +109,8 @@ module OCI
109
109
  # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
110
110
 
111
111
 
112
- # Creates a new steering policy in the specified compartment.
112
+ # Creates a new steering policy in the specified compartment. For more information on
113
+ # creating policies with templates, see [Traffic Management API Guide](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
113
114
  #
114
115
  # @param [OCI::Dns::Models::CreateSteeringPolicyDetails] create_steering_policy_details Details for creating a new steering policy.
115
116
  # @param [Hash] opts the optional parameters
@@ -169,9 +170,12 @@ module OCI
169
170
  # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
170
171
 
171
172
 
172
- # Creates a new attachment between a steering policy and a domain.
173
+ # Creates a new attachment between a steering policy and a domain, giving the
174
+ # policy permission to answer queries for the specified domain. A steering policy must
175
+ # be attached to a domain for the policy to answer DNS queries for that domain.
176
+ #
173
177
  # For the purposes of access control, the attachment is automatically placed
174
- # into the same compartment as the containing zone of the domain.
178
+ # into the same compartment as the domain's zone.
175
179
  #
176
180
  # @param [OCI::Dns::Models::CreateSteeringPolicyAttachmentDetails] create_steering_policy_attachment_details Details for creating a new steering policy attachment.
177
181
  # @param [Hash] opts the optional parameters
@@ -430,7 +434,8 @@ module OCI
430
434
 
431
435
  # Deletes the specified steering policy.
432
436
  # A `204` response indicates that the delete has been successful.
433
- # Deletion will fail if the policy is attached to any zones.
437
+ # Deletion will fail if the policy is attached to any zones. To detach a
438
+ # policy from a zone, see `DeleteSteeringPolicyAttachment`.
434
439
  #
435
440
  # @param [String] steering_policy_id The OCID of the target steering policy.
436
441
  # @param [Hash] opts the optional parameters
@@ -1123,7 +1128,7 @@ module OCI
1123
1128
  # (case-insensitive) contains the provided value.
1124
1129
  #
1125
1130
  # @option opts [String] :health_check_monitor_id Search by health check monitor OCID.
1126
- # Will match any resource whose health check monitor id matches the provided value.
1131
+ # Will match any resource whose health check monitor ID matches the provided value.
1127
1132
  #
1128
1133
  # @option opts [DateTime] :time_created_greater_than_or_equal_to An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states
1129
1134
  # all returned resources were created on or after the indicated time.
@@ -1131,11 +1136,11 @@ module OCI
1131
1136
  # @option opts [DateTime] :time_created_less_than An [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp that states
1132
1137
  # all returned resources were created before the indicated time.
1133
1138
  #
1134
- # @option opts [String] :template Search by template type.
1139
+ # @option opts [String] :template Search by steering template type.
1135
1140
  # Will match any resource whose template type matches the provided value.
1136
1141
  #
1137
1142
  # @option opts [String] :lifecycle_state The state of a resource.
1138
- # @option opts [String] :sort_by The field by which to sort steering policies. (default to timeCreated)
1143
+ # @option opts [String] :sort_by The field by which to sort steering policies. If unspecified, defaults to `timeCreated`. (default to timeCreated)
1139
1144
  # Allowed values are: displayName, timeCreated, template
1140
1145
  # @option opts [String] :sort_order The order to sort the resources.
1141
1146
  #
@@ -1222,10 +1227,10 @@ module OCI
1222
1227
  # @option opts [String] :id The OCID of a resource.
1223
1228
  # @option opts [String] :display_name The displayName of a resource.
1224
1229
  # @option opts [String] :steering_policy_id Search by steering policy OCID.
1225
- # Will match any resource whose steering policy id matches the provided value.
1230
+ # Will match any resource whose steering policy ID matches the provided value.
1226
1231
  #
1227
1232
  # @option opts [String] :zone_id Search by zone OCID.
1228
- # Will match any resource whose zone id matches the provided value.
1233
+ # Will match any resource whose zone ID matches the provided value.
1229
1234
  #
1230
1235
  # @option opts [String] :domain Search by domain.
1231
1236
  # Will match any record whose domain (case-insensitive) equals the provided value.
@@ -1240,7 +1245,7 @@ module OCI
1240
1245
  # all returned resources were created before the indicated time.
1241
1246
  #
1242
1247
  # @option opts [String] :lifecycle_state The state of a resource.
1243
- # @option opts [String] :sort_by The field by which to sort steering policy attachments. (default to timeCreated)
1248
+ # @option opts [String] :sort_by The field by which to sort steering policy attachments. If unspecified, defaults to `timeCreated`. (default to timeCreated)
1244
1249
  # Allowed values are: displayName, timeCreated, domainName
1245
1250
  # @option opts [String] :sort_order The order to sort the resources.
1246
1251
  #
@@ -1420,7 +1425,11 @@ module OCI
1420
1425
  # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
1421
1426
 
1422
1427
 
1423
- # Updates records in the specified zone at a domain. You can update one record or all records for the specified zone depending on the changes provided in the request body. You can also add or remove records using this function.
1428
+ # Updates records in the specified zone at a domain. You can update
1429
+ # one record or all records for the specified zone depending on the changes
1430
+ # provided in the request body. You can also add or remove records using this
1431
+ # function.
1432
+ #
1424
1433
  # @param [String] zone_name_or_id The name or OCID of the target zone.
1425
1434
  # @param [String] domain The target fully-qualified domain name (FQDN) within the target zone.
1426
1435
  # @param [OCI::Dns::Models::PatchDomainRecordsDetails] patch_domain_records_details Operations describing how to modify the collection of records.
@@ -1794,7 +1803,7 @@ module OCI
1794
1803
  # rubocop:disable Metrics/MethodLength, Layout/EmptyLines
1795
1804
 
1796
1805
 
1797
- # Updates the specified steering policy with your new information.
1806
+ # Updates the configuration of the specified steering policy.
1798
1807
  #
1799
1808
  # @param [String] steering_policy_id The OCID of the target steering policy.
1800
1809
  # @param [OCI::Dns::Models::UpdateSteeringPolicyDetails] update_steering_policy_details New data for the steering policy.
@@ -5,12 +5,9 @@ require 'date'
5
5
  # rubocop:disable Lint/UnneededCopDisableDirective
6
6
  module OCI
7
7
  # The body for defining an attachment between a steering policy and a domain.
8
- # An attachment occludes all records at its domain that are of a covered rtype, constructing
9
- # DNS responses from its steering policy rather than from those domain records.
10
- # The attachment will cover every rtype that matches the rtype of an answer in its policy, and
11
- # will cover all address rtypes (e.g., A and AAAA) if the policy includes at least one CNAME
12
- # answer.
13
- # A domain can have at most one attachment covering any given rtype.
8
+ #
9
+ #
10
+ # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
14
11
  #
15
12
  class Dns::Models::CreateSteeringPolicyAttachmentDetails # rubocop:disable Metrics/LineLength
16
13
  # **[Required]** The OCID of the attached steering policy.
@@ -26,7 +23,7 @@ module OCI
26
23
  attr_accessor :domain_name
27
24
 
28
25
  # A user-friendly name for the steering policy attachment.
29
- # Does not have to be unique, and it's changeable.
26
+ # Does not have to be unique and can be changed.
30
27
  # Avoid entering confidential information.
31
28
  #
32
29
  # @return [String]
@@ -6,7 +6,7 @@ require 'date'
6
6
  module OCI
7
7
  # The body for defining a new steering policy.
8
8
  #
9
- # *Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
9
+ # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
10
10
  #
11
11
  class Dns::Models::CreateSteeringPolicyDetails # rubocop:disable Metrics/LineLength
12
12
  TEMPLATE_ENUM = [
@@ -22,80 +22,90 @@ module OCI
22
22
  # @return [String]
23
23
  attr_accessor :compartment_id
24
24
 
25
- # **[Required]** A user-friendly name for the steering policy.
26
- # Does not have to be unique, and it's changeable.
25
+ # **[Required]** A user-friendly name for the steering policy. Does not have to be unique and can be changed.
27
26
  # Avoid entering confidential information.
28
27
  #
29
28
  # @return [String]
30
29
  attr_accessor :display_name
31
30
 
32
- # The Time To Live for responses from the steering policy, in seconds.
31
+ # The Time To Live (TTL) for responses from the steering policy, in seconds.
33
32
  # If not specified during creation, a value of 30 seconds will be used.
34
33
  #
35
34
  # @return [Integer]
36
35
  attr_accessor :ttl
37
36
 
38
37
  # The OCID of the health check monitor providing health data about the answers of the
39
- # steering policy.
40
- # A steering policy answer with `rdata` matching a monitored endpoint will use the health
41
- # data of that endpoint.
42
- # A steering policy answer with `rdata` not matching any monitored endpoint will be assumed
43
- # healthy.
38
+ # steering policy. A steering policy answer with `rdata` matching a monitored endpoint
39
+ # will use the health data of that endpoint. A steering policy answer with `rdata` not
40
+ # matching any monitored endpoint will be assumed healthy.
41
+ #
42
+ #
43
+ # **Note:** To use the Health Check monitoring feature in a steering policy, a monitor
44
+ # must be created using the Health Checks service first. For more information on how to
45
+ # create a monitor, please see [Managing Health Checks](https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm).
44
46
  #
45
47
  # @return [String]
46
48
  attr_accessor :health_check_monitor_id
47
49
 
48
- # **[Required]** The common pattern (or lack thereof) to which the steering policy adheres. This
49
- # value restricts the possible configurations of rules, but thereby supports
50
- # specifically tailored interfaces. Values other than \"CUSTOM\" require the rules to
51
- # begin with an unconditional FILTER that keeps answers contingent upon
52
- # `answer.isDisabled != true`, followed
53
- # _if and only if the policy references a health check monitor_ by an unconditional
54
- # HEALTH rule, and require the last rule to be an unconditional LIMIT.
55
- # What must precede the LIMIT rule is determined by the template value:
56
- # - FAILOVER requires exactly an unconditional PRIORITY rule that ranks answers by pool.
57
- # Each answer pool must have a unique priority value assigned to it. Answer data must
58
- # be defined in the `defaultAnswerData` property for the rule and the `cases` property
59
- # must not be defined.
60
- # - LOAD_BALANCE requires exactly an unconditional WEIGHTED rule that shuffles answers
61
- # by name. Answer data must be defined in the `defaultAnswerData` property for the
62
- # rule and the `cases` property must not be defined.
63
- # - ROUTE_BY_GEO requires exactly one PRIORITY rule that ranks answers by pool using the
64
- # geographical location of the client as a condition. Within that rule you may only
65
- # use `query.client.geoKey` in the `caseCondition` expressions for defining the cases.
66
- # For each case in the PRIORITY rule each answer pool must have a unique priority
67
- # value assigned to it. Answer data can only be defined within cases and
68
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
69
- # - ROUTE_BY_ASN requires exactly one PRIORITY rule that ranks answers by pool using the
70
- # ASN of the client as a condition. Within that rule you may only use
71
- # `query.client.asn` in the `caseCondition` expressions for defining the cases.
72
- # For each case in the PRIORITY rule each answer pool must have a unique priority
73
- # value assigned to it. Answer data can only be defined within cases and
74
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
75
- # - ROUTE_BY_IP requires exactly one PRIORITY rule that ranks answers by pool using the
76
- # IP subnet of the client as a condition. Within that rule you may only use
77
- # `query.client.address` in the `caseCondition` expressions for defining the cases.
78
- # For each case in the PRIORITY rule each answer pool must have a unique priority
79
- # value assigned to it. Answer data can only be defined within cases and
80
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
81
- # - CUSTOM allows an arbitrary configuration of rules.
82
- #
83
- # For an existing steering policy, the template value may be changed to any of the
84
- # supported options but the resulting policy must conform to the requirements for the
85
- # new template type or else a Bad Request error will be returned.
50
+ # **[Required]** A set of predefined rules based on the desired purpose of the steering policy. Each
51
+ # template utilizes Traffic Management's rules in a different order to produce the desired
52
+ # results when answering DNS queries.
53
+ #
54
+ #
55
+ # **Example:** The `FAILOVER` template determines answers by filtering the policy's answers
56
+ # using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`,
57
+ # and `LIMIT`. This gives the domain dynamic failover capability.
58
+ #
59
+ #
60
+ # It is **strongly recommended** to use a template other than `CUSTOM` when creating
61
+ # a steering policy.
62
+ #
63
+ #
64
+ # All templates require the rule order to begin with an unconditional `FILTER` rule that keeps
65
+ # answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined
66
+ # `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`.
67
+ # The last rule of a template must must be a `LIMIT` rule. For more information about templates
68
+ # and code examples, see [Traffic Management API Guide](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
69
+ #
70
+ # **Template Types**
71
+ #
72
+ # * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers
73
+ # to serve. If an endpoint fails a health check, the answer for that endpoint will be removed
74
+ # from the list of available answers until the endpoint is detected as healthy.
75
+ #
76
+ #
77
+ # * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights.
78
+ #
79
+ #
80
+ # * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic
81
+ # locations to route by, see [Traffic Management Geographic Locations](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm).
82
+ #
83
+ #
84
+ # * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN.
85
+ #
86
+ #
87
+ # * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address.
88
+ #
89
+ #
90
+ # * `CUSTOM` - Allows a customized configuration of rules.
86
91
  #
87
92
  # @return [String]
88
93
  attr_reader :template
89
94
 
90
- # Simple key-value pair that is applied without any predefined name, type, or scope.
95
+ # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
91
96
  # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
92
- # Example: `{\"bar-key\": \"value\"}`
97
+ #
98
+ #
99
+ # **Example:** `{\"Department\": \"Finance\"}`
93
100
  #
94
101
  # @return [Hash<String, String>]
95
102
  attr_accessor :freeform_tags
96
103
 
97
- # Usage of predefined tag keys. These predefined keys are scoped to a namespace.
98
- # Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
104
+ # Defined tags for this resource. Each key is predefined and scoped to a namespace.
105
+ # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
106
+ #
107
+ #
108
+ # **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}`
99
109
  #
100
110
  # @return [Hash<String, Hash<String, Object>>]
101
111
  attr_accessor :defined_tags
@@ -105,9 +115,10 @@ module OCI
105
115
  # @return [Array<OCI::Dns::Models::SteeringPolicyAnswer>]
106
116
  attr_accessor :answers
107
117
 
108
- # The pipeline of rules that will be processed in sequence to reduce the pool of answers
118
+ # The series of rules that will be processed in sequence to reduce the pool of answers
109
119
  # to a response for any given request.
110
120
  #
121
+ #
111
122
  # The first rule receives a shuffled list of all answers, and every other rule receives
112
123
  # the list of answers emitted by the one preceding it. The last rule populates the
113
124
  # response.
@@ -6,7 +6,7 @@ require 'date'
6
6
  module OCI
7
7
  # The body for defining a new zone.
8
8
  #
9
- # *Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
9
+ # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
10
10
  #
11
11
  class Dns::Models::CreateZoneDetails # rubocop:disable Metrics/LineLength
12
12
  ZONE_TYPE_ENUM = [
@@ -27,15 +27,20 @@ module OCI
27
27
  # @return [String]
28
28
  attr_accessor :compartment_id
29
29
 
30
- # Simple key-value pair that is applied without any predefined name, type, or scope.
30
+ # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
31
31
  # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
32
- # Example: `{\"bar-key\": \"value\"}`
32
+ #
33
+ #
34
+ # **Example:** `{\"Department\": \"Finance\"}`
33
35
  #
34
36
  # @return [Hash<String, String>]
35
37
  attr_accessor :freeform_tags
36
38
 
37
- # Usage of predefined tag keys. These predefined keys are scoped to a namespace.
38
- # Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
39
+ # Defined tags for this resource. Each key is predefined and scoped to a namespace.
40
+ # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
41
+ #
42
+ #
43
+ # **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}`
39
44
  #
40
45
  # @return [Hash<String, Hash<String, Object>>]
41
46
  attr_accessor :defined_tags
@@ -4,7 +4,9 @@ require 'date'
4
4
 
5
5
  # rubocop:disable Lint/UnneededCopDisableDirective
6
6
  module OCI
7
- # A DNS resource record. For more information about DNS records, see [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.6).
7
+ # A DNS resource record. For more information, see
8
+ # [Supported DNS Resource Record Types](https://docs.cloud.oracle.com/iaas/Content/DNS/Reference/supporteddnsresource.htm).
9
+ #
8
10
  class Dns::Models::Record # rubocop:disable Metrics/LineLength
9
11
  # The fully qualified domain name where the record can be located.
10
12
  #
@@ -58,18 +58,22 @@ module OCI
58
58
 
59
59
  # A description of how a record relates to a PATCH operation.
60
60
  #
61
+ #
61
62
  # - `REQUIRE` indicates a precondition that record data **must** already exist.
62
63
  # - `PROHIBIT` indicates a precondition that record data **must not** already exist.
63
64
  # - `ADD` indicates that record data **must** exist after successful application.
64
65
  # - `REMOVE` indicates that record data **must not** exist after successful application.
65
66
  #
67
+ #
66
68
  # **Note:** `ADD` and `REMOVE` operations can succeed even if
67
69
  # they require no changes when applied, such as when the described
68
70
  # records are already present or absent.
69
71
  #
72
+ #
70
73
  # **Note:** `ADD` and `REMOVE` operations can describe changes for
71
74
  # more than one record.
72
75
  #
76
+ #
73
77
  # **Example:** `{ \"domain\": \"www.example.com\", \"rtype\": \"AAAA\", \"ttl\": 60 }`
74
78
  # specifies a new TTL for every record in the www.example.com AAAA RRSet.
75
79
  #
@@ -7,7 +7,7 @@ require 'logger'
7
7
  module OCI
8
8
  # A DNS steering policy.
9
9
  #
10
- # *Warning:* Oracle recommends that you avoid using any confidential information when you supply string values using the API.
10
+ # **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
11
11
  #
12
12
  class Dns::Models::SteeringPolicy # rubocop:disable Metrics/LineLength
13
13
  TEMPLATE_ENUM = [
@@ -32,80 +32,90 @@ module OCI
32
32
  # @return [String]
33
33
  attr_accessor :compartment_id
34
34
 
35
- # A user-friendly name for the steering policy.
36
- # Does not have to be unique, and it's changeable.
35
+ # A user-friendly name for the steering policy. Does not have to be unique and can be changed.
37
36
  # Avoid entering confidential information.
38
37
  #
39
38
  # @return [String]
40
39
  attr_accessor :display_name
41
40
 
42
- # The Time To Live for responses from the steering policy, in seconds.
41
+ # The Time To Live (TTL) for responses from the steering policy, in seconds.
43
42
  # If not specified during creation, a value of 30 seconds will be used.
44
43
  #
45
44
  # @return [Integer]
46
45
  attr_accessor :ttl
47
46
 
48
47
  # The OCID of the health check monitor providing health data about the answers of the
49
- # steering policy.
50
- # A steering policy answer with `rdata` matching a monitored endpoint will use the health
51
- # data of that endpoint.
52
- # A steering policy answer with `rdata` not matching any monitored endpoint will be assumed
53
- # healthy.
48
+ # steering policy. A steering policy answer with `rdata` matching a monitored endpoint
49
+ # will use the health data of that endpoint. A steering policy answer with `rdata` not
50
+ # matching any monitored endpoint will be assumed healthy.
51
+ #
52
+ #
53
+ # **Note:** To use the Health Check monitoring feature in a steering policy, a monitor
54
+ # must be created using the Health Checks service first. For more information on how to
55
+ # create a monitor, please see [Managing Health Checks](https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm).
54
56
  #
55
57
  # @return [String]
56
58
  attr_accessor :health_check_monitor_id
57
59
 
58
- # The common pattern (or lack thereof) to which the steering policy adheres. This
59
- # value restricts the possible configurations of rules, but thereby supports
60
- # specifically tailored interfaces. Values other than \"CUSTOM\" require the rules to
61
- # begin with an unconditional FILTER that keeps answers contingent upon
62
- # `answer.isDisabled != true`, followed
63
- # _if and only if the policy references a health check monitor_ by an unconditional
64
- # HEALTH rule, and require the last rule to be an unconditional LIMIT.
65
- # What must precede the LIMIT rule is determined by the template value:
66
- # - FAILOVER requires exactly an unconditional PRIORITY rule that ranks answers by pool.
67
- # Each answer pool must have a unique priority value assigned to it. Answer data must
68
- # be defined in the `defaultAnswerData` property for the rule and the `cases` property
69
- # must not be defined.
70
- # - LOAD_BALANCE requires exactly an unconditional WEIGHTED rule that shuffles answers
71
- # by name. Answer data must be defined in the `defaultAnswerData` property for the
72
- # rule and the `cases` property must not be defined.
73
- # - ROUTE_BY_GEO requires exactly one PRIORITY rule that ranks answers by pool using the
74
- # geographical location of the client as a condition. Within that rule you may only
75
- # use `query.client.geoKey` in the `caseCondition` expressions for defining the cases.
76
- # For each case in the PRIORITY rule each answer pool must have a unique priority
77
- # value assigned to it. Answer data can only be defined within cases and
78
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
79
- # - ROUTE_BY_ASN requires exactly one PRIORITY rule that ranks answers by pool using the
80
- # ASN of the client as a condition. Within that rule you may only use
81
- # `query.client.asn` in the `caseCondition` expressions for defining the cases.
82
- # For each case in the PRIORITY rule each answer pool must have a unique priority
83
- # value assigned to it. Answer data can only be defined within cases and
84
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
85
- # - ROUTE_BY_IP requires exactly one PRIORITY rule that ranks answers by pool using the
86
- # IP subnet of the client as a condition. Within that rule you may only use
87
- # `query.client.address` in the `caseCondition` expressions for defining the cases.
88
- # For each case in the PRIORITY rule each answer pool must have a unique priority
89
- # value assigned to it. Answer data can only be defined within cases and
90
- # `defaultAnswerData` cannot be used in the PRIORITY rule.
91
- # - CUSTOM allows an arbitrary configuration of rules.
92
- #
93
- # For an existing steering policy, the template value may be changed to any of the
94
- # supported options but the resulting policy must conform to the requirements for the
95
- # new template type or else a Bad Request error will be returned.
60
+ # A set of predefined rules based on the desired purpose of the steering policy. Each
61
+ # template utilizes Traffic Management's rules in a different order to produce the desired
62
+ # results when answering DNS queries.
63
+ #
64
+ #
65
+ # **Example:** The `FAILOVER` template determines answers by filtering the policy's answers
66
+ # using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`,
67
+ # and `LIMIT`. This gives the domain dynamic failover capability.
68
+ #
69
+ #
70
+ # It is **strongly recommended** to use a template other than `CUSTOM` when creating
71
+ # a steering policy.
72
+ #
73
+ #
74
+ # All templates require the rule order to begin with an unconditional `FILTER` rule that keeps
75
+ # answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined
76
+ # `HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`.
77
+ # The last rule of a template must must be a `LIMIT` rule. For more information about templates
78
+ # and code examples, see [Traffic Management API Guide](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).
79
+ #
80
+ # **Template Types**
81
+ #
82
+ # * `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers
83
+ # to serve. If an endpoint fails a health check, the answer for that endpoint will be removed
84
+ # from the list of available answers until the endpoint is detected as healthy.
85
+ #
86
+ #
87
+ # * `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights.
88
+ #
89
+ #
90
+ # * `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic
91
+ # locations to route by, see [Traffic Management Geographic Locations](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm).
92
+ #
93
+ #
94
+ # * `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN.
95
+ #
96
+ #
97
+ # * `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address.
98
+ #
99
+ #
100
+ # * `CUSTOM` - Allows a customized configuration of rules.
96
101
  #
97
102
  # @return [String]
98
103
  attr_reader :template
99
104
 
100
- # Simple key-value pair that is applied without any predefined name, type, or scope.
105
+ # Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
101
106
  # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
102
- # Example: `{\"bar-key\": \"value\"}`
107
+ #
108
+ #
109
+ # **Example:** `{\"Department\": \"Finance\"}`
103
110
  #
104
111
  # @return [Hash<String, String>]
105
112
  attr_accessor :freeform_tags
106
113
 
107
- # Usage of predefined tag keys. These predefined keys are scoped to a namespace.
108
- # Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`
114
+ # Defined tags for this resource. Each key is predefined and scoped to a namespace.
115
+ # For more information, see [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
116
+ #
117
+ #
118
+ # **Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}`
109
119
  #
110
120
  # @return [Hash<String, Hash<String, Object>>]
111
121
  attr_accessor :defined_tags
@@ -115,9 +125,10 @@ module OCI
115
125
  # @return [Array<OCI::Dns::Models::SteeringPolicyAnswer>]
116
126
  attr_accessor :answers
117
127
 
118
- # The pipeline of rules that will be processed in sequence to reduce the pool of answers
128
+ # The series of rules that will be processed in sequence to reduce the pool of answers
119
129
  # to a response for any given request.
120
130
  #
131
+ #
121
132
  # The first rule receives a shuffled list of all answers, and every other rule receives
122
133
  # the list of answers emitted by the one preceding it. The last rule populates the
123
134
  # response.
@@ -133,8 +144,7 @@ module OCI
133
144
  # @return [String]
134
145
  attr_accessor :id
135
146
 
136
- # The date and time the resource was created in \"YYYY-MM-ddThh:mmZ\" format
137
- # with a Z offset, as defined by RFC 3339.
147
+ # The date and time the resource was created, expressed in RFC 3339 timestamp format.
138
148
  #
139
149
  # **Example:** `2016-07-22T17:23:59:60Z`
140
150
  #