All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.oracle.bmc.psql.PostgresqlAsync Maven / Gradle / Ivy

There is a newer version: 3.53.1
Show newest version
/**
 * Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
package com.oracle.bmc.psql;

import com.oracle.bmc.psql.requests.*;
import com.oracle.bmc.psql.responses.*;

/**
 * Use the OCI Database with PostgreSQL API to manage resources such as database systems, database
 * nodes, backups, and configurations. For information, see the user guide documentation for the
 * [service](https://docs.cloud.oracle.com/iaas/Content/postgresql/home.htm).
 */
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20220915")
public interface PostgresqlAsync extends AutoCloseable {

    /** Rebuilds the client from scratch. Useful to refresh certificates. */
    void refreshClient();

    /**
     * Sets the endpoint to call (ex, https://www.example.com).
     *
     * @param endpoint The endpoint of the serice.
     */
    void setEndpoint(String endpoint);

    /** Gets the set endpoint for REST call (ex, https://www.example.com) */
    String getEndpoint();

    /**
     * Sets the region to call (ex, Region.US_PHOENIX_1).
     *
     * 

Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the * endpoint. If the service is not available in this region, however, an * IllegalArgumentException will be raised. * * @param region The region of the service. */ void setRegion(com.oracle.bmc.Region region); /** * 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 {@link * #setRegion(Region) setRegion}. * *

If no known Region could be determined, it will create an endpoint based on the default * endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)} * and then call {@link #setEndpoint(String) setEndpoint}. * * @param regionId The public region ID. */ void setRegion(String regionId); /** * Determines whether realm specific endpoint should be used or not. Set * realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm * specific endpoint template, otherwise set it to "false" * * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint * template */ void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled); /** * Moves a backup from one compartment to another. When provided, If-Match is checked against * ETag values of the resource. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future changeBackupCompartment( ChangeBackupCompartmentRequest request, com.oracle.bmc.responses.AsyncHandler< ChangeBackupCompartmentRequest, ChangeBackupCompartmentResponse> handler); /** * Moves a configuration from one compartment to another. When provided, If-Match is checked * against ETag values of the resource. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future changeConfigurationCompartment( ChangeConfigurationCompartmentRequest request, com.oracle.bmc.responses.AsyncHandler< ChangeConfigurationCompartmentRequest, ChangeConfigurationCompartmentResponse> handler); /** * Moves a database system from one compartment to another. When provided, If-Match is checked * against ETag values of the resource. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future changeDbSystemCompartment( ChangeDbSystemCompartmentRequest request, com.oracle.bmc.responses.AsyncHandler< ChangeDbSystemCompartmentRequest, ChangeDbSystemCompartmentResponse> handler); /** * Creates a new backup. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future createBackup( CreateBackupRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Creates a new configuration. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future createConfiguration( CreateConfigurationRequest request, com.oracle.bmc.responses.AsyncHandler< CreateConfigurationRequest, CreateConfigurationResponse> handler); /** * Creates a new database system. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future createDbSystem( CreateDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Deletes a backup by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future deleteBackup( DeleteBackupRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Deletes a configuration by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future deleteConfiguration( DeleteConfigurationRequest request, com.oracle.bmc.responses.AsyncHandler< DeleteConfigurationRequest, DeleteConfigurationResponse> handler); /** * Deletes a database system by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future deleteDbSystem( DeleteDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Runs a failover operation. Optionally, specify the desired AD for regions with three ADs. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future failoverDbSystem( FailoverDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Gets a backup by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getBackup( GetBackupRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Gets a configuration by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getConfiguration( GetConfigurationRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Gets the database system connection details. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getConnectionDetails( GetConnectionDetailsRequest request, com.oracle.bmc.responses.AsyncHandler< GetConnectionDetailsRequest, GetConnectionDetailsResponse> handler); /** * Gets a database system by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getDbSystem( GetDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Gets a default configuration by identifier. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getDefaultConfiguration( GetDefaultConfigurationRequest request, com.oracle.bmc.responses.AsyncHandler< GetDefaultConfigurationRequest, GetDefaultConfigurationResponse> handler); /** * Gets the primary database instance node details. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getPrimaryDbInstance( GetPrimaryDbInstanceRequest request, com.oracle.bmc.responses.AsyncHandler< GetPrimaryDbInstanceRequest, GetPrimaryDbInstanceResponse> handler); /** * Gets details of the work request with the given ID. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future getWorkRequest( GetWorkRequestRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Returns a list of backups. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listBackups( ListBackupsRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Returns a list of configurations. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listConfigurations( ListConfigurationsRequest request, com.oracle.bmc.responses.AsyncHandler< ListConfigurationsRequest, ListConfigurationsResponse> handler); /** * Returns a list of database systems. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listDbSystems( ListDbSystemsRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Returns a list of default configurations. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listDefaultConfigurations( ListDefaultConfigurationsRequest request, com.oracle.bmc.responses.AsyncHandler< ListDefaultConfigurationsRequest, ListDefaultConfigurationsResponse> handler); /** * Returns the list of shapes allowed in the region. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listShapes( ListShapesRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Returns a (paginated) list of errors for the work request with the given ID. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listWorkRequestErrors( ListWorkRequestErrorsRequest request, com.oracle.bmc.responses.AsyncHandler< ListWorkRequestErrorsRequest, ListWorkRequestErrorsResponse> handler); /** * Returns a (paginated) list of logs for the work request with the given ID. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listWorkRequestLogs( ListWorkRequestLogsRequest request, com.oracle.bmc.responses.AsyncHandler< ListWorkRequestLogsRequest, ListWorkRequestLogsResponse> handler); /** * Lists the work requests in a compartment. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future listWorkRequests( ListWorkRequestsRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Modifies the database system by adding or removing database instance nodes. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future patchDbSystem( PatchDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Resets the database system's master password. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future resetMasterUserPassword( ResetMasterUserPasswordRequest request, com.oracle.bmc.responses.AsyncHandler< ResetMasterUserPasswordRequest, ResetMasterUserPasswordResponse> handler); /** * Restarts the running database instance node. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future restartDbInstanceInDbSystem( RestartDbInstanceInDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler< RestartDbInstanceInDbSystemRequest, RestartDbInstanceInDbSystemResponse> handler); /** * Restore the database system. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future restoreDbSystem( RestoreDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Updates the backup. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future updateBackup( UpdateBackupRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Updates a display name or description of the configuration. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future updateConfiguration( UpdateConfigurationRequest request, com.oracle.bmc.responses.AsyncHandler< UpdateConfigurationRequest, UpdateConfigurationResponse> handler); /** * Updates the database system. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future updateDbSystem( UpdateDbSystemRequest request, com.oracle.bmc.responses.AsyncHandler handler); /** * Updates the database instance node. * * @param request The request object containing the details to send * @param handler The request handler to invoke upon completion, may be null. * @return A Future that can be used to get the response if no AsyncHandler was provided. Note, * if you provide an AsyncHandler and use the Future, some types of responses (like * java.io.InputStream) may not be able to be read in both places as the underlying stream * may only be consumed once. */ java.util.concurrent.Future updateDbSystemDbInstance( UpdateDbSystemDbInstanceRequest request, com.oracle.bmc.responses.AsyncHandler< UpdateDbSystemDbInstanceRequest, UpdateDbSystemDbInstanceResponse> handler); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy