Class ListResourceAnchorsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.multicloud.requests.ListResourceAnchorsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListResourceAnchorsRequest,Void>
- Enclosing class:
- ListResourceAnchorsRequest
public static class ListResourceAnchorsRequest.Builder extends Object implements BmcRequest.Builder<ListResourceAnchorsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListResourceAnchorsRequestbuild()Build the instance of ListResourceAnchorsRequest as configured by this builderListResourceAnchorsRequestbuildWithoutInvocationCallback()Build the instance of ListResourceAnchorsRequest as configured by this builderListResourceAnchorsRequest.BuildercompartmentId(String compartmentId)The OCID of the Multicloud base compartment or sub-compartment in which to list resources.ListResourceAnchorsRequest.Buildercopy(ListResourceAnchorsRequest o)Copy method to populate the builder with values from the given instance.ListResourceAnchorsRequest.BuilderdisplayName(String displayName)A filter to return only resources that match the given display name exactly.ListResourceAnchorsRequest.Builderid(String id)The OCID of the ResourceAnchor.ListResourceAnchorsRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.ListResourceAnchorsRequest.BuilderisCompartmentIdInSubtree(Boolean isCompartmentIdInSubtree)Check the sub-compartments of a given compartmentIdListResourceAnchorsRequest.BuilderlifecycleState(ResourceAnchor.LifecycleState lifecycleState)A filter to return only resources that match the given lifecycle state.ListResourceAnchorsRequest.Builderlimit(Integer limit)For list pagination.ListResourceAnchorsRequest.BuilderlinkedCompartmentId(String linkedCompartmentId)The OCID of the compartment linked to the resource.ListResourceAnchorsRequest.BuilderopcRequestId(String opcRequestId)Unique Oracle-assigned identifier for the request.ListResourceAnchorsRequest.Builderpage(String page)For list pagination.ListResourceAnchorsRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.ListResourceAnchorsRequest.BuildershouldFetchCompartmentName(Boolean shouldFetchCompartmentName)Whether to fetch and include the compartment name, setting this field to yes may introduce additional latency.ListResourceAnchorsRequest.BuildersortBy(ListResourceAnchorsRequest.SortBy sortBy)The field to sort by.ListResourceAnchorsRequest.BuildersortOrder(SortOrder sortOrder)The sort order to use, either ascending (ASC) or descending (DESC).ListResourceAnchorsRequest.BuildersubscriptionId(String subscriptionId)The OCID of the Multicloud subscription in which to list resources.ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.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
-
linkedCompartmentId
public ListResourceAnchorsRequest.Builder linkedCompartmentId(String linkedCompartmentId)
The OCID of the compartment linked to the resource.- Parameters:
linkedCompartmentId- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListResourceAnchorsRequest.Builder lifecycleState(ResourceAnchor.LifecycleState lifecycleState)
A filter to return only resources that match the given lifecycle state.The state value is case-insensitive.
- Parameters:
lifecycleState- the value to set- Returns:
- this builder instance
-
displayName
public ListResourceAnchorsRequest.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
-
id
public ListResourceAnchorsRequest.Builder id(String id)
The OCID of the ResourceAnchor.- Parameters:
id- the value to set- Returns:
- this builder instance
-
limit
public ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.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
-
sortOrder
public ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.Builder sortBy(ListResourceAnchorsRequest.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
-
isCompartmentIdInSubtree
public ListResourceAnchorsRequest.Builder isCompartmentIdInSubtree(Boolean isCompartmentIdInSubtree)
Check the sub-compartments of a given compartmentId- Parameters:
isCompartmentIdInSubtree- the value to set- Returns:
- this builder instance
-
shouldFetchCompartmentName
public ListResourceAnchorsRequest.Builder shouldFetchCompartmentName(Boolean shouldFetchCompartmentName)
Whether to fetch and include the compartment name, setting this field to yes may introduce additional latency.- Parameters:
shouldFetchCompartmentName- the value to set- Returns:
- this builder instance
-
subscriptionServiceName
public ListResourceAnchorsRequest.Builder subscriptionServiceName(SubscriptionType subscriptionServiceName)
The subscription service name of the Cloud Service Provider.- Parameters:
subscriptionServiceName- the value to set- Returns:
- this builder instance
-
subscriptionId
public ListResourceAnchorsRequest.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
-
opcRequestId
public ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.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 ListResourceAnchorsRequest.Builder copy(ListResourceAnchorsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<ListResourceAnchorsRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public ListResourceAnchorsRequest build()
Build the instance of ListResourceAnchorsRequest 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<ListResourceAnchorsRequest,Void>- Returns:
- instance of ListResourceAnchorsRequest
-
buildWithoutInvocationCallback
public ListResourceAnchorsRequest buildWithoutInvocationCallback()
Build the instance of ListResourceAnchorsRequest 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 ListResourceAnchorsRequest
-
-