com.oracle.bmc.core.requests

Class ListDedicatedVmHostsRequest

java.lang.Object

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

com.oracle.bmc.core.requests.ListDedicatedVmHostsRequest

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

Example: Click here to see how to use ListDedicatedVmHostsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDedicatedVmHostsRequest.Builder
static class	ListDedicatedVmHostsRequest.LifecycleState A filter to only return resources that match the given lifecycle state.
static class	ListDedicatedVmHostsRequest.SortBy The field to sort by.
static class	ListDedicatedVmHostsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Method Summary

Modifier and Type	Method and Description
static ListDedicatedVmHostsRequest.Builder	builder()
String	getAvailabilityDomain() The name of the availability domain.
String	getCompartmentId() The OCID of the compartment.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
String	getInstanceShapeName() The name for the instance’s shape.
ListDedicatedVmHostsRequest.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() For list pagination.
String	getOpcRequestId() Unique identifier for the request.
String	getPage() For list pagination.
ListDedicatedVmHostsRequest.SortBy	getSortBy() The field to sort by.
ListDedicatedVmHostsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListDedicatedVmHostsRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: `Uocm:PHX-AD-1`

getLifecycleState

public ListDedicatedVmHostsRequest.LifecycleState getLifecycleState()

A filter to only return resources that match the given lifecycle state.

getDisplayName

public String getDisplayName()

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

getInstanceShapeName

public String getInstanceShapeName()

The name for the instance’s shape.

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.

Example: `50`

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.

getOpcRequestId

public String getOpcRequestId()

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

getSortBy

public ListDedicatedVmHostsRequest.SortBy getSortBy()

The field to sort by. You can provide one sort order (sortOrder). 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.

getSortOrder

public ListDedicatedVmHostsRequest.SortOrder getSortOrder()

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