Class CapacityManagementClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.capacitymanagement.CapacityManagementClient
-
- All Implemented Interfaces:
CapacityManagement,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20231107") public class CapacityManagementClient extends BaseSyncClient implements CapacityManagement
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCapacityManagementClient.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 CapacityManagement.
-
Constructor Summary
Constructors Constructor Description CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.capacitymanagement.CapacityManagement
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeCapacityManagementClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(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 (seeCapacityManagementClient.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)
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(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 (seeCapacityManagementClient.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
-
CapacityManagementClient
@Deprecated public CapacityManagementClient(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 (seeCapacityManagementClient.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-CapacityManagementClient.Builder.executorService
-
-
Method Detail
-
builder
public static CapacityManagementClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:CapacityManagementSets 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 interfaceCapacityManagement- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:CapacityManagementSets 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 interfaceCapacityManagement- Parameters:
regionId- The public region ID.
-
createOccAvailabilityCatalog
public CreateOccAvailabilityCatalogResponse createOccAvailabilityCatalog(CreateOccAvailabilityCatalogRequest request)
Description copied from interface:CapacityManagementCreate availability catalog- Specified by:
createOccAvailabilityCatalogin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOccCapacityRequest
public CreateOccCapacityRequestResponse createOccCapacityRequest(CreateOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementCreate Capacity Request.- Specified by:
createOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOccCustomer
public CreateOccCustomerResponse createOccCustomer(CreateOccCustomerRequest request)
Description copied from interface:CapacityManagementCreate customer.- Specified by:
createOccCustomerin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOccCustomerGroup
public CreateOccCustomerGroupResponse createOccCustomerGroup(CreateOccCustomerGroupRequest request)
Description copied from interface:CapacityManagementCreate customer group.- Specified by:
createOccCustomerGroupin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccAvailabilityCatalog
public DeleteOccAvailabilityCatalogResponse deleteOccAvailabilityCatalog(DeleteOccAvailabilityCatalogRequest request)
Description copied from interface:CapacityManagementDeletes the availability catalog resource.- Specified by:
deleteOccAvailabilityCatalogin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccCapacityRequest
public DeleteOccCapacityRequestResponse deleteOccCapacityRequest(DeleteOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementDeletes the capacity request resource.- Specified by:
deleteOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccCustomer
public DeleteOccCustomerResponse deleteOccCustomer(DeleteOccCustomerRequest request)
Description copied from interface:CapacityManagementDeletes the customer resource.- Specified by:
deleteOccCustomerin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteOccCustomerGroup
public DeleteOccCustomerGroupResponse deleteOccCustomerGroup(DeleteOccCustomerGroupRequest request)
Description copied from interface:CapacityManagementDeletes the customer group resource.- Specified by:
deleteOccCustomerGroupin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccAvailabilityCatalog
public GetOccAvailabilityCatalogResponse getOccAvailabilityCatalog(GetOccAvailabilityCatalogRequest request)
Description copied from interface:CapacityManagementGet details about availability catalog.- Specified by:
getOccAvailabilityCatalogin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccAvailabilityCatalogContent
public GetOccAvailabilityCatalogContentResponse getOccAvailabilityCatalogContent(GetOccAvailabilityCatalogContentRequest request)
Description copied from interface:CapacityManagementReturns the binary contents of the availability catalog.Can be saved as a csv file.
- Specified by:
getOccAvailabilityCatalogContentin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccCapacityRequest
public GetOccCapacityRequestResponse getOccCapacityRequest(GetOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementGet details about the capacity request.- Specified by:
getOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getOccCustomerGroup
public GetOccCustomerGroupResponse getOccCustomerGroup(GetOccCustomerGroupRequest request)
Description copied from interface:CapacityManagementGets information about the specified customer group.- Specified by:
getOccCustomerGroupin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInternalNamespaceOccOverviews
public ListInternalNamespaceOccOverviewsResponse listInternalNamespaceOccOverviews(ListInternalNamespaceOccOverviewsRequest request)
Description copied from interface:CapacityManagementLists an overview of all resources in that namespace in a given time interval.- Specified by:
listInternalNamespaceOccOverviewsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInternalOccHandoverResourceBlockDetails
public ListInternalOccHandoverResourceBlockDetailsResponse listInternalOccHandoverResourceBlockDetails(ListInternalOccHandoverResourceBlockDetailsRequest request)
Description copied from interface:CapacityManagementList details about a given occHandoverResourceBlock.- Specified by:
listInternalOccHandoverResourceBlockDetailsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listInternalOccHandoverResourceBlocks
public ListInternalOccHandoverResourceBlocksResponse listInternalOccHandoverResourceBlocks(ListInternalOccHandoverResourceBlocksRequest request)
Description copied from interface:CapacityManagementList Occ Handover Resource blocks.- Specified by:
listInternalOccHandoverResourceBlocksin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccAvailabilities
public ListOccAvailabilitiesResponse listOccAvailabilities(ListOccAvailabilitiesRequest request)
Description copied from interface:CapacityManagementLists availabilities for a particular availability catalog.- Specified by:
listOccAvailabilitiesin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccAvailabilityCatalogs
public ListOccAvailabilityCatalogsResponse listOccAvailabilityCatalogs(ListOccAvailabilityCatalogsRequest request)
Description copied from interface:CapacityManagementLists all availability catalogs.- Specified by:
listOccAvailabilityCatalogsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccAvailabilityCatalogsInternal
public ListOccAvailabilityCatalogsInternalResponse listOccAvailabilityCatalogsInternal(ListOccAvailabilityCatalogsInternalRequest request)
Description copied from interface:CapacityManagementAn internal api to list availability catalogs.- Specified by:
listOccAvailabilityCatalogsInternalin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccCapacityRequests
public ListOccCapacityRequestsResponse listOccCapacityRequests(ListOccCapacityRequestsRequest request)
Description copied from interface:CapacityManagementLists all capacity requests.- Specified by:
listOccCapacityRequestsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccCapacityRequestsInternal
public ListOccCapacityRequestsInternalResponse listOccCapacityRequestsInternal(ListOccCapacityRequestsInternalRequest request)
Description copied from interface:CapacityManagementAn internal api to list all capacity requests.- Specified by:
listOccCapacityRequestsInternalin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccCustomerGroups
public ListOccCustomerGroupsResponse listOccCustomerGroups(ListOccCustomerGroupsRequest request)
Description copied from interface:CapacityManagementLists all the customer groups.- Specified by:
listOccCustomerGroupsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccHandoverResourceBlockDetails
public ListOccHandoverResourceBlockDetailsResponse listOccHandoverResourceBlockDetails(ListOccHandoverResourceBlockDetailsRequest request)
Description copied from interface:CapacityManagementList details about a given occHandoverResourceBlock.- Specified by:
listOccHandoverResourceBlockDetailsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccHandoverResourceBlocks
public ListOccHandoverResourceBlocksResponse listOccHandoverResourceBlocks(ListOccHandoverResourceBlocksRequest request)
Description copied from interface:CapacityManagementList Occ Handover Resource blocks.- Specified by:
listOccHandoverResourceBlocksin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listOccOverviews
public ListOccOverviewsResponse listOccOverviews(ListOccOverviewsRequest request)
Description copied from interface:CapacityManagementLists an overview of all resources in that namespace in a given time interval.- Specified by:
listOccOverviewsin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchInternalOccCapacityRequest
public PatchInternalOccCapacityRequestResponse patchInternalOccCapacityRequest(PatchInternalOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementUpdates the OccCapacityRequest by evaluating a sequence of instructions.- Specified by:
patchInternalOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
patchOccCapacityRequest
public PatchOccCapacityRequestResponse patchOccCapacityRequest(PatchOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementUpdates the OccCapacityRequest by evaluating a sequence of instructions.- Specified by:
patchOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
publishOccAvailabilityCatalog
public PublishOccAvailabilityCatalogResponse publishOccAvailabilityCatalog(PublishOccAvailabilityCatalogRequest request)
Description copied from interface:CapacityManagementPublishes the version of availability catalog specified by the operator.This makes that catalog version visible to customers.
- Specified by:
publishOccAvailabilityCatalogin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateInternalOccCapacityRequest
public UpdateInternalOccCapacityRequestResponse updateInternalOccCapacityRequest(UpdateInternalOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementThe internal api to update the capacity request.This api will be used by operators for updating the capacity request to either completed, resubmitted or rejected.
- Specified by:
updateInternalOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccAvailabilityCatalog
public UpdateOccAvailabilityCatalogResponse updateOccAvailabilityCatalog(UpdateOccAvailabilityCatalogRequest request)
Description copied from interface:CapacityManagementThe request to update the availability catalog.Currently only freeform tags can be updated via this api.
- Specified by:
updateOccAvailabilityCatalogin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccCapacityRequest
public UpdateOccCapacityRequestResponse updateOccCapacityRequest(UpdateOccCapacityRequestRequest request)
Description copied from interface:CapacityManagementThe request to update the capacity request.The user can perform actions like closing a partially completed request so that it doesn’t go ahead for full completion.
- Specified by:
updateOccCapacityRequestin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccCustomer
public UpdateOccCustomerResponse updateOccCustomer(UpdateOccCustomerRequest request)
Description copied from interface:CapacityManagementThe request to update the customer.- Specified by:
updateOccCustomerin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateOccCustomerGroup
public UpdateOccCustomerGroupResponse updateOccCustomerGroup(UpdateOccCustomerGroupRequest request)
Description copied from interface:CapacityManagementThe request to update the customer group.- Specified by:
updateOccCustomerGroupin interfaceCapacityManagement- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public CapacityManagementWaiters getWaiters()
Description copied from interface:CapacityManagementGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceCapacityManagement- Returns:
- The service waiters.
-
getPaginators
public CapacityManagementPaginators getPaginators()
Description copied from interface:CapacityManagementGets 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 interfaceCapacityManagement- 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()
-
-