com.oracle.bmc.computeinstanceagent

Interface Plugin

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PluginClient

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

API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent is a lightweight process that monitors and manages compute instances.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetInstanceAgentPluginResponse	getInstanceAgentPlugin(GetInstanceAgentPluginRequest request) The API to get information for a plugin.
PluginPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListInstanceAgentPluginsResponse	listInstanceAgentPlugins(ListInstanceAgentPluginsRequest request) The API to get one or more plugin information.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(com.oracle.bmc.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’).

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(com.oracle.bmc.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.

getInstanceAgentPlugin

GetInstanceAgentPluginResponse getInstanceAgentPlugin(GetInstanceAgentPluginRequest request)

The API to get information for a plugin.

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

listInstanceAgentPlugins

ListInstanceAgentPluginsResponse listInstanceAgentPlugins(ListInstanceAgentPluginsRequest request)

The API to get one or more plugin information.

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

getPaginators

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