Class ListInventoryResourcesRequest.Builder
- java.lang.Object
-
- com.oracle.bmc.fleetappsmanagement.requests.ListInventoryResourcesRequest.Builder
-
- All Implemented Interfaces:
BmcRequest.Builder<ListInventoryResourcesRequest,Void>
- Enclosing class:
- ListInventoryResourcesRequest
public static class ListInventoryResourcesRequest.Builder extends Object implements BmcRequest.Builder<ListInventoryResourcesRequest,Void>
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListInventoryResourcesRequest
build()
Build the instance of ListInventoryResourcesRequest as configured by this builderListInventoryResourcesRequest
buildWithoutInvocationCallback()
Build the instance of ListInventoryResourcesRequest as configured by this builderListInventoryResourcesRequest.Builder
compartmentId(String compartmentId)
A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID.ListInventoryResourcesRequest.Builder
copy(ListInventoryResourcesRequest o)
Copy method to populate the builder with values from the given instance.ListInventoryResourcesRequest.Builder
definedTagEquals(String singularValue)
Singular setter.ListInventoryResourcesRequest.Builder
definedTagEquals(List<String> definedTagEquals)
A list of tag filters to apply.ListInventoryResourcesRequest.Builder
displayName(String displayName)
A filter to return only resources that match the entire display name given.ListInventoryResourcesRequest.Builder
freeformTagEquals(String singularValue)
Singular setter.ListInventoryResourcesRequest.Builder
freeformTagEquals(List<String> freeformTagEquals)
A list of tag filters to apply.ListInventoryResourcesRequest.Builder
inventoryProperties(String singularValue)
Singular setter.ListInventoryResourcesRequest.Builder
inventoryProperties(List<String> inventoryProperties)
A list of inventory properties filters to apply.ListInventoryResourcesRequest.Builder
invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)
Set the invocation callback for the request to be built.ListInventoryResourcesRequest.Builder
lifecycleState(String lifecycleState)
A filter to return only resources their lifecycleState matches the given lifecycleState.ListInventoryResourcesRequest.Builder
limit(Integer limit)
The maximum number of items to return.ListInventoryResourcesRequest.Builder
matchingCriteria(String matchingCriteria)
Fetch resources matching ANY or ALL criteria passed as params in “tags” and “inventoryProperties”.ListInventoryResourcesRequest.Builder
opcRequestId(String opcRequestId)
The client request ID for tracing.ListInventoryResourcesRequest.Builder
page(String page)
A token representing the position at which to start retrieving results.ListInventoryResourcesRequest.Builder
resourceCompartmentId(String resourceCompartmentId)
A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID.ListInventoryResourcesRequest.Builder
resourceRegion(String resourceRegion)
Resource RegionListInventoryResourcesRequest.Builder
retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.ListInventoryResourcesRequest.Builder
sortBy(InventoryResourceSortBy sortBy)
The field to sort by.ListInventoryResourcesRequest.Builder
sortOrder(SortOrder sortOrder)
The sort order to use, either ‘ASC’ or ‘DESC’.-
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 ListInventoryResourcesRequest.Builder compartmentId(String compartmentId)
A filter to return only resources whose base Compartment ID(TenancyId) matches the given base Compartment ID.- Parameters:
compartmentId
- the value to set- Returns:
- this builder instance
-
resourceCompartmentId
public ListInventoryResourcesRequest.Builder resourceCompartmentId(String resourceCompartmentId)
A filter to return only resources whose resource Compartment ID matches the given resource Compartment ID.- Parameters:
resourceCompartmentId
- the value to set- Returns:
- this builder instance
-
lifecycleState
public ListInventoryResourcesRequest.Builder lifecycleState(String lifecycleState)
A filter to return only resources their lifecycleState matches the given lifecycleState.- Parameters:
lifecycleState
- the value to set- Returns:
- this builder instance
-
displayName
public ListInventoryResourcesRequest.Builder displayName(String displayName)
A filter to return only resources that match the entire display name given.- Parameters:
displayName
- the value to set- Returns:
- this builder instance
-
resourceRegion
public ListInventoryResourcesRequest.Builder resourceRegion(String resourceRegion)
Resource Region- Parameters:
resourceRegion
- the value to set- Returns:
- this builder instance
-
definedTagEquals
public ListInventoryResourcesRequest.Builder definedTagEquals(List<String> definedTagEquals)
A list of tag filters to apply.Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}={value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. Example: Identification.Development=Yes
- Parameters:
definedTagEquals
- the value to set- Returns:
- this builder instance
-
definedTagEquals
public ListInventoryResourcesRequest.Builder definedTagEquals(String singularValue)
Singular setter.A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}={value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”. Example: Identification.Development=Yes
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
freeformTagEquals
public ListInventoryResourcesRequest.Builder freeformTagEquals(List<String> freeformTagEquals)
A list of tag filters to apply.Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.
- Parameters:
freeformTagEquals
- the value to set- Returns:
- this builder instance
-
freeformTagEquals
public ListInventoryResourcesRequest.Builder freeformTagEquals(String singularValue)
Singular setter.A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
inventoryProperties
public ListInventoryResourcesRequest.Builder inventoryProperties(List<String> inventoryProperties)
A list of inventory properties filters to apply.The key for each inventory property and value for each resource type is “{resourceType}.{inventoryProperty}={value}”. Example: Instance.displayName=TEST_INSTANCE
- Parameters:
inventoryProperties
- the value to set- Returns:
- this builder instance
-
inventoryProperties
public ListInventoryResourcesRequest.Builder inventoryProperties(String singularValue)
Singular setter.A list of inventory properties filters to apply. The key for each inventory property and value for each resource type is “{resourceType}.{inventoryProperty}={value}”. Example: Instance.displayName=TEST_INSTANCE
- Parameters:
singularValue
- the singular value to set- Returns:
- this builder instance
-
matchingCriteria
public ListInventoryResourcesRequest.Builder matchingCriteria(String matchingCriteria)
Fetch resources matching ANY or ALL criteria passed as params in “tags” and “inventoryProperties”.Example: matchingCriteria=ANY
- Parameters:
matchingCriteria
- the value to set- Returns:
- this builder instance
-
limit
public ListInventoryResourcesRequest.Builder limit(Integer limit)
The maximum number of items to return.- Parameters:
limit
- the value to set- Returns:
- this builder instance
-
page
public ListInventoryResourcesRequest.Builder page(String page)
A token representing the position at which to start retrieving results.This must come from the opc-next-page header field of a previous response.
- Parameters:
page
- the value to set- Returns:
- this builder instance
-
sortOrder
public ListInventoryResourcesRequest.Builder sortOrder(SortOrder sortOrder)
The sort order to use, either ‘ASC’ or ‘DESC’.- Parameters:
sortOrder
- the value to set- Returns:
- this builder instance
-
sortBy
public ListInventoryResourcesRequest.Builder sortBy(InventoryResourceSortBy sortBy)
The field to sort by.Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.
- Parameters:
sortBy
- the value to set- Returns:
- this builder instance
-
opcRequestId
public ListInventoryResourcesRequest.Builder opcRequestId(String opcRequestId)
The client request ID for tracing.- Parameters:
opcRequestId
- the value to set- Returns:
- this builder instance
-
invocationCallback
public ListInventoryResourcesRequest.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 ListInventoryResourcesRequest.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 ListInventoryResourcesRequest.Builder copy(ListInventoryResourcesRequest o)
Copy method to populate the builder with values from the given instance.- Specified by:
copy
in interfaceBmcRequest.Builder<ListInventoryResourcesRequest,Void>
- Parameters:
o
- other request from which to copy values- Returns:
- this builder instance
-
build
public ListInventoryResourcesRequest build()
Build the instance of ListInventoryResourcesRequest 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<ListInventoryResourcesRequest,Void>
- Returns:
- instance of ListInventoryResourcesRequest
-
buildWithoutInvocationCallback
public ListInventoryResourcesRequest buildWithoutInvocationCallback()
Build the instance of ListInventoryResourcesRequest 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 ListInventoryResourcesRequest
-
-