Class ListFileSystemsRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.filestorage.requests.ListFileSystemsRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListFileSystemsRequest,Void>
- Enclosing class:
- ListFileSystemsRequest
public static class ListFileSystemsRequest.Builder extends Object implements BmcRequest.Builder<ListFileSystemsRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListFileSystemsRequest.Builder
availabilityDomain(String availabilityDomain)
The name of the availability domain.ListFileSystemsRequest
build()
Build the instance of ListFileSystemsRequest as configured by this builderListFileSystemsRequest
buildWithoutInvocationCallback()
Build the instance of ListFileSystemsRequest as configured by this builderListFileSystemsRequest.Builder
compartmentId(String compartmentId)
The OCID of the compartment.ListFileSystemsRequest.Builder
copy(ListFileSystemsRequest o)
Copy method to populate the builder with values from the given instance.ListFileSystemsRequest.Builder
displayName(String displayName)
A user-friendly name.ListFileSystemsRequest.Builder
filesystemSnapshotPolicyId(String filesystemSnapshotPolicyId)
The OCID of the file system snapshot policy that is associated with the file systems.ListFileSystemsRequest.Builder
id(String id)
Filter results by OCID.ListFileSystemsRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListFileSystemsRequest.Builder
lifecycleState(ListFileSystemsRequest.LifecycleState lifecycleState)
Filter results by the specified lifecycle state.ListFileSystemsRequest.Builder
limit(Integer limit)
For list pagination.ListFileSystemsRequest.Builder
opcRequestId(String opcRequestId)
Unique identifier for the request.ListFileSystemsRequest.Builder
page(String page)
For list pagination.ListFileSystemsRequest.Builder
parentFileSystemId(String parentFileSystemId)
The OCID of the file system that contains the source snapshot of a cloned file system.ListFileSystemsRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListFileSystemsRequest.Builder
sortBy(ListFileSystemsRequest.SortBy sortBy)
The field to sort by.ListFileSystemsRequest.Builder
sortOrder(ListFileSystemsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.ListFileSystemsRequest.Builder
sourceSnapshotId(String sourceSnapshotId)
The OCID of the snapshot used to create a cloned file system.-
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 ListFileSystemsRequest.Builder compartmentId(String compartmentId)
The OCID of the compartment.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
availabilityDomain
public ListFileSystemsRequest.Builder availabilityDomain(String availabilityDomain)
The name of the availability domain.Example: Uocm:PHX-AD-1
- Parameters:
availabilityDomain
- the value to set- Returns:
- this builder instance
-
limit
public ListFileSystemsRequest.Builder limit(Integer limit)
For list pagination.The maximum number of results per page, or items to return in a paginated “List” call. 1 is the minimum, 4096 is the maximum.
For important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
Example: 500
- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListFileSystemsRequest.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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
displayName
public ListFileSystemsRequest.Builder displayName(String displayName)
A user-friendly name.It does not have to be unique, and it is changeable.
Example: My resource
- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListFileSystemsRequest.Builder lifecycleState(ListFileSystemsRequest.LifecycleState lifecycleState)
Filter results by the specified lifecycle state.Must be a valid state for the resource type.
- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
id
public ListFileSystemsRequest.Builder id(String id)
Filter results by OCID.Must be an OCID of the correct type for the resouce type.
- Parameters:
id
- the value to set- Returns:
- this builder instance
-
sourceSnapshotId
public ListFileSystemsRequest.Builder sourceSnapshotId(String sourceSnapshotId)
The OCID of the snapshot used to create a cloned file system.- Parameters:
sourceSnapshotId
- the value to set- Returns:
- this builder instance
-
parentFileSystemId
public ListFileSystemsRequest.Builder parentFileSystemId(String parentFileSystemId)
The OCID of the file system that contains the source snapshot of a cloned file system.- Parameters:
parentFileSystemId
- the value to set- Returns:
- this builder instance
-
filesystemSnapshotPolicyId
public ListFileSystemsRequest.Builder filesystemSnapshotPolicyId(String filesystemSnapshotPolicyId)
The OCID of the file system snapshot policy that is associated with the file systems.- Parameters:
filesystemSnapshotPolicyId
- the value to set- Returns:
- this builder instance
-
sortBy
public ListFileSystemsRequest.Builder sortBy(ListFileSystemsRequest.SortBy sortBy)
The field to sort by.You can provide either value, but not both. By default, when you sort by time created, results are shown in descending order. When you sort by display name, results are shown in ascending order.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListFileSystemsRequest.Builder sortOrder(ListFileSystemsRequest.SortOrder sortOrder)
The sort order to use, either ‘asc’ or ‘desc’, where ‘asc’ is ascending and ‘desc’ is descending.The default order is ‘desc’ except for numeric values.
- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListFileSystemsRequest.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
-
invocationCallback
public ListFileSystemsRequest.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 ListFileSystemsRequest.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 ListFileSystemsRequest.Builder copy(ListFileSystemsRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListFileSystemsRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListFileSystemsRequest build()
Build the instance of ListFileSystemsRequest 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:
build
in interfaceBmcRequest.Builder<ListFileSystemsRequest,Void>
- Returns:
- instance of ListFileSystemsRequest
-
buildWithoutInvocationCallback
public ListFileSystemsRequest buildWithoutInvocationCallback()
Build the instance of ListFileSystemsRequest 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 ListFileSystemsRequest
-
-