Class ListAssetsRequest

Inheritance

object

ListAssetsRequest

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

Assembly: OCI.DotNetSDK.Cloudbridge.dll

Syntax

public class ListAssetsRequest : IOciRequest

Examples

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

Properties

AssetId

Declaration

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

Property Value

Type	Description
string	Unique asset identifier.

AssetType

Declaration

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

Property Value

Type	Description
AssetType?	The type of asset.

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

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.

ExternalAssetKey

Declaration

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

Property Value

Type	Description
string	External asset key.

InventoryId

Declaration

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

Property Value

Type	Description
string	Unique Inventory identifier.

LifecycleState

Declaration

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

Property Value

Type	Description
Asset.LifecycleStateEnum?	A filter to return only assets whose 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.

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.

SortBy

Declaration

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

Property Value

Type	Description
ListAssetsRequest.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 SortOrders? SortOrder { get; set; }

Property Value

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

SourceKey

Declaration

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

Property Value

Type	Description
string	Source key from where the assets originate.

Implements

IOciRequest