Class BlueGreenDeploymentsClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.mysql.BlueGreenDeploymentsClient
-
- All Implemented Interfaces:
BlueGreenDeployments,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20190415") public class BlueGreenDeploymentsClient extends BaseSyncClient implements BlueGreenDeployments
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBlueGreenDeploymentsClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for BlueGreenDeployments.
-
Constructor Summary
Constructors Constructor Description BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static BlueGreenDeploymentsClient.Builderbuilder()Create a builder for this client.ChangeBlueGreenDeploymentCompartmentResponsechangeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest request)Moves only the blue/green deployment wrapper resource into a different compartment.voidclose()CreateBlueGreenDeploymentResponsecreateBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)Creates a blue/green deployment resource and its replication channel.DeleteBlueGreenDeploymentResponsedeleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)Deletes only the blue/green deployment wrapper resource.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetBlueGreenDeploymentResponsegetBlueGreenDeployment(GetBlueGreenDeploymentRequest request)Gets a blue/green deployment by identifier.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.BlueGreenDeploymentsPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.BlueGreenDeploymentsWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListBlueGreenDeploymentsResponselistBlueGreenDeployments(ListBlueGreenDeploymentsRequest request)Lists blue/green deployments in a compartment.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).SwitchoverBlueGreenDeploymentResponseswitchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)Initiates switchover for a blue/green deployment.UpdateBlueGreenDeploymentResponseupdateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest request)Updates mutable metadata for a blue/green deployment.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.mysql.BlueGreenDeployments
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
BlueGreenDeploymentsClient
@Deprecated public BlueGreenDeploymentsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBlueGreenDeploymentsClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-BlueGreenDeploymentsClient.Builder.executorService
-
-
Method Detail
-
builder
public static BlueGreenDeploymentsClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:BlueGreenDeploymentsSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceBlueGreenDeployments- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:BlueGreenDeploymentsSets 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.- Specified by:
setRegionin interfaceBlueGreenDeployments- Parameters:
regionId- The public region ID.
-
changeBlueGreenDeploymentCompartment
public ChangeBlueGreenDeploymentCompartmentResponse changeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest request)
Description copied from interface:BlueGreenDeploymentsMoves 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.
- Specified by:
changeBlueGreenDeploymentCompartmentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createBlueGreenDeployment
public CreateBlueGreenDeploymentResponse createBlueGreenDeployment(CreateBlueGreenDeploymentRequest request)
Description copied from interface:BlueGreenDeploymentsCreates a blue/green deployment resource and its replication channel.- Specified by:
createBlueGreenDeploymentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteBlueGreenDeployment
public DeleteBlueGreenDeploymentResponse deleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request)
Description copied from interface:BlueGreenDeploymentsDeletes 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.
- Specified by:
deleteBlueGreenDeploymentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getBlueGreenDeployment
public GetBlueGreenDeploymentResponse getBlueGreenDeployment(GetBlueGreenDeploymentRequest request)
Description copied from interface:BlueGreenDeploymentsGets a blue/green deployment by identifier.- Specified by:
getBlueGreenDeploymentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listBlueGreenDeployments
public ListBlueGreenDeploymentsResponse listBlueGreenDeployments(ListBlueGreenDeploymentsRequest request)
Description copied from interface:BlueGreenDeploymentsLists blue/green deployments in a compartment.- Specified by:
listBlueGreenDeploymentsin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
switchoverBlueGreenDeployment
public SwitchoverBlueGreenDeploymentResponse switchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request)
Description copied from interface:BlueGreenDeploymentsInitiates 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.
- Specified by:
switchoverBlueGreenDeploymentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateBlueGreenDeployment
public UpdateBlueGreenDeploymentResponse updateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest request)
Description copied from interface:BlueGreenDeploymentsUpdates mutable metadata for a blue/green deployment.Currently only
displayName,freeformTags, anddefinedTagscan be changed.- Specified by:
updateBlueGreenDeploymentin interfaceBlueGreenDeployments- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public BlueGreenDeploymentsWaiters getWaiters()
Description copied from interface:BlueGreenDeploymentsGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceBlueGreenDeployments- Returns:
- The service waiters.
-
getPaginators
public BlueGreenDeploymentsPaginators getPaginators()
Description copied from interface:BlueGreenDeploymentsGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceBlueGreenDeployments- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-