All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SubscribersClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public interface Subscribers
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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`AddSubscriberLockResponse`	`addSubscriberLock(AddSubscriberLockRequest request)`	Adds a lock to a Subscriber resource.
`ChangeSubscriberCompartmentResponse`	`changeSubscriberCompartment(ChangeSubscriberCompartmentRequest request)`	Changes the subscriber compartment.
`CreateSubscriberResponse`	`createSubscriber(CreateSubscriberRequest request)`	Creates a new subscriber.
`DeleteSubscriberResponse`	`deleteSubscriber(DeleteSubscriberRequest request)`	Deletes the subscriber with the given identifier.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`SubscribersPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetSubscriberResponse`	`getSubscriber(GetSubscriberRequest request)`	Gets a subscriber by identifier.
`SubscribersWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListSubscribersResponse`	`listSubscribers(ListSubscribersRequest request)`	Returns a list of subscribers.
`void`	`refreshClient()`	Rebuilds the client from scratch.
`RemoveSubscriberLockResponse`	`removeSubscriberLock(RemoveSubscriberLockRequest request)`	Removes a lock from a Subscriber resource.
`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’).
`UpdateSubscriberResponse`	`updateSubscriber(UpdateSubscriberRequest request)`	Updates the subscriber with the given identifier.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch.
    Useful to refresh certificates.
  - 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.
  - useRealmSpecificEndpointTemplate
```
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
```
    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 - flag to enable the use of realm specific endpoint template
  - addSubscriberLock
```
AddSubscriberLockResponse addSubscriberLock(AddSubscriberLockRequest request)
```
    Adds a lock to a Subscriber resource.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/AddSubscriberLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddSubscriberLock API.
  - changeSubscriberCompartment
```
ChangeSubscriberCompartmentResponse changeSubscriberCompartment(ChangeSubscriberCompartmentRequest request)
```
    Changes the subscriber 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/ChangeSubscriberCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeSubscriberCompartment API.
  - createSubscriber
```
CreateSubscriberResponse createSubscriber(CreateSubscriberRequest request)
```
    Creates a new subscriber.
    
    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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/CreateSubscriberExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSubscriber API.
  - deleteSubscriber
```
DeleteSubscriberResponse deleteSubscriber(DeleteSubscriberRequest request)
```
    Deletes the subscriber 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/DeleteSubscriberExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSubscriber API.
  - getSubscriber
```
GetSubscriberResponse getSubscriber(GetSubscriberRequest request)
```
    Gets a subscriber 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/GetSubscriberExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSubscriber API.
  - listSubscribers
```
ListSubscribersResponse listSubscribers(ListSubscribersRequest request)
```
    Returns a list of subscribers.
    
    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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/ListSubscribersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSubscribers API.
  - removeSubscriberLock
```
RemoveSubscriberLockResponse removeSubscriberLock(RemoveSubscriberLockRequest request)
```
    Removes a lock from a Subscriber resource.
    
    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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/RemoveSubscriberLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveSubscriberLock API.
  - updateSubscriber
```
UpdateSubscriberResponse updateSubscriber(UpdateSubscriberRequest request)
```
    Updates the subscriber 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/apigateway/UpdateSubscriberExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSubscriber API.
  - getWaiters
```
SubscribersWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
SubscribersPaginators 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.

Interface Subscribers

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

addSubscriberLock

changeSubscriberCompartment

createSubscriber

deleteSubscriber

getSubscriber

listSubscribers

removeSubscriberLock

updateSubscriber

getWaiters

getPaginators