Class ListCatalogItemsRequest

Inheritance

object

ListCatalogItemsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.FleetappsmanagementService.Requests

Assembly: OCI.DotNetSDK.Fleetappsmanagement.dll

Syntax

public class ListCatalogItemsRequest : IOciRequest

Examples

Click here to see an example of how to use ListCatalogItems request.

Properties

CatalogListingId

Declaration

[HttpConverter(TargetEnum.Query, "catalogListingId")]
public string CatalogListingId { get; set; }

Property Value

Type	Description
string	catalogListingId of the package. This is an integer whose min and max length are specified.

CatalogListingVersionCriteria

Declaration

[HttpConverter(TargetEnum.Query, "catalogListingVersionCriteria")]
public CatalogListingVersionCriteriaEnum? CatalogListingVersionCriteria { get; set; }

Property Value

Type	Description
CatalogListingVersionCriteriaEnum?	Parameter to list all catalog items only with latest version or list all catalog items with all versions.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

ConfigSourceType

Declaration

[HttpConverter(TargetEnum.Query, "configSourceType")]
public string ConfigSourceType { get; set; }

Property Value

Type	Description
string	The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public CatalogItem.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
CatalogItem.LifecycleStateEnum?	A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

ShouldListPublicItems

Declaration

[HttpConverter(TargetEnum.Query, "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.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public CatalogItemSortBy? SortBy { get; set; }

Property Value

Type	Description
CatalogItemSortBy?	The field to sort by. You can provide only one sort by. Default value for timeCreated is descending. Default order for displayName is ascending

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	The sort order to use, either 'ASC' or 'DESC'.

Implements

IOciRequest