Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoftwareSourceClient

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

  • SoftwareSourceClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

addPackagesToSoftwareSource

  • Adds packages to a software source. This operation can only be done for custom and versioned custom software sources that are not created using filters. For a versioned custom software source, you can only add packages when the source is created. Once content is added to a versioned custom software source, it is immutable.

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

    Parameters

    Returns Promise<AddPackagesToSoftwareSourceResponse>

    AddPackagesToSoftwareSourceResponse

changeAvailabilityOfSoftwareSources

changeSoftwareSourceCompartment

close

  • close(): void

createEntitlement

  • Registers the necessary entitlement credentials for OS vendor software sources.

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

    Parameters

    Returns Promise<CreateEntitlementResponse>

    CreateEntitlementResponse

createSoftwareSource

createWaiters

deleteSoftwareSource

getErratum

  • Returns information about the specified erratum based on its advisory name.

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

    Parameters

    Returns Promise<GetErratumResponse>

    GetErratumResponse

getModuleStream

  • Returns information about the specified module stream in a software source.

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

    Parameters

    Returns Promise<GetModuleStreamResponse>

    GetModuleStreamResponse

getModuleStreamProfile

getPackageGroup

  • Returns information about the specified package group from a software source.

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

    Parameters

    Returns Promise<GetPackageGroupResponse>

    GetPackageGroupResponse

getSoftwarePackage

getSoftwarePackageByName

getSoftwareSource

getWaiters

listAllSoftwarePackages

  • Lists software packages available through the OS Management Hub service. Filter the list against a variety of criteria including but not limited to its name.

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

    Parameters

    Returns Promise<ListAllSoftwarePackagesResponse>

    ListAllSoftwarePackagesResponse

listEntitlements

  • Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its Customer Support Identifier (CSI), and vendor name.

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

    Parameters

    Returns Promise<ListEntitlementsResponse>

    ListEntitlementsResponse

listErrata

  • Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

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

    Parameters

    Returns Promise<ListErrataResponse>

    ListErrataResponse

listModuleStreamProfiles

  • Lists module stream profiles from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name, stream name, and profile name.

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

    Parameters

    Returns Promise<ListModuleStreamProfilesResponse>

    ListModuleStreamProfilesResponse

listModuleStreams

  • Lists module streams from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.

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

    Parameters

    Returns Promise<ListModuleStreamsResponse>

    ListModuleStreamsResponse

listPackageGroups

  • Lists package groups that are associated with the specified software source OCID. Filter the list against a variety of criteria including but not limited to its name, and package group type.

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

    Parameters

    Returns Promise<ListPackageGroupsResponse>

    ListPackageGroupsResponse

listSoftwarePackageSoftwareSources

  • Lists the software sources in the tenancy that contain the software package. Filter the list against a variety of criteria including but not limited to its name, type, architecture, and OS family.

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

    Parameters

    Returns Promise<ListSoftwarePackageSoftwareSourcesResponse>

    ListSoftwarePackageSoftwareSourcesResponse

listSoftwarePackages

  • Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.

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

    Parameters

    Returns Promise<ListSoftwarePackagesResponse>

    ListSoftwarePackagesResponse

listSoftwareSourceVendors

  • Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.

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

    Parameters

    Returns Promise<ListSoftwareSourceVendorsResponse>

    ListSoftwareSourceVendorsResponse

listSoftwareSources

  • Lists software sources that match the specified tenancy or software source OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

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

    Parameters

    Returns Promise<ListSoftwareSourcesResponse>

    ListSoftwareSourcesResponse

searchSoftwareSourceModuleStreams

  • Returns a list of module streams from the specified software sources. Filter the list against a variety of criteria including the module name.

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

    Parameters

    Returns Promise<SearchSoftwareSourceModuleStreamsResponse>

    SearchSoftwareSourceModuleStreamsResponse

searchSoftwareSourceModules

  • Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.

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

    Parameters

    Returns Promise<SearchSoftwareSourceModulesResponse>

    SearchSoftwareSourceModulesResponse

searchSoftwareSourcePackageGroups

  • Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria including but not limited to its name, and group type.

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

    Parameters

    Returns Promise<SearchSoftwareSourcePackageGroupsResponse>

    SearchSoftwareSourcePackageGroupsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateSoftwareSource

  • Updates the specified software source's details, including but not limited to name, description, and tags.

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

    Parameters

    Returns Promise<UpdateSoftwareSourceResponse>

    UpdateSoftwareSourceResponse