Class Deployment

A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see API Gateway Concepts.

Inheritance

object

Deployment

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 Deployment

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 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

Endpoint

Declaration

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

Property Value

Type	Description
string	The endpoint to access this deployment on the gateway.

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"}

GatewayId

Declaration

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

Property Value

Type	Description
string	The OCID of the resource.

Remarks

Required

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(ResponseEnumConverter))]
public Deployment.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Deployment.LifecycleStateEnum?	The current state of the deployment.

PathPrefix

Declaration

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

Property Value

Type	Description
string	A path on which to deploy all routes contained in the API deployment specification. For more information, see Deploying an API on an API Gateway by Creating an API Deployment.

Remarks

Required

Specification

Declaration

[Required(ErrorMessage = "Specification is required.")]
[JsonProperty(PropertyName = "specification")]
public ApiSpecification Specification { get; set; }

Property Value

Type	Description
ApiSpecification

Remarks

Required

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.