Class GuardedDataPipelineClient

Service client instance for GuardedDataPipeline.

Inheritance

object

ClientBase

RegionalClientBase

GuardedDataPipelineClient

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)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.GdpService

Assembly: OCI.DotNetSDK.Gdp.dll

Syntax

public class GuardedDataPipelineClient : RegionalClientBase, IDisposable

Constructors

GuardedDataPipelineClient(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 GuardedDataPipelineClient(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 GuardedDataPipelinePaginators Paginators { get; }

Property Value

Type	Description
GuardedDataPipelinePaginators

Waiters

Declaration

public GuardedDataPipelineWaiters Waiters { get; }

Property Value

Type	Description
GuardedDataPipelineWaiters

Methods

ChangeGdpPipelineCompartment(ChangeGdpPipelineCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a pipeline resource from one compartment to another. When provided, if-match is checked against etag values of the resource.

Declaration

public Task<ChangeGdpPipelineCompartmentResponse> ChangeGdpPipelineCompartment(ChangeGdpPipelineCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeGdpPipelineCompartmentRequest	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<ChangeGdpPipelineCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateGdpPipeline(CreateGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new pipeline.

Declaration

public Task<CreateGdpPipelineResponse> CreateGdpPipeline(CreateGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateGdpPipelineRequest	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<CreateGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

DeleteGdpPipeline(DeleteGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a pipeline by identifier.

Declaration

public Task<DeleteGdpPipelineResponse> DeleteGdpPipeline(DeleteGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteGdpPipelineRequest	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<DeleteGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

GetGdpPipeline(GetGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a pipeline by identifier.

Declaration

public Task<GetGdpPipelineResponse> GetGdpPipeline(GetGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGdpPipelineRequest	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<GetGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

GetGdpWorkRequest(GetGdpWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets details of the work request with the given ID.

Declaration

public Task<GetGdpWorkRequestResponse> GetGdpWorkRequest(GetGdpWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetGdpWorkRequestRequest	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<GetGdpWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

ListGdpPipelines(ListGdpPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of pipelines.

Declaration

public Task<ListGdpPipelinesResponse> ListGdpPipelines(ListGdpPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGdpPipelinesRequest	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<ListGdpPipelinesResponse>	A response object containing details about the completed operation

Examples

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

ListGdpWorkRequestErrors(ListGdpWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of errors for the work request with the given ID.

Declaration

public Task<ListGdpWorkRequestErrorsResponse> ListGdpWorkRequestErrors(ListGdpWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGdpWorkRequestErrorsRequest	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<ListGdpWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

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

ListGdpWorkRequestLogs(ListGdpWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a (paginated) list of logs for the work request with the given ID.

Declaration

public Task<ListGdpWorkRequestLogsResponse> ListGdpWorkRequestLogs(ListGdpWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGdpWorkRequestLogsRequest	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<ListGdpWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

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

ListGdpWorkRequests(ListGdpWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListGdpWorkRequestsResponse> ListGdpWorkRequests(ListGdpWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListGdpWorkRequestsRequest	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<ListGdpWorkRequestsResponse>	A response object containing details about the completed operation

Examples

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

PeerGdpPipeline(PeerGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Peers the pipeline.

Declaration

public Task<PeerGdpPipelineResponse> PeerGdpPipeline(PeerGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
PeerGdpPipelineRequest	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<PeerGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

RotateGdpPipelineKeys(RotateGdpPipelineKeysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Rotates the pipeline keys by resending the control message with a fresh pair of keys.

Declaration

public Task<RotateGdpPipelineKeysResponse> RotateGdpPipelineKeys(RotateGdpPipelineKeysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RotateGdpPipelineKeysRequest	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<RotateGdpPipelineKeysResponse>	A response object containing details about the completed operation

Examples

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

StartGdpPipeline(StartGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts the pipeline.

Declaration

public Task<StartGdpPipelineResponse> StartGdpPipeline(StartGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartGdpPipelineRequest	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<StartGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

StopGdpPipeline(StopGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops the pipeline.

Declaration

public Task<StopGdpPipelineResponse> StopGdpPipeline(StopGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopGdpPipelineRequest	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<StopGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

UpdateGdpPipeline(UpdateGdpPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the pipeline.

Declaration

public Task<UpdateGdpPipelineResponse> UpdateGdpPipeline(UpdateGdpPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateGdpPipelineRequest	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<UpdateGdpPipelineResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable