Class BlueGreenDeploymentsClient

Service client instance for BlueGreenDeployments.

Inheritance

object

ClientBase

RegionalClientBase

BlueGreenDeploymentsClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MysqlService

Assembly: OCI.DotNetSDK.Mysql.dll

Syntax

public class BlueGreenDeploymentsClient : RegionalClientBase, IDisposable

Constructors

BlueGreenDeploymentsClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public BlueGreenDeploymentsClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public BlueGreenDeploymentsPaginators Paginators { get; }

Property Value

Type	Description
BlueGreenDeploymentsPaginators

Waiters

Declaration

public BlueGreenDeploymentsWaiters Waiters { get; }

Property Value

Type	Description
BlueGreenDeploymentsWaiters

Methods

ChangeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeBlueGreenDeploymentCompartmentResponse> ChangeBlueGreenDeploymentCompartment(ChangeBlueGreenDeploymentCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeBlueGreenDeploymentCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeBlueGreenDeploymentCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeBlueGreenDeploymentCompartment API.

CreateBlueGreenDeployment(CreateBlueGreenDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a blue/green deployment resource and its replication channel.

Declaration

public Task<CreateBlueGreenDeploymentResponse> CreateBlueGreenDeployment(CreateBlueGreenDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateBlueGreenDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateBlueGreenDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateBlueGreenDeployment API.

DeleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<DeleteBlueGreenDeploymentResponse> DeleteBlueGreenDeployment(DeleteBlueGreenDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteBlueGreenDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteBlueGreenDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteBlueGreenDeployment API.

GetBlueGreenDeployment(GetBlueGreenDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a blue/green deployment by identifier.

Declaration

public Task<GetBlueGreenDeploymentResponse> GetBlueGreenDeployment(GetBlueGreenDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBlueGreenDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetBlueGreenDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetBlueGreenDeployment API.

ListBlueGreenDeployments(ListBlueGreenDeploymentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists blue/green deployments in a compartment.

Declaration

public Task<ListBlueGreenDeploymentsResponse> ListBlueGreenDeployments(ListBlueGreenDeploymentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBlueGreenDeploymentsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListBlueGreenDeploymentsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListBlueGreenDeployments API.

SwitchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates switchover for a blue/green deployment. <br/> 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. <br/> 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. <br/> Switchover outcome and partial/failure conditions are surfaced through lifecycleState, lifecycleDetails, switchoverStatus, and activeDbSystemId in the blue/green deployment resource. <br/> 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.

Declaration

public Task<SwitchoverBlueGreenDeploymentResponse> SwitchoverBlueGreenDeployment(SwitchoverBlueGreenDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SwitchoverBlueGreenDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SwitchoverBlueGreenDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SwitchoverBlueGreenDeployment API.

UpdateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates mutable metadata for a blue/green deployment. Currently only displayName, freeformTags, and definedTags can be changed.

Declaration

public Task<UpdateBlueGreenDeploymentResponse> UpdateBlueGreenDeployment(UpdateBlueGreenDeploymentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateBlueGreenDeploymentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateBlueGreenDeploymentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateBlueGreenDeployment API.

Implements

IDisposable