Class BaseinfraClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.datacc.BaseinfraClient
-
- All Implemented Interfaces:
Baseinfra,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20251101") public class BaseinfraClient extends BaseSyncClient implements Baseinfra
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBaseinfraClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Baseinfra.
-
Constructor Summary
Constructors Constructor Description BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ActivateInfrastructureResponseactivateInfrastructure(ActivateInfrastructureRequest request)Activate an Database Infrastructure using the specified details.static BaseinfraClient.Builderbuilder()Create a builder for this client.ChangeInfrastructureCompartmentResponsechangeInfrastructureCompartment(ChangeInfrastructureCompartmentRequest request)Change the Database Infrastructure Cloud@Customer Compartment to the specified OCID.ChangeVmClusterNetworkCompartmentResponsechangeVmClusterNetworkCompartment(ChangeVmClusterNetworkCompartmentRequest request)Change the VM cluster network Compartment to the specified OCID.ChangeVmInstanceCompartmentResponsechangeVmInstanceCompartment(ChangeVmInstanceCompartmentRequest request)Change the VM instance on Database Infrastructure Compartment to the specified OCID.voidclose()CreateInfrastructureResponsecreateInfrastructure(CreateInfrastructureRequest request)Create a Database Infrastructure using the specified details.CreateVmClusterNetworkResponsecreateVmClusterNetwork(CreateVmClusterNetworkRequest request)Create an VM cluster on Database Infrastructure network using the specified details.CreateVmInstanceResponsecreateVmInstance(CreateVmInstanceRequest request)Create an VM instance on Database Infrastructure using the specified details.DeleteInfrastructureResponsedeleteInfrastructure(DeleteInfrastructureRequest request)Delete the Database Infrastructure that has the specified OCID.DeleteVmClusterNetworkResponsedeleteVmClusterNetwork(DeleteVmClusterNetworkRequest request)Delete the VM cluster network on Database Infrastructure that has the specified OCID.DeleteVmInstanceResponsedeleteVmInstance(DeleteVmInstanceRequest request)Delete the VM instance on Database Infrastructure that has the specified OCID.DownloadInfrastructureConfigFileResponsedownloadInfrastructureConfigFile(DownloadInfrastructureConfigFileRequest request)Downloads the configuration file for the specified Database Infrastructure Cloud@Customer.DownloadInfrastructureValidationScriptResponsedownloadInfrastructureValidationScript(DownloadInfrastructureValidationScriptRequest request)Downloads the validation script for the specified Database Infrastructure Cloud@Customer.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GenerateRecommendedVmClusterNetworkResponsegenerateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request)Generates an VM cluster network configuration using the specified details.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetInfrastructureResponsegetInfrastructure(GetInfrastructureRequest request)Obtain the Database Infrastructure that has the specified OCID.GetInfrastructureScaleOptionResponsegetInfrastructureScaleOption(GetInfrastructureScaleOptionRequest request)Get the available scale options for the infrastructure that has the specified OCID.GetMaintenanceExecutionResponsegetMaintenanceExecution(GetMaintenanceExecutionRequest request)Gets information about the specified OCID.GetMaintenanceRunResponsegetMaintenanceRun(GetMaintenanceRunRequest request)Gets information about the specified OCID.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.BaseinfraPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.StringgetResolvedEndpoint(Map<String,Object> requiredParametersMap)Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.GetVmClusterNetworkResponsegetVmClusterNetwork(GetVmClusterNetworkRequest request)Obtain the VM cluster network on Database Infrastructure that has the specified OCID.GetVmInstanceResponsegetVmInstance(GetVmInstanceRequest request)Obtain the VM instance on Database Infrastructure that has the specified OCID.BaseinfraWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.GetWorkRequestResponsegetWorkRequest(GetWorkRequestRequest request)Get the status of the work request having the specified work request OCID.ListInfrastructuresResponselistInfrastructures(ListInfrastructuresRequest request)Obtain a list of Database Infrastructures.ListMaintenanceExecutionsResponselistMaintenanceExecutions(ListMaintenanceExecutionsRequest request)Gets a list of the maintenance executions in the specified compartment.ListMaintenanceRunsResponselistMaintenanceRuns(ListMaintenanceRunsRequest request)Gets a list of the maintenance runs in the specified compartment.ListVmClusterNetworksResponselistVmClusterNetworks(ListVmClusterNetworksRequest request)Obtain a list of VM cluster networks on Database Infrastructure.ListVmInstancesResponselistVmInstances(ListVmInstancesRequest request)Obtain a list of VM instances.ListWorkRequestErrorsResponselistWorkRequestErrors(ListWorkRequestErrorsRequest request)View the list of errors for the work request that have the specified work request OCID.ListWorkRequestLogsResponselistWorkRequestLogs(ListWorkRequestLogsRequest request)View the log entries for the work request that have the specified work request OCID.ListWorkRequestsResponselistWorkRequests(ListWorkRequestsRequest request)View a list of work request details in the specified compartment.MigrateVmInstanceResponsemigrateVmInstance(MigrateVmInstanceRequest request)Migrate the VM instance on Database Infrastructure that has the specified OCID.voidrefreshClient()Rebuild the backingHttpClient.RescheduleMaintenanceRunResponserescheduleMaintenanceRun(RescheduleMaintenanceRunRequest request)Reschedules the specified maintenance run by providing a newtimeScheduledvalue.RestartVmInstanceResponserestartVmInstance(RestartVmInstanceRequest request)Restart the VM instance on Database Infrastructure that has the specified OCID.ScaleInfrastructureStorageResponsescaleInfrastructureStorage(ScaleInfrastructureStorageRequest request)Scale storage for the specified infrastructure using the specified details.ScaleVmInstanceResponsescaleVmInstance(ScaleVmInstanceRequest request)Scale the VM instance on Database Infrastructure that has the specified OCID.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).StartVmInstanceResponsestartVmInstance(StartVmInstanceRequest request)Start the VM instance on Database Infrastructure that has the specified OCID.StopVmInstanceResponsestopVmInstance(StopVmInstanceRequest request)Stop the VM instance on Database Infrastructure that has the specified OCID.UpdateInfrastructureResponseupdateInfrastructure(UpdateInfrastructureRequest request)Update the Database Infrastructure that has the specified OCID.UpdateMaintenanceRunResponseupdateMaintenanceRun(UpdateMaintenanceRunRequest request)Update maintenance run attributes.UpdateVmClusterNetworkResponseupdateVmClusterNetwork(UpdateVmClusterNetworkRequest request)Update the VM cluster network on Database Infrastructure that has the specified OCID.UpdateVmInstanceResponseupdateVmInstance(UpdateVmInstanceRequest request)Update the VM instance on Database Infrastructure that has the specified OCID.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.ValidateInfrastructureResponsevalidateInfrastructure(ValidateInfrastructureRequest request)Validate an Database Infrastructure using the specified details.ValidateVmClusterNetworkResponsevalidateVmClusterNetwork(ValidateVmClusterNetworkRequest request)Validates an VM cluster network on Database Infrastructure.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.datacc.Baseinfra
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
BaseinfraClient
@Deprecated public BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
BaseinfraClient
@Deprecated public BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
BaseinfraClient
@Deprecated public BaseinfraClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
BaseinfraClient
@Deprecated public BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
BaseinfraClient
@Deprecated public BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
BaseinfraClient
@Deprecated public BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)
-
BaseinfraClient
@Deprecated public BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactories
-
BaseinfraClient
@Deprecated public BaseinfraClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeBaseinfraClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-BaseinfraClient.Builder.executorService
-
-
Method Detail
-
builder
public static BaseinfraClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:BaseinfraSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:BaseinfraSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.
-
activateInfrastructure
public ActivateInfrastructureResponse activateInfrastructure(ActivateInfrastructureRequest request)
Description copied from interface:BaseinfraActivate an Database Infrastructure using the specified details.- Specified by:
activateInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeInfrastructureCompartment
public ChangeInfrastructureCompartmentResponse changeInfrastructureCompartment(ChangeInfrastructureCompartmentRequest request)
Description copied from interface:BaseinfraChange the Database Infrastructure Cloud@Customer Compartment to the specified OCID.- Specified by:
changeInfrastructureCompartmentin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeVmClusterNetworkCompartment
public ChangeVmClusterNetworkCompartmentResponse changeVmClusterNetworkCompartment(ChangeVmClusterNetworkCompartmentRequest request)
Description copied from interface:BaseinfraChange the VM cluster network Compartment to the specified OCID.- Specified by:
changeVmClusterNetworkCompartmentin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeVmInstanceCompartment
public ChangeVmInstanceCompartmentResponse changeVmInstanceCompartment(ChangeVmInstanceCompartmentRequest request)
Description copied from interface:BaseinfraChange the VM instance on Database Infrastructure Compartment to the specified OCID.- Specified by:
changeVmInstanceCompartmentin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createInfrastructure
public CreateInfrastructureResponse createInfrastructure(CreateInfrastructureRequest request)
Description copied from interface:BaseinfraCreate a Database Infrastructure using the specified details.- Specified by:
createInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createVmClusterNetwork
public CreateVmClusterNetworkResponse createVmClusterNetwork(CreateVmClusterNetworkRequest request)
Description copied from interface:BaseinfraCreate an VM cluster on Database Infrastructure network using the specified details.- Specified by:
createVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createVmInstance
public CreateVmInstanceResponse createVmInstance(CreateVmInstanceRequest request)
Description copied from interface:BaseinfraCreate an VM instance on Database Infrastructure using the specified details.- Specified by:
createVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteInfrastructure
public DeleteInfrastructureResponse deleteInfrastructure(DeleteInfrastructureRequest request)
Description copied from interface:BaseinfraDelete the Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteVmClusterNetwork
public DeleteVmClusterNetworkResponse deleteVmClusterNetwork(DeleteVmClusterNetworkRequest request)
Description copied from interface:BaseinfraDelete the VM cluster network on Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteVmInstance
public DeleteVmInstanceResponse deleteVmInstance(DeleteVmInstanceRequest request)
Description copied from interface:BaseinfraDelete the VM instance on Database Infrastructure that has the specified OCID.It must be called once the resource usage is complete.
- Specified by:
deleteVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadInfrastructureConfigFile
public DownloadInfrastructureConfigFileResponse downloadInfrastructureConfigFile(DownloadInfrastructureConfigFileRequest request)
Description copied from interface:BaseinfraDownloads the configuration file for the specified Database Infrastructure Cloud@Customer.- Specified by:
downloadInfrastructureConfigFilein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downloadInfrastructureValidationScript
public DownloadInfrastructureValidationScriptResponse downloadInfrastructureValidationScript(DownloadInfrastructureValidationScriptRequest request)
Description copied from interface:BaseinfraDownloads the validation script for the specified Database Infrastructure Cloud@Customer.- Specified by:
downloadInfrastructureValidationScriptin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
generateRecommendedVmClusterNetwork
public GenerateRecommendedVmClusterNetworkResponse generateRecommendedVmClusterNetwork(GenerateRecommendedVmClusterNetworkRequest request)
Description copied from interface:BaseinfraGenerates an VM cluster network configuration using the specified details.- Specified by:
generateRecommendedVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInfrastructure
public GetInfrastructureResponse getInfrastructure(GetInfrastructureRequest request)
Description copied from interface:BaseinfraObtain the Database Infrastructure that has the specified OCID.- Specified by:
getInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getInfrastructureScaleOption
public GetInfrastructureScaleOptionResponse getInfrastructureScaleOption(GetInfrastructureScaleOptionRequest request)
Description copied from interface:BaseinfraGet the available scale options for the infrastructure that has the specified OCID.- Specified by:
getInfrastructureScaleOptionin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaintenanceExecution
public GetMaintenanceExecutionResponse getMaintenanceExecution(GetMaintenanceExecutionRequest request)
Description copied from interface:BaseinfraGets information about the specified OCID.- Specified by:
getMaintenanceExecutionin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaintenanceRun
public GetMaintenanceRunResponse getMaintenanceRun(GetMaintenanceRunRequest request)
Description copied from interface:BaseinfraGets information about the specified OCID.- Specified by:
getMaintenanceRunin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVmClusterNetwork
public GetVmClusterNetworkResponse getVmClusterNetwork(GetVmClusterNetworkRequest request)
Description copied from interface:BaseinfraObtain the VM cluster network on Database Infrastructure that has the specified OCID.- Specified by:
getVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getVmInstance
public GetVmInstanceResponse getVmInstance(GetVmInstanceRequest request)
Description copied from interface:BaseinfraObtain the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
getVmInstancein interfaceBaseinfra- 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:BaseinfraGet the status of the work request having the specified work request OCID.- Specified by:
getWorkRequestin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInfrastructures
public ListInfrastructuresResponse listInfrastructures(ListInfrastructuresRequest request)
Description copied from interface:BaseinfraObtain a list of Database Infrastructures.- Specified by:
listInfrastructuresin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaintenanceExecutions
public ListMaintenanceExecutionsResponse listMaintenanceExecutions(ListMaintenanceExecutionsRequest request)
Description copied from interface:BaseinfraGets a list of the maintenance executions in the specified compartment.- Specified by:
listMaintenanceExecutionsin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaintenanceRuns
public ListMaintenanceRunsResponse listMaintenanceRuns(ListMaintenanceRunsRequest request)
Description copied from interface:BaseinfraGets a list of the maintenance runs in the specified compartment.- Specified by:
listMaintenanceRunsin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVmClusterNetworks
public ListVmClusterNetworksResponse listVmClusterNetworks(ListVmClusterNetworksRequest request)
Description copied from interface:BaseinfraObtain a list of VM cluster networks on Database Infrastructure.- Specified by:
listVmClusterNetworksin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listVmInstances
public ListVmInstancesResponse listVmInstances(ListVmInstancesRequest request)
Description copied from interface:BaseinfraObtain a list of VM instances.- Specified by:
listVmInstancesin interfaceBaseinfra- 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:BaseinfraView the list of errors for the work request that have the specified work request OCID.- Specified by:
listWorkRequestErrorsin interfaceBaseinfra- 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:BaseinfraView the log entries for the work request that have the specified work request OCID.- Specified by:
listWorkRequestLogsin interfaceBaseinfra- 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:BaseinfraView a list of work request details in the specified compartment.- Specified by:
listWorkRequestsin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
migrateVmInstance
public MigrateVmInstanceResponse migrateVmInstance(MigrateVmInstanceRequest request)
Description copied from interface:BaseinfraMigrate the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
migrateVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
rescheduleMaintenanceRun
public RescheduleMaintenanceRunResponse rescheduleMaintenanceRun(RescheduleMaintenanceRunRequest request)
Description copied from interface:BaseinfraReschedules the specified maintenance run by providing a newtimeScheduledvalue.Only maintenance runs in eligible states may be rescheduled.
- Specified by:
rescheduleMaintenanceRunin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
restartVmInstance
public RestartVmInstanceResponse restartVmInstance(RestartVmInstanceRequest request)
Description copied from interface:BaseinfraRestart the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
restartVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scaleInfrastructureStorage
public ScaleInfrastructureStorageResponse scaleInfrastructureStorage(ScaleInfrastructureStorageRequest request)
Description copied from interface:BaseinfraScale storage for the specified infrastructure using the specified details.- Specified by:
scaleInfrastructureStoragein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
scaleVmInstance
public ScaleVmInstanceResponse scaleVmInstance(ScaleVmInstanceRequest request)
Description copied from interface:BaseinfraScale the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
scaleVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
startVmInstance
public StartVmInstanceResponse startVmInstance(StartVmInstanceRequest request)
Description copied from interface:BaseinfraStart the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
startVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
stopVmInstance
public StopVmInstanceResponse stopVmInstance(StopVmInstanceRequest request)
Description copied from interface:BaseinfraStop the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
stopVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInfrastructure
public UpdateInfrastructureResponse updateInfrastructure(UpdateInfrastructureRequest request)
Description copied from interface:BaseinfraUpdate the Database Infrastructure that has the specified OCID.- Specified by:
updateInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMaintenanceRun
public UpdateMaintenanceRunResponse updateMaintenanceRun(UpdateMaintenanceRunRequest request)
Description copied from interface:BaseinfraUpdate maintenance run attributes.- Specified by:
updateMaintenanceRunin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateVmClusterNetwork
public UpdateVmClusterNetworkResponse updateVmClusterNetwork(UpdateVmClusterNetworkRequest request)
Description copied from interface:BaseinfraUpdate the VM cluster network on Database Infrastructure that has the specified OCID.- Specified by:
updateVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateVmInstance
public UpdateVmInstanceResponse updateVmInstance(UpdateVmInstanceRequest request)
Description copied from interface:BaseinfraUpdate the VM instance on Database Infrastructure that has the specified OCID.- Specified by:
updateVmInstancein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateInfrastructure
public ValidateInfrastructureResponse validateInfrastructure(ValidateInfrastructureRequest request)
Description copied from interface:BaseinfraValidate an Database Infrastructure using the specified details.- Specified by:
validateInfrastructurein interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
validateVmClusterNetwork
public ValidateVmClusterNetworkResponse validateVmClusterNetwork(ValidateVmClusterNetworkRequest request)
Description copied from interface:BaseinfraValidates an VM cluster network on Database Infrastructure.- Specified by:
validateVmClusterNetworkin interfaceBaseinfra- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public BaseinfraWaiters getWaiters()
Description copied from interface:BaseinfraGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceBaseinfra- Returns:
- The service waiters.
-
getPaginators
public BaseinfraPaginators getPaginators()
Description copied from interface:BaseinfraGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceBaseinfra- Returns:
- The service paginators.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
enableDualStackEndpoints
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
This method should be used to enable or disable the use of dual-stack endpoints.The default value is false i.e. dual-stack endpoints are disabled by default.
- Parameters:
enableDualStackEndpoints- This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
-
getOptionsMap
public Map<String,Boolean> getOptionsMap()
Return an immutable snapshot representing the current options set for this client.- Returns:
- immutable snapshot representing the current options set for this client
-
getResolvedEndpoint
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
Returns the endpoint after filling in the current options, as determined byBaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.- Parameters:
requiredParametersMap- the map from required parameter name to their values- Returns:
- resolved endpoint, with all options and placeholders filled in
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
Get the endpoint of the client.Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a
Region.Examples of endpoints this may return:
- Unparameterized endpoints
https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with placeholders
https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com - Parameterized endpoints with options
https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com - Parameterized endpoints with placeholders and options
https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
To get the actual endpoint for a parameterized request, you can use
BaseClient.getResolvedEndpoint(Map)orParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).- Returns:
- the endpoint being used by the client
- Unparameterized endpoints
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-