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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/tenantmanagercontrolplane/ListDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDomainsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListDomainsRequest.Builderstatic classListDomainsRequest.SortByThe field to sort by.
-
Constructor Summary
Constructors Constructor Description ListDomainsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListDomainsRequest.Builderbuilder()Return a new builder for this request object.booleanequals(Object o)Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.StringgetCompartmentId()The ID of the compartment in which to list resources.StringgetDomainId()The domain OCID.LifecycleStategetLifecycleState()The lifecycle state of the resource.IntegergetLimit()The maximum number of items to return.StringgetName()A filter to return only resources that exactly match the name given.StringgetOpcRequestId()The client request ID for tracing.StringgetPage()The page token representing the page at which to start retrieving results.ListDomainsRequest.SortBygetSortBy()The field to sort by.SortOrdergetSortOrder()The sort order to use, whether ‘asc’ or ‘desc’.Domain.StatusgetStatus()The status of the domain.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListDomainsRequest.BuildertoBuilder()Return an instance ofListDomainsRequest.Builderthat allows you to modify request properties.StringtoString()-
Methods inherited from class com.oracle.bmc.requests.BmcRequest
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue
-
-
-
-
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 ofListDomainsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListDomainsRequest.Builderthat 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
-
equals
public boolean equals(Object o)
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.- Overrides:
equalsin classBmcRequest<Void>
-
hashCode
public int hashCode()
Description copied from class:BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.- Overrides:
hashCodein classBmcRequest<Void>
-
-