Class GetVcnTopologyRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.core.requests.GetVcnTopologyRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<GetVcnTopologyRequest,Void>
- Enclosing class:
- GetVcnTopologyRequest
public static class GetVcnTopologyRequest.Builder extends Object implements BmcRequest.Builder<GetVcnTopologyRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetVcnTopologyRequest.BuilderaccessLevel(GetVcnTopologyRequest.AccessLevel accessLevel)Valid values are ANY and ACCESSIBLE.GetVcnTopologyRequestbuild()Build the instance of GetVcnTopologyRequest as configured by this builderGetVcnTopologyRequestbuildWithoutInvocationCallback()Build the instance of GetVcnTopologyRequest as configured by this builderGetVcnTopologyRequest.BuildercacheControl(String cacheControl)The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.GetVcnTopologyRequest.BuildercompartmentId(String compartmentId)The OCID of the compartment.GetVcnTopologyRequest.Buildercopy(GetVcnTopologyRequest o)Copy method to populate the builder with values from the given instance.GetVcnTopologyRequest.BuilderifNoneMatch(String ifNoneMatch)For querying if there is a cached value on the server.GetVcnTopologyRequest.BuilderinvocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)Set the invocation callback for the request to be built.GetVcnTopologyRequest.BuilderopcRequestId(String opcRequestId)Unique identifier for the request.GetVcnTopologyRequest.BuilderqueryCompartmentSubtree(Boolean queryCompartmentSubtree)When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel.GetVcnTopologyRequest.BuilderretryConfiguration(RetryConfiguration retryConfiguration)Set the retry configuration for the request to be built.GetVcnTopologyRequest.BuildervcnId(String vcnId)The OCID of the VCN.-
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 GetVcnTopologyRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.- Parameters:
compartmentId- the value to set- Returns:
- this builder instance
-
vcnId
public GetVcnTopologyRequest.Builder vcnId(String vcnId)
The OCID of the VCN.- Parameters:
vcnId- the value to set- Returns:
- this builder instance
-
accessLevel
public GetVcnTopologyRequest.Builder accessLevel(GetVcnTopologyRequest.AccessLevel accessLevel)
Valid values are ANY and ACCESSIBLE.The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.
When set to ANY permissions are not checked.
- Parameters:
accessLevel- the value to set- Returns:
- this builder instance
-
queryCompartmentSubtree
public GetVcnTopologyRequest.Builder queryCompartmentSubtree(Boolean queryCompartmentSubtree)
When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel.Default is false.
- Parameters:
queryCompartmentSubtree- the value to set- Returns:
- this builder instance
-
opcRequestId
public GetVcnTopologyRequest.Builder opcRequestId(String opcRequestId)
Unique identifier for the request.If you need to contact Oracle about a particular request, please provide the request ID.
- Parameters:
opcRequestId- the value to set- Returns:
- this builder instance
-
ifNoneMatch
public GetVcnTopologyRequest.Builder ifNoneMatch(String ifNoneMatch)
For querying if there is a cached value on the server.The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn’t have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource’s ETag doesn’t match any of the values listed.
- Parameters:
ifNoneMatch- the value to set- Returns:
- this builder instance
-
cacheControl
public GetVcnTopologyRequest.Builder cacheControl(String cacheControl)
The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.- Parameters:
cacheControl- the value to set- Returns:
- this builder instance
-
invocationCallback
public GetVcnTopologyRequest.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 GetVcnTopologyRequest.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 GetVcnTopologyRequest.Builder copy(GetVcnTopologyRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copyin interfaceBmcRequest.Builder<GetVcnTopologyRequest,Void>- Parameters:
o- other request from which to copy values- Returns:
- this builder instance
-
build
public GetVcnTopologyRequest build()
Build the instance of GetVcnTopologyRequest 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<GetVcnTopologyRequest,Void>- Returns:
- instance of GetVcnTopologyRequest
-
buildWithoutInvocationCallback
public GetVcnTopologyRequest buildWithoutInvocationCallback()
Build the instance of GetVcnTopologyRequest 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 GetVcnTopologyRequest
-
-