Class ListNetworkAnchorsRequest
- java.lang.Object
-
- com.oracle.bmc.requests.BmcRequest<Void>
-
- com.oracle.bmc.multicloud.requests.ListNetworkAnchorsRequest
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20180828") public class ListNetworkAnchorsRequest extends BmcRequest<Void>Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/latest/multicloud/ListNetworkAnchorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListNetworkAnchorsRequest.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListNetworkAnchorsRequest.Builderstatic classListNetworkAnchorsRequest.SortByThe field to sort by.
-
Constructor Summary
Constructors Constructor Description ListNetworkAnchorsRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListNetworkAnchorsRequest.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 OCID of the Multicloud base compartment or sub-compartment in which to list resources.BooleangetCompartmentIdInSubtree()If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter.StringgetDisplayName()A filter to return only resources that match the given display name exactly.StringgetExternalLocation()The Cloud Service Provider region.StringgetId()The OCID of the NetworkAnchor.IntegergetLimit()For list pagination.NetworkAnchor.NetworkAnchorLifecycleStategetNetworkAnchorLifecycleState()A filter to return only resources that match the given lifecycle state.StringgetNetworkAnchorOciSubnetId()A filter to return only NetworkAnchor resources that match the given OCI subnet Id.StringgetNetworkAnchorOciVcnId()A filter to return only NetworkAnchor resources that match the given OCI Vcn Id.StringgetOpcRequestId()Unique Oracle-assigned identifier for the request.StringgetPage()For list pagination.BooleangetShouldFetchVcnName()Whether to fetch and include the vcn display name, which may introduce additional latency.ListNetworkAnchorsRequest.SortBygetSortBy()The field to sort by.SortOrdergetSortOrder()The sort order to use, either ascending (ASC) or descending (DESC).StringgetSubscriptionId()The OCID of the Multicloud subscription in which to list resources.SubscriptionTypegetSubscriptionServiceName()The subscription service name of the Cloud Service Provider.inthashCode()Uses getInvocationCallback and getRetryConfiguration to generate a hash.ListNetworkAnchorsRequest.BuildertoBuilder()Return an instance ofListNetworkAnchorsRequest.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 OCID of the Multicloud base compartment or sub-compartment in which to list resources.A Multicloud base compartment is an OCI compartment that maps to a subscription in a Cloud Service Provider (such as Azure, AWS, or Google Cloud).
-
getSubscriptionId
public String getSubscriptionId()
The OCID of the Multicloud subscription in which to list resources.
-
getSubscriptionServiceName
public SubscriptionType getSubscriptionServiceName()
The subscription service name of the Cloud Service Provider.
-
getNetworkAnchorLifecycleState
public NetworkAnchor.NetworkAnchorLifecycleState getNetworkAnchorLifecycleState()
A filter to return only resources that match the given lifecycle state.The state value is case-insensitive.
-
getDisplayName
public String getDisplayName()
A filter to return only resources that match the given display name exactly.
-
getExternalLocation
public String getExternalLocation()
The Cloud Service Provider region.
-
getNetworkAnchorOciSubnetId
public String getNetworkAnchorOciSubnetId()
A filter to return only NetworkAnchor resources that match the given OCI subnet Id.
-
getCompartmentIdInSubtree
public Boolean getCompartmentIdInSubtree()
If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter.
-
getNetworkAnchorOciVcnId
public String getNetworkAnchorOciVcnId()
A filter to return only NetworkAnchor resources that match the given OCI Vcn Id.
-
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 about how pagination works, see List Pagination.
-
getShouldFetchVcnName
public Boolean getShouldFetchVcnName()
Whether to fetch and include the vcn display name, which may introduce additional latency.
-
getSortOrder
public SortOrder getSortOrder()
The sort order to use, either ascending (ASC) or descending (DESC).
-
getSortBy
public ListNetworkAnchorsRequest.SortBy getSortBy()
The field to sort by.You can provide only one sort order. 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, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
-
toBuilder
public ListNetworkAnchorsRequest.Builder toBuilder()
Return an instance ofListNetworkAnchorsRequest.Builderthat allows you to modify request properties.- Returns:
- instance of
ListNetworkAnchorsRequest.Builderthat allows you to modify request properties.
-
builder
public static ListNetworkAnchorsRequest.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>
-
-