Package com.oracle.bmc.iot.requests

Class ListIotDomainsRequest

java.lang.Object

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

com.oracle.bmc.iot.requests.ListIotDomainsRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListIotDomainsRequest()

Method Summary

Modifier and Type	Method	Description
static ListIotDomainsRequest.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	getCompartmentId()	The OCID of the compartment in which to list resources.
String	getDisplayName()	Filter resources whose display name matches the specified value.
String	getId()	Filter resources by OCID.
String	getIotDomainGroupId()	Filter resources that match the specified OCID of the IoT domain group.
IotDomain.LifecycleState	getLifecycleState()	Filter resources whose lifecycleState matches the specified value.
Integer	getLimit()	For list pagination.
String	getOpcRequestId()	Unique Oracle-assigned identifier for the request.
String	getPage()	For list pagination: The value of the opc-next-page response header from the previous “List” call.
ListIotDomainsRequest.SortBy	getSortBy()	The field to sort by.
ListIotDomainsRequest.SortOrder	getSortOrder()	Specifies sort order to use, either ASC (ascending) or DESC (descending).
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListIotDomainsRequest.Builder	toBuilder()	Return an instance of ListIotDomainsRequest.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

ListIotDomainsRequest

public ListIotDomainsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment in which to list resources.

getId

public String getId()

Filter resources by OCID.

Must be a valid OCID of the resource type.

getIotDomainGroupId

public String getIotDomainGroupId()

Filter resources that match the specified OCID of the IoT domain group.

getDisplayName

public String getDisplayName()

Filter resources whose display name matches the specified value.

getLifecycleState

public IotDomain.LifecycleState getLifecycleState()

Filter resources whose lifecycleState matches the specified value.

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 on how pagination works, see List Pagination.

getSortOrder

public ListIotDomainsRequest.SortOrder getSortOrder()

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

getSortBy

public ListIotDomainsRequest.SortBy getSortBy()

The field to sort by.

Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request.

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

toBuilder

public ListIotDomainsRequest.Builder toBuilder()

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

Returns:

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

builder

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