Class GatewayClient
Service client instance for Gateway.
Implements
Inherited Members
Namespace: Oci.ApigatewayService
Assembly: OCI.DotNetSDK.Apigateway.dll
Syntax
public class GatewayClient : RegionalClientBase, IDisposable
Constructors
GatewayClient(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 GatewayClient(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 GatewayPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
GatewayPaginators |
Waiters
Declaration
public GatewayWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
GatewayWaiters |
Methods
ChangeGatewayCompartment(ChangeGatewayCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Changes the gateway compartment.
Declaration
public Task<ChangeGatewayCompartmentResponse> ChangeGatewayCompartment(ChangeGatewayCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeGatewayCompartmentRequest | 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<ChangeGatewayCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeGatewayCompartment API.
CreateGateway(CreateGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new gateway.
Declaration
public Task<CreateGatewayResponse> CreateGateway(CreateGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateGatewayRequest | 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<CreateGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateGateway API.
DeleteGateway(DeleteGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the gateway with the given identifier.
Declaration
public Task<DeleteGatewayResponse> DeleteGateway(DeleteGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteGatewayRequest | 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<DeleteGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteGateway API.
GetGateway(GetGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a gateway by identifier.
Declaration
public Task<GetGatewayResponse> GetGateway(GetGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetGatewayRequest | 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<GetGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetGateway API.
ListGateways(ListGatewaysRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of gateways.
Declaration
public Task<ListGatewaysResponse> ListGateways(ListGatewaysRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListGatewaysRequest | 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<ListGatewaysResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListGateways API.
UpdateGateway(UpdateGatewayRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the gateway with the given identifier.
Declaration
public Task<UpdateGatewayResponse> UpdateGateway(UpdateGatewayRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateGatewayRequest | 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<UpdateGatewayResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateGateway API.