Show / Hide Table of Contents

Class DiscoveryClient

Service client instance for Discovery.

Inheritance
object
ClientBase
RegionalClientBase
DiscoveryClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CloudbridgeService
Assembly: OCI.DotNetSDK.Cloudbridge.dll
Syntax
public class DiscoveryClient : RegionalClientBase, IDisposable

Constructors

DiscoveryClient(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 DiscoveryClient(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 DiscoveryPaginators Paginators { get; }
Property Value
Type Description
DiscoveryPaginators

Waiters

Declaration
public DiscoveryWaiters Waiters { get; }
Property Value
Type Description
DiscoveryWaiters

Methods

ChangeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeAssetSourceCompartmentResponse> ChangeAssetSourceCompartment(ChangeAssetSourceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeAssetSourceCompartmentRequest 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<ChangeAssetSourceCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAssetSourceCompartment API.

ChangeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified discovery schedule into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeDiscoveryScheduleCompartmentResponse> ChangeDiscoveryScheduleCompartment(ChangeDiscoveryScheduleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeDiscoveryScheduleCompartmentRequest 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<ChangeDiscoveryScheduleCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeDiscoveryScheduleCompartment API.

CreateAssetSource(CreateAssetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an asset source.

Declaration
public Task<CreateAssetSourceResponse> CreateAssetSource(CreateAssetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateAssetSourceRequest 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<CreateAssetSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateAssetSource API.

CreateDiscoverySchedule(CreateDiscoveryScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates the discovery schedule.

Declaration
public Task<CreateDiscoveryScheduleResponse> CreateDiscoverySchedule(CreateDiscoveryScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDiscoveryScheduleRequest 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<CreateDiscoveryScheduleResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDiscoverySchedule API.

DeleteAssetSource(DeleteAssetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the asset source by ID.

Declaration
public Task<DeleteAssetSourceResponse> DeleteAssetSource(DeleteAssetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteAssetSourceRequest 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<DeleteAssetSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteAssetSource API.

DeleteDiscoverySchedule(DeleteDiscoveryScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified discovery schedule.

Declaration
public Task<DeleteDiscoveryScheduleResponse> DeleteDiscoverySchedule(DeleteDiscoveryScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDiscoveryScheduleRequest 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<DeleteDiscoveryScheduleResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDiscoverySchedule API.

GetAssetSource(GetAssetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the asset source by ID.

Declaration
public Task<GetAssetSourceResponse> GetAssetSource(GetAssetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetAssetSourceRequest 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<GetAssetSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAssetSource API.

GetDiscoverySchedule(GetDiscoveryScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Reads information about the specified discovery schedule.

Declaration
public Task<GetDiscoveryScheduleResponse> GetDiscoverySchedule(GetDiscoveryScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDiscoveryScheduleRequest 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<GetDiscoveryScheduleResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDiscoverySchedule API.

ListAssetSourceConnections(ListAssetSourceConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets known connections to the asset source by the asset source ID.

Declaration
public Task<ListAssetSourceConnectionsResponse> ListAssetSourceConnections(ListAssetSourceConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAssetSourceConnectionsRequest 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<ListAssetSourceConnectionsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAssetSourceConnections API.

ListAssetSources(ListAssetSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of asset sources.

Declaration
public Task<ListAssetSourcesResponse> ListAssetSources(ListAssetSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAssetSourcesRequest 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<ListAssetSourcesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAssetSources API.

ListDiscoverySchedules(ListDiscoverySchedulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists discovery schedules.

Declaration
public Task<ListDiscoverySchedulesResponse> ListDiscoverySchedules(ListDiscoverySchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDiscoverySchedulesRequest 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<ListDiscoverySchedulesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDiscoverySchedules API.

ListSupportedCloudRegions(ListSupportedCloudRegionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of supported cloud regions related to AssetSourceTypeParam.

Declaration
public Task<ListSupportedCloudRegionsResponse> ListSupportedCloudRegions(ListSupportedCloudRegionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSupportedCloudRegionsRequest 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<ListSupportedCloudRegionsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSupportedCloudRegions API.

RefreshAssetSource(RefreshAssetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates the process of asset metadata synchronization with the related asset source.

Declaration
public Task<RefreshAssetSourceResponse> RefreshAssetSource(RefreshAssetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RefreshAssetSourceRequest 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<RefreshAssetSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RefreshAssetSource API.

UpdateAssetSource(UpdateAssetSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the asset source.

Declaration
public Task<UpdateAssetSourceResponse> UpdateAssetSource(UpdateAssetSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateAssetSourceRequest 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<UpdateAssetSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateAssetSource API.

UpdateDiscoverySchedule(UpdateDiscoveryScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified discovery schedule.

Declaration
public Task<UpdateDiscoveryScheduleResponse> UpdateDiscoverySchedule(UpdateDiscoveryScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDiscoveryScheduleRequest 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<UpdateDiscoveryScheduleResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDiscoverySchedule API.

Implements

IDisposable
In this article
Back to top