Class SubscribersClient
Service client instance for Subscribers.
Implements
Inherited Members
Namespace: Oci.ApigatewayService
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class SubscribersClient : RegionalClientBase, IDisposable
Constructors
SubscribersClient(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 SubscribersClient(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 SubscribersPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
SubscribersPaginators |
Waiters
Declaration
public SubscribersWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
SubscribersWaiters |
Methods
ChangeSubscriberCompartment(ChangeSubscriberCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the subscriber compartment.
Declaration
public Task<ChangeSubscriberCompartmentResponse> ChangeSubscriberCompartment(ChangeSubscriberCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSubscriberCompartmentRequest | 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<ChangeSubscriberCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSubscriberCompartment API.
CreateSubscriber(CreateSubscriberRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new subscriber.
Declaration
public Task<CreateSubscriberResponse> CreateSubscriber(CreateSubscriberRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSubscriberRequest | 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<CreateSubscriberResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSubscriber API.
DeleteSubscriber(DeleteSubscriberRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the subscriber with the given identifier.
Declaration
public Task<DeleteSubscriberResponse> DeleteSubscriber(DeleteSubscriberRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSubscriberRequest | 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<DeleteSubscriberResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSubscriber API.
GetSubscriber(GetSubscriberRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a subscriber by identifier.
Declaration
public Task<GetSubscriberResponse> GetSubscriber(GetSubscriberRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSubscriberRequest | 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<GetSubscriberResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSubscriber API.
ListSubscribers(ListSubscribersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of subscribers.
Declaration
public Task<ListSubscribersResponse> ListSubscribers(ListSubscribersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSubscribersRequest | 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<ListSubscribersResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSubscribers API.
UpdateSubscriber(UpdateSubscriberRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the subscriber with the given identifier.
Declaration
public Task<UpdateSubscriberResponse> UpdateSubscriber(UpdateSubscriberRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSubscriberRequest | 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<UpdateSubscriberResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSubscriber API.