Class DatabaseToolsDatabaseApiGatewayConfigGlobal

The content of a Database Tools database API gateway config global resource.

Inheritance
object
DatabaseToolsDatabaseApiGatewayConfigGlobal
DatabaseToolsDatabaseApiGatewayConfigGlobalDefault
Inherited Members
Namespace: Oci.DatabasetoolsruntimeService.Models
Assembly: OCI.DotNetSDK.Databasetoolsruntime.dll
Syntax
[JsonConverter(typeof(DatabaseToolsDatabaseApiGatewayConfigGlobalModelConverter))]
public class DatabaseToolsDatabaseApiGatewayConfigGlobal

Properties

AdvancedProperties

Declaration
[JsonProperty(PropertyName = "advancedProperties")]
public Dictionary<string, string> AdvancedProperties { get; set; }
Property Value
Type Description
Dictionary<string, string>

Advanced global properties.

CertificateBundle

Declaration
[JsonProperty(PropertyName = "certificateBundle")]
public DatabaseApiGatewayConfigCertificateBundle CertificateBundle { get; set; }
Property Value
Type Description
DatabaseApiGatewayConfigCertificateBundle

DatabaseApiStatus

Declaration
[JsonProperty(PropertyName = "databaseApiStatus")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatusEnum? DatabaseApiStatus { get; set; }
Property Value
Type Description
DatabaseToolsDatabaseApiGatewayConfigGlobal.DatabaseApiStatusEnum?

ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.

DocumentRoot

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

The location of the static resources to be served under the / root server path.

HttpPort

Declaration
[JsonProperty(PropertyName = "httpPort")]
public int? HttpPort { get; set; }
Property Value
Type Description
int?

Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024\u201365535) is recommended.

HttpsPort

Declaration
[JsonProperty(PropertyName = "httpsPort")]
public int? HttpsPort { get; set; }
Property Value
Type Description
int?

Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024\u201365535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.

Key

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

A string that uniquely identifies a Database Tools database API gateway config global settings resource.
Remarks

Required

MetadataSource

Declaration
[JsonProperty(PropertyName = "metadataSource")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSourceEnum? MetadataSource { get; set; }
Property Value
Type Description
DatabaseToolsDatabaseApiGatewayConfigGlobal.MetadataSourceEnum?

The RESTful service definition location.

PoolRoute

Declaration
[JsonProperty(PropertyName = "poolRoute")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRouteEnum? PoolRoute { get; set; }
Property Value
Type Description
DatabaseToolsDatabaseApiGatewayConfigGlobal.PoolRouteEnum?

How the target pool route value is determined for a HTTP request.

PoolRoutingHeader

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

The request header name providing the pool route value.

TimeCreated

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

The time the resource was created. An RFC3339 formatted datetime string.
Remarks

Required

TimeUpdated

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

The time the resource was updated. An RFC3339 formatted datetime string.
Remarks

Required