Class GatewaySummary

A summary of the gateway.

Inheritance

object

GatewaySummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApigatewayService.Models

Assembly: OCI.DotNetSDK.Apigateway.dll

Syntax

public class GatewaySummary

Properties

CertificateId

Declaration

[JsonProperty(PropertyName = "certificateId")]
public string CertificateId { get; set; }

Property Value

Type	Description
string	The OCID of the resource.

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 in which the resource is created.

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

[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. Example: My new resource

EndpointType

Declaration

[Required(ErrorMessage = "EndpointType is required.")]
[JsonProperty(PropertyName = "endpointType")]
[JsonConverter(typeof(StringEnumConverter))]
public Gateway.EndpointTypeEnum? EndpointType { get; set; }

Property Value

Type	Description
Gateway.EndpointTypeEnum?	Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE

Remarks

Required

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Hostname

Declaration

[JsonProperty(PropertyName = "hostname")]
public string Hostname { get; set; }

Property Value

Type	Description
string	The hostname for the APIs deployed on the gateway.

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the resource.

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, can be used to provide actionable information for a resource in a Failed state.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public Gateway.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Gateway.LifecycleStateEnum?	The current state of the gateway.

NetworkSecurityGroupIds

Declaration

[JsonProperty(PropertyName = "networkSecurityGroupIds")]
public List<string> NetworkSecurityGroupIds { get; set; }

Property Value

Type	Description
List<string>	An array of Network Security Groups OCIDs associated with this API Gateway.

SubnetId

Declaration

[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the subnet in which related resources are created.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time this resource was last updated. An RFC3339 formatted datetime string.