Class ListOccAvailabilityCatalogsRequest

Inheritance

object

ListOccAvailabilityCatalogsRequest

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.CapacitymanagementService.Requests

Assembly: OCI.DotNetSDK.Capacitymanagement.dll

Syntax

public class ListOccAvailabilityCatalogsRequest : IOciRequest

Examples

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

Properties

CatalogState

Declaration

[HttpConverter(TargetEnum.Query, "catalogState")]
public OccAvailabilityCatalog.CatalogStateEnum? CatalogState { get; set; }

Property Value

Type	Description
OccAvailabilityCatalog.CatalogStateEnum?	Filter the list of availability catalogs based on the catalog state.

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only the resources that match the entire display name. The match is not case sensitive.

Id

Declaration

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

Property Value

Type	Description
string	The OCID of the availability catalog to filter the list of availability catalogs.

Limit

Declaration

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

Property Value

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

Namespace

Declaration

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

Property Value

Type	Description
Namespace?	The namespace by which we would filter the list.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

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 opc-next-page header field of a previous response.

SortBy

Declaration

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

Property Value

Type	Description
ListOccAvailabilityCatalogsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending.

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