Class ResourceSearchClient
Service client instance for ResourceSearch.
Implements
Inherited Members
Namespace: Oci.ResourcesearchService
Assembly: OCI.DotNetSDK.Resourcesearch.dll
Syntax
public class ResourceSearchClient : RegionalClientBase, IDisposable
Constructors
ResourceSearchClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public ResourceSearchClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public ResourceSearchPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ResourceSearchPaginators |
Methods
GetResourceType(GetResourceTypeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets detailed information about a resource type by using the resource type name.
Declaration
public Task<GetResourceTypeResponse> GetResourceType(GetResourceTypeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceTypeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetResourceTypeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourceType API.
ListResourceTypes(ListResourceTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all resource types that you can search or query for.
Declaration
public Task<ListResourceTypesResponse> ListResourceTypes(ListResourceTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListResourceTypesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListResourceTypesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListResourceTypes API.
SearchResources(SearchResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Queries any and all compartments in the specified 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.
Declaration
public Task<SearchResourcesResponse> SearchResources(SearchResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
SearchResourcesRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<SearchResourcesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SearchResources API.