Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MarketplacePublisherClient

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

  • MarketplacePublisherClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

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

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 = "MarketplacePublisher"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://marketplace-publisher.{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

activateTermVersion

cancelWorkRequest

cascadingDeleteListing

cascadingDeleteListingRevision

changeArtifactCompartment

changeListingCompartment

changeListingRevisionToNewStatus

changeTermCompartment

cloneListingRevision

close

  • close(): void

createArtifact

  • Creates a new artifact in your compartment. You must specify your compartment ID in the request object.

    You must also specify a *name* for the artifact(although it can be an empty string). It does not have to be unique, and you can change it anytime with {@link #updateArtifact(UpdateArtifactRequest) updateArtifact}..

    You must also specify a *artifactType* for the artifact. Allowed values are CONTAINER_IMAGE and HELM_CHART

    You must also provide the container or helm chart registry details for the corresponding images. Oracle container registry details (Registry/Concepts/registryoverview.htm).

    After you send your request, the new object's `status` will temporarily be IN_PROGRESS and `lifecycleState` will be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE and the status has changed to \u2018AVAILABLE\u2019 for the new Artifact.

    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 CreateArtifact API.

    Parameters

    Returns Promise<CreateArtifactResponse>

    CreateArtifactResponse

createListing

  • Creates a new listing in your compartment. You must specify your compartment ID in the request object.

    You must also specify a *name* for the listing and cannot be updated later.

    You must also specify a *packageType* for the listing. Allowed values are CONTAINER_IMAGE and HELM_CHART

    After you send your request, the new object's `lifecycleState` will be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.

    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 CreateListing API.

    Parameters

    Returns Promise<CreateListingResponse>

    CreateListingResponse

createListingRevision

createListingRevisionAttachment

createListingRevisionNote

createListingRevisionPackage

createTerm

createTermVersion

createWaiters

deleteArtifact

deleteListing

deleteListingRevision

deleteListingRevisionAttachment

deleteListingRevisionNote

deleteListingRevisionPackage

deleteTerm

deleteTermVersion

getArtifact

getCategory

getListing

getListingRevision

getListingRevisionAttachment

getListingRevisionNote

getListingRevisionPackage

getMarket

  • Gets the specified market's information. 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 GetMarket API.

    Parameters

    Returns Promise<GetMarketResponse>

    GetMarketResponse

getProduct

getPublisher

getTerm

getTermVersion

getWaiters

getWorkRequest

listArtifacts

  • Lists 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).

    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 ListArtifacts API.

    Parameters

    Returns Promise<ListArtifactsResponse>

    ListArtifactsResponse

listCategories

  • Lists the categories 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).

    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

listListingRevisionAttachments

listListingRevisionNotes

listListingRevisionPackages

listListingRevisions

  • Lists the list of listing revisions for a specific listing ID, compartment ID or listing revision status.

    You can specify your compartment's OCID as the value for the compartment ID. For information about OCIDs, see Resource Identifiers (Content/General/Concepts/identifiers.htm).

    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 ListListingRevisions API.

    Parameters

    Returns Promise<ListListingRevisionsResponse>

    ListListingRevisionsResponse

listListings

  • Lists the listings 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).

    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

listMarkets

  • Lists the markets 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).

    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 ListMarkets API.

    Parameters

    Returns Promise<ListMarketsResponse>

    ListMarketsResponse

listProducts

  • Lists the products 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).

    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 ListProducts API.

    Parameters

    Returns Promise<ListProductsResponse>

    ListProductsResponse

listPublishers

listTermVersions

listTerms

  • Returns a list of the publisher terms. 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 ListTerms API.

    Parameters

    Returns Promise<ListTermsResponse>

    ListTermsResponse

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

markListingRevisionPackageAsDefault

publishListingRevision

publishListingRevisionAsPrivate

publishListingRevisionPackage

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

submitListingRevisionForReview

unPublishListingRevisionPackage

updateArtifact

updateListing

updateListingRevision

updateListingRevisionAttachment

updateListingRevisionAttachmentContent

updateListingRevisionIconContent

updateListingRevisionPackage

updateTerm

updateTermVersion

updateTermVersionContent

validateAndPublishArtifact

withdrawListingRevision