Interface Replicas
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
ReplicasClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public interface Replicas extends AutoCloseable
The API for the MySQL Database Service 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 CreateReplicaResponse
createReplica(CreateReplicaRequest request)
Creates a DB System read replica.DeleteReplicaResponse
deleteReplica(DeleteReplicaRequest request)
Deletes the specified read replica.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)ReplicasPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetReplicaResponse
getReplica(GetReplicaRequest request)
Gets the full details of the specified read replica.ReplicasWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListReplicasResponse
listReplicas(ListReplicasRequest request)
Lists all the read replicas that match the specified filters.void
refreshClient()
Rebuilds the client from scratch.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’).UpdateReplicaResponse
updateReplica(UpdateReplicaRequest request)
Updates the properties of the specified read replica.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 callsetEndpoint
.- 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
-
createReplica
CreateReplicaResponse createReplica(CreateReplicaRequest request)
Creates a DB System read replica.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/mysql/CreateReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateReplica API.
-
deleteReplica
DeleteReplicaResponse deleteReplica(DeleteReplicaRequest request)
Deletes the specified read replica.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/mysql/DeleteReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteReplica API.
-
getReplica
GetReplicaResponse getReplica(GetReplicaRequest request)
Gets the full details of the specified read replica.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/mysql/GetReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetReplica API.
-
listReplicas
ListReplicasResponse listReplicas(ListReplicasRequest request)
Lists all the read replicas that match the specified filters.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/mysql/ListReplicasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListReplicas API.
-
updateReplica
UpdateReplicaResponse updateReplica(UpdateReplicaRequest request)
Updates the properties of the specified read replica.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/mysql/UpdateReplicaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateReplica API.
-
getWaiters
ReplicasWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
ReplicasPaginators 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.
-
-