com.oracle.bmc.apigateway

Interface Deployment

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DeploymentClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface Deployment
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
ChangeDeploymentCompartmentResponse	changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request) Changes the deployment compartment.
CreateDeploymentResponse	createDeployment(CreateDeploymentRequest request) Creates a new deployment.
DeleteDeploymentResponse	deleteDeployment(DeleteDeploymentRequest request) Deletes the deployment with the given identifier.
GetDeploymentResponse	getDeployment(GetDeploymentRequest request) Gets a deployment by identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
DeploymentPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
DeploymentWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListDeploymentsResponse	listDeployments(ListDeploymentsRequest request) Returns a list of deployments.
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’).
UpdateDeploymentResponse	updateDeployment(UpdateDeploymentRequest request) Updates the deployment 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.

changeDeploymentCompartment

ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)

Changes the deployment 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 ChangeDeploymentCompartment API.

createDeployment

CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)

Creates a new deployment.

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 CreateDeployment API.

deleteDeployment

DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)

Deletes the deployment 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 DeleteDeployment API.

getDeployment

GetDeploymentResponse getDeployment(GetDeploymentRequest request)

Gets a deployment 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 GetDeployment API.

listDeployments

ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)

Returns a list of deployments.

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 ListDeployments API.

updateDeployment

UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)

Updates the deployment 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 UpdateDeployment API.

getWaiters

DeploymentWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

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