@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public interface SoftwareSource extends AutoCloseable
Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
AddPackagesToSoftwareSourceResponse |
addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request)
Adds packages to a software source.
|
ChangeAvailabilityOfSoftwareSourcesResponse |
changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request)
Updates the availability for a list of specified software sources.
|
ChangeSoftwareSourceCompartmentResponse |
changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request)
Moves the specified software sources to a different compartment within the same tenancy.
|
CreateEntitlementResponse |
createEntitlement(CreateEntitlementRequest request)
Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.
|
CreateSoftwareSourceResponse |
createSoftwareSource(CreateSoftwareSourceRequest request)
Creates a new versioned or custom software source.
|
DeleteSoftwareSourceResponse |
deleteSoftwareSource(DeleteSoftwareSourceRequest request)
Deletes the specified software source.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetErratumResponse |
getErratum(GetErratumRequest request)
Returns information about the specified erratum based on its advisory name.
|
GetModuleStreamResponse |
getModuleStream(GetModuleStreamRequest request)
Returns information about the specified module stream in a software source.
|
GetModuleStreamProfileResponse |
getModuleStreamProfile(GetModuleStreamProfileRequest request)
Returns information about the specified module stream profile in a software source.
|
GetPackageGroupResponse |
getPackageGroup(GetPackageGroupRequest request)
Returns information about the specified package group from a software source.
|
SoftwareSourcePaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetSoftwarePackageResponse |
getSoftwarePackage(GetSoftwarePackageRequest request)
Returns information about the specified software package.
|
GetSoftwarePackageByNameResponse |
getSoftwarePackageByName(GetSoftwarePackageByNameRequest request)
Returns information about the specified software package based on its fully qualified name.
|
GetSoftwareSourceResponse |
getSoftwareSource(GetSoftwareSourceRequest request)
Returns information about the specified software source.
|
SoftwareSourceWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListAllSoftwarePackagesResponse |
listAllSoftwarePackages(ListAllSoftwarePackagesRequest request)
Lists software packages available through the OS Management Hub service.
|
ListEntitlementsResponse |
listEntitlements(ListEntitlementsRequest request)
Lists entitlements in the specified tenancy
OCID.
|
ListErrataResponse |
listErrata(ListErrataRequest request)
Lists all of the currently available errata.
|
ListModuleStreamProfilesResponse |
listModuleStreamProfiles(ListModuleStreamProfilesRequest request)
Lists module stream profiles from the specified software source
OCID.
|
ListModuleStreamsResponse |
listModuleStreams(ListModuleStreamsRequest request)
Lists module streams from the specified software source
OCID.
|
ListPackageGroupsResponse |
listPackageGroups(ListPackageGroupsRequest request)
Lists package groups that are associated with the specified software source
OCID.
|
ListSoftwarePackagesResponse |
listSoftwarePackages(ListSoftwarePackagesRequest request)
Lists software packages in the specified software source.
|
ListSoftwarePackageSoftwareSourcesResponse |
listSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest request)
Lists the software sources in the tenancy that contain the software package.
|
ListSoftwareSourcesResponse |
listSoftwareSources(ListSoftwareSourcesRequest request)
Lists software sources that match the specified tenancy or software source
OCID.
|
ListSoftwareSourceVendorsResponse |
listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request)
Lists available software source vendors.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
SearchSoftwareSourceModulesResponse |
searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request)
Lists modules from a list of software sources.
|
SearchSoftwareSourceModuleStreamsResponse |
searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request)
Returns a list of module streams from the specified software sources.
|
SearchSoftwareSourcePackageGroupsResponse |
searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request)
Searches the package groups from the specified list of software sources.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateSoftwareSourceResponse |
updateSoftwareSource(UpdateSoftwareSourceRequest request)
Updates the specified software source’s details, including but not limited to name,
description, and tags.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateAddPackagesToSoftwareSourceResponse addPackagesToSoftwareSource(AddPackagesToSoftwareSourceRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use AddPackagesToSoftwareSource API.
ChangeAvailabilityOfSoftwareSourcesResponse changeAvailabilityOfSoftwareSources(ChangeAvailabilityOfSoftwareSourcesRequest request)
Updates the availability for a list of specified software sources.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeAvailabilityOfSoftwareSources API.
ChangeSoftwareSourceCompartmentResponse changeSoftwareSourceCompartment(ChangeSoftwareSourceCompartmentRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ChangeSoftwareSourceCompartment API.
CreateEntitlementResponse createEntitlement(CreateEntitlementRequest request)
Registers the necessary entitlement credentials for OS vendor software sources for a tenancy.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateEntitlement API.
CreateSoftwareSourceResponse createSoftwareSource(CreateSoftwareSourceRequest request)
Creates a new versioned or custom software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use CreateSoftwareSource API.
DeleteSoftwareSourceResponse deleteSoftwareSource(DeleteSoftwareSourceRequest request)
Deletes the specified software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use DeleteSoftwareSource API.
GetErratumResponse getErratum(GetErratumRequest request)
Returns information about the specified erratum based on its advisory name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetErratum API.
GetModuleStreamResponse getModuleStream(GetModuleStreamRequest request)
Returns information about the specified module stream in a software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetModuleStream API.
GetModuleStreamProfileResponse getModuleStreamProfile(GetModuleStreamProfileRequest request)
Returns information about the specified module stream profile in a software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetModuleStreamProfile API.
GetPackageGroupResponse getPackageGroup(GetPackageGroupRequest request)
Returns information about the specified package group from a software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetPackageGroup API.
GetSoftwarePackageResponse getSoftwarePackage(GetSoftwarePackageRequest request)
Returns information about the specified software package.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSoftwarePackage API.
GetSoftwarePackageByNameResponse getSoftwarePackageByName(GetSoftwarePackageByNameRequest request)
Returns information about the specified software package based on its fully qualified name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSoftwarePackageByName API.
GetSoftwareSourceResponse getSoftwareSource(GetSoftwareSourceRequest request)
Returns information about the specified software source.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use GetSoftwareSource API.
ListAllSoftwarePackagesResponse listAllSoftwarePackages(ListAllSoftwarePackagesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListAllSoftwarePackages API.
ListEntitlementsResponse listEntitlements(ListEntitlementsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListEntitlements API.
ListErrataResponse listErrata(ListErrataRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListErrata API.
ListModuleStreamProfilesResponse listModuleStreamProfiles(ListModuleStreamProfilesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListModuleStreamProfiles API.
ListModuleStreamsResponse listModuleStreams(ListModuleStreamsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListModuleStreams API.
ListPackageGroupsResponse listPackageGroups(ListPackageGroupsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListPackageGroups API.
ListSoftwarePackageSoftwareSourcesResponse listSoftwarePackageSoftwareSources(ListSoftwarePackageSoftwareSourcesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSoftwarePackageSoftwareSources API.
ListSoftwarePackagesResponse listSoftwarePackages(ListSoftwarePackagesRequest request)
Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSoftwarePackages API.
ListSoftwareSourceVendorsResponse listSoftwareSourceVendors(ListSoftwareSourceVendorsRequest request)
Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSoftwareSourceVendors API.
ListSoftwareSourcesResponse listSoftwareSources(ListSoftwareSourcesRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use ListSoftwareSources API.
SearchSoftwareSourceModuleStreamsResponse searchSoftwareSourceModuleStreams(SearchSoftwareSourceModuleStreamsRequest request)
Returns a list of module streams from the specified software sources. Filter the list against a variety of criteria including the module name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SearchSoftwareSourceModuleStreams API.
SearchSoftwareSourceModulesResponse searchSoftwareSourceModules(SearchSoftwareSourceModulesRequest request)
Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SearchSoftwareSourceModules API.
SearchSoftwareSourcePackageGroupsResponse searchSoftwareSourcePackageGroups(SearchSoftwareSourcePackageGroupsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use SearchSoftwareSourcePackageGroups API.
UpdateSoftwareSourceResponse updateSoftwareSource(UpdateSoftwareSourceRequest request)
Updates the specified software source’s details, including but not limited to name, description, and tags.
request
- The request object containing the details to sendBmcException
- when an error occurs. This operation uses
RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is
provided. The specifics of the default retry strategy are described here
https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
Example: Click here to see how to use UpdateSoftwareSource API.
SoftwareSourceWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
SoftwareSourcePaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
Copyright © 2016–2024. All rights reserved.