com.oracle.bmc.identity.requests

Class ListDomainsRequest

java.lang.Object

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

com.oracle.bmc.identity.requests.ListDomainsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
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.
static class	ListDomainsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

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 OCID of the compartment (remember that the tenancy is simply the root compartment).
String	getDisplayName() The mutable display name of the identity domain.
String	getHomeRegionUrl() The region-specific identity domain URL.
Boolean	getIsHiddenOnLogin() Indicates whether or not the identity domain is visible at the sign-in screen.
String	getLicenseType() The license type of the identity domain.
Domain.LifecycleState	getLifecycleState() A filter to only return resources that match the given lifecycle state.
Integer	getLimit() The maximum number of items to return in a paginated “List” call.
String	getName() A filter to only return resources that match the given name exactly.
String	getOpcRequestId() Unique Oracle-assigned identifier for the request.
String	getPage() The value of the opc-next-page response header from the previous “List” call.
ListDomainsRequest.SortBy	getSortBy() The field to sort by.
ListDomainsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getType() The identity domain type.
String	getUrl() The region-agnostic identity domain URL.
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 OCID of the compartment (remember that the tenancy is simply the root compartment).

getDisplayName

public String getDisplayName()

The mutable display name of the identity domain.

getUrl

public String getUrl()

The region-agnostic identity domain URL.

getHomeRegionUrl

public String getHomeRegionUrl()

The region-specific identity domain URL.

getType

public String getType()

The identity domain type.

getLicenseType

public String getLicenseType()

The license type of the identity domain.

getIsHiddenOnLogin

public Boolean getIsHiddenOnLogin()

Indicates whether or not the identity domain is visible at the sign-in screen.

getPage

public String getPage()

The value of the opc-next-page response header from the previous “List” call.

getLimit

public Integer getLimit()

The maximum number of items to return in a paginated “List” call.

getName

public String getName()

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

getSortBy

public ListDomainsRequest.SortBy getSortBy()

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME 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 ListDomainsRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

getOpcRequestId

public String getOpcRequestId()

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

getLifecycleState

public Domain.LifecycleState getLifecycleState()

A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

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>