Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /proc/self/root/usr/share/mysqlsh/oci_sdk/oci/dns/models/ |
# coding: utf-8
# Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class UpdateSteeringPolicyDetails(object):
"""
The body for updating a steering policy. New rules and answers provided in the request will
replace the existing rules and answers in the policy.
**Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
"""
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "FAILOVER"
TEMPLATE_FAILOVER = "FAILOVER"
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "LOAD_BALANCE"
TEMPLATE_LOAD_BALANCE = "LOAD_BALANCE"
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "ROUTE_BY_GEO"
TEMPLATE_ROUTE_BY_GEO = "ROUTE_BY_GEO"
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "ROUTE_BY_ASN"
TEMPLATE_ROUTE_BY_ASN = "ROUTE_BY_ASN"
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "ROUTE_BY_IP"
TEMPLATE_ROUTE_BY_IP = "ROUTE_BY_IP"
#: A constant which can be used with the template property of a UpdateSteeringPolicyDetails.
#: This constant has a value of "CUSTOM"
TEMPLATE_CUSTOM = "CUSTOM"
def __init__(self, **kwargs):
"""
Initializes a new UpdateSteeringPolicyDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param display_name:
The value to assign to the display_name property of this UpdateSteeringPolicyDetails.
:type display_name: str
:param ttl:
The value to assign to the ttl property of this UpdateSteeringPolicyDetails.
:type ttl: int
:param health_check_monitor_id:
The value to assign to the health_check_monitor_id property of this UpdateSteeringPolicyDetails.
:type health_check_monitor_id: str
:param template:
The value to assign to the template property of this UpdateSteeringPolicyDetails.
Allowed values for this property are: "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM"
:type template: str
:param freeform_tags:
The value to assign to the freeform_tags property of this UpdateSteeringPolicyDetails.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this UpdateSteeringPolicyDetails.
:type defined_tags: dict(str, dict(str, object))
:param answers:
The value to assign to the answers property of this UpdateSteeringPolicyDetails.
:type answers: list[SteeringPolicyAnswer]
:param rules:
The value to assign to the rules property of this UpdateSteeringPolicyDetails.
:type rules: list[SteeringPolicyRule]
"""
self.swagger_types = {
'display_name': 'str',
'ttl': 'int',
'health_check_monitor_id': 'str',
'template': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'answers': 'list[SteeringPolicyAnswer]',
'rules': 'list[SteeringPolicyRule]'
}
self.attribute_map = {
'display_name': 'displayName',
'ttl': 'ttl',
'health_check_monitor_id': 'healthCheckMonitorId',
'template': 'template',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'answers': 'answers',
'rules': 'rules'
}
self._display_name = None
self._ttl = None
self._health_check_monitor_id = None
self._template = None
self._freeform_tags = None
self._defined_tags = None
self._answers = None
self._rules = None
@property
def display_name(self):
"""
Gets the display_name of this UpdateSteeringPolicyDetails.
A user-friendly name for the steering policy. Does not have to be unique and can be changed.
Avoid entering confidential information.
:return: The display_name of this UpdateSteeringPolicyDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this UpdateSteeringPolicyDetails.
A user-friendly name for the steering policy. Does not have to be unique and can be changed.
Avoid entering confidential information.
:param display_name: The display_name of this UpdateSteeringPolicyDetails.
:type: str
"""
self._display_name = display_name
@property
def ttl(self):
"""
Gets the ttl of this UpdateSteeringPolicyDetails.
The Time To Live (TTL) for responses from the steering policy, in seconds.
If not specified during creation, a value of 30 seconds will be used.
:return: The ttl of this UpdateSteeringPolicyDetails.
:rtype: int
"""
return self._ttl
@ttl.setter
def ttl(self, ttl):
"""
Sets the ttl of this UpdateSteeringPolicyDetails.
The Time To Live (TTL) for responses from the steering policy, in seconds.
If not specified during creation, a value of 30 seconds will be used.
:param ttl: The ttl of this UpdateSteeringPolicyDetails.
:type: int
"""
self._ttl = ttl
@property
def health_check_monitor_id(self):
"""
Gets the health_check_monitor_id of this UpdateSteeringPolicyDetails.
The OCID of the health check monitor providing health data about the answers of the
steering policy. A steering policy answer with `rdata` matching a monitored endpoint
will use the health data of that endpoint. A steering policy answer with `rdata` not
matching any monitored endpoint will be assumed healthy.
**Note:** To use the Health Check monitoring feature in a steering policy, a monitor
must be created using the Health Checks service first. For more information on how to
create a monitor, please see `Managing Health Checks`__.
__ https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm
:return: The health_check_monitor_id of this UpdateSteeringPolicyDetails.
:rtype: str
"""
return self._health_check_monitor_id
@health_check_monitor_id.setter
def health_check_monitor_id(self, health_check_monitor_id):
"""
Sets the health_check_monitor_id of this UpdateSteeringPolicyDetails.
The OCID of the health check monitor providing health data about the answers of the
steering policy. A steering policy answer with `rdata` matching a monitored endpoint
will use the health data of that endpoint. A steering policy answer with `rdata` not
matching any monitored endpoint will be assumed healthy.
**Note:** To use the Health Check monitoring feature in a steering policy, a monitor
must be created using the Health Checks service first. For more information on how to
create a monitor, please see `Managing Health Checks`__.
__ https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm
:param health_check_monitor_id: The health_check_monitor_id of this UpdateSteeringPolicyDetails.
:type: str
"""
self._health_check_monitor_id = health_check_monitor_id
@property
def template(self):
"""
Gets the template of this UpdateSteeringPolicyDetails.
A set of predefined rules based on the desired purpose of the steering policy. Each
template utilizes Traffic Management's rules in a different order to produce the desired
results when answering DNS queries.
**Example:** The `FAILOVER` template determines answers by filtering the policy's answers
using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`,
and `LIMIT`. This gives the domain dynamic failover capability.
It is **strongly recommended** to use a template other than `CUSTOM` when creating
a steering policy.
All templates require the rule order to begin with an unconditional `FILTER` rule that keeps
answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined
`HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`.
The last rule of a template must must be a `LIMIT` rule. For more information about templates
and code examples, see `Traffic Management API Guide`__.
**Template Types**
* `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers
to serve. If an endpoint fails a health check, the answer for that endpoint will be removed
from the list of available answers until the endpoint is detected as healthy.
* `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights.
* `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic
locations to route by, see `Traffic Management Geographic Locations`__.
* `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN.
* `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address.
* `CUSTOM` - Allows a customized configuration of rules.
__ https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm
__ https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm
Allowed values for this property are: "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM"
:return: The template of this UpdateSteeringPolicyDetails.
:rtype: str
"""
return self._template
@template.setter
def template(self, template):
"""
Sets the template of this UpdateSteeringPolicyDetails.
A set of predefined rules based on the desired purpose of the steering policy. Each
template utilizes Traffic Management's rules in a different order to produce the desired
results when answering DNS queries.
**Example:** The `FAILOVER` template determines answers by filtering the policy's answers
using the `FILTER` rule first, then the following rules in succession: `HEALTH`, `PRIORITY`,
and `LIMIT`. This gives the domain dynamic failover capability.
It is **strongly recommended** to use a template other than `CUSTOM` when creating
a steering policy.
All templates require the rule order to begin with an unconditional `FILTER` rule that keeps
answers contingent upon `answer.isDisabled != true`, except for `CUSTOM`. A defined
`HEALTH` rule must follow the `FILTER` rule if the policy references a `healthCheckMonitorId`.
The last rule of a template must must be a `LIMIT` rule. For more information about templates
and code examples, see `Traffic Management API Guide`__.
**Template Types**
* `FAILOVER` - Uses health check information on your endpoints to determine which DNS answers
to serve. If an endpoint fails a health check, the answer for that endpoint will be removed
from the list of available answers until the endpoint is detected as healthy.
* `LOAD_BALANCE` - Distributes web traffic to specified endpoints based on defined weights.
* `ROUTE_BY_GEO` - Answers DNS queries based on the query's geographic location. For a list of geographic
locations to route by, see `Traffic Management Geographic Locations`__.
* `ROUTE_BY_ASN` - Answers DNS queries based on the query's originating ASN.
* `ROUTE_BY_IP` - Answers DNS queries based on the query's IP address.
* `CUSTOM` - Allows a customized configuration of rules.
__ https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm
__ https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm
:param template: The template of this UpdateSteeringPolicyDetails.
:type: str
"""
allowed_values = ["FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM"]
if not value_allowed_none_or_none_sentinel(template, allowed_values):
raise ValueError(
"Invalid value for `template`, must be None or one of {0}"
.format(allowed_values)
)
self._template = template
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this UpdateSteeringPolicyDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
**Example:** `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this UpdateSteeringPolicyDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this UpdateSteeringPolicyDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
For more information, see `Resource Tags`__.
**Example:** `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this UpdateSteeringPolicyDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
Gets the defined_tags of this UpdateSteeringPolicyDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
**Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this UpdateSteeringPolicyDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this UpdateSteeringPolicyDetails.
Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see `Resource Tags`__.
**Example:** `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this UpdateSteeringPolicyDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def answers(self):
"""
Gets the answers of this UpdateSteeringPolicyDetails.
The set of all answers that can potentially issue from the steering policy.
:return: The answers of this UpdateSteeringPolicyDetails.
:rtype: list[SteeringPolicyAnswer]
"""
return self._answers
@answers.setter
def answers(self, answers):
"""
Sets the answers of this UpdateSteeringPolicyDetails.
The set of all answers that can potentially issue from the steering policy.
:param answers: The answers of this UpdateSteeringPolicyDetails.
:type: list[SteeringPolicyAnswer]
"""
self._answers = answers
@property
def rules(self):
"""
Gets the rules of this UpdateSteeringPolicyDetails.
The series of rules that will be processed in sequence to reduce the pool of answers
to a response for any given request.
The first rule receives a shuffled list of all answers, and every other rule receives
the list of answers emitted by the one preceding it. The last rule populates the
response.
:return: The rules of this UpdateSteeringPolicyDetails.
:rtype: list[SteeringPolicyRule]
"""
return self._rules
@rules.setter
def rules(self, rules):
"""
Sets the rules of this UpdateSteeringPolicyDetails.
The series of rules that will be processed in sequence to reduce the pool of answers
to a response for any given request.
The first rule receives a shuffled list of all answers, and every other rule receives
the list of answers emitted by the one preceding it. The last rule populates the
response.
:param rules: The rules of this UpdateSteeringPolicyDetails.
:type: list[SteeringPolicyRule]
"""
self._rules = rules
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other