Show / Hide Table of Contents

Class DbSystemEndpoint

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

Inheritance
object
DbSystemEndpoint
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.MysqlService.Models
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class DbSystemEndpoint

Properties

Hostname

Declaration
[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }
Property Value
Type Description
string

The network address of the DB System.

IpAddress

Declaration
[Required(ErrorMessage = "IpAddress is required.")]
[JsonProperty(PropertyName = "ipAddress")]
public string IpAddress { get; set; }
Property Value
Type Description
string

The IP address the DB System is configured to listen on.

Remarks

Required

Modes

Declaration
[JsonProperty(PropertyName = "modes", ItemConverterType = typeof(ResponseEnumConverter))]
public List<DbSystemEndpoint.ModesEnum> Modes { get; set; }
Property Value
Type Description
List<DbSystemEndpoint.ModesEnum>

The access modes from the client that this endpoint supports.

Port

Declaration
[Required(ErrorMessage = "Port is required.")]
[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }
Property Value
Type Description
int?

The port the MySQL instance listens on.

Remarks

Required

PortX

Declaration
[Required(ErrorMessage = "PortX is required.")]
[JsonProperty(PropertyName = "portX")]
public int? PortX { get; set; }
Property Value
Type Description
int?

The network port where to connect to use this endpoint using the X protocol.

Remarks

Required

ResourceId

Declaration
[JsonProperty(PropertyName = "resourceId")]
public string ResourceId { get; set; }
Property Value
Type Description
string

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

ResourceType

Declaration
[JsonProperty(PropertyName = "resourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemEndpoint.ResourceTypeEnum? ResourceType { get; set; }
Property Value
Type Description
DbSystemEndpoint.ResourceTypeEnum?

The type of endpoint that clients and connectors can connect to.

Status

Declaration
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DbSystemEndpoint.StatusEnum? Status { get; set; }
Property Value
Type Description
DbSystemEndpoint.StatusEnum?

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.

StatusDetails

Declaration
[JsonProperty(PropertyName = "statusDetails")]
public string StatusDetails { get; set; }
Property Value
Type Description
string

Additional information about the current endpoint status.

In this article
Back to top