@Generated(value="OracleSDKGenerator", comments="API Version: 0.0.4") public interface ResourceSearch extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
ResourceSearchPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetResourceTypeResponse |
getResourceType(GetResourceTypeRequest request)
Gets detailed information about a resource type by using the resource type name.
|
ListResourceTypesResponse |
listResourceTypes(ListResourceTypesRequest request)
Lists all resource types that you can search or query for.
|
SearchResourcesResponse |
searchResources(SearchResourcesRequest request)
Queries any and all compartments in the tenancy to find resources that match the specified criteria.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.GetResourceTypeResponse getResourceType(GetResourceTypeRequest request)
Gets detailed information about a resource type by using the resource type name.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListResourceTypesResponse listResourceTypes(ListResourceTypesRequest request)
Lists all resource types that you can search or query for.
request
- The request object containing the details to sendBmcException
- when an error occurs.SearchResourcesResponse searchResources(SearchResourcesRequest request)
Queries any and all compartments in the tenancy to find resources that match the specified criteria. Results include resources that you have permission to view and can span different resource types. You can also sort results based on a specified resource attribute.
request
- The request object containing the details to sendBmcException
- when an error occurs.ResourceSearchPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2019. All rights reserved.