Show / Hide Table of Contents

Class SoftwareSourceClient

Service client instance for SoftwareSource.

Inheritance
object
ClientBase
RegionalClientBase
SoftwareSourceClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.OsmanagementhubService
Assembly: OCI.DotNetSDK.Osmanagementhub.dll
Syntax
public class SoftwareSourceClient : RegionalClientBase, IDisposable

Constructors

SoftwareSourceClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public SoftwareSourceClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public SoftwareSourcePaginators Paginators { get; }
Property Value
Type Description
SoftwareSourcePaginators

Waiters

Declaration
public SoftwareSourceWaiters Waiters { get; }
Property Value
Type Description
SoftwareSourceWaiters

Methods

AddPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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. Packages can be of the format:

  • name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added.
  • name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)
  • name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
Declaration
public Task<AddPackagesToSoftwareSourceResponse> AddPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AddPackagesToSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AddPackagesToSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddPackagesToSoftwareSource API.

ChangeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the availability for a list of specified software sources.

Declaration
public Task<ChangeAvailabilityOfSoftwareSourcesResponse> ChangeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeAvailabilityOfSoftwareSourcesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeAvailabilityOfSoftwareSourcesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeAvailabilityOfSoftwareSources API.

ChangeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the specified software sources to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration
public Task<ChangeSoftwareSourceCompartmentResponse> ChangeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeSoftwareSourceCompartmentRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ChangeSoftwareSourceCompartmentResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeSoftwareSourceCompartment API.

