Class ListComputeHostsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.core.requests.ListComputeHostsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListComputeHostsRequest,Void>
- Enclosing class:
- ListComputeHostsRequest
public static class ListComputeHostsRequest.Builder extends Object implements BmcRequest.Builder<ListComputeHostsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListComputeHostsRequest.Builder
availabilityDomain(String availabilityDomain)
The name of the availability domain.ListComputeHostsRequest
build()
Build the instance of ListComputeHostsRequest as configured by this builderListComputeHostsRequest
buildWithoutInvocationCallback()
Build the instance of ListComputeHostsRequest as configured by this builderListComputeHostsRequest.Builder
compartmentId(String compartmentId)
The OCID of the compartment.ListComputeHostsRequest.Builder
computeHostGroupId(String computeHostGroupId)
The OCID of the compute host group.ListComputeHostsRequest.Builder
computeHostHealth(String computeHostHealth)
A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.ListComputeHostsRequest.Builder
computeHostLifecycleState(String computeHostLifecycleState)
A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.ListComputeHostsRequest.Builder
copy(ListComputeHostsRequest o)
Copy method to populate the builder with values from the given instance.ListComputeHostsRequest.Builder
displayName(String displayName)
A filter to return only resources that match the given display name exactly.ListComputeHostsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListComputeHostsRequest.Builder
limit(Integer limit)
For list pagination.ListComputeHostsRequest.Builder
networkResourceId(String networkResourceId)
The OCID of the compute host network resoruce.ListComputeHostsRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListComputeHostsRequest.Builder
page(String page)
For list pagination.ListComputeHostsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListComputeHostsRequest.Builder
sortBy(ListComputeHostsRequest.SortBy sortBy)
The field to sort by.ListComputeHostsRequest.Builder
sortOrder(ListComputeHostsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$
-
-
-
-
Method Detail
-
compartmentId
public ListComputeHostsRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListComputeHostsRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.If you need to contact Oracle about a particular request, please provide the request ID.
- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
availabilityDomain
public ListComputeHostsRequest.Builder availabilityDomain(String availabilityDomain)
The name of the availability domain.Example: Uocm:PHX-AD-1
- Parameters:
availabilityDomain
- the value to set- Returns:
- this builder instance
-
displayName
public ListComputeHostsRequest.Builder displayName(String displayName)
A filter to return only resources that match the given display name exactly.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
networkResourceId
public ListComputeHostsRequest.Builder networkResourceId(String networkResourceId)
The OCID of the compute host network resoruce.- Customer-unique HPC island ID - Customer-unique network block ID - Customer-unique local block ID
- Parameters:
networkResourceId
- the value to set- Returns:
- this builder instance
-
limit
public ListComputeHostsRequest.Builder limit(Integer limit)
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
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListComputeHostsRequest.Builder page(String page)
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.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
sortBy
public ListComputeHostsRequest.Builder sortBy(ListComputeHostsRequest.SortBy sortBy)
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.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListComputeHostsRequest.Builder sortOrder(ListComputeHostsRequest.SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).The DISPLAYNAME sort order is case sensitive.
- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
computeHostLifecycleState
public ListComputeHostsRequest.Builder computeHostLifecycleState(String computeHostLifecycleState)
A filter to return only ComputeHostSummary resources that match the given Compute Host lifecycle State OCID exactly.- Parameters:
computeHostLifecycleState
- the value to set- Returns:
- this builder instance
-
computeHostHealth
public ListComputeHostsRequest.Builder computeHostHealth(String computeHostHealth)
A filter to return only ComputeHostSummary resources that match the given Compute Host health State OCID exactly.- Parameters:
computeHostHealth
- the value to set- Returns:
- this builder instance
-
computeHostGroupId
public ListComputeHostsRequest.Builder computeHostGroupId(String computeHostGroupId)
The OCID of the compute host group.- Parameters:
computeHostGroupId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListComputeHostsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.- Parameters:
invocationCallback
- the invocation callback to be set for the request- Returns:
- this builder instance
-
retryConfiguration
public ListComputeHostsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.- Parameters:
retryConfiguration
- the retry configuration to be used for the request- Returns:
- this builder instance
-
copy
public ListComputeHostsRequest.Builder copy(ListComputeHostsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListComputeHostsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListComputeHostsRequest build()
Build the instance of ListComputeHostsRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuildWithoutInvocationCallback()
does not.This is the preferred method to build an instance.
- Specified by:
build
in interfaceBmcRequest.Builder<ListComputeHostsRequest,Void>
- Returns:
- instance of ListComputeHostsRequest
-
buildWithoutInvocationCallback
public ListComputeHostsRequest buildWithoutInvocationCallback()
Build the instance of ListComputeHostsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)
into account, while the methodbuild()
does- Returns:
- instance of ListComputeHostsRequest
-
-