Class ApiGatewayClient

Service client instance for ApiGateway.

Inheritance

object

ClientBase

RegionalClientBase

ApiGatewayClient

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

Assembly: OCI.DotNetSDK.Apigateway.dll

Syntax

public class ApiGatewayClient : RegionalClientBase, IDisposable

Constructors

ApiGatewayClient(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 ApiGatewayClient(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 ApiGatewayPaginators Paginators { get; }

Property Value

Type	Description
ApiGatewayPaginators

Waiters

Declaration

public ApiGatewayWaiters Waiters { get; }

Property Value

Type	Description
ApiGatewayWaiters

Methods

ChangeApiCompartment(ChangeApiCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Changes the API compartment.

Declaration

public Task<ChangeApiCompartmentResponse> ChangeApiCompartment(ChangeApiCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangeCertificateCompartment(ChangeCertificateCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Changes the certificate compartment.

Declaration

public Task<ChangeCertificateCompartmentResponse> ChangeCertificateCompartment(ChangeCertificateCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateApi(CreateApiRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new API.

Declaration

public Task<CreateApiResponse> CreateApi(CreateApiRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateCertificate(CreateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Certificate.

Declaration

public Task<CreateCertificateResponse> CreateCertificate(CreateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateSdk(CreateSdkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new SDK.

Declaration

public Task<CreateSdkResponse> CreateSdk(CreateSdkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteApi(DeleteApiRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the API with the given identifier.

Declaration

public Task<DeleteApiResponse> DeleteApi(DeleteApiRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteCertificate(DeleteCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the certificate with the given identifier.

Declaration

public Task<DeleteCertificateResponse> DeleteCertificate(DeleteCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteSdk(DeleteSdkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes provided SDK.

Declaration

public Task<DeleteSdkResponse> DeleteSdk(DeleteSdkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetApi(GetApiRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an API by identifier.

Declaration

public Task<GetApiResponse> GetApi(GetApiRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetApiContent(GetApiContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the raw API content.

Declaration

public Task<GetApiContentResponse> GetApiContent(GetApiContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetApiDeploymentSpecification(GetApiDeploymentSpecificationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an API Deployment specification by identifier.

Declaration

public Task<GetApiDeploymentSpecificationResponse> GetApiDeploymentSpecification(GetApiDeploymentSpecificationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetApiValidations(GetApiValidationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the API validation results.

Declaration

public Task<GetApiValidationsResponse> GetApiValidations(GetApiValidationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCertificate(GetCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a certificate by identifier.

Declaration

public Task<GetCertificateResponse> GetCertificate(GetCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetSdk(GetSdkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return object store downloadable URL and metadata.

Declaration

public Task<GetSdkResponse> GetSdk(GetSdkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListApis(ListApisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of APIs.

Declaration

public Task<ListApisResponse> ListApis(ListApisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListCertificates(ListCertificatesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of certificates.

Declaration

public Task<ListCertificatesResponse> ListCertificates(ListCertificatesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListSdkLanguageTypes(ListSdkLanguageTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists programming languages in which SDK can be generated.

Declaration

public Task<ListSdkLanguageTypesResponse> ListSdkLanguageTypes(ListSdkLanguageTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListSdks(ListSdksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns list of generated SDKs.

Declaration

public Task<ListSdksResponse> ListSdks(ListSdksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateApi(UpdateApiRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the API with the given identifier.

Declaration

public Task<UpdateApiResponse> UpdateApi(UpdateApiRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateCertificate(UpdateCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a certificate with the given identifier

Declaration

public Task<UpdateCertificateResponse> UpdateCertificate(UpdateCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateSdk(UpdateSdkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the SDK with the given identifier.

Declaration

public Task<UpdateSdkResponse> UpdateSdk(UpdateSdkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable