Class DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary
Description of a database API gateway config setting to be provided as an advanced property.
Inherited Members
Namespace: Oci.DatabasetoolsruntimeService.Models
Assembly: OCI.DotNetSDK.Databasetoolsruntime.dll
Syntax
public class DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary
Properties
CategoryDisplayName
Declaration
[JsonProperty(PropertyName = "categoryDisplayName")]
public string CategoryDisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly name of a category. |
CategoryKey
Declaration
[JsonProperty(PropertyName = "categoryKey")]
public string CategoryKey { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The category of the Database Tools database API gateway config global setting. |
ConfigTypes
Declaration
[JsonProperty(PropertyName = "configTypes", ItemConverterType = typeof(ResponseEnumConverter))]
public List<DatabaseApiGatewayConfigAdvancedPropertyConfigType> ConfigTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| List<DatabaseApiGatewayConfigAdvancedPropertyConfigType> | The config types that support this advanced property. The supported types are GLOBAL and POOL. |
DataType
Declaration
[Required(ErrorMessage = "DataType is required.")]
[JsonProperty(PropertyName = "dataType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataTypeEnum? DataType { get; set; }
Property Value
| Type | Description |
|---|---|
| DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DataTypeEnum? | The data type of a database API gateway config setting. |
Remarks
Required
DatabaseToolsConnectionTypes
Declaration
[JsonProperty(PropertyName = "databaseToolsConnectionTypes", ItemConverterType = typeof(ResponseEnumConverter))]
public List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypesEnum> DatabaseToolsConnectionTypes { get; set; }
Property Value
| Type | Description |
|---|---|
| List<DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary.DatabaseToolsConnectionTypesEnum> | The type of database (as determined by a type of Database Tools connection) to which this setting applies. The advancedProperty applies to all types of Database Tools connection when null. This is only applicable when configTypes includes POOL. |
DefaultValue
Declaration
[JsonProperty(PropertyName = "defaultValue")]
public string DefaultValue { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The default value (if applicable) of a database API gateway config setting. |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly description of a database API gateway config setting. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly name. |
Remarks
Required
DocumentationUrl
Declaration
[JsonProperty(PropertyName = "documentationUrl")]
public string DocumentationUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Uniform resource locator (URL) of documentation related to this setting. |
HintText
Declaration
[JsonProperty(PropertyName = "hintText")]
public string HintText { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Hint text for a database API gateway config setting. |
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
ListOfValues
Declaration
[JsonProperty(PropertyName = "listOfValues")]
public List<string> ListOfValues { get; set; }
Property Value
| Type | Description |
|---|---|
| List<string> | A list of string values (if applicable) supported by this database API gateway config setting. |
MaxValue
Declaration
[JsonProperty(PropertyName = "maxValue")]
public int? MaxValue { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | A maximum numeric value (if applicable) of a database API gateway config setting. |
MinValue
Declaration
[JsonProperty(PropertyName = "minValue")]
public int? MinValue { get; set; }
Property Value
| Type | Description |
|---|---|
| int? | A minimum numeric value (if applicable) of a database API gateway config setting. |