Class CatalogItem

A description of a CatalogItem resource.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Inheritance

object

CatalogItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FleetappsmanagementService.Models

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class CatalogItem

Properties

CatalogResultPayload

Declaration

[JsonProperty(PropertyName = "catalogResultPayload")]
public CatalogResultPayload CatalogResultPayload { get; set; }

Property Value

Type	Description
CatalogResultPayload

CatalogSourcePayload

Declaration

[JsonProperty(PropertyName = "catalogSourcePayload")]
public CatalogSourcePayload CatalogSourcePayload { get; set; }

Property Value

Type	Description
CatalogSourcePayload

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.

Remarks

Required

ConfigSourceType

Declaration

[Required(ErrorMessage = "ConfigSourceType is required.")]
[JsonProperty(PropertyName = "configSourceType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CatalogItem.ConfigSourceTypeEnum? ConfigSourceType { get; set; }

Property Value

Type	Description
CatalogItem.ConfigSourceTypeEnum?	Config source type Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, GIT_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

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

Description

Declaration

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

Property Value

Type	Description
string	Description about the catalog item.

Remarks

Required

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

Remarks

Required

LifecycleDetails

Declaration

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

Property Value

Type	Description
string	The details of lifecycle state CatalogItem.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CatalogItem.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
CatalogItem.LifecycleStateEnum?	The current state of the CatalogItem.

Remarks

Required

ListingId

Declaration

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

Property Value

Type	Description
string	The catalog listing Id.

Remarks

Required

ListingVersion

Declaration

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

Property Value

Type	Description
string	The catalog package version.

Remarks

Required

PackageType

Declaration

[Required(ErrorMessage = "PackageType is required.")]
[JsonProperty(PropertyName = "packageType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public CatalogItem.PackageTypeEnum? PackageType { get; set; }

Property Value

Type	Description
CatalogItem.PackageTypeEnum?	Config package type Eg: TF_PACKAGE, NON_TF_PACKAGE, CONFIG_FILE.

Remarks

Required

ShortDescription

Declaration

[JsonProperty(PropertyName = "shortDescription")]
public string ShortDescription { get; set; }

Property Value

Type	Description
string	Short description about the catalog item.

ShouldListPublicItems

Declaration

[JsonProperty(PropertyName = "shouldListPublicItems")]
public bool? ShouldListPublicItems { get; set; }

Property Value

Type	Description
bool?	The indicator to append Public Items from the root compartment to any query, when set to TRUE.

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

TimeBackfillLastChecked

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the CatalogItem was last checked by backfill job, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the CatalogItem was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

TimeLastChecked

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the CatalogItem was last checked, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeReleased

Declaration

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

Property Value

Type	Description
DateTime?	The date and time the CatalogItem was released, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the CatalogItem was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required

VersionDescription

Declaration

[JsonProperty(PropertyName = "versionDescription")]
public string VersionDescription { get; set; }

Property Value

Type	Description
string	Version description about the catalog item.