Class ListInventoryResourcesRequest

Inheritance

object

ListInventoryResourcesRequest

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 ListInventoryResourcesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID.

Remarks

Required

DefinedTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "definedTagEquals", CollectionFormatType.Multi)]
public List<string> DefinedTagEquals { get; set; }

Property Value

Type	Description
List<string>	A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}={value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". Example: Identification.Development=Yes

Type

Description

List<string>

A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format "{namespace}.{tagName}={value}". All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as "OR". Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as "AND". Example: Identification.Development=Yes

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.

FreeformTagEquals

Declaration

[HttpConverter(TargetEnum.Query, "freeformTagEquals", CollectionFormatType.Multi)]
public List<string> FreeformTagEquals { get; set; }

Property Value

Type	Description
List<string>	A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is "{tagName}.{value}". All inputs are case-insensitive. Multiple values for the same tag name are interpreted as "OR". Values for different tag names are interpreted as "AND".

InventoryProperties

Declaration

[HttpConverter(TargetEnum.Query, "inventoryProperties", CollectionFormatType.Multi)]
public List<string> InventoryProperties { get; set; }

Property Value

Type	Description
List<string>	A list of inventory properties filters to apply. The key for each inventory property and value for each resource type is "{resourceType}.{inventoryProperty}={value}". Example: Instance.displayName=TEST_INSTANCE

LifecycleState

Declaration

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

Property Value

Type	Description
string	A filter to return only resources their lifecycleState matches the given lifecycleState.

Limit

Declaration

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

Property Value

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

MatchingCriteria

Declaration

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

Property Value

Type	Description
string	Fetch resources matching ANY or ALL criteria passed as params in "tags" and "inventoryProperties". Example: matchingCriteria=ANY

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.

ResourceCompartmentId

Declaration

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

Property Value

Type	Description
string	A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID.

Remarks

Required

ResourceRegion

Declaration

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

Property Value

Type	Description
string	Resource Region

SortBy

Declaration

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

Property Value

Type	Description
ListInventoryResourcesRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order 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