CreateEntitlement(CreateEntitlementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.

Declaration
public Task<CreateEntitlementResponse> CreateEntitlement(CreateEntitlementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateEntitlementRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateEntitlementResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateEntitlement API.

CreateSoftwareSource(CreateSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new software source.

Declaration
public Task<CreateSoftwareSourceResponse> CreateSoftwareSource(CreateSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSoftwareSource API.

DeleteSoftwareSource(DeleteSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified software source.

Declaration
public Task<DeleteSoftwareSourceResponse> DeleteSoftwareSource(DeleteSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSoftwareSource API.

GetErratum(GetErratumRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<GetErratumResponse> GetErratum(GetErratumRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetErratumRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetErratumResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetErratum API.

GetModuleStream(GetModuleStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<GetModuleStreamResponse> GetModuleStream(GetModuleStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModuleStreamRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetModuleStreamResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetModuleStream API.

GetModuleStreamProfile(GetModuleStreamProfileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<GetModuleStreamProfileResponse> GetModuleStreamProfile(GetModuleStreamProfileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetModuleStreamProfileRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetModuleStreamProfileResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetModuleStreamProfile API.

GetPackageGroup(GetPackageGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<GetPackageGroupResponse> GetPackageGroup(GetPackageGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetPackageGroupRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetPackageGroupResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetPackageGroup API.

GetSoftwarePackage(GetSoftwarePackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns information about the specified software package.

Declaration
public Task<GetSoftwarePackageResponse> GetSoftwarePackage(GetSoftwarePackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSoftwarePackageRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSoftwarePackageResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSoftwarePackage API.

GetSoftwarePackageByName(GetSoftwarePackageByNameRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns information about the specified software package based on its fully qualified name (NVRA or NEVRA).

Declaration
public Task<GetSoftwarePackageByNameResponse> GetSoftwarePackageByName(GetSoftwarePackageByNameRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSoftwarePackageByNameRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSoftwarePackageByNameResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSoftwarePackageByName API.

GetSoftwareSource(GetSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns information about the specified software source.

Declaration
public Task<GetSoftwareSourceResponse> GetSoftwareSource(GetSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSoftwareSource API.

GetSoftwareSourceManifest(GetSoftwareSourceManifestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns an archive containing the list of packages in the software source.

Declaration
public Task<GetSoftwareSourceManifestResponse> GetSoftwareSourceManifest(GetSoftwareSourceManifestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSoftwareSourceManifestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSoftwareSourceManifestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSoftwareSourceManifest API.

ListAllSoftwarePackages(ListAllSoftwarePackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListAllSoftwarePackagesResponse> ListAllSoftwarePackages(ListAllSoftwarePackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAllSoftwarePackagesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListAllSoftwarePackagesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAllSoftwarePackages API.

ListAvailableSoftwarePackages(ListAvailableSoftwarePackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists software packages that are available to be added to a custom software source of type MANIFEST. Filter the list against a variety of criteria including but not limited to its name.

Declaration
public Task<ListAvailableSoftwarePackagesResponse> ListAvailableSoftwarePackages(ListAvailableSoftwarePackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAvailableSoftwarePackagesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListAvailableSoftwarePackagesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListAvailableSoftwarePackages API.

ListEntitlements(ListEntitlementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListEntitlementsResponse> ListEntitlements(ListEntitlementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListEntitlementsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListEntitlementsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListEntitlements API.

ListErrata(ListErrataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListErrataResponse> ListErrata(ListErrataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListErrataRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListErrataResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListErrata API.

ListModuleStreamProfiles(ListModuleStreamProfilesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListModuleStreamProfilesResponse> ListModuleStreamProfiles(ListModuleStreamProfilesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModuleStreamProfilesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListModuleStreamProfilesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListModuleStreamProfiles API.

ListModuleStreams(ListModuleStreamsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListModuleStreamsResponse> ListModuleStreams(ListModuleStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListModuleStreamsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListModuleStreamsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListModuleStreams API.

ListPackageGroups(ListPackageGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListPackageGroupsResponse> ListPackageGroups(ListPackageGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPackageGroupsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListPackageGroupsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPackageGroups API.

ListSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListSoftwarePackageSoftwareSourcesResponse> ListSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSoftwarePackageSoftwareSourcesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSoftwarePackageSoftwareSourcesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSoftwarePackageSoftwareSources API.

ListSoftwarePackages(ListSoftwarePackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<ListSoftwarePackagesResponse> ListSoftwarePackages(ListSoftwarePackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSoftwarePackagesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSoftwarePackagesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSoftwarePackages API.

ListSoftwareSourceVendors(ListSoftwareSourceVendorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<ListSoftwareSourceVendorsResponse> ListSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSoftwareSourceVendorsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSoftwareSourceVendorsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSoftwareSourceVendors API.

ListSoftwareSources(ListSoftwareSourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListSoftwareSourcesResponse> ListSoftwareSources(ListSoftwareSourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSoftwareSourcesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSoftwareSourcesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSoftwareSources API.

RemovePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Removes packages from a software source. This operation can only be done for custom software sources that are not created using filters. Packages can be of the format:

  • name (for example: git). This removes all versions of the package.
  • name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)
  • name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
Declaration
public Task<RemovePackagesFromSoftwareSourceResponse> RemovePackagesFromSoftwareSource(RemovePackagesFromSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RemovePackagesFromSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RemovePackagesFromSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemovePackagesFromSoftwareSource API.

ReplacePackagesInSoftwareSource(ReplacePackagesInSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Replaces packages in a software source with the provided list of packages. This operation can only be done for custom software sources that are not created using filters. Packages can be of the format:

  • name (for example: git). If isLatestContentOnly is true, only the latest version of the package will be added, otherwise all versions of the package will be added.
  • name-version-release.architecture (for example: git-2.43.5-1.el8_10.x86_64)
  • name-epoch:version-release.architecture (for example: git-0:2.43.5-1.el8_10.x86_64)
Declaration
public Task<ReplacePackagesInSoftwareSourceResponse> ReplacePackagesInSoftwareSource(ReplacePackagesInSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ReplacePackagesInSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ReplacePackagesInSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ReplacePackagesInSoftwareSource API.

SearchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<SearchSoftwareSourceModuleStreamsResponse> SearchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
SearchSoftwareSourceModuleStreamsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<SearchSoftwareSourceModuleStreamsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSoftwareSourceModuleStreams API.

SearchSoftwareSourceModules(SearchSoftwareSourceModulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<SearchSoftwareSourceModulesResponse> SearchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
SearchSoftwareSourceModulesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<SearchSoftwareSourceModulesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSoftwareSourceModules API.

SearchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<SearchSoftwareSourcePackageGroupsResponse> SearchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
SearchSoftwareSourcePackageGroupsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<SearchSoftwareSourcePackageGroupsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use SearchSoftwareSourcePackageGroups API.

SoftwareSourceGenerateMetadata(SoftwareSourceGenerateMetadataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Regenerates metadata for the specified custom software source.

Declaration
public Task<SoftwareSourceGenerateMetadataResponse> SoftwareSourceGenerateMetadata(SoftwareSourceGenerateMetadataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
SoftwareSourceGenerateMetadataRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<SoftwareSourceGenerateMetadataResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use SoftwareSourceGenerateMetadata API.

UpdateSoftwareSource(UpdateSoftwareSourceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration
public Task<UpdateSoftwareSourceResponse> UpdateSoftwareSource(UpdateSoftwareSourceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateSoftwareSourceRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateSoftwareSourceResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSoftwareSource API.

UpdateSoftwareSourceManifest(UpdateSoftwareSourceManifestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the package list document for the software source.

Declaration
public Task<UpdateSoftwareSourceManifestResponse> UpdateSoftwareSourceManifest(UpdateSoftwareSourceManifestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateSoftwareSourceManifestRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateSoftwareSourceManifestResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSoftwareSourceManifest API.

Implements

IDisposable
In this article
Back to top