com.oracle.bmc.goldengate

Class GoldenGateClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.goldengate.GoldenGateClient

All Implemented Interfaces:

GoldenGate, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public class GoldenGateClient
extends BaseSyncClient
implements GoldenGate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GoldenGateClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for GoldenGate.

Constructor Summary

Constructors

Constructor and Description
GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
AddConnectionLockResponse	addConnectionLock(AddConnectionLockRequest request) Adds a lock to a Connection resource.
AddDeploymentBackupLockResponse	addDeploymentBackupLock(AddDeploymentBackupLockRequest request) Adds a lock to a DeploymentBackup resource.
AddDeploymentLockResponse	addDeploymentLock(AddDeploymentLockRequest request) Adds a lock to a Deployment resource.
static GoldenGateClient.Builder	builder() Create a builder for this client.
CancelDeploymentBackupResponse	cancelDeploymentBackup(CancelDeploymentBackupRequest request) Cancels a Deployment Backup creation process.
CancelDeploymentUpgradeResponse	cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request) Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
CancelSnoozeDeploymentUpgradeResponse	cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request) Cancel snooze of a DeploymentUpgrade.
ChangeConnectionCompartmentResponse	changeConnectionCompartment(ChangeConnectionCompartmentRequest request) Moves the Connection into a different compartment within the same tenancy.
ChangeDatabaseRegistrationCompartmentResponse	changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request) Note: Deprecated.
ChangeDeploymentBackupCompartmentResponse	changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request) Moves a DeploymentBackup into a different compartment within the same tenancy.
ChangeDeploymentCompartmentResponse	changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request) Moves the Deployment into a different compartment within the same tenancy.
void	close()
CollectDeploymentDiagnosticResponse	collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request) Collects the diagnostic of a Deployment.
CopyDeploymentBackupResponse	copyDeploymentBackup(CopyDeploymentBackupRequest request) Creates a copy of a Deployment Backup.
CreateCertificateResponse	createCertificate(CreateCertificateRequest request) Creates a new certificate to truststore.
CreateConnectionResponse	createConnection(CreateConnectionRequest request) Creates a new Connection.
CreateConnectionAssignmentResponse	createConnectionAssignment(CreateConnectionAssignmentRequest request) Creates a new Connection Assignment.
CreateDatabaseRegistrationResponse	createDatabaseRegistration(CreateDatabaseRegistrationRequest request) Note: Deprecated.
CreateDeploymentResponse	createDeployment(CreateDeploymentRequest request) Creates a new Deployment.
CreateDeploymentBackupResponse	createDeploymentBackup(CreateDeploymentBackupRequest request) Creates a new DeploymentBackup.
DeleteCertificateResponse	deleteCertificate(DeleteCertificateRequest request) Deletes the certificate from truststore.
DeleteConnectionResponse	deleteConnection(DeleteConnectionRequest request) Deletes a Connection.
DeleteConnectionAssignmentResponse	deleteConnectionAssignment(DeleteConnectionAssignmentRequest request) Deletes a Connection Assignment.
DeleteDatabaseRegistrationResponse	deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request) Note: Deprecated.
DeleteDeploymentResponse	deleteDeployment(DeleteDeploymentRequest request) Deletes the Deployment.
DeleteDeploymentBackupResponse	deleteDeploymentBackup(DeleteDeploymentBackupRequest request) Deletes a DeploymentBackup.
DeploymentWalletExistsResponse	deploymentWalletExists(DeploymentWalletExistsRequest request) Checks if a wallet is already present in the deployment.
ExportDeploymentWalletResponse	exportDeploymentWallet(ExportDeploymentWalletRequest request) Export the OGG wallet from the deployment to OCI vault.
GenerateLibraryUrlResponse	generateLibraryUrl(GenerateLibraryUrlRequest request) Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it.
GetCertificateResponse	getCertificate(GetCertificateRequest request) Retrieves a Certificate.
String	getClientCommonLibraryVersion()
GetConnectionResponse	getConnection(GetConnectionRequest request) Retrieves a Connection.
GetConnectionAssignmentResponse	getConnectionAssignment(GetConnectionAssignmentRequest request) Retrieves a Connection Assignment.
GetDatabaseRegistrationResponse	getDatabaseRegistration(GetDatabaseRegistrationRequest request) Note: Deprecated.
protected ClientConfigurator	getDefaultConfigurator()
GetDeploymentResponse	getDeployment(GetDeploymentRequest request) Retrieves a deployment.
GetDeploymentBackupResponse	getDeploymentBackup(GetDeploymentBackupRequest request) Retrieves a DeploymentBackup.
GetDeploymentUpgradeResponse	getDeploymentUpgrade(GetDeploymentUpgradeRequest request) Retrieves a deployment upgrade.
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
GoldenGatePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GoldenGateWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Retrieve the WorkRequest identified by the given OCID.
ImportDeploymentWalletResponse	importDeploymentWallet(ImportDeploymentWalletRequest request) Imports an OGG wallet from the OCI Vault to the Deployment.
ListCertificatesResponse	listCertificates(ListCertificatesRequest request) Returns a list of certificates from truststore.
ListConnectionAssignmentsResponse	listConnectionAssignments(ListConnectionAssignmentsRequest request) Lists the Connection Assignments in the compartment.
ListConnectionsResponse	listConnections(ListConnectionsRequest request) Lists the Connections in the compartment.
ListDatabaseRegistrationsResponse	listDatabaseRegistrations(ListDatabaseRegistrationsRequest request) Note: Deprecated.
ListDeploymentBackupsResponse	listDeploymentBackups(ListDeploymentBackupsRequest request) Lists the Backups in a compartment.
ListDeploymentEnvironmentsResponse	listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request) Returns an array of DeploymentEnvironmentDescriptor
ListDeploymentsResponse	listDeployments(ListDeploymentsRequest request) Lists the Deployments in a compartment.
ListDeploymentTypesResponse	listDeploymentTypes(ListDeploymentTypesRequest request) Returns an array of DeploymentTypeDescriptor
ListDeploymentUpgradesResponse	listDeploymentUpgrades(ListDeploymentUpgradesRequest request) Lists the Deployment Upgrades in a compartment.
ListDeploymentVersionsResponse	listDeploymentVersions(ListDeploymentVersionsRequest request) Returns the list of available deployment versions.
ListDeploymentWalletsOperationsResponse	listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request) Lists the wallets export/import operations to/from a deployment.
ListMessagesResponse	listMessages(ListMessagesRequest request) Lists the DeploymentMessages for a deployment.
ListTrailFilesResponse	listTrailFiles(ListTrailFilesRequest request) Lists the TrailFiles for a deployment.
ListTrailSequencesResponse	listTrailSequences(ListTrailSequencesRequest request) Lists the Trail Sequences for a TrailFile in a given deployment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Lists work request errors.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Lists work request logs.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in the compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
RefreshConnectionResponse	refreshConnection(RefreshConnectionRequest request) Refresh the external Connection attributes.
RemoveConnectionLockResponse	removeConnectionLock(RemoveConnectionLockRequest request) Removes a lock from a Connection resource.
RemoveDeploymentBackupLockResponse	removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request) Removes a lock from a DeploymentBackup resource.
RemoveDeploymentLockResponse	removeDeploymentLock(RemoveDeploymentLockRequest request) Removes a lock from a Deployment resource.
RescheduleDeploymentUpgradeResponse	rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request) Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state.
RestoreDeploymentResponse	restoreDeployment(RestoreDeploymentRequest request) Restores a Deployment from a Deployment Backup created from the same Deployment.
RollbackDeploymentUpgradeResponse	rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request) Rollback a deployment to it’s previous version.
void	setEndpoint(String endpoint)
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’).
SnoozeDeploymentUpgradeResponse	snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request) Snooze a DeploymentUpgrade.
StartDeploymentResponse	startDeployment(StartDeploymentRequest request) Starts a Deployment.
StopDeploymentResponse	stopDeployment(StopDeploymentRequest request) Stops a Deployment.
TestConnectionAssignmentResponse	testConnectionAssignment(TestConnectionAssignmentRequest request) Tests the connectivity between given GoldenGate deployment and one of the associated database / service.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateConnectionResponse	updateConnection(UpdateConnectionRequest request) Updates the Connection.
UpdateDatabaseRegistrationResponse	updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request) Note: Deprecated.
UpdateDeploymentResponse	updateDeployment(UpdateDeploymentRequest request) Modifies a Deployment.
UpdateDeploymentBackupResponse	updateDeploymentBackup(UpdateDeploymentBackupRequest request) Modifies a Deployment Backup.
UpgradeDeploymentResponse	upgradeDeployment(UpgradeDeploymentRequest request) Upgrade a Deployment.
UpgradeDeploymentUpgradeResponse	upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request) Upgrade a deployment.
void	useRealmSpecificEndpointTemplate(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 com.oracle.bmc.goldengate.GoldenGate

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for GoldenGate.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

GoldenGateClient

@Deprecated
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

GoldenGateClient

@Deprecated
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

GoldenGateClient

@Deprecated
public GoldenGateClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

GoldenGateClient

@Deprecated
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

GoldenGateClient

@Deprecated
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

GoldenGateClient

@Deprecated
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

GoldenGateClient

@Deprecated
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

GoldenGateClient

@Deprecated
public GoldenGateClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory,
                                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                    List<ClientConfigurator> additionalClientConfigurators,
                                    String endpoint,
                                    ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see GoldenGateClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - GoldenGateClient.Builder.executorService

Method Detail

builder

public static GoldenGateClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: GoldenGate

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.

Specified by:

setRegion in interface GoldenGate

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: GoldenGate

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.

Specified by:

setRegion in interface GoldenGate

Parameters:

regionId - The public region ID.

addConnectionLock

public AddConnectionLockResponse addConnectionLock(AddConnectionLockRequest request)

Description copied from interface: GoldenGate

Adds a lock to a Connection resource.

Specified by:

addConnectionLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addDeploymentBackupLock

public AddDeploymentBackupLockResponse addDeploymentBackupLock(AddDeploymentBackupLockRequest request)

Description copied from interface: GoldenGate

Adds a lock to a DeploymentBackup resource.

Specified by:

addDeploymentBackupLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

addDeploymentLock

public AddDeploymentLockResponse addDeploymentLock(AddDeploymentLockRequest request)

Description copied from interface: GoldenGate

Adds a lock to a Deployment resource.

Specified by:

addDeploymentLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelDeploymentBackup

public CancelDeploymentBackupResponse cancelDeploymentBackup(CancelDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Cancels a Deployment Backup creation process.

Specified by:

cancelDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelDeploymentUpgrade

public CancelDeploymentUpgradeResponse cancelDeploymentUpgrade(CancelDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Cancels a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Specified by:

cancelDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

cancelSnoozeDeploymentUpgrade

public CancelSnoozeDeploymentUpgradeResponse cancelSnoozeDeploymentUpgrade(CancelSnoozeDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Cancel snooze of a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Specified by:

cancelSnoozeDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeConnectionCompartment

public ChangeConnectionCompartmentResponse changeConnectionCompartment(ChangeConnectionCompartmentRequest request)

Description copied from interface: GoldenGate

Moves the Connection into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeConnectionCompartment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDatabaseRegistrationCompartment

public ChangeDatabaseRegistrationCompartmentResponse changeDatabaseRegistrationCompartment(ChangeDatabaseRegistrationCompartmentRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Moves the DatabaseRegistration into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeDatabaseRegistrationCompartment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDeploymentBackupCompartment

public ChangeDeploymentBackupCompartmentResponse changeDeploymentBackupCompartment(ChangeDeploymentBackupCompartmentRequest request)

Description copied from interface: GoldenGate

Moves a DeploymentBackup into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeDeploymentBackupCompartment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeDeploymentCompartment

public ChangeDeploymentCompartmentResponse changeDeploymentCompartment(ChangeDeploymentCompartmentRequest request)

Description copied from interface: GoldenGate

Moves the Deployment into a different compartment within the same tenancy. When provided, If-Match is checked against ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeDeploymentCompartment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

collectDeploymentDiagnostic

public CollectDeploymentDiagnosticResponse collectDeploymentDiagnostic(CollectDeploymentDiagnosticRequest request)

Description copied from interface: GoldenGate

Collects the diagnostic of a Deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

collectDeploymentDiagnostic in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

copyDeploymentBackup

public CopyDeploymentBackupResponse copyDeploymentBackup(CopyDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Creates a copy of a Deployment Backup.

Specified by:

copyDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCertificate

public CreateCertificateResponse createCertificate(CreateCertificateRequest request)

Description copied from interface: GoldenGate

Creates a new certificate to truststore.

Specified by:

createCertificate in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createConnection

public CreateConnectionResponse createConnection(CreateConnectionRequest request)

Description copied from interface: GoldenGate

Creates a new Connection.

Specified by:

createConnection in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createConnectionAssignment

public CreateConnectionAssignmentResponse createConnectionAssignment(CreateConnectionAssignmentRequest request)

Description copied from interface: GoldenGate

Creates a new Connection Assignment.

Specified by:

createConnectionAssignment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDatabaseRegistration

public CreateDatabaseRegistrationResponse createDatabaseRegistration(CreateDatabaseRegistrationRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Creates a new DatabaseRegistration.

Specified by:

createDatabaseRegistration in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDeployment

public CreateDeploymentResponse createDeployment(CreateDeploymentRequest request)

Description copied from interface: GoldenGate

Creates a new Deployment.

Specified by:

createDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDeploymentBackup

public CreateDeploymentBackupResponse createDeploymentBackup(CreateDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Creates a new DeploymentBackup.

Specified by:

createDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteCertificate

public DeleteCertificateResponse deleteCertificate(DeleteCertificateRequest request)

Description copied from interface: GoldenGate

Deletes the certificate from truststore.

Specified by:

deleteCertificate in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteConnection

public DeleteConnectionResponse deleteConnection(DeleteConnectionRequest request)

Description copied from interface: GoldenGate

Deletes a Connection.

Specified by:

deleteConnection in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteConnectionAssignment

public DeleteConnectionAssignmentResponse deleteConnectionAssignment(DeleteConnectionAssignmentRequest request)

Description copied from interface: GoldenGate

Deletes a Connection Assignment.

Specified by:

deleteConnectionAssignment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDatabaseRegistration

public DeleteDatabaseRegistrationResponse deleteDatabaseRegistration(DeleteDatabaseRegistrationRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Deletes a DatabaseRegistration.

Specified by:

deleteDatabaseRegistration in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDeployment

public DeleteDeploymentResponse deleteDeployment(DeleteDeploymentRequest request)

Description copied from interface: GoldenGate

Deletes the Deployment.

Specified by:

deleteDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDeploymentBackup

public DeleteDeploymentBackupResponse deleteDeploymentBackup(DeleteDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Deletes a DeploymentBackup.

Specified by:

deleteDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deploymentWalletExists

public DeploymentWalletExistsResponse deploymentWalletExists(DeploymentWalletExistsRequest request)

Description copied from interface: GoldenGate

Checks if a wallet is already present in the deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

deploymentWalletExists in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

exportDeploymentWallet

public ExportDeploymentWalletResponse exportDeploymentWallet(ExportDeploymentWalletRequest request)

Description copied from interface: GoldenGate

Export the OGG wallet from the deployment to OCI vault. When provided, If-Match is checked against ETag values of the resource.

Specified by:

exportDeploymentWallet in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

generateLibraryUrl

public GenerateLibraryUrlResponse generateLibraryUrl(GenerateLibraryUrlRequest request)

Description copied from interface: GoldenGate

Generates a Pre-Authenticated Request Object URL to a DB2 for z/OS library that needs to be uploaded to your DB2 for z/OS server in order to establish GoldenGate connections to it. For licensing reasons, the URL is accessible for 10 minutes only.

Specified by:

generateLibraryUrl in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificate

public GetCertificateResponse getCertificate(GetCertificateRequest request)

Description copied from interface: GoldenGate

Retrieves a Certificate.

Specified by:

getCertificate in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConnection

public GetConnectionResponse getConnection(GetConnectionRequest request)

Description copied from interface: GoldenGate

Retrieves a Connection.

Specified by:

getConnection in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConnectionAssignment

public GetConnectionAssignmentResponse getConnectionAssignment(GetConnectionAssignmentRequest request)

Description copied from interface: GoldenGate

Retrieves a Connection Assignment.

Specified by:

getConnectionAssignment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDatabaseRegistration

public GetDatabaseRegistrationResponse getDatabaseRegistration(GetDatabaseRegistrationRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Retrieves a DatabaseRegistration.

Specified by:

getDatabaseRegistration in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDeployment

public GetDeploymentResponse getDeployment(GetDeploymentRequest request)

Description copied from interface: GoldenGate

Retrieves a deployment.

Specified by:

getDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDeploymentBackup

public GetDeploymentBackupResponse getDeploymentBackup(GetDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Retrieves a DeploymentBackup.

Specified by:

getDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDeploymentUpgrade

public GetDeploymentUpgradeResponse getDeploymentUpgrade(GetDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Retrieves a deployment upgrade.

Specified by:

getDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: GoldenGate

Retrieve the WorkRequest identified by the given OCID.

Specified by:

getWorkRequest in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

importDeploymentWallet

public ImportDeploymentWalletResponse importDeploymentWallet(ImportDeploymentWalletRequest request)

Description copied from interface: GoldenGate

Imports an OGG wallet from the OCI Vault to the Deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

importDeploymentWallet in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificates

public ListCertificatesResponse listCertificates(ListCertificatesRequest request)

Description copied from interface: GoldenGate

Returns a list of certificates from truststore.

Specified by:

listCertificates in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listConnectionAssignments

public ListConnectionAssignmentsResponse listConnectionAssignments(ListConnectionAssignmentsRequest request)

Description copied from interface: GoldenGate

Lists the Connection Assignments in the compartment.

Specified by:

listConnectionAssignments in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listConnections

public ListConnectionsResponse listConnections(ListConnectionsRequest request)

Description copied from interface: GoldenGate

Lists the Connections in the compartment.

Specified by:

listConnections in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDatabaseRegistrations

public ListDatabaseRegistrationsResponse listDatabaseRegistrations(ListDatabaseRegistrationsRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Lists the DatabaseRegistrations in the compartment.

Specified by:

listDatabaseRegistrations in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentBackups

public ListDeploymentBackupsResponse listDeploymentBackups(ListDeploymentBackupsRequest request)

Description copied from interface: GoldenGate

Lists the Backups in a compartment.

Specified by:

listDeploymentBackups in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentEnvironments

public ListDeploymentEnvironmentsResponse listDeploymentEnvironments(ListDeploymentEnvironmentsRequest request)

Description copied from interface: GoldenGate

Returns an array of DeploymentEnvironmentDescriptor

Specified by:

listDeploymentEnvironments in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentTypes

public ListDeploymentTypesResponse listDeploymentTypes(ListDeploymentTypesRequest request)

Description copied from interface: GoldenGate

Returns an array of DeploymentTypeDescriptor

Specified by:

listDeploymentTypes in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentUpgrades

public ListDeploymentUpgradesResponse listDeploymentUpgrades(ListDeploymentUpgradesRequest request)

Description copied from interface: GoldenGate

Lists the Deployment Upgrades in a compartment.

Specified by:

listDeploymentUpgrades in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentVersions

public ListDeploymentVersionsResponse listDeploymentVersions(ListDeploymentVersionsRequest request)

Description copied from interface: GoldenGate

Returns the list of available deployment versions.

Specified by:

listDeploymentVersions in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeploymentWalletsOperations

public ListDeploymentWalletsOperationsResponse listDeploymentWalletsOperations(ListDeploymentWalletsOperationsRequest request)

Description copied from interface: GoldenGate

Lists the wallets export/import operations to/from a deployment.

Specified by:

listDeploymentWalletsOperations in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDeployments

public ListDeploymentsResponse listDeployments(ListDeploymentsRequest request)

Description copied from interface: GoldenGate

Lists the Deployments in a compartment.

Specified by:

listDeployments in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMessages

public ListMessagesResponse listMessages(ListMessagesRequest request)

Description copied from interface: GoldenGate

Lists the DeploymentMessages for a deployment. The sorting order is not important. By default first will be Upgrade message, next Exception message and then Storage Utilization message.

Specified by:

listMessages in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTrailFiles

public ListTrailFilesResponse listTrailFiles(ListTrailFilesRequest request)

Description copied from interface: GoldenGate

Lists the TrailFiles for a deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

Specified by:

listTrailFiles in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listTrailSequences

public ListTrailSequencesResponse listTrailSequences(ListTrailSequencesRequest request)

Description copied from interface: GoldenGate

Lists the Trail Sequences for a TrailFile in a given deployment. Deprecated: Please access trail file management functions directly on OGG console which are available since version Oracle GoldenGate 23c.

Specified by:

listTrailSequences in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: GoldenGate

Lists work request errors.

Specified by:

listWorkRequestErrors in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: GoldenGate

Lists work request logs.

Specified by:

listWorkRequestLogs in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: GoldenGate

Lists the work requests in the compartment.

Specified by:

listWorkRequests in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

refreshConnection

public RefreshConnectionResponse refreshConnection(RefreshConnectionRequest request)

Description copied from interface: GoldenGate

Refresh the external Connection attributes.

Specified by:

refreshConnection in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeConnectionLock

public RemoveConnectionLockResponse removeConnectionLock(RemoveConnectionLockRequest request)

Description copied from interface: GoldenGate

Removes a lock from a Connection resource.

Specified by:

removeConnectionLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeDeploymentBackupLock

public RemoveDeploymentBackupLockResponse removeDeploymentBackupLock(RemoveDeploymentBackupLockRequest request)

Description copied from interface: GoldenGate

Removes a lock from a DeploymentBackup resource.

Specified by:

removeDeploymentBackupLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeDeploymentLock

public RemoveDeploymentLockResponse removeDeploymentLock(RemoveDeploymentLockRequest request)

Description copied from interface: GoldenGate

Removes a lock from a Deployment resource.

Specified by:

removeDeploymentLock in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rescheduleDeploymentUpgrade

public RescheduleDeploymentUpgradeResponse rescheduleDeploymentUpgrade(RescheduleDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Reschedules a DeploymentUpgrade, applicable only for DeploymentUpgrade in Waiting state. When provided, If-Match is checked against ETag values of the resource.

Specified by:

rescheduleDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

restoreDeployment

public RestoreDeploymentResponse restoreDeployment(RestoreDeploymentRequest request)

Description copied from interface: GoldenGate

Restores a Deployment from a Deployment Backup created from the same Deployment.

Specified by:

restoreDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rollbackDeploymentUpgrade

public RollbackDeploymentUpgradeResponse rollbackDeploymentUpgrade(RollbackDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Rollback a deployment to it’s previous version. When provided, If-Match is checked against ETag values of the resource.

Specified by:

rollbackDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

snoozeDeploymentUpgrade

public SnoozeDeploymentUpgradeResponse snoozeDeploymentUpgrade(SnoozeDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Snooze a DeploymentUpgrade. When provided, If-Match is checked against ETag values of the resource.

Specified by:

snoozeDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startDeployment

public StartDeploymentResponse startDeployment(StartDeploymentRequest request)

Description copied from interface: GoldenGate

Starts a Deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

startDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopDeployment

public StopDeploymentResponse stopDeployment(StopDeploymentRequest request)

Description copied from interface: GoldenGate

Stops a Deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

stopDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

testConnectionAssignment

public TestConnectionAssignmentResponse testConnectionAssignment(TestConnectionAssignmentRequest request)

Description copied from interface: GoldenGate

Tests the connectivity between given GoldenGate deployment and one of the associated database / service. When provided, If-Match is checked against ETag values of the resource.

Specified by:

testConnectionAssignment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConnection

public UpdateConnectionResponse updateConnection(UpdateConnectionRequest request)

Description copied from interface: GoldenGate

Updates the Connection.

Specified by:

updateConnection in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDatabaseRegistration

public UpdateDatabaseRegistrationResponse updateDatabaseRegistration(UpdateDatabaseRegistrationRequest request)

Description copied from interface: GoldenGate

Note: Deprecated. Use the /connections API instead. Updates the DatabaseRegistration.

Specified by:

updateDatabaseRegistration in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDeployment

public UpdateDeploymentResponse updateDeployment(UpdateDeploymentRequest request)

Description copied from interface: GoldenGate

Modifies a Deployment.

Specified by:

updateDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDeploymentBackup

public UpdateDeploymentBackupResponse updateDeploymentBackup(UpdateDeploymentBackupRequest request)

Description copied from interface: GoldenGate

Modifies a Deployment Backup.

Specified by:

updateDeploymentBackup in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

upgradeDeployment

public UpgradeDeploymentResponse upgradeDeployment(UpgradeDeploymentRequest request)

Description copied from interface: GoldenGate

Upgrade a Deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

upgradeDeployment in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

upgradeDeploymentUpgrade

public UpgradeDeploymentUpgradeResponse upgradeDeploymentUpgrade(UpgradeDeploymentUpgradeRequest request)

Description copied from interface: GoldenGate

Upgrade a deployment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

upgradeDeploymentUpgrade in interface GoldenGate

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public GoldenGateWaiters getWaiters()

Description copied from interface: GoldenGate

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface GoldenGate

Returns:

The service waiters.

getPaginators

public GoldenGatePaginators getPaginators()

Description copied from interface: GoldenGate

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.

Specified by:

getPaginators in interface GoldenGate

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

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

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()