Class OpensearchClusterPipelineClient

Service client instance for OpensearchClusterPipeline.

Inheritance

object

ClientBase

RegionalClientBase

OpensearchClusterPipelineClient

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.OpensearchService

Assembly: OCI.DotNetSDK.Opensearch.dll

Syntax

public class OpensearchClusterPipelineClient : RegionalClientBase, IDisposable

Constructors

OpensearchClusterPipelineClient(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 OpensearchClusterPipelineClient(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 OpensearchClusterPipelinePaginators Paginators { get; }

Property Value

Type	Description
OpensearchClusterPipelinePaginators

Waiters

Declaration

public OpensearchClusterPipelineWaiters Waiters { get; }

Property Value

Type	Description
OpensearchClusterPipelineWaiters

Methods

CreateOpensearchClusterPipeline(CreateOpensearchClusterPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new OpensearchCluster Pipeline.

Declaration

public Task<CreateOpensearchClusterPipelineResponse> CreateOpensearchClusterPipeline(CreateOpensearchClusterPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteOpensearchClusterPipeline(DeleteOpensearchClusterPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a OpensearchCluster Pipeline resource by identifier

Declaration

public Task<DeleteOpensearchClusterPipelineResponse> DeleteOpensearchClusterPipeline(DeleteOpensearchClusterPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetOpensearchClusterPipeline(GetOpensearchClusterPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a OpensearchCluster Pipeline by identifier

Declaration

public Task<GetOpensearchClusterPipelineResponse> GetOpensearchClusterPipeline(GetOpensearchClusterPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListOpensearchClusterPipelines(ListOpensearchClusterPipelinesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of OpensearchClusterPipelines.

Declaration

public Task<ListOpensearchClusterPipelinesResponse> ListOpensearchClusterPipelines(ListOpensearchClusterPipelinesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateOpensearchClusterPipeline(UpdateOpensearchClusterPipelineRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the OpensearchCluster Pipeline

Declaration

public Task<UpdateOpensearchClusterPipelineResponse> UpdateOpensearchClusterPipeline(UpdateOpensearchClusterPipelineRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable