Class MarketplaceAdministratorAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.marketplacepublisher.MarketplaceAdministratorAsyncClient
-
- All Implemented Interfaces:
MarketplaceAdministratorAsync,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20241201") public class MarketplaceAdministratorAsyncClient extends BaseAsyncClient implements MarketplaceAdministratorAsyncAsync client implementation for MarketplaceAdministrator service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMarketplaceAdministratorAsyncClient.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 MarketplaceAdministrator.
-
Constructor Summary
Constructors Constructor Description MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
-
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.marketplacepublisher.MarketplaceAdministratorAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(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 (seeMarketplaceAdministratorAsyncClient.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)
-
MarketplaceAdministratorAsyncClient
@Deprecated public MarketplaceAdministratorAsyncClient(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 (seeMarketplaceAdministratorAsyncClient.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
-
-
Method Detail
-
builder
public static MarketplaceAdministratorAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:MarketplaceAdministratorAsyncSets 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 interfaceMarketplaceAdministratorAsync- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:MarketplaceAdministratorAsyncSets 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 interfaceMarketplaceAdministratorAsync- Parameters:
regionId- The public region ID.
-
changeListingRevisionStatusToNew
public Future<ChangeListingRevisionStatusToNewResponse> changeListingRevisionStatusToNew(ChangeListingRevisionStatusToNewRequest request, AsyncHandler<ChangeListingRevisionStatusToNewRequest,ChangeListingRevisionStatusToNewResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncChange the Listing Revision status to New- Specified by:
changeListingRevisionStatusToNewin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
createMarket
public Future<CreateMarketResponse> createMarket(CreateMarketRequest request, AsyncHandler<CreateMarketRequest,CreateMarketResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncCreates a new Market.- Specified by:
createMarketin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminArtifact
public Future<GetAdminArtifactResponse> getAdminArtifact(GetAdminArtifactRequest request, AsyncHandler<GetAdminArtifactRequest,GetAdminArtifactResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGets the specified artifact’s information.- Specified by:
getAdminArtifactin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminListing
public Future<GetAdminListingResponse> getAdminListing(GetAdminListingRequest request, AsyncHandler<GetAdminListingRequest,GetAdminListingResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncReturns details of the Listing.- Specified by:
getAdminListingin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminListingRevision
public Future<GetAdminListingRevisionResponse> getAdminListingRevision(GetAdminListingRevisionRequest request, AsyncHandler<GetAdminListingRevisionRequest,GetAdminListingRevisionResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncReturns details of the Listing revision.- Specified by:
getAdminListingRevisionin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminListingRevisionAttachment
public Future<GetAdminListingRevisionAttachmentResponse> getAdminListingRevisionAttachment(GetAdminListingRevisionAttachmentRequest request, AsyncHandler<GetAdminListingRevisionAttachmentRequest,GetAdminListingRevisionAttachmentResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGet the details of the specified listing revision attachment.- Specified by:
getAdminListingRevisionAttachmentin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminListingRevisionPackage
public Future<GetAdminListingRevisionPackageResponse> getAdminListingRevisionPackage(GetAdminListingRevisionPackageRequest request, AsyncHandler<GetAdminListingRevisionPackageRequest,GetAdminListingRevisionPackageResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGet the details of the specified version of a package.- Specified by:
getAdminListingRevisionPackagein interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminTerm
public Future<GetAdminTermResponse> getAdminTerm(GetAdminTermRequest request, AsyncHandler<GetAdminTermRequest,GetAdminTermResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGets a Term by identifier- Specified by:
getAdminTermin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
getAdminTermVersion
public Future<GetAdminTermVersionResponse> getAdminTermVersion(GetAdminTermVersionRequest request, AsyncHandler<GetAdminTermVersionRequest,GetAdminTermVersionResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGets a Term Version by the identifier- Specified by:
getAdminTermVersionin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminArtifacts
public Future<ListAdminArtifactsResponse> listAdminArtifacts(ListAdminArtifactsRequest request, AsyncHandler<ListAdminArtifactsRequest,ListAdminArtifactsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncLists the artifacts in your compartment.You must specify your compartment’s OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).
- Specified by:
listAdminArtifactsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminListingRevisionAttachments
public Future<ListAdminListingRevisionAttachmentsResponse> listAdminListingRevisionAttachments(ListAdminListingRevisionAttachmentsRequest request, AsyncHandler<ListAdminListingRevisionAttachmentsRequest,ListAdminListingRevisionAttachmentsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGets the list of attachments for a listing revision- Specified by:
listAdminListingRevisionAttachmentsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminListingRevisionPackages
public Future<ListAdminListingRevisionPackagesResponse> listAdminListingRevisionPackages(ListAdminListingRevisionPackagesRequest request, AsyncHandler<ListAdminListingRevisionPackagesRequest,ListAdminListingRevisionPackagesResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncGets the list of packages for a listing revision.- Specified by:
listAdminListingRevisionPackagesin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminListingRevisions
public Future<ListAdminListingRevisionsResponse> listAdminListingRevisions(ListAdminListingRevisionsRequest request, AsyncHandler<ListAdminListingRevisionsRequest,ListAdminListingRevisionsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncReturns a list of all the Listing revisions.- Specified by:
listAdminListingRevisionsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminPublisherSkus
public Future<ListAdminPublisherSkusResponse> listAdminPublisherSkus(ListAdminPublisherSkusRequest request, AsyncHandler<ListAdminPublisherSkusRequest,ListAdminPublisherSkusResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncRetrieve a list of publisher SKUs- Specified by:
listAdminPublisherSkusin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminTermVersions
public Future<ListAdminTermVersionsResponse> listAdminTermVersions(ListAdminTermVersionsRequest request, AsyncHandler<ListAdminTermVersionsRequest,ListAdminTermVersionsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncReturns a list of the publisher term versions.- Specified by:
listAdminTermVersionsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminTerms
public Future<ListAdminTermsResponse> listAdminTerms(ListAdminTermsRequest request, AsyncHandler<ListAdminTermsRequest,ListAdminTermsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncReturns a list of the publisher terms.- Specified by:
listAdminTermsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
listAdminWorkRequests
public Future<ListAdminWorkRequestsResponse> listAdminWorkRequests(ListAdminWorkRequestsRequest request, AsyncHandler<ListAdminWorkRequestsRequest,ListAdminWorkRequestsResponse> handler)
Description copied from interface:MarketplaceAdministratorAsyncLists the work requests in a compartment.- Specified by:
listAdminWorkRequestsin interfaceMarketplaceAdministratorAsync- Parameters:
request- The request object containing the details to sendhandler- The request handler to invoke upon completion, may be null.- Returns:
- 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.
-
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()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-