Show / Hide Table of Contents

Class DatabaseToolsDatabaseApiGatewayConfig

Manage configuration related to database API gateway config resources.

Inheritance
object
DatabaseToolsDatabaseApiGatewayConfig
DatabaseToolsDatabaseApiGatewayConfigDefault
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.DatabasetoolsService.Models
Assembly: OCI.DotNetSDK.Databasetools.dll
Syntax
[JsonConverter(typeof(DatabaseToolsDatabaseApiGatewayConfigModelConverter))]
public class DatabaseToolsDatabaseApiGatewayConfig

Properties

CompartmentId

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

The OCID of the compartment containing the Database Tools database API gateway config.

Remarks

Required

DefinedTags

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

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

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

FreeformTags

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

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

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

The OCID of the Database Tools database API gateway config.

Remarks

Required

LifecycleDetails

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

A message describing the current state in more detail. For example, this message can be used to provide actionable information for a resource in the Failed state.

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseToolsDatabaseApiGatewayConfigLifecycleState? LifecycleState { get; set; }
Property Value
Type Description
DatabaseToolsDatabaseApiGatewayConfigLifecycleState?

The current state of the Database Tools database API gateway config.

Remarks

Required

Locks

Declaration
[JsonProperty(PropertyName = "locks")]
public List<ResourceLock> Locks { get; set; }
Property Value
Type Description
List<ResourceLock>

Locks associated with this resource.

MetadataSource

Declaration
[Required(ErrorMessage = "MetadataSource is required.")]
[JsonProperty(PropertyName = "metadataSource")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DatabaseApiGatewayConfigMetadataSource? MetadataSource { get; set; }
Property Value
Type Description
DatabaseApiGatewayConfigMetadataSource?

The RESTful service definition location.

Remarks

Required

SystemTags

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

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

The time the Database Tools database API gateway config 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 Database Tools database API gateway config was updated. An RFC3339 formatted datetime string.

Remarks

Required

In this article
Back to top