com.oracle.bmc.core.requests

Class ListCrossConnectsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest

com.oracle.bmc.core.requests.ListCrossConnectsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class ListCrossConnectsRequest
extends BmcRequest

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ListCrossConnectsRequest.Builder	builder()
String	getCompartmentId() The OCID of the compartment.
String	getCrossConnectGroupId() The OCID of the cross-connect group.
String	getDisplayName() A filter to return only resources that match the given display name exactly.
CrossConnect.LifecycleState	getLifecycleState() A filter to return only resources that match the specified lifecycle state.
Integer	getLimit() For list pagination.
String	getPage() For list pagination.
ListCrossConnectsRequest.SortBy	getSortBy() The field to sort by.
ListCrossConnectsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListCrossConnectsRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment.

getCrossConnectGroupId

public String getCrossConnectGroupId()

The OCID of the cross-connect group.

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.

Example: 50

getPage

public String getPage()

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.

getDisplayName

public String getDisplayName()

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

getSortBy

public ListCrossConnectsRequest.SortBy getSortBy()

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.

getSortOrder

public ListCrossConnectsRequest.SortOrder getSortOrder()

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

getLifecycleState

public CrossConnect.LifecycleState getLifecycleState()

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