com.oracle.bmc.apigateway

Interface Gateway

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

GatewayClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface Gateway
extends AutoCloseable

API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.

Method Summary

Modifier and Type	Method and Description
ChangeGatewayCompartmentResponse	changeGatewayCompartment(ChangeGatewayCompartmentRequest request) Changes the gateway compartment.
CreateGatewayResponse	createGateway(CreateGatewayRequest request) Creates a new gateway.
DeleteGatewayResponse	deleteGateway(DeleteGatewayRequest request) Deletes the gateway with the given identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetGatewayResponse	getGateway(GetGatewayRequest request) Gets a gateway by identifier.
GatewayPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GatewayWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListGatewaysResponse	listGateways(ListGatewaysRequest request) Returns a list of gateways.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
UpdateGatewayResponse	updateGateway(UpdateGatewayRequest request) Updates the gateway with the given identifier.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

changeGatewayCompartment

ChangeGatewayCompartmentResponse changeGatewayCompartment(ChangeGatewayCompartmentRequest request)

Changes the gateway compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeGatewayCompartment API.

createGateway

CreateGatewayResponse createGateway(CreateGatewayRequest request)

Creates a new gateway.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateGateway API.

deleteGateway

DeleteGatewayResponse deleteGateway(DeleteGatewayRequest request)

Deletes the gateway with the given identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteGateway API.

getGateway

GetGatewayResponse getGateway(GetGatewayRequest request)

Gets a gateway by identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetGateway API.

listGateways

ListGatewaysResponse listGateways(ListGatewaysRequest request)

Returns a list of gateways.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListGateways API.

updateGateway

UpdateGatewayResponse updateGateway(UpdateGatewayRequest request)

Updates the gateway with the given identifier.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateGateway API.

getWaiters

GatewayWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

GatewayPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.