Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OdapackageClient

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

  • OdapackageClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

close

  • close(): void

createImportedPackage

  • Starts an asynchronous job to import a package into a Digital Assistant instance.

    To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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

    Parameters

    Returns Promise<CreateImportedPackageResponse>

    CreateImportedPackageResponse

deleteImportedPackage

  • Starts an asynchronous job to delete a package from a Digital Assistant instance.

    To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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

    Parameters

    Returns Promise<DeleteImportedPackageResponse>

    DeleteImportedPackageResponse

getImportedPackage

  • Returns a list of summaries for imported packages in the instance.

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

    Parameters

    Returns Promise<GetImportedPackageResponse>

    GetImportedPackageResponse

getPackage

  • Returns details about a package, and how to import it.

    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

listAllImportedPackages

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

    Parameters

    Returns AsyncIterableIterator<ImportedPackageSummary>

listAllImportedPackagesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListImportedPackagesResponse>

listAllPackages

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

    Parameters

    Returns AsyncIterableIterator<PackageSummary>

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>

listImportedPackages

  • Returns a list of summaries for imported packages in the instance.

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

    Parameters

    Returns Promise<ListImportedPackagesResponse>

    ListImportedPackagesResponse

listImportedPackagesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ImportedPackageSummary>

listImportedPackagesResponseIterator

listPackages

  • Returns a page of summaries for packages that are available for import. The optional odaInstanceId query parameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId query parameter is not provided, the returned list will include packages available within the region indicated by the request URL. The optional resourceType query param may be specified to filter packages that contain the indicated resource type. If no resourceType query param is given, packages containing all resource types will be returned. The optional name query parameter can be used to limit the list to packages whose name matches the given name. The optional displayName query parameter can be used to limit the list to packages whose displayName matches the given name. The optional isLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version of any given package. If not specified, all versions of any otherwise matching package will be returned.

    If the `opc-next-page` header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the `page` query parameter.

    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.PackageSummary objects contained in responses from the listPackages operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PackageSummary>

listPackagesResponseIterator

  • 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>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateImportedPackage

  • Starts an asynchronous job to update a package within a Digital Assistant instance.

    To monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.

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

    Parameters

    Returns Promise<UpdateImportedPackageResponse>

    UpdateImportedPackageResponse