Class AdminProduct

The properties of a product

Inheritance
object
AdminProduct
Inherited Members
Namespace: Oci.OciproductcatalogService.Models
Assembly: OCI.DotNetSDK.Ociproductcatalog.dll
Syntax
public class AdminProduct

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 (remember that the tenancy is simply the root compartment).
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"}}

Description

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

description to the product
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

OCID of the product
Remarks

Required

IsExcluded

Declaration
[JsonProperty(PropertyName = "isExcluded")]
public bool? IsExcluded { get; set; }
Property Value
Type Description
bool?

Whether the product is currently excluded from SKU processing flows. Nullable when the exclusion flag has not been explicitly set.

LifecycleDetails

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

The displayed status of a product. lifecycleState to lifecycleDetails mapping: INACTIVE -> "Not yet launched" ACTIVE -> "Launched" NEEDS_ATTENTION -> "Pricing not set"

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AdminProduct.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
AdminProduct.LifecycleStateEnum?

The status of a product following the OCI standard. ACTIVE: resources of this product can be used by the end customer. INACTIVE: resources of this product can't be used by the end customer. Product needs manual approval. NEEDS_ATTENTION: operator action is needed.

Limits

Declaration
[Required(ErrorMessage = "Limits is required.")]
[JsonProperty(PropertyName = "limits")]
public List<Limit> Limits { get; set; }
Property Value
Type Description
List<Limit>

List of limits that this product is associated with.
Remarks

Required

MeterwithSKUs

Declaration
[Required(ErrorMessage = "MeterwithSKUs is required.")]
[JsonProperty(PropertyName = "meterwithSKUs")]
public List<MeterWithSKU> MeterwithSKUs { get; set; }
Property Value
Type Description
List<MeterWithSKU>

List of meters associated with this product, including SKU information
Remarks

Required

Name

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

Name of the product, defined by service teams. Unique within one service
Remarks

Required

ServiceName

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

Name of the metering service this product relates to.
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>>

System tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

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

Date and time when the product was created Example: 2022-01-25T21:10:29.600Z

TimeExcluded

Declaration
[JsonProperty(PropertyName = "timeExcluded")]
public DateTime? TimeExcluded { get; set; }
Property Value
Type Description
DateTime?

Date and time when the product was marked as excluded. Nullable Example: 2022-01-25T21:10:29.600Z

TimeLaunched

Declaration
[JsonProperty(PropertyName = "timeLaunched")]
public DateTime? TimeLaunched { get; set; }
Property Value
Type Description
DateTime?

Date and time when the product was launched. Nullable Example: 2022-01-25T21:10:29.600Z

TimeReady

Declaration
[JsonProperty(PropertyName = "timeReady")]
public DateTime? TimeReady { get; set; }
Property Value
Type Description
DateTime?

Date and time when the product was set to ready. Nullable Example: 2022-01-25T21:10:29.600Z

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

Date and time when the product was updated. Nullable Example: 2022-01-25T21:10:29.600Z