ResolverVnicEndpointSummary

class oci.dns.models.ResolverVnicEndpointSummary(**kwargs)

Bases: ResolverEndpointSummary

An OCI DNS resolver VNIC endpoint. A VNIC is created for each ResolverVnicEndpoint. VCNs and subnets cannot be deleted while ResolverVnicEndpoints exist in them due to the VNIC.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes:

ENDPOINT_TYPE_VNIC

A constant which can be used with the endpoint_type property of a ResolverEndpointSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary.

compartment_id

[Required] Gets the compartment_id of this ResolverEndpointSummary.

defined_tags

[Required] Gets the defined_tags of this ResolverEndpointSummary.

endpoint_type

Gets the endpoint_type of this ResolverEndpointSummary.

forwarding_address

Gets the forwarding_address of this ResolverEndpointSummary.

freeform_tags

[Required] Gets the freeform_tags of this ResolverEndpointSummary.

id

[Required] Gets the id of this ResolverEndpointSummary.

is_forwarding

[Required] Gets the is_forwarding of this ResolverEndpointSummary.

is_listening

[Required] Gets the is_listening of this ResolverEndpointSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this ResolverEndpointSummary.

listening_address

Gets the listening_address of this ResolverEndpointSummary.

name

[Required] Gets the name of this ResolverEndpointSummary.

pe_id

Gets the pe_id of this ResolverVnicEndpointSummary.

resolver_id

[Required] Gets the resolver_id of this ResolverEndpointSummary.

security_attributes

[Required] Gets the security_attributes of this ResolverVnicEndpointSummary.

subnet_id

[Required] Gets the subnet_id of this ResolverVnicEndpointSummary.

time_created

[Required] Gets the time_created of this ResolverEndpointSummary.

time_updated

[Required] Gets the time_updated of this ResolverEndpointSummary.

vnic_id

Gets the vnic_id of this ResolverVnicEndpointSummary.

Methods:

__init__(**kwargs)

Initializes a new ResolverVnicEndpointSummary object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ENDPOINT_TYPE_VNIC = 'VNIC'

A constant which can be used with the endpoint_type property of a ResolverEndpointSummary. This constant has a value of “VNIC”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a ResolverEndpointSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new ResolverVnicEndpointSummary object with values from keyword arguments. The default value of the endpoint_type attribute of this class is VNIC and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this ResolverVnicEndpointSummary.

  • endpoint_type (str) – The value to assign to the endpoint_type property of this ResolverVnicEndpointSummary. Allowed values for this property are: “VNIC”

  • forwarding_address (str) – The value to assign to the forwarding_address property of this ResolverVnicEndpointSummary.

  • is_forwarding (bool) – The value to assign to the is_forwarding property of this ResolverVnicEndpointSummary.

  • is_listening (bool) – The value to assign to the is_listening property of this ResolverVnicEndpointSummary.

  • listening_address (str) – The value to assign to the listening_address property of this ResolverVnicEndpointSummary.

  • id (str) – The value to assign to the id property of this ResolverVnicEndpointSummary.

  • resolver_id (str) – The value to assign to the resolver_id property of this ResolverVnicEndpointSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this ResolverVnicEndpointSummary.

  • time_created (datetime) – The value to assign to the time_created property of this ResolverVnicEndpointSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this ResolverVnicEndpointSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this ResolverVnicEndpointSummary. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”

  • _self (str) – The value to assign to the _self property of this ResolverVnicEndpointSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ResolverVnicEndpointSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ResolverVnicEndpointSummary.

  • subnet_id (str) – The value to assign to the subnet_id property of this ResolverVnicEndpointSummary.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this ResolverVnicEndpointSummary.

  • pe_id (str) – The value to assign to the pe_id property of this ResolverVnicEndpointSummary.

  • vnic_id (str) – The value to assign to the vnic_id property of this ResolverVnicEndpointSummary.

property compartment_id

[Required] Gets the compartment_id of this ResolverEndpointSummary. The OCID of the owning compartment. This will match the resolver that the resolver endpoint is under and will be updated if the resolver’s compartment is changed.

Returns

The compartment_id of this ResolverEndpointSummary.

Return type

str

property defined_tags

[Required] Gets the defined_tags of this ResolverEndpointSummary.

Returns

The defined_tags of this ResolverEndpointSummary.

Return type

dict(str, dict(str, object))

property endpoint_type

Gets the endpoint_type of this ResolverEndpointSummary. The type of resolver endpoint. VNIC is currently the only supported type.

Allowed values for this property are: “VNIC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The endpoint_type of this ResolverEndpointSummary.

Return type

str

property forwarding_address

Gets the forwarding_address of this ResolverEndpointSummary. An IP address from which forwarded queries may be sent. For VNIC endpoints, this IP address must be part of the subnet and will be assigned by the system if unspecified when isForwarding is true.

Returns

The forwarding_address of this ResolverEndpointSummary.

Return type

str

property freeform_tags

[Required] Gets the freeform_tags of this ResolverEndpointSummary.

Returns

The freeform_tags of this ResolverEndpointSummary.

Return type

dict(str, str)

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property id

[Required] Gets the id of this ResolverEndpointSummary. The OCID of the resolver endpoint.

Returns

The id of this ResolverEndpointSummary.

Return type

str

property is_forwarding

[Required] Gets the is_forwarding of this ResolverEndpointSummary. A Boolean flag indicating whether or not the resolver endpoint is for forwarding.

Returns

The is_forwarding of this ResolverEndpointSummary.

Return type

bool

property is_listening

[Required] Gets the is_listening of this ResolverEndpointSummary. A Boolean flag indicating whether or not the resolver endpoint is for listening.

Returns

The is_listening of this ResolverEndpointSummary.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this ResolverEndpointSummary. The current state of the resource.

Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETED”, “DELETING”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this ResolverEndpointSummary.

Return type

str

property listening_address

Gets the listening_address of this ResolverEndpointSummary. An IP address to listen to queries on. For VNIC endpoints this IP address must be part of the subnet and will be assigned by the system if unspecified when isListening is true.

Returns

The listening_address of this ResolverEndpointSummary.

Return type

str

property name

[Required] Gets the name of this ResolverEndpointSummary. The name of the resolver endpoint. Must be unique, case-insensitive, within the resolver.

Returns

The name of this ResolverEndpointSummary.

Return type

str

property pe_id

Gets the pe_id of this ResolverVnicEndpointSummary. The OCID of the private endpoint resource that this resolver endpoint corresponds to.

Returns

The pe_id of this ResolverVnicEndpointSummary.

Return type

str

property resolver_id

[Required] Gets the resolver_id of this ResolverEndpointSummary. The OCID of the resolver.

Returns

The resolver_id of this ResolverEndpointSummary.

Return type

str

property security_attributes

[Required] Gets the security_attributes of this ResolverVnicEndpointSummary.

Returns

The security_attributes of this ResolverVnicEndpointSummary.

Return type

dict(str, dict(str, object))

property subnet_id

[Required] Gets the subnet_id of this ResolverVnicEndpointSummary. The OCID of a subnet. Must be part of the VCN that the resolver is attached to.

Returns

The subnet_id of this ResolverVnicEndpointSummary.

Return type

str

property time_created

[Required] Gets the time_created of this ResolverEndpointSummary. The date and time the resource was created in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns

The time_created of this ResolverEndpointSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this ResolverEndpointSummary. The date and time the resource was last updated in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.

Example: 2016-07-22T17:23:59:60Z

Returns

The time_updated of this ResolverEndpointSummary.

Return type

datetime

property vnic_id

Gets the vnic_id of this ResolverVnicEndpointSummary. The OCID of the VNIC resource that this resolver endpoint corresponds to.

Returns

The vnic_id of this ResolverVnicEndpointSummary.

Return type

str