oci-managementagent 2.5.2 → 2.8.0

package/lib/client.d.ts

@@ -17,6 +17,9 @@ import * as responses from "./response";
 import { ManagementAgentWaiter } from "./managementagent-waiter";
 export declare enum ManagementAgentApiKeys {
 }
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
 export declare class ManagementAgentClient {
     protected static serviceEndpointTemplate: string;
     protected "_endpoint": string;
@@ -67,94 +70,105 @@ export declare class ManagementAgentClient {
     /**
      * User creates a new install key as part of this API.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateManagementAgentInstallKeyRequest
      * @return CreateManagementAgentInstallKeyResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/CreateManagementAgentInstallKey.ts.html |here} to see how to use CreateManagementAgentInstallKey API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/CreateManagementAgentInstallKey.ts.html |here} to see how to use CreateManagementAgentInstallKey API.
      */
     createManagementAgentInstallKey(createManagementAgentInstallKeyRequest: requests.CreateManagementAgentInstallKeyRequest): Promise<responses.CreateManagementAgentInstallKeyResponse>;
     /**
      * Deletes a Management Agent resource by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteManagementAgentRequest
      * @return DeleteManagementAgentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/DeleteManagementAgent.ts.html |here} to see how to use DeleteManagementAgent API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/DeleteManagementAgent.ts.html |here} to see how to use DeleteManagementAgent API.
      */
     deleteManagementAgent(deleteManagementAgentRequest: requests.DeleteManagementAgentRequest): Promise<responses.DeleteManagementAgentResponse>;
     /**
      * Deletes a Management Agent install Key resource by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteManagementAgentInstallKeyRequest
      * @return DeleteManagementAgentInstallKeyResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/DeleteManagementAgentInstallKey.ts.html |here} to see how to use DeleteManagementAgentInstallKey API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/DeleteManagementAgentInstallKey.ts.html |here} to see how to use DeleteManagementAgentInstallKey API.
      */
     deleteManagementAgentInstallKey(deleteManagementAgentInstallKeyRequest: requests.DeleteManagementAgentInstallKeyRequest): Promise<responses.DeleteManagementAgentInstallKeyResponse>;
     /**
      * Cancel the work request with the given ID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteWorkRequestRequest
      * @return DeleteWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
      */
     deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise<responses.DeleteWorkRequestResponse>;
     /**
      * Deploys Plugins to a given list of agentIds.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeployPluginsRequest
      * @return DeployPluginsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/DeployPlugins.ts.html |here} to see how to use DeployPlugins API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/DeployPlugins.ts.html |here} to see how to use DeployPlugins API.
      */
     deployPlugins(deployPluginsRequest: requests.DeployPluginsRequest): Promise<responses.DeployPluginsResponse>;
     /**
      * Get the AutoUpgradable configuration for all agents in a tenancy.
      * The supplied compartmentId must be a tenancy root.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetAutoUpgradableConfigRequest
      * @return GetAutoUpgradableConfigResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/GetAutoUpgradableConfig.ts.html |here} to see how to use GetAutoUpgradableConfig API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/GetAutoUpgradableConfig.ts.html |here} to see how to use GetAutoUpgradableConfig API.
      */
     getAutoUpgradableConfig(getAutoUpgradableConfigRequest: requests.GetAutoUpgradableConfigRequest): Promise<responses.GetAutoUpgradableConfigResponse>;
     /**
      * Gets complete details of the inventory of a given agent id
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetManagementAgentRequest
      * @return GetManagementAgentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/GetManagementAgent.ts.html |here} to see how to use GetManagementAgent API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/GetManagementAgent.ts.html |here} to see how to use GetManagementAgent API.
      */
     getManagementAgent(getManagementAgentRequest: requests.GetManagementAgentRequest): Promise<responses.GetManagementAgentResponse>;
     /**
      * Gets complete details of the Agent install Key for a given key id
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetManagementAgentInstallKeyRequest
      * @return GetManagementAgentInstallKeyResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/GetManagementAgentInstallKey.ts.html |here} to see how to use GetManagementAgentInstallKey API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/GetManagementAgentInstallKey.ts.html |here} to see how to use GetManagementAgentInstallKey API.
      */
     getManagementAgentInstallKey(getManagementAgentInstallKeyRequest: requests.GetManagementAgentInstallKeyRequest): Promise<responses.GetManagementAgentInstallKeyResponse>;
     /**
      * Returns a file with Management Agent install Key in it
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetManagementAgentInstallKeyContentRequest
      * @return GetManagementAgentInstallKeyContentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/GetManagementAgentInstallKeyContent.ts.html |here} to see how to use GetManagementAgentInstallKeyContent API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/GetManagementAgentInstallKeyContent.ts.html |here} to see how to use GetManagementAgentInstallKeyContent API.
      */
     getManagementAgentInstallKeyContent(getManagementAgentInstallKeyContentRequest: requests.GetManagementAgentInstallKeyContentRequest): Promise<responses.GetManagementAgentInstallKeyContentResponse>;
     /**
      * Gets the status of the work request with the given ID.
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetWorkRequestRequest
      * @return GetWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
      * Lists the availability history records of Management Agent
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListAvailabilityHistoriesRequest
      * @return ListAvailabilityHistoriesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListAvailabilityHistories.ts.html |here} to see how to use ListAvailabilityHistories API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListAvailabilityHistories.ts.html |here} to see how to use ListAvailabilityHistories API.
      */
     listAvailabilityHistories(listAvailabilityHistoriesRequest: requests.ListAvailabilityHistoriesRequest): Promise<responses.ListAvailabilityHistoriesResponse>;
     /**
@@ -192,10 +206,11 @@ export declare class ManagementAgentClient {
     /**
      * Get supported agent image information
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListManagementAgentImagesRequest
      * @return ListManagementAgentImagesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListManagementAgentImages.ts.html |here} to see how to use ListManagementAgentImages API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListManagementAgentImages.ts.html |here} to see how to use ListManagementAgentImages API.
      */
     listManagementAgentImages(listManagementAgentImagesRequest: requests.ListManagementAgentImagesRequest): Promise<responses.ListManagementAgentImagesResponse>;
     /**
@@ -233,10 +248,11 @@ export declare class ManagementAgentClient {
     /**
      * Returns a list of Management Agent installed Keys.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListManagementAgentInstallKeysRequest
      * @return ListManagementAgentInstallKeysResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListManagementAgentInstallKeys.ts.html |here} to see how to use ListManagementAgentInstallKeys API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListManagementAgentInstallKeys.ts.html |here} to see how to use ListManagementAgentInstallKeys API.
      */
     listManagementAgentInstallKeys(listManagementAgentInstallKeysRequest: requests.ListManagementAgentInstallKeysRequest): Promise<responses.ListManagementAgentInstallKeysResponse>;
     /**
@@ -274,10 +290,11 @@ export declare class ManagementAgentClient {
     /**
      * Returns a list of managementAgentPlugins.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListManagementAgentPluginsRequest
      * @return ListManagementAgentPluginsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListManagementAgentPlugins.ts.html |here} to see how to use ListManagementAgentPlugins API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListManagementAgentPlugins.ts.html |here} to see how to use ListManagementAgentPlugins API.
      */
     listManagementAgentPlugins(listManagementAgentPluginsRequest: requests.ListManagementAgentPluginsRequest): Promise<responses.ListManagementAgentPluginsResponse>;
     /**
@@ -315,10 +332,11 @@ export declare class ManagementAgentClient {
     /**
      * Returns a list of Management Agent.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListManagementAgentsRequest
      * @return ListManagementAgentsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListManagementAgents.ts.html |here} to see how to use ListManagementAgents API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListManagementAgents.ts.html |here} to see how to use ListManagementAgents API.
      */
     listManagementAgents(listManagementAgentsRequest: requests.ListManagementAgentsRequest): Promise<responses.ListManagementAgentsResponse>;
     /**
@@ -356,10 +374,11 @@ export declare class ManagementAgentClient {
     /**
      * Return a (paginated) list of errors for a given work request.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestErrorsRequest
      * @return ListWorkRequestErrorsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
@@ -397,10 +416,11 @@ export declare class ManagementAgentClient {
     /**
      * Return a (paginated) list of logs for a given work request.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestLogsRequest
      * @return ListWorkRequestLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
@@ -438,10 +458,11 @@ export declare class ManagementAgentClient {
     /**
      * Lists the work requests in a compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestsRequest
      * @return ListWorkRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
@@ -480,48 +501,53 @@ export declare class ManagementAgentClient {
      * Sets the AutoUpgradable configuration for all agents in a tenancy.
      * The supplied compartmentId must be a tenancy root.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param SetAutoUpgradableConfigRequest
      * @return SetAutoUpgradableConfigResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/SetAutoUpgradableConfig.ts.html |here} to see how to use SetAutoUpgradableConfig API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/SetAutoUpgradableConfig.ts.html |here} to see how to use SetAutoUpgradableConfig API.
      */
     setAutoUpgradableConfig(setAutoUpgradableConfigRequest: requests.SetAutoUpgradableConfigRequest): Promise<responses.SetAutoUpgradableConfigResponse>;
     /**
      * Gets count of the inventory of agents for a given compartment id, group by, and isPluginDeployed parameters.
      * Supported groupBy parameters: availabilityStatus, platformType, version
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param SummarizeManagementAgentCountsRequest
      * @return SummarizeManagementAgentCountsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/SummarizeManagementAgentCounts.ts.html |here} to see how to use SummarizeManagementAgentCounts API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/SummarizeManagementAgentCounts.ts.html |here} to see how to use SummarizeManagementAgentCounts API.
      */
     summarizeManagementAgentCounts(summarizeManagementAgentCountsRequest: requests.SummarizeManagementAgentCountsRequest): Promise<responses.SummarizeManagementAgentCountsResponse>;
     /**
      * Gets count of the inventory of management agent plugins for a given compartment id and group by parameter.
      * Supported groupBy parameter: pluginName
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param SummarizeManagementAgentPluginCountsRequest
      * @return SummarizeManagementAgentPluginCountsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/SummarizeManagementAgentPluginCounts.ts.html |here} to see how to use SummarizeManagementAgentPluginCounts API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/SummarizeManagementAgentPluginCounts.ts.html |here} to see how to use SummarizeManagementAgentPluginCounts API.
      */
     summarizeManagementAgentPluginCounts(summarizeManagementAgentPluginCountsRequest: requests.SummarizeManagementAgentPluginCountsRequest): Promise<responses.SummarizeManagementAgentPluginCountsResponse>;
     /**
      * API to update the console managed properties of the Management Agent.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateManagementAgentRequest
      * @return UpdateManagementAgentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/UpdateManagementAgent.ts.html |here} to see how to use UpdateManagementAgent API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/UpdateManagementAgent.ts.html |here} to see how to use UpdateManagementAgent API.
      */
     updateManagementAgent(updateManagementAgentRequest: requests.UpdateManagementAgentRequest): Promise<responses.UpdateManagementAgentResponse>;
     /**
      * API to update the modifiable properties of the Management Agent install key.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateManagementAgentInstallKeyRequest
      * @return UpdateManagementAgentInstallKeyResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/managementagent/UpdateManagementAgentInstallKey.ts.html |here} to see how to use UpdateManagementAgentInstallKey API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/managementagent/UpdateManagementAgentInstallKey.ts.html |here} to see how to use UpdateManagementAgentInstallKey API.
      */
     updateManagementAgentInstallKey(updateManagementAgentInstallKeyRequest: requests.UpdateManagementAgentInstallKeyRequest): Promise<responses.UpdateManagementAgentInstallKeyResponse>;
 }