Package com.oracle.bmc.ocvp.requests

Class ListByolAllocationsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.ocvp.requests.ListByolAllocationsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public class ListByolAllocationsRequest
extends BmcRequest<Void>

Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.81.1/ocvp/ListByolAllocationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListByolAllocationsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListByolAllocationsRequest.Builder
static class	ListByolAllocationsRequest.SortBy	The field to sort by.

Constructor Summary

Constructors

Constructor	Description
ListByolAllocationsRequest()

Method Summary

Modifier and Type	Method	Description
static ListByolAllocationsRequest.Builder	builder()	Return a new builder for this request object.
boolean	equals(Object o)	Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
Float	getAvailableUnitsGreaterThanOrEqualTo()	A filter to return only resources whose availableUnits greater than or equal to the given value.
String	getByolAllocationId()	The OCID of the BYOL Allocation.
String	getByolId()	The OCID of the BYOL.
String	getCompartmentId()	The OCID of the compartment.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
ByolAllocation.LifecycleState	getLifecycleState()	A filter to return only resources whose lifecycle state matches the given value.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	Unique identifier for the request.
String	getPage()	For list pagination.
ByolAllocation.SoftwareType	getSoftwareType()	A filter to return only resources whose softwareType matches the given value.
ListByolAllocationsRequest.SortBy	getSortBy()	The field to sort by.
SortOrders	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListByolAllocationsRequest.Builder	toBuilder()	Return an instance of ListByolAllocationsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListByolAllocationsRequest

public ListByolAllocationsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getByolAllocationId

public String getByolAllocationId()

The OCID of the BYOL Allocation.

getLifecycleState

public ByolAllocation.LifecycleState getLifecycleState()

A filter to return only resources whose lifecycle state matches the given value.

getSoftwareType

public ByolAllocation.SoftwareType getSoftwareType()

A filter to return only resources whose softwareType matches the given value.

getAvailableUnitsGreaterThanOrEqualTo

public Float getAvailableUnitsGreaterThanOrEqualTo()

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

getByolId

public String getByolId()

The OCID of the BYOL.

getDisplayName

public String getDisplayName()

A filter to return only resources that match the given display name exactly.

getLimit

public Integer getLimit()

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.

getPage

public String getPage()

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.

getSortOrder

public SortOrders getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

The DISPLAYNAME sort order is case sensitive.

getSortBy

public ListByolAllocationsRequest.SortBy getSortBy()

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.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

toBuilder

public ListByolAllocationsRequest.Builder toBuilder()

Return an instance of ListByolAllocationsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListByolAllocationsRequest.Builder that allows you to modify request properties.

builder

public static ListByolAllocationsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>