Class ListNetworkAnchorsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.multicloud.requests.ListNetworkAnchorsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListNetworkAnchorsRequest,Void>
- Enclosing class:
- ListNetworkAnchorsRequest
public static class ListNetworkAnchorsRequest.Builder extends Object implements BmcRequest.Builder<ListNetworkAnchorsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListNetworkAnchorsRequestbuild()Build the instance of ListNetworkAnchorsRequest as configured by this builderListNetworkAnchorsRequestbuildWithoutInvocationCallback()Build the instance of ListNetworkAnchorsRequest as configured by this builderListNetworkAnchorsRequest.BuildercompartmentId(String compartmentId)The OCID of the Multicloud base compartment or sub-compartment in which to list resources.ListNetworkAnchorsRequest.BuildercompartmentIdInSubtree(Boolean compartmentIdInSubtree)If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter.ListNetworkAnchorsRequest.Buildercopy(ListNetworkAnchorsRequest o)Copy method to populate the builder with values from the given instance.ListNetworkAnchorsRequest.BuilderdisplayName(String displayName)A filter to return only resources that match the given display name exactly.ListNetworkAnchorsRequest.BuilderexternalLocation(String externalLocation)The Cloud Service Provider region.ListNetworkAnchorsRequest.Builderid(String id)The OCID of the NetworkAnchor.ListNetworkAnchorsRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListNetworkAnchorsRequest.Builderlimit(Integer limit)For list pagination.ListNetworkAnchorsRequest.BuildernetworkAnchorLifecycleState(NetworkAnchor.NetworkAnchorLifecycleState networkAnchorLifecycleState)A filter to return only resources that match the given lifecycle state.ListNetworkAnchorsRequest.BuildernetworkAnchorOciSubnetId(String networkAnchorOciSubnetId)A filter to return only NetworkAnchor resources that match the given OCI subnet Id.ListNetworkAnchorsRequest.BuildernetworkAnchorOciVcnId(String networkAnchorOciVcnId)A filter to return only NetworkAnchor resources that match the given OCI Vcn Id.ListNetworkAnchorsRequest.BuilderopcRequestId(String opcRequestId)Unique Oracle-assigned identifier for the request.ListNetworkAnchorsRequest.Builderpage(String page)For list pagination.ListNetworkAnchorsRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListNetworkAnchorsRequest.BuildershouldFetchVcnName(Boolean shouldFetchVcnName)Whether to fetch and include the vcn display name, which may introduce additional latency.ListNetworkAnchorsRequest.BuildersortBy(ListNetworkAnchorsRequest.SortBy sortBy)The field to sort by.ListNetworkAnchorsRequest.BuildersortOrder(SortOrder sortOrder)The sort order to use, either ascending (ASC) or descending (DESC).ListNetworkAnchorsRequest.BuildersubscriptionId(String subscriptionId)The OCID of the Multicloud subscription in which to list resources.ListNetworkAnchorsRequest.BuildersubscriptionServiceName(SubscriptionType subscriptionServiceName)The subscription service name of the Cloud Service Provider.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder
body$
-
-
-
-
Method Detail
-
compartmentId
public ListNetworkAnchorsRequest.Builder compartmentId(String compartmentId)
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).
- Parameters:
compartmentId- the value to set- Returns:
- this builder instance
-
subscriptionId
public ListNetworkAnchorsRequest.Builder subscriptionId(String subscriptionId)
The OCID of the Multicloud subscription in which to list resources.- Parameters:
subscriptionId- the value to set- Returns:
- this builder instance
-
subscriptionServiceName
public ListNetworkAnchorsRequest.Builder subscriptionServiceName(SubscriptionType subscriptionServiceName)
The subscription service name of the Cloud Service Provider.- Parameters:
subscriptionServiceName- the value to set- Returns:
- this builder instance
-
networkAnchorLifecycleState
public ListNetworkAnchorsRequest.Builder networkAnchorLifecycleState(NetworkAnchor.NetworkAnchorLifecycleState networkAnchorLifecycleState)
A filter to return only resources that match the given lifecycle state.The state value is case-insensitive.
- Parameters:
networkAnchorLifecycleState- the value to set- Returns:
- this builder instance
-
displayName
public ListNetworkAnchorsRequest.Builder displayName(String displayName)
A filter to return only resources that match the given display name exactly.- Parameters:
displayName- the value to set- Returns:
- this builder instance
-
externalLocation
public ListNetworkAnchorsRequest.Builder externalLocation(String externalLocation)
The Cloud Service Provider region.- Parameters:
externalLocation- the value to set- Returns:
- this builder instance
-
networkAnchorOciSubnetId
public ListNetworkAnchorsRequest.Builder networkAnchorOciSubnetId(String networkAnchorOciSubnetId)
A filter to return only NetworkAnchor resources that match the given OCI subnet Id.- Parameters:
networkAnchorOciSubnetId- the value to set- Returns:
- this builder instance
-
compartmentIdInSubtree
public ListNetworkAnchorsRequest.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
If set to true, a list operation will return NetworkAnchors from all child compartments in the provided compartmentId parameter.- Parameters:
compartmentIdInSubtree- the value to set- Returns:
- this builder instance
-
networkAnchorOciVcnId
public ListNetworkAnchorsRequest.Builder networkAnchorOciVcnId(String networkAnchorOciVcnId)
A filter to return only NetworkAnchor resources that match the given OCI Vcn Id.- Parameters:
networkAnchorOciVcnId- the value to set- Returns:
- this builder instance
-
id
public ListNetworkAnchorsRequest.Builder id(String id)
The OCID of the NetworkAnchor.- Parameters:
id- the value to set- Returns:
- this builder instance
-
limit
public ListNetworkAnchorsRequest.Builder limit(Integer limit)
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.
- Parameters:
limit- the value to set- Returns:
- this builder instance
-
page
public ListNetworkAnchorsRequest.Builder page(String page)
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.
- Parameters:
page- the value to set- Returns:
- this builder instance
-
shouldFetchVcnName
public ListNetworkAnchorsRequest.Builder shouldFetchVcnName(Boolean shouldFetchVcnName)
Whether to fetch and include the vcn display name, which may introduce additional latency.- Parameters:
shouldFetchVcnName- the value to set- Returns:
- this builder instance
-
sortOrder
public ListNetworkAnchorsRequest.Builder sortOrder(SortOrder sortOrder)
The sort order to use, either ascending (ASC) or descending (DESC).- Parameters:
sortOrder- the value to set- Returns:
- this builder instance
-
sortBy
public ListNetworkAnchorsRequest.Builder sortBy(ListNetworkAnchorsRequest.SortBy sortBy)
The field to sort by.You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.
- Parameters:
sortBy- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListNetworkAnchorsRequest.Builder opcRequestId(String opcRequestId)
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.
- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListNetworkAnchorsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.- Parameters:
invocationCallback- the invocation callback to be set for the request- Returns:
- this builder instance
-
retryConfiguration
public ListNetworkAnchorsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.- Parameters:
retryConfiguration- the retry configuration to be used for the request- Returns:
- this builder instance
-
copy
public ListNetworkAnchorsRequest.Builder copy(ListNetworkAnchorsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListNetworkAnchorsRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListNetworkAnchorsRequest build()
Build the instance of ListNetworkAnchorsRequest as configured by this builderNote that this method takes calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuildWithoutInvocationCallback()does not.This is the preferred method to build an instance.
- Specified by:
buildin interfaceBmcRequest.Builder<ListNetworkAnchorsRequest,Void>- Returns:
- instance of ListNetworkAnchorsRequest
-
buildWithoutInvocationCallback
public ListNetworkAnchorsRequest buildWithoutInvocationCallback()
Build the instance of ListNetworkAnchorsRequest as configured by this builderNote that this method does not take calls to
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor)into account, while the methodbuild()does- Returns:
- instance of ListNetworkAnchorsRequest
-
-