Class ListVmInstancesRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.datacc.requests.ListVmInstancesRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20251101") public class ListVmInstancesRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/datacc/ListVmInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListVmInstancesRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListVmInstancesRequest.Builderstatic classListVmInstancesRequest.SortByThe field by which you want to sort.
-
Constructor Summary
Constructors Constructor Description ListVmInstancesRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListVmInstancesRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetBaseServerId()The OCID of the Database Infrastructure Server Id.StringgetCompartmentId()The OCID of the compartment.StringgetDisplayName()A filter to return resources that match the entire display name given.StringgetInfrastructureId()The OCID of the Database Infrastructure.List<VmInstanceLifecycleState>getLifecycleState()A filter to return resources that match the specified lifecycle state.IntegergetLimit()The maximum number of items to return in a page.StringgetOpcRequestId()The client request identifier.StringgetPage()The page token representing the page at which you want to start retrieving results.ListVmInstancesRequest.SortBygetSortBy()The field by which you want to sort.SortOrdergetSortOrder()The sort order that you want to use, which is either ASC or DESC.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListVmInstancesRequest.BuildertoBuilder()Return an instance ofListVmInstancesRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
Method Detail
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment.For list operations, you may provide the tenant [OCID] in this field. When a tenant OCID is provided, it will be validated against the caller’s tenant and then treated as tenant scope (compartmentId filtering is not applied).
-
getDisplayName
public String getDisplayName()
A filter to return resources that match the entire display name given.The match is case sensitive.
-
getLifecycleState
public List<VmInstanceLifecycleState> getLifecycleState()
A filter to return resources that match the specified lifecycle state.
-
getLimit
public Integer getLimit()
The maximum number of items to return in a page.
-
getPage
public String getPage()
The page token representing the page at which you want to start retrieving results.This token is usually retrieved from a previous list call.
-
getSortOrder
public SortOrder getSortOrder()
The sort order that you want to use, which is either ASC or DESC.
-
getSortBy
public ListVmInstancesRequest.SortBy getSortBy()
The field by which you want to sort.You can provide only one type of sort order. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified, then timeCreated is the default. When listing software images within the same version, using sortBy=buildIdentifier is recommended. buildIdentifier is a monotonically increasing, time-ordered string marker (yyyy-mm-dd-hh:mm:ss) stored with the image.
-
getOpcRequestId
public String getOpcRequestId()
The client request identifier.
-
toBuilder
public ListVmInstancesRequest.Builder toBuilder()
Return an instance ofListVmInstancesRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListVmInstancesRequest.Builderthat allows you to modify request properties.
-
builder
public static ListVmInstancesRequest.Builder builder()
Return a new builder for this request object.- Returns:
- builder for the request object
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-