Class MarketplaceAdministratorClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.marketplacepublisher.MarketplaceAdministratorClient
-
- All Implemented Interfaces:
MarketplaceAdministrator,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20241201") public class MarketplaceAdministratorClient extends BaseSyncClient implements MarketplaceAdministrator
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMarketplaceAdministratorClient.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 MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MarketplaceAdministratorClient.Builderbuilder()Create a builder for this client.ChangeListingRevisionStatusToNewResponsechangeListingRevisionStatusToNew(ChangeListingRevisionStatusToNewRequest request)Change the Listing Revision status to Newvoidclose()CreateMarketResponsecreateMarket(CreateMarketRequest request)Creates a new Market.voidenableDualStackEndpoints(boolean enableDualStackEndpoints)This method should be used to enable or disable the use of dual-stack endpoints.GetAdminArtifactResponsegetAdminArtifact(GetAdminArtifactRequest request)Gets the specified artifact’s information.GetAdminListingResponsegetAdminListing(GetAdminListingRequest request)Returns details of the Listing.GetAdminListingRevisionResponsegetAdminListingRevision(GetAdminListingRevisionRequest request)Returns details of the Listing revision.GetAdminListingRevisionAttachmentResponsegetAdminListingRevisionAttachment(GetAdminListingRevisionAttachmentRequest request)Get the details of the specified listing revision attachment.GetAdminListingRevisionPackageResponsegetAdminListingRevisionPackage(GetAdminListingRevisionPackageRequest request)Get the details of the specified version of a package.GetAdminTermResponsegetAdminTerm(GetAdminTermRequest request)Gets a Term by identifierGetAdminTermVersionResponsegetAdminTermVersion(GetAdminTermVersionRequest request)Gets a Term Version by the identifierStringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Get the endpoint of the client.Optional<String>getMinimumClientCommonLibraryVersionFromClient()Map<String,Boolean>getOptionsMap()Return an immutable snapshot representing the current options set for this client.MarketplaceAdministratorPaginatorsgetPaginators()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.ListAdminArtifactsResponselistAdminArtifacts(ListAdminArtifactsRequest request)Lists the artifacts in your compartment.ListAdminListingRevisionAttachmentsResponselistAdminListingRevisionAttachments(ListAdminListingRevisionAttachmentsRequest request)Gets the list of attachments for a listing revisionListAdminListingRevisionPackagesResponselistAdminListingRevisionPackages(ListAdminListingRevisionPackagesRequest request)Gets the list of packages for a listing revision.ListAdminListingRevisionsResponselistAdminListingRevisions(ListAdminListingRevisionsRequest request)Returns a list of all the Listing revisions.ListAdminPublisherSkusResponselistAdminPublisherSkus(ListAdminPublisherSkusRequest request)Retrieve a list of publisher SKUsListAdminTermsResponselistAdminTerms(ListAdminTermsRequest request)Returns a list of the publisher terms.ListAdminTermVersionsResponselistAdminTermVersions(ListAdminTermVersionsRequest request)Returns a list of the publisher term versions.ListAdminWorkRequestsResponselistAdminWorkRequests(ListAdminWorkRequestsRequest request)Lists the work requests in a 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’).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.marketplacepublisher.MarketplaceAdministrator
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactory
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeMarketplaceAdministratorClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(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 (seeMarketplaceAdministratorClient.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)
-
MarketplaceAdministratorClient
@Deprecated public MarketplaceAdministratorClient(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 (seeMarketplaceAdministratorClient.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 MarketplaceAdministratorClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:MarketplaceAdministratorSets 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 interfaceMarketplaceAdministrator- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:MarketplaceAdministratorSets 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 interfaceMarketplaceAdministrator- Parameters:
regionId- The public region ID.
-
changeListingRevisionStatusToNew
public ChangeListingRevisionStatusToNewResponse changeListingRevisionStatusToNew(ChangeListingRevisionStatusToNewRequest request)
Description copied from interface:MarketplaceAdministratorChange the Listing Revision status to New- Specified by:
changeListingRevisionStatusToNewin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createMarket
public CreateMarketResponse createMarket(CreateMarketRequest request)
Description copied from interface:MarketplaceAdministratorCreates a new Market.- Specified by:
createMarketin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminArtifact
public GetAdminArtifactResponse getAdminArtifact(GetAdminArtifactRequest request)
Description copied from interface:MarketplaceAdministratorGets the specified artifact’s information.- Specified by:
getAdminArtifactin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminListing
public GetAdminListingResponse getAdminListing(GetAdminListingRequest request)
Description copied from interface:MarketplaceAdministratorReturns details of the Listing.- Specified by:
getAdminListingin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminListingRevision
public GetAdminListingRevisionResponse getAdminListingRevision(GetAdminListingRevisionRequest request)
Description copied from interface:MarketplaceAdministratorReturns details of the Listing revision.- Specified by:
getAdminListingRevisionin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminListingRevisionAttachment
public GetAdminListingRevisionAttachmentResponse getAdminListingRevisionAttachment(GetAdminListingRevisionAttachmentRequest request)
Description copied from interface:MarketplaceAdministratorGet the details of the specified listing revision attachment.- Specified by:
getAdminListingRevisionAttachmentin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminListingRevisionPackage
public GetAdminListingRevisionPackageResponse getAdminListingRevisionPackage(GetAdminListingRevisionPackageRequest request)
Description copied from interface:MarketplaceAdministratorGet the details of the specified version of a package.- Specified by:
getAdminListingRevisionPackagein interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminTerm
public GetAdminTermResponse getAdminTerm(GetAdminTermRequest request)
Description copied from interface:MarketplaceAdministratorGets a Term by identifier- Specified by:
getAdminTermin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getAdminTermVersion
public GetAdminTermVersionResponse getAdminTermVersion(GetAdminTermVersionRequest request)
Description copied from interface:MarketplaceAdministratorGets a Term Version by the identifier- Specified by:
getAdminTermVersionin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminArtifacts
public ListAdminArtifactsResponse listAdminArtifacts(ListAdminArtifactsRequest request)
Description copied from interface:MarketplaceAdministratorLists 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 interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminListingRevisionAttachments
public ListAdminListingRevisionAttachmentsResponse listAdminListingRevisionAttachments(ListAdminListingRevisionAttachmentsRequest request)
Description copied from interface:MarketplaceAdministratorGets the list of attachments for a listing revision- Specified by:
listAdminListingRevisionAttachmentsin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminListingRevisionPackages
public ListAdminListingRevisionPackagesResponse listAdminListingRevisionPackages(ListAdminListingRevisionPackagesRequest request)
Description copied from interface:MarketplaceAdministratorGets the list of packages for a listing revision.- Specified by:
listAdminListingRevisionPackagesin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminListingRevisions
public ListAdminListingRevisionsResponse listAdminListingRevisions(ListAdminListingRevisionsRequest request)
Description copied from interface:MarketplaceAdministratorReturns a list of all the Listing revisions.- Specified by:
listAdminListingRevisionsin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminPublisherSkus
public ListAdminPublisherSkusResponse listAdminPublisherSkus(ListAdminPublisherSkusRequest request)
Description copied from interface:MarketplaceAdministratorRetrieve a list of publisher SKUs- Specified by:
listAdminPublisherSkusin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminTermVersions
public ListAdminTermVersionsResponse listAdminTermVersions(ListAdminTermVersionsRequest request)
Description copied from interface:MarketplaceAdministratorReturns a list of the publisher term versions.- Specified by:
listAdminTermVersionsin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminTerms
public ListAdminTermsResponse listAdminTerms(ListAdminTermsRequest request)
Description copied from interface:MarketplaceAdministratorReturns a list of the publisher terms.- Specified by:
listAdminTermsin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listAdminWorkRequests
public ListAdminWorkRequestsResponse listAdminWorkRequests(ListAdminWorkRequestsRequest request)
Description copied from interface:MarketplaceAdministratorLists the work requests in a compartment.- Specified by:
listAdminWorkRequestsin interfaceMarketplaceAdministrator- Parameters:
request- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPaginators
public MarketplaceAdministratorPaginators getPaginators()
Description copied from interface:MarketplaceAdministratorGets 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 interfaceMarketplaceAdministrator- 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()
-
-