Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MarketplaceClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • MarketplaceClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new MarketplaceClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): MarketplaceClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "Marketplace"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://marketplace.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changePublicationCompartment

close

  • close(): void

createAcceptedAgreement

  • Accepts a terms of use agreement for a specific package version of a listing. You must accept all terms of use for a package before you can deploy the package.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateAcceptedAgreement API.

    Parameters

    Returns Promise<CreateAcceptedAgreementResponse>

    CreateAcceptedAgreementResponse

createPublication

  • Creates a publication of the specified listing type with an optional default package. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePublication API.

    Parameters

    Returns Promise<CreatePublicationResponse>

    CreatePublicationResponse

createWaiters

  • Creates a new MarketplaceWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns MarketplaceWaiter

    The service waiters.

deleteAcceptedAgreement

  • Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks before initiating a deployment. Listings in Marketplace that require acceptance of the specified terms of use can no longer be deployed, but existing deployments aren't affected.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteAcceptedAgreement API.

    Parameters

    Returns Promise<DeleteAcceptedAgreementResponse>

    DeleteAcceptedAgreementResponse

deletePublication

  • Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePublication API.

    Parameters

    Returns Promise<DeletePublicationResponse>

    DeletePublicationResponse

exportListing

  • Exports container images or helm chart from marketplace to customer's registry. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ExportListing API.

    Parameters

    Returns Promise<ExportListingResponse>

    ExportListingResponse

getAcceptedAgreement

  • Gets the details of a specific, previously accepted terms of use agreement.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAcceptedAgreement API.

    Parameters

    Returns Promise<GetAcceptedAgreementResponse>

    GetAcceptedAgreementResponse

getAgreement

  • Returns a terms of use agreement for a package with a time-based signature that can be used to accept the agreement.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAgreement API.

    Parameters

    Returns Promise<GetAgreementResponse>

    GetAgreementResponse

getListing

  • Gets detailed information about a listing, including the listing's name, version, description, and resources.

    If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

    Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

    To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetListing API.

    Parameters

    Returns Promise<GetListingResponse>

    GetListingResponse

getPackage

  • Get the details of the specified version of a package, including information needed to launch the package.

    If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

    Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

    To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPackage API.

    Parameters

    Returns Promise<GetPackageResponse>

    GetPackageResponse

getPublication

  • Gets the details of the specified publication. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublication API.

    Parameters

    Returns Promise<GetPublicationResponse>

    GetPublicationResponse

getPublicationPackage

  • Gets the details of a specific package version within a given publication. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublicationPackage API.

    Parameters

    Returns Promise<GetPublicationPackageResponse>

    GetPublicationPackageResponse

getWaiters

getWorkRequest

  • Gets the details of the specified work request This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAcceptedAgreements

  • Lists the terms of use agreements that have been accepted in the specified compartment. You can filter results by specifying query parameters.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAcceptedAgreements API.

    Parameters

    Returns Promise<ListAcceptedAgreementsResponse>

    ListAcceptedAgreementsResponse

listAcceptedAgreementsRecordIterator

listAcceptedAgreementsResponseIterator

listAgreements

  • Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListAgreements API.

    Parameters

    Returns Promise<ListAgreementsResponse>

    ListAgreementsResponse

listAgreementsRecordIterator

  • Creates a new async iterator which will iterate over the models.AgreementSummary objects contained in responses from the listAgreements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AgreementSummary>

listAgreementsResponseIterator

listAllAcceptedAgreements

  • NOTE: This function is deprecated in favor of listAcceptedAgreementsRecordIterator function. Creates a new async iterator which will iterate over the models.AcceptedAgreementSummary objects contained in responses from the listAcceptedAgreements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AcceptedAgreementSummary>

listAllAcceptedAgreementsResponses

  • NOTE: This function is deprecated in favor of listAcceptedAgreementsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAcceptedAgreements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAcceptedAgreementsResponse>

listAllAgreements

  • NOTE: This function is deprecated in favor of listAgreementsRecordIterator function. Creates a new async iterator which will iterate over the models.AgreementSummary objects contained in responses from the listAgreements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<AgreementSummary>

listAllAgreementsResponses

  • NOTE: This function is deprecated in favor of listAgreementsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listAgreements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListAgreementsResponse>

listAllCategories

  • NOTE: This function is deprecated in favor of listCategoriesRecordIterator function. Creates a new async iterator which will iterate over the models.CategorySummary objects contained in responses from the listCategories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CategorySummary>

listAllCategoriesResponses

  • NOTE: This function is deprecated in favor of listCategoriesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCategories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCategoriesResponse>

listAllListings

  • NOTE: This function is deprecated in favor of listListingsRecordIterator function. Creates a new async iterator which will iterate over the models.ListingSummary objects contained in responses from the listListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingSummary>

listAllListingsResponses

  • NOTE: This function is deprecated in favor of listListingsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListListingsResponse>

listAllPackages

  • NOTE: This function is deprecated in favor of listPackagesRecordIterator function. Creates a new async iterator which will iterate over the models.ListingPackageSummary objects contained in responses from the listPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingPackageSummary>

listAllPackagesResponses

  • NOTE: This function is deprecated in favor of listPackagesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPackagesResponse>

listAllPublicationPackages

  • NOTE: This function is deprecated in favor of listPublicationPackagesRecordIterator function. Creates a new async iterator which will iterate over the models.PublicationPackageSummary objects contained in responses from the listPublicationPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublicationPackageSummary>

listAllPublicationPackagesResponses

  • NOTE: This function is deprecated in favor of listPublicationPackagesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPublicationPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPublicationPackagesResponse>

listAllPublications

  • NOTE: This function is deprecated in favor of listPublicationsRecordIterator function. Creates a new async iterator which will iterate over the models.PublicationSummary objects contained in responses from the listPublications operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublicationSummary>

listAllPublicationsResponses

  • NOTE: This function is deprecated in favor of listPublicationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPublications operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPublicationsResponse>

listAllPublishers

  • NOTE: This function is deprecated in favor of listPublishersRecordIterator function. Creates a new async iterator which will iterate over the models.PublisherSummary objects contained in responses from the listPublishers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublisherSummary>

listAllPublishersResponses

  • NOTE: This function is deprecated in favor of listPublishersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPublishers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPublishersResponse>

listCategories

  • Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply to the software product provided by the listing.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCategories API.

    Parameters

    Returns Promise<ListCategoriesResponse>

    ListCategoriesResponse

listCategoriesRecordIterator

  • Creates a new async iterator which will iterate over the models.CategorySummary objects contained in responses from the listCategories operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CategorySummary>

listCategoriesResponseIterator

listListings

  • Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and filtering according to listing attributes.

    If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

    Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

    To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListListings API.

    Parameters

    Returns Promise<ListListingsResponse>

    ListListingsResponse

listListingsRecordIterator

  • Creates a new async iterator which will iterate over the models.ListingSummary objects contained in responses from the listListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingSummary>

listListingsResponseIterator

listPackages

  • Gets the list of packages for a listing.

    If you plan to launch an instance from an image listing, you must first subscribe to the listing. When you launch the instance, you also need to provide the image ID of the listing resource version that you want.

    Subscribing to the listing requires you to first get a signature from the terms of use agreement for the listing resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call. The [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including its signature, is returned in the response. With the signature for the terms of use agreement for the desired listing resource version, create a subscription by issuing a [CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.

    To get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call. Lastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPackages API.

    Parameters

    Returns Promise<ListPackagesResponse>

    ListPackagesResponse

listPackagesRecordIterator

  • Creates a new async iterator which will iterate over the models.ListingPackageSummary objects contained in responses from the listPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingPackageSummary>

listPackagesResponseIterator

listPublicationPackages

listPublicationPackagesRecordIterator

listPublicationPackagesResponseIterator

listPublications

  • Lists the publications in the specified compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPublications API.

    Parameters

    Returns Promise<ListPublicationsResponse>

    ListPublicationsResponse

listPublicationsRecordIterator

  • Creates a new async iterator which will iterate over the models.PublicationSummary objects contained in responses from the listPublications operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublicationSummary>

listPublicationsResponseIterator

listPublishers

  • Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPublishers API.

    Parameters

    Returns Promise<ListPublishersResponse>

    ListPublishersResponse

listPublishersRecordIterator

  • Creates a new async iterator which will iterate over the models.PublisherSummary objects contained in responses from the listPublishers operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublisherSummary>

listPublishersResponseIterator

listReportTypes

  • Lists available types of reports for the compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListReportTypes API.

    Parameters

    Returns Promise<ListReportTypesResponse>

    ListReportTypesResponse

listReports

  • Lists reports in the compartment that match the specified report type and date. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListReports API.

    Parameters

    Returns Promise<ListReportsResponse>

    ListReportsResponse

listTaxes

  • Returns list of all tax implications that current tenant may be liable to once they launch the listing. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTaxes API.

    Parameters

    Returns Promise<ListTaxesResponse>

    ListTaxesResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

  • List all work requests in a compartment This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

searchAllListings

  • NOTE: This function is deprecated in favor of searchListingsRecordIterator function. Creates a new async iterator which will iterate over the models.ListingSummary objects contained in responses from the searchListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingSummary>

searchAllListingsResponses

  • NOTE: This function is deprecated in favor of searchListingsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the searchListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SearchListingsResponse>

searchListings

  • Queries all Marketplace Applications to find listings that match the specified criteria. To search for a listing, you can use a free text or structured search.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use SearchListings API.

    Parameters

    Returns Promise<SearchListingsResponse>

    SearchListingsResponse

searchListingsRecordIterator

  • Creates a new async iterator which will iterate over the models.ListingSummary objects contained in responses from the searchListings operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListingSummary>

searchListingsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateAcceptedAgreement

  • Updates the display name or tags associated with a listing's previously accepted terms of use agreement.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateAcceptedAgreement API.

    Parameters

    Returns Promise<UpdateAcceptedAgreementResponse>

    UpdateAcceptedAgreementResponse

updatePublication

  • Updates the details of an existing publication. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePublication API.

    Parameters

    Returns Promise<UpdatePublicationResponse>

    UpdatePublicationResponse