Class ApiGatewayClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

ApiGatewayClient

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ApiGatewayClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): ApiGatewayClient

- Defined in lib/apigateway/lib/client.ts:59
Parameters
- params: common.AuthParams
- Optional clientConfiguration: common.ClientConfiguration
Returns ApiGatewayClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: ApiGatewayWaiter

targetService

targetService: string = "ApiGateway"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://apigateway.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

get endpoint(): string
set endpoint(endpoint: string): void

- Defined in lib/apigateway/lib/client.ts:116
Get the endpoint that is being used to call (ex, https://www.example.com).

Returns string
- Defined in lib/apigateway/lib/client.ts:124
Sets the endpoint to call (ex, https://www.example.com).

Parameters
- endpoint: string
  
  The endpoint of the service.
Returns void

logger

get logger(): Logger

- Defined in lib/apigateway/lib/client.ts:130
Returns Logger

region

set region(region: Region): void

- Defined in lib/apigateway/lib/client.ts:165
Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

Parameters
- region: Region
  
  The region of the service.
Returns void

regionId

set regionId(regionId: string): void

- Defined in lib/apigateway/lib/client.ts:183
Sets the regionId to call (ex, 'us-phoenix-1').

Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

Parameters
- regionId: string
  
  The public region ID.
Returns void

useRealmSpecificEndpointTemplate

set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void

- Defined in lib/apigateway/lib/client.ts:139
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

Parameters
- realmSpecificEndpointTemplateEnabled: boolean
  
  flag to enable the use of realm specific endpoint template
Returns void

Methods

changeApiCompartment

changeApiCompartment(changeApiCompartmentRequest: ChangeApiCompartmentRequest): Promise<ChangeApiCompartmentResponse>

- Defined in lib/apigateway/lib/client.ts:240
Changes the API compartment. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ChangeApiCompartment API.

Parameters
- changeApiCompartmentRequest: ChangeApiCompartmentRequest
Returns Promise<ChangeApiCompartmentResponse>

ChangeApiCompartmentResponse

changeCertificateCompartment

changeCertificateCompartment(changeCertificateCompartmentRequest: ChangeCertificateCompartmentRequest): Promise<ChangeCertificateCompartmentResponse>

- Defined in lib/apigateway/lib/client.ts:319
Changes the certificate compartment. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use ChangeCertificateCompartment API.

Parameters
- changeCertificateCompartmentRequest: ChangeCertificateCompartmentRequest
Returns Promise<ChangeCertificateCompartmentResponse>

ChangeCertificateCompartmentResponse

close

close(): void

- Defined in lib/apigateway/lib/client.ts:228
Close the client once it is no longer needed

Returns void

createApi

createApi(createApiRequest: CreateApiRequest): Promise<CreateApiResponse>

- Defined in lib/apigateway/lib/client.ts:395
Creates a new API.

This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use CreateApi API.

Parameters
- createApiRequest: CreateApiRequest
Returns Promise<CreateApiResponse>

CreateApiResponse

createCertificate

createCertificate(createCertificateRequest: CreateCertificateRequest): Promise<CreateCertificateResponse>

- Defined in lib/apigateway/lib/client.ts:485
Creates a new Certificate.

This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use CreateCertificate API.

Parameters
- createCertificateRequest: CreateCertificateRequest
Returns Promise<CreateCertificateResponse>

CreateCertificateResponse

createSdk

createSdk(createSdkRequest: CreateSdkRequest): Promise<CreateSdkResponse>

- Defined in lib/apigateway/lib/client.ts:574
Creates a new SDK. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use CreateSdk API.

Parameters
- createSdkRequest: CreateSdkRequest
Returns Promise<CreateSdkResponse>

CreateSdkResponse

createWaiters

createWaiters(config?: common.WaiterConfiguration): ApiGatewayWaiter

- Defined in lib/apigateway/lib/client.ts:199
Creates a new ApiGatewayWaiter for resources for this service.

Parameters
- Optional config: common.WaiterConfiguration
  
  The waiter configuration for termination and delay strategy
Returns ApiGatewayWaiter

The service waiters.

deleteApi

deleteApi(deleteApiRequest: DeleteApiRequest): Promise<DeleteApiResponse>

- Defined in lib/apigateway/lib/client.ts:664
Deletes the API with the given identifier. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteApi API.

Parameters
- deleteApiRequest: DeleteApiRequest
Returns Promise<DeleteApiResponse>

DeleteApiResponse

deleteCertificate

deleteCertificate(deleteCertificateRequest: DeleteCertificateRequest): Promise<DeleteCertificateResponse>

- Defined in lib/apigateway/lib/client.ts:737
Deletes the certificate with the given identifier. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteCertificate API.

Parameters
- deleteCertificateRequest: DeleteCertificateRequest
Returns Promise<DeleteCertificateResponse>

DeleteCertificateResponse

deleteSdk

deleteSdk(deleteSdkRequest: DeleteSdkRequest): Promise<DeleteSdkResponse>

- Defined in lib/apigateway/lib/client.ts:810
Deletes provided SDK. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use DeleteSdk API.

Parameters
- deleteSdkRequest: DeleteSdkRequest
Returns Promise<DeleteSdkResponse>

DeleteSdkResponse

getApi

getApi(getApiRequest: GetApiRequest): Promise<GetApiResponse>

- Defined in lib/apigateway/lib/client.ts:883
Gets an API by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetApi API.

Parameters
- getApiRequest: GetApiRequest
Returns Promise<GetApiResponse>

GetApiResponse

getApiContent

getApiContent(getApiContentRequest: GetApiContentRequest): Promise<GetApiContentResponse>

- Defined in lib/apigateway/lib/client.ts:957
Get the raw API content. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetApiContent API.

Parameters
- getApiContentRequest: GetApiContentRequest
Returns Promise<GetApiContentResponse>

GetApiContentResponse

getApiDeploymentSpecification

getApiDeploymentSpecification(getApiDeploymentSpecificationRequest: GetApiDeploymentSpecificationRequest): Promise<GetApiDeploymentSpecificationResponse>

- Defined in lib/apigateway/lib/client.ts:1040
Gets an API Deployment specification by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetApiDeploymentSpecification API.

Parameters
- getApiDeploymentSpecificationRequest: GetApiDeploymentSpecificationRequest
Returns Promise<GetApiDeploymentSpecificationResponse>

GetApiDeploymentSpecificationResponse

getApiValidations

getApiValidations(getApiValidationsRequest: GetApiValidationsRequest): Promise<GetApiValidationsResponse>

- Defined in lib/apigateway/lib/client.ts:1118
Gets the API validation results. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetApiValidations API.

Parameters
- getApiValidationsRequest: GetApiValidationsRequest
Returns Promise<GetApiValidationsResponse>

GetApiValidationsResponse

getCertificate

getCertificate(getCertificateRequest: GetCertificateRequest): Promise<GetCertificateResponse>

- Defined in lib/apigateway/lib/client.ts:1195
Gets a certificate by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetCertificate API.

Parameters
- getCertificateRequest: GetCertificateRequest
Returns Promise<GetCertificateResponse>

GetCertificateResponse

getSdk

getSdk(getSdkRequest: GetSdkRequest): Promise<GetSdkResponse>

- Defined in lib/apigateway/lib/client.ts:1271
Return object store downloadable URL and metadata. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use GetSdk API.

Parameters
- getSdkRequest: GetSdkRequest
Returns Promise<GetSdkResponse>

GetSdkResponse

getWaiters

getWaiters(): ApiGatewayWaiter

- Defined in lib/apigateway/lib/client.ts:209
Gets the waiters available for resources for this service.

Returns ApiGatewayWaiter

The service waiters.

listApis

listApis(listApisRequest: ListApisRequest): Promise<ListApisResponse>

- Defined in lib/apigateway/lib/client.ts:1346
Returns a list of APIs.

This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use ListApis API.

Parameters
- listApisRequest: ListApisRequest
Returns Promise<ListApisResponse>

ListApisResponse

listCertificates

listCertificates(listCertificatesRequest: ListCertificatesRequest): Promise<ListCertificatesResponse>

- Defined in lib/apigateway/lib/client.ts:1434
Returns a list of certificates.

This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use ListCertificates API.

Parameters
- listCertificatesRequest: ListCertificatesRequest
Returns Promise<ListCertificatesResponse>

ListCertificatesResponse

listSdkLanguageTypes

listSdkLanguageTypes(listSdkLanguageTypesRequest: ListSdkLanguageTypesRequest): Promise<ListSdkLanguageTypesResponse>

- Defined in lib/apigateway/lib/client.ts:1521
Lists programming languages in which SDK can be generated. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use ListSdkLanguageTypes API.

Parameters
- listSdkLanguageTypesRequest: ListSdkLanguageTypesRequest
Returns Promise<ListSdkLanguageTypesResponse>

ListSdkLanguageTypesResponse

listSdks

listSdks(listSdksRequest: ListSdksRequest): Promise<ListSdksResponse>

- Defined in lib/apigateway/lib/client.ts:1607
Returns list of generated SDKs. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

throws

OciError when an error occurs

example

Click here to see how to use ListSdks API.

Parameters
- listSdksRequest: ListSdksRequest
Returns Promise<ListSdksResponse>

ListSdksResponse

shutdownCircuitBreaker

shutdownCircuitBreaker(): void

- Defined in lib/apigateway/lib/client.ts:219
Shutdown the circuit breaker used by the client when it is no longer needed

Returns void

updateApi

updateApi(updateApiRequest: UpdateApiRequest): Promise<UpdateApiResponse>

- Defined in lib/apigateway/lib/client.ts:1695
Updates the API with the given identifier. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use UpdateApi API.

Parameters
- updateApiRequest: UpdateApiRequest
Returns Promise<UpdateApiResponse>

UpdateApiResponse

updateCertificate

updateCertificate(updateCertificateRequest: UpdateCertificateRequest): Promise<UpdateCertificateResponse>

- Defined in lib/apigateway/lib/client.ts:1773
Updates a certificate with the given identifier This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use UpdateCertificate API.

Parameters
- updateCertificateRequest: UpdateCertificateRequest
Returns Promise<UpdateCertificateResponse>

UpdateCertificateResponse

updateSdk

updateSdk(updateSdkRequest: UpdateSdkRequest): Promise<UpdateSdkResponse>

- Defined in lib/apigateway/lib/client.ts:1851
Updates the SDK with the given identifier. This operation does not retry by default if the user has not defined a retry configuration.

throws

OciError when an error occurs

example

Click here to see how to use UpdateSdk API.

Parameters
- updateSdkRequest: UpdateSdkRequest
Returns Promise<UpdateSdkResponse>

UpdateSdkResponse

Class ApiGatewayClient

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: common.AuthParams

Optional clientConfiguration: common.ClientConfiguration

Returns ApiGatewayClient

Properties

Protected _bodyDuplexMode

Protected _circuitBreaker

Protected _clientConfiguration

Protected _defaultHeaders

Protected _endpoint

Protected _httpClient

Protected _httpOptions

Protected _lastSetRegionOrRegionId

Protected _realmSpecificEndpointTemplateEnabled

Protected _region

Protected _regionId

Protected _waiters

targetService

Static Protected endpointServiceName

Static Protected serviceEndpointTemplate

Accessors

endpoint

Returns string

Parameters

endpoint: string

Returns void

logger

Returns Logger

region

Parameters

region: Region

Returns void

regionId

Parameters

regionId: string

Returns void

useRealmSpecificEndpointTemplate

Parameters

realmSpecificEndpointTemplateEnabled: boolean

Returns void

Methods

changeApiCompartment

Parameters

changeApiCompartmentRequest: ChangeApiCompartmentRequest

Returns Promise<ChangeApiCompartmentResponse>

changeCertificateCompartment

Parameters

changeCertificateCompartmentRequest: ChangeCertificateCompartmentRequest

Returns Promise<ChangeCertificateCompartmentResponse>

close

Returns void

createApi

Parameters

createApiRequest: CreateApiRequest

Returns Promise<CreateApiResponse>

createCertificate

Parameters

createCertificateRequest: CreateCertificateRequest

Returns Promise<CreateCertificateResponse>

createSdk

Parameters

createSdkRequest: CreateSdkRequest

Returns Promise<CreateSdkResponse>

createWaiters

Parameters

Optional config: common.WaiterConfiguration

Returns ApiGatewayWaiter

deleteApi

Parameters

deleteApiRequest: DeleteApiRequest

Returns Promise<DeleteApiResponse>

deleteCertificate