com.oracle.bmc.tenantmanagercontrolplane.requests

Class ListDomainsRequest

java.lang.Object

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

com.oracle.bmc.tenantmanagercontrolplane.requests.ListDomainsRequest

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

Example: Click here to see how to use ListDomainsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDomainsRequest.Builder
static class	ListDomainsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListDomainsRequest()

Method Summary

Modifier and Type	Method and Description
static ListDomainsRequest.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 ID of the compartment in which to list resources.
String	getDomainId() The domain OCID.
LifecycleState	getLifecycleState() The lifecycle state of the resource.
Integer	getLimit() The maximum number of items to return.
String	getName() A filter to return only resources that exactly match the name given.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListDomainsRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, whether ‘asc’ or ‘desc’.
Domain.Status	getStatus() The status of the domain.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListDomainsRequest.Builder	toBuilder() Return an instance of ListDomainsRequest.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

ListDomainsRequest

public ListDomainsRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getDomainId

public String getDomainId()

The domain OCID.

getLifecycleState

public LifecycleState getLifecycleState()

The lifecycle state of the resource.

getStatus

public Domain.Status getStatus()

The status of the domain.

getName

public String getName()

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getLimit

public Integer getLimit()

The maximum number of items to return.

getSortBy

public ListDomainsRequest.SortBy getSortBy()

The field to sort by. Only one sort order can be provided. * The default order for timeCreated is descending. * The default order for displayName is ascending. * If no value is specified, timeCreated is the default.

getSortOrder

public SortOrder getSortOrder()

The sort order to use, whether ‘asc’ or ‘desc’.

toBuilder

public ListDomainsRequest.Builder toBuilder()

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

Returns:

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

builder

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