Class FleetAppsManagementMaintenanceWindowClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.fleetappsmanagement.FleetAppsManagementMaintenanceWindowClient
-
- All Implemented Interfaces:
FleetAppsManagementMaintenanceWindow,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20250228") public class FleetAppsManagementMaintenanceWindowClient extends BaseSyncClient implements FleetAppsManagementMaintenanceWindow
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFleetAppsManagementMaintenanceWindowClient.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 FleetAppsManagementMaintenanceWindow.
-
Constructor Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FleetAppsManagementMaintenanceWindowClient.Builderbuilder()Create a builder for this client.voidclose()CreateMaintenanceWindowResponsecreateMaintenanceWindow(CreateMaintenanceWindowRequest request)Create a maintenance window in Fleet Application Management.DeleteMaintenanceWindowResponsedeleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)Delete a maintenance window in Fleet Application Management.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.GetMaintenanceWindowResponsegetMaintenanceWindow(GetMaintenanceWindowRequest request)Get the details for a maintenance window in Fleet Application Management.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.FleetAppsManagementMaintenanceWindowPaginatorsgetPaginators()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.FleetAppsManagementMaintenanceWindowWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListMaintenanceWindowsResponselistMaintenanceWindows(ListMaintenanceWindowsRequest request)Returns a list of all the Maintenance Windows in the specified compartment.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).UpdateMaintenanceWindowResponseupdateMaintenanceWindow(UpdateMaintenanceWindowRequest request)Update a maintenance window in Fleet Application Management.voiduseRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)This method should be used to enable or disable the use of realm-specific endpoint template.-
Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.fleetappsmanagement.FleetAppsManagementMaintenanceWindow
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementMaintenanceWindowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementMaintenanceWindowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementMaintenanceWindowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementMaintenanceWindowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeFleetAppsManagementMaintenanceWindowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(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 (seeFleetAppsManagementMaintenanceWindowClient.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)
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(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 (seeFleetAppsManagementMaintenanceWindowClient.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
-
FleetAppsManagementMaintenanceWindowClient
@Deprecated public FleetAppsManagementMaintenanceWindowClient(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 (seeFleetAppsManagementMaintenanceWindowClient.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-FleetAppsManagementMaintenanceWindowClient.Builder.executorService
-
-
Method Detail
-
builder
public static FleetAppsManagementMaintenanceWindowClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:FleetAppsManagementMaintenanceWindowSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:FleetAppsManagementMaintenanceWindowSets the region to call (ex, ‘us-phoenix-1’).Note, this will first try to map the region ID to a known Region and call
setRegion.If no known Region could be determined, it will create an endpoint based on the default endpoint format (
Region.formatDefaultRegionEndpoint(Service, String)and then callsetEndpoint.- Specified by:
setRegionin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
regionId- The public region ID.
-
createMaintenanceWindow
public CreateMaintenanceWindowResponse createMaintenanceWindow(CreateMaintenanceWindowRequest request)
Description copied from interface:FleetAppsManagementMaintenanceWindowCreate a maintenance window in Fleet Application Management.- Specified by:
createMaintenanceWindowin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteMaintenanceWindow
public DeleteMaintenanceWindowResponse deleteMaintenanceWindow(DeleteMaintenanceWindowRequest request)
Description copied from interface:FleetAppsManagementMaintenanceWindowDelete a maintenance window in Fleet Application Management.- Specified by:
deleteMaintenanceWindowin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getMaintenanceWindow
public GetMaintenanceWindowResponse getMaintenanceWindow(GetMaintenanceWindowRequest request)
Description copied from interface:FleetAppsManagementMaintenanceWindowGet the details for a maintenance window in Fleet Application Management.- Specified by:
getMaintenanceWindowin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listMaintenanceWindows
public ListMaintenanceWindowsResponse listMaintenanceWindows(ListMaintenanceWindowsRequest request)
Description copied from interface:FleetAppsManagementMaintenanceWindowReturns a list of all the Maintenance Windows in the specified compartment.The query parameter
compartmentIdis required unless the query parameteridis specified.- Specified by:
listMaintenanceWindowsin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateMaintenanceWindow
public UpdateMaintenanceWindowResponse updateMaintenanceWindow(UpdateMaintenanceWindowRequest request)
Description copied from interface:FleetAppsManagementMaintenanceWindowUpdate a maintenance window in Fleet Application Management.- Specified by:
updateMaintenanceWindowin interfaceFleetAppsManagementMaintenanceWindow- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public FleetAppsManagementMaintenanceWindowWaiters getWaiters()
Description copied from interface:FleetAppsManagementMaintenanceWindowGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceFleetAppsManagementMaintenanceWindow- Returns:
- The service waiters.
-
getPaginators
public FleetAppsManagementMaintenanceWindowPaginators getPaginators()
Description copied from interface:FleetAppsManagementMaintenanceWindowGets 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 interfaceFleetAppsManagementMaintenanceWindow- 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()
-
-