DbSystemEndpoint

class oci.mysql.models.DbSystemEndpoint(**kwargs)

Bases: object

A particular functional endpoint for access to a DB System, and the properties that apply to it.

Attributes:

IP_ADDRESS_VERSION_IPV4	A constant which can be used with the ip_address_version property of a DbSystemEndpoint.
IP_ADDRESS_VERSION_IPV6	A constant which can be used with the ip_address_version property of a DbSystemEndpoint.
MODES_READ	A constant which can be used with the modes property of a DbSystemEndpoint.
MODES_WRITE	A constant which can be used with the modes property of a DbSystemEndpoint.
RESOURCE_TYPE_DBSYSTEM	A constant which can be used with the resource_type property of a DbSystemEndpoint.
RESOURCE_TYPE_LOAD_BALANCER	A constant which can be used with the resource_type property of a DbSystemEndpoint.
RESOURCE_TYPE_READ_ENDPOINT	A constant which can be used with the resource_type property of a DbSystemEndpoint.
RESOURCE_TYPE_READ_REPLICA	A constant which can be used with the resource_type property of a DbSystemEndpoint.
STATUS_ACTIVE	A constant which can be used with the status property of a DbSystemEndpoint.
STATUS_INACTIVE	A constant which can be used with the status property of a DbSystemEndpoint.
STATUS_UPDATING	A constant which can be used with the status property of a DbSystemEndpoint.
hostname	Gets the hostname of this DbSystemEndpoint.
ip_address	[Required] Gets the ip_address of this DbSystemEndpoint.
ip_address_version	Gets the ip_address_version of this DbSystemEndpoint.
modes	Gets the modes of this DbSystemEndpoint.
port	[Required] Gets the port of this DbSystemEndpoint.
port_x	[Required] Gets the port_x of this DbSystemEndpoint.
resource_id	Gets the resource_id of this DbSystemEndpoint.
resource_type	Gets the resource_type of this DbSystemEndpoint.
status	Gets the status of this DbSystemEndpoint.
status_details	Gets the status_details of this DbSystemEndpoint.

Methods:

__init__(**kwargs)

Initializes a new DbSystemEndpoint object with values from keyword arguments.

IP_ADDRESS_VERSION_IPV4 = 'IPV4'

A constant which can be used with the ip_address_version property of a DbSystemEndpoint. This constant has a value of “IPV4”

IP_ADDRESS_VERSION_IPV6 = 'IPV6'

A constant which can be used with the ip_address_version property of a DbSystemEndpoint. This constant has a value of “IPV6”

MODES_READ = 'READ'

A constant which can be used with the modes property of a DbSystemEndpoint. This constant has a value of “READ”

MODES_WRITE = 'WRITE'

A constant which can be used with the modes property of a DbSystemEndpoint. This constant has a value of “WRITE”

RESOURCE_TYPE_DBSYSTEM = 'DBSYSTEM'

A constant which can be used with the resource_type property of a DbSystemEndpoint. This constant has a value of “DBSYSTEM”

RESOURCE_TYPE_LOAD_BALANCER = 'LOAD_BALANCER'

A constant which can be used with the resource_type property of a DbSystemEndpoint. This constant has a value of “LOAD_BALANCER”

RESOURCE_TYPE_READ_ENDPOINT = 'READ_ENDPOINT'

A constant which can be used with the resource_type property of a DbSystemEndpoint. This constant has a value of “READ_ENDPOINT”

RESOURCE_TYPE_READ_REPLICA = 'READ_REPLICA'

A constant which can be used with the resource_type property of a DbSystemEndpoint. This constant has a value of “READ_REPLICA”

STATUS_ACTIVE = 'ACTIVE'

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

STATUS_INACTIVE = 'INACTIVE'

A constant which can be used with the status property of a DbSystemEndpoint. This constant has a value of “INACTIVE”

STATUS_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new DbSystemEndpoint object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

• hostname (str) – The value to assign to the hostname property of this DbSystemEndpoint.

• ip_address (str) – The value to assign to the ip_address property of this DbSystemEndpoint.

• ip_address_version (str) – The value to assign to the ip_address_version property of this DbSystemEndpoint. Allowed values for this property are: “IPV4”, “IPV6”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• port (int) – The value to assign to the port property of this DbSystemEndpoint.

• port_x (int) – The value to assign to the port_x property of this DbSystemEndpoint.

• modes (list[str]) – The value to assign to the modes property of this DbSystemEndpoint. Allowed values for items in this list are: “READ”, “WRITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• status (str) – The value to assign to the status property of this DbSystemEndpoint. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• status_details (str) – The value to assign to the status_details property of this DbSystemEndpoint.

• resource_type (str) – The value to assign to the resource_type property of this DbSystemEndpoint. Allowed values for this property are: “DBSYSTEM”, “READ_REPLICA”, “LOAD_BALANCER”, “READ_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• resource_id (str) – The value to assign to the resource_id property of this DbSystemEndpoint.

property hostname

Gets the hostname of this DbSystemEndpoint. The network address of the DB System.

Returns

The hostname of this DbSystemEndpoint.

Return type

str

property ip_address

[Required] Gets the ip_address of this DbSystemEndpoint. The IP address the DB System is configured to listen on.

Returns

The ip_address of this DbSystemEndpoint.

Return type

str

property ip_address_version

Gets the ip_address_version of this DbSystemEndpoint. The internet protocol (IP) version of the IP address.

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

Returns

The ip_address_version of this DbSystemEndpoint.

Return type

str

property modes

Gets the modes of this DbSystemEndpoint. The access modes from the client that this endpoint supports.

Allowed values for items in this list are: “READ”, “WRITE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The modes of this DbSystemEndpoint.

Return type

list[str]

property port

[Required] Gets the port of this DbSystemEndpoint. The port the MySQL instance listens on.

Returns

The port of this DbSystemEndpoint.

Return type

int

property port_x

[Required] Gets the port_x of this DbSystemEndpoint. The network port where to connect to use this endpoint using the X protocol.

Returns

The port_x of this DbSystemEndpoint.

Return type

int

property resource_id

Gets the resource_id of this DbSystemEndpoint. The OCID of the resource that this endpoint is attached to.

Returns

The resource_id of this DbSystemEndpoint.

Return type

str

property resource_type

Gets the resource_type of this DbSystemEndpoint. The type of endpoint that clients and connectors can connect to.

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

Returns

The resource_type of this DbSystemEndpoint.

Return type

str

property status

Gets the status of this DbSystemEndpoint. The state of the endpoints, as far as it can seen from the DB System. There may be some inconsistency with the actual state of the MySQL service.

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

Returns

The status of this DbSystemEndpoint.

Return type

str

property status_details

Gets the status_details of this DbSystemEndpoint. Additional information about the current endpoint status.

Returns

The status_details of this DbSystemEndpoint.

Return type

str