Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubscriptionClient

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

  • SubscriptionClient

Constructors

constructor

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

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

targetService

targetService: string = "Subscription"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://csaap-e.oracle.com"

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

close

  • close(): void

listAllSubscriptions

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

    Parameters

    Returns AsyncIterableIterator<SubscriptionSummary>

listAllSubscriptionsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListSubscriptionsResponse>

listSubscriptions

  • This list API returns all subscriptions for a given plan number or subscription id or buyer email and provides additional parameters to include ratecard and commitment details. This API expects exactly one of the above mentioned parameters as input. If more than one parameters are provided the API will throw a 400 - invalid parameters exception and if no parameters are provided it will throw a 400 - missing parameter exception

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSubscriptions API.

    Parameters

    Returns Promise<ListSubscriptionsResponse>

    ListSubscriptionsResponse

listSubscriptionsRecordIterator

listSubscriptionsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void