Class Sdk

Information about the SDK.

Inheritance

object

Sdk

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 Sdk

Properties

ApiId

Declaration

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

Property Value

Type	Description
string	The OCID of API resource

Remarks

Required

ArtifactUrl

Declaration

[JsonProperty(PropertyName = "artifactUrl")]
public string ArtifactUrl { get; set; }

Property Value

Type	Description
string	File location for generated SDK.

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment in which the resource is created.

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

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

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

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 Sdk.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Sdk.LifecycleStateEnum?	The current state of the SDK. The SDK will be in CREATING state if the SDK creation is in progress. The SDK will be in ACTIVE state if create is successful. The SDK will be in FAILED state if the create, or delete fails. The SDK will be in DELETING state if the deletion in in progress. The SDK will be in DELETED state if the delete is successful.

Type

Description

Sdk.LifecycleStateEnum?

The current state of the SDK.

The SDK will be in CREATING state if the SDK creation is in progress.
The SDK will be in ACTIVE state if create is successful.
The SDK will be in FAILED state if the create, or delete fails.
The SDK will be in DELETING state if the deletion in in progress.
The SDK will be in DELETED state if the delete is successful.

Parameters

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Additional optional configurations passed. The applicable config keys are listed under "parameters" when "/sdkLanguageTypes" is called. Example: {"configName": "configValue"}

TargetLanguage

Declaration

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

Property Value

Type	Description
string	The string representing the target programming language for generating the SDK.

Remarks

Required

TimeArtifactUrlExpiresAt

Declaration

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

Property Value

Type	Description
DateTime?	Expiry of artifact url.

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.