Class ListByolsRequest

Inheritance

object

ListByolsRequest

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

Assembly: OCI.DotNetSDK.Ocvp.dll

Syntax

public class ListByolsRequest : IOciRequest

Examples

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

Properties

AvailableUnitsGreaterThanOrEqualTo

Declaration

[HttpConverter(TargetEnum.Query, "availableUnitsGreaterThanOrEqualTo")]
public float? AvailableUnitsGreaterThanOrEqualTo { get; set; }

Property Value

Type	Description
float?	A filter to return only resources whose availableUnits greater than or equal to the given value.

ByolId

Declaration

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

Property Value

Type	Description
string	The OCID of the BYOL.

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.

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 given display name exactly.

LifecycleState

Declaration

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

Property Value

Type	Description
Byol.LifecycleStateEnum?	A filter to return only resources whose lifecycle state matches the given value.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SoftwareType

Declaration

[HttpConverter(TargetEnum.Query, "softwareType")]
public Byol.SoftwareTypeEnum? SoftwareType { get; set; }

Property Value

Type	Description
Byol.SoftwareTypeEnum?	A filter to return only resources whose softwareType matches the given value.

SortBy

Declaration

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

Property Value

Type

Description

ListByolsRequest.SortByEnum?

The field to sort by. You can provide one sort order (sortOrder). Default order for timeTermStart is descending. Default order for timeCreated is descending. Default order for displayName is ascending. The displayName sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrders?	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Implements

IOciRequest