Package com.oracle.bmc.core.requests

Class ListComputeHostsRequest

java.lang.Object

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

com.oracle.bmc.core.requests.ListComputeHostsRequest

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListComputeHostsRequest.Builder
static class	ListComputeHostsRequest.SortBy	The field to sort by.
static class	ListComputeHostsRequest.SortOrder	The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor	Description
ListComputeHostsRequest()

Method Summary

Modifier and Type	Method	Description
static ListComputeHostsRequest.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’.
String	getAvailabilityDomain()	The name of the availability domain.
String	getCompartmentId()	The OCID of the compartment.
String	getComputeHostHealth()	A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.
String	getComputeHostLifecycleState()	A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.
String	getDisplayName()	A filter to return only resources that match the given display name exactly.
Integer	getLimit()	For list pagination.
String	getNetworkResourceId()	The OCID of the compute host network resoruce.
String	getOpcRequestId()	Unique identifier for the request.
String	getPage()	For list pagination.
ListComputeHostsRequest.SortBy	getSortBy()	The field to sort by.
ListComputeHostsRequest.SortOrder	getSortOrder()	The sort order to use, either ascending (ASC) or descending (DESC).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListComputeHostsRequest.Builder	toBuilder()	Return an instance of ListComputeHostsRequest.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

ListComputeHostsRequest

public ListComputeHostsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getOpcRequestId

public String getOpcRequestId()

Unique identifier for the request.

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

getAvailabilityDomain

public String getAvailabilityDomain()

The name of the availability domain.

Example: Uocm:PHX-AD-1

getDisplayName

public String getDisplayName()

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

getNetworkResourceId

public String getNetworkResourceId()

The OCID of the compute host network resoruce.

• Customer-unique HPC island ID - Customer-unique network block ID - Customer-unique local block ID

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.

getSortBy

public ListComputeHostsRequest.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 ListComputeHostsRequest.SortOrder getSortOrder()

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

The DISPLAYNAME sort order is case sensitive.

getComputeHostLifecycleState

public String getComputeHostLifecycleState()

A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.

getComputeHostHealth

public String getComputeHostHealth()

A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.

toBuilder

public ListComputeHostsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListComputeHostsRequest.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>