All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BlueGreenDeploymentsClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190415")
public interface BlueGreenDeployments
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
`ChangeBlueGreenDeploymentCompartmentResponse`	`changeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest request)`	Moves only the blue/green deployment wrapper resource into a different compartment.
`CreateBlueGreenDeploymentResponse`	`createBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)`	Creates a blue/green deployment resource and its replication channel.
`DeleteBlueGreenDeploymentResponse`	`deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)`	Deletes only the blue/green deployment wrapper resource.
`GetBlueGreenDeploymentResponse`	`getBlueGreenDeployment(GetBlueGreenDeploymentRequest request)`	Gets a blue/green deployment by identifier.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`BlueGreenDeploymentsPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`BlueGreenDeploymentsWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListBlueGreenDeploymentsResponse`	`listBlueGreenDeployments(ListBlueGreenDeploymentsRequest request)`	Lists blue/green deployments in a compartment.
`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’).
`SwitchoverBlueGreenDeploymentResponse`	`switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)`	Initiates switchover for a blue/green deployment.
`UpdateBlueGreenDeploymentResponse`	`updateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest request)`	Updates mutable metadata for a blue/green deployment.
`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
  - changeBlueGreenDeploymentCompartment
```
ChangeBlueGreenDeploymentCompartmentResponse changeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest request)
```
    Moves only the blue/green deployment wrapper resource into a different compartment.
    This operation does not move the source DB system, target DB system, or replication channel referenced by the deployment. When provided, If-Match is checked against ETag values of the blue/green 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. 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.95.0/mysql/ChangeBlueGreenDeploymentCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeBlueGreenDeploymentCompartment API.
  - createBlueGreenDeployment
```
CreateBlueGreenDeploymentResponse createBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)
```
    Creates a blue/green deployment resource and its replication channel.
    
    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.95.0/mysql/CreateBlueGreenDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateBlueGreenDeployment API.
  - deleteBlueGreenDeployment
```
DeleteBlueGreenDeploymentResponse deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)
```
    Deletes only the blue/green deployment wrapper resource.
    This operation does not delete the source DB system, target DB system, or replication channel associated with the 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. 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.95.0/mysql/DeleteBlueGreenDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteBlueGreenDeployment API.
  - getBlueGreenDeployment
```
GetBlueGreenDeploymentResponse getBlueGreenDeployment(GetBlueGreenDeploymentRequest request)
```
    Gets a blue/green 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. 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.95.0/mysql/GetBlueGreenDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetBlueGreenDeployment API.
  - listBlueGreenDeployments
```
ListBlueGreenDeploymentsResponse listBlueGreenDeployments(ListBlueGreenDeploymentsRequest request)
```
    Lists blue/green deployments in a 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 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.95.0/mysql/ListBlueGreenDeploymentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListBlueGreenDeployments API.
  - switchoverBlueGreenDeployment
```
SwitchoverBlueGreenDeploymentResponse switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)
```
    Initiates switchover for a blue/green deployment.
    This action is asynchronous and supports idempotent retry only when the same `opc-retry-token` is reused for an equivalent switchover request on the same blue/green deployment. Equivalent request identity includes materially equivalent request parameters after applying defaults and preconditions, including the effective `waitTimeInSeconds` from the request body and the same `If-Match` value when provided. An empty switchover details body and a body that explicitly passes the default `waitTimeInSeconds=300` are equivalent.
    Requests that change `If-Match` or other material preconditions are treated as new requests and follow normal conflict (`409`) or precondition (`412`) handling instead of ordinary retry reuse.
    Switchover outcome and partial/failure conditions are surfaced through `lifecycleState`, `lifecycleDetails`, `switchoverStatus`, and `activeDbSystemId` in the blue/green deployment resource.
    When `waitTimeInSeconds` is omitted from the request body, the default wait time applies. The effective wait time provides upper bound guidance for waiting while the target DB System applies remaining replication changes during switchover processing.
    
    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.95.0/mysql/SwitchoverBlueGreenDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SwitchoverBlueGreenDeployment API.
  - updateBlueGreenDeployment
```
UpdateBlueGreenDeploymentResponse updateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest request)
```
    Updates mutable metadata for a blue/green deployment.
    Currently only displayName, freeformTags, and definedTags can be changed.
    
    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.95.0/mysql/UpdateBlueGreenDeploymentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateBlueGreenDeployment API.
  - getWaiters
```
BlueGreenDeploymentsWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
BlueGreenDeploymentsPaginators 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 BlueGreenDeployments

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeBlueGreenDeploymentCompartment

createBlueGreenDeployment

deleteBlueGreenDeployment

getBlueGreenDeployment

listBlueGreenDeployments

switchoverBlueGreenDeployment

updateBlueGreenDeployment

getWaiters

getPaginators