oci-multicloud 2.127.0 → 2.129.0

package/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Oracle Multicloud API
- * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see <link to docs>.
+ * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see [Oracle Multicloud Hub](https://docs.oracle.com/iaas/Content/multicloud-hub/home.htm).
  * OpenAPI spec version: 20180828
  *
  *
@@ -20,6 +20,8 @@ export { requests };
 export { responses };
 export import MetadataClient = client.MetadataClient;
 export import MultiCloudsMetadataClient = client.MultiCloudsMetadataClient;
+export import MulticloudAlertsClient = client.MulticloudAlertsClient;
+export import MulticloudPoliciesClient = client.MulticloudPoliciesClient;
 export import MulticloudResourcesClient = client.MulticloudResourcesClient;
 export import MulticloudsubscriptionsClient = client.MulticloudsubscriptionsClient;
 export import OmhubNetworkAnchorClient = client.OmhubNetworkAnchorClient;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Oracle Multicloud API
- * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see <link to docs>.
+ * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see [Oracle Multicloud Hub](https://docs.oracle.com/iaas/Content/multicloud-hub/home.htm).
  * OpenAPI spec version: 20180828
  *
  *
@@ -31,7 +31,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OmhubResourceAnchorWaiter = exports.OmhubResourceAnchorClient = exports.OmhubNetworkAnchorClient = exports.MulticloudsubscriptionsClient = exports.MulticloudResourcesClient = exports.MultiCloudsMetadataClient = exports.MetadataClient = exports.responses = exports.requests = exports.models = void 0;
+exports.OmhubResourceAnchorWaiter = exports.OmhubResourceAnchorClient = exports.OmhubNetworkAnchorClient = exports.MulticloudsubscriptionsClient = exports.MulticloudResourcesClient = exports.MulticloudPoliciesClient = exports.MulticloudAlertsClient = exports.MultiCloudsMetadataClient = exports.MetadataClient = exports.responses = exports.requests = exports.models = void 0;
 const requests = __importStar(require("./lib/request"));
 exports.requests = requests;
 const models = __importStar(require("./lib/model"));
@@ -42,6 +42,8 @@ const client = __importStar(require("./lib/client"));
 const omhubresourceanchor_waiter = __importStar(require("./lib/omhubresourceanchor-waiter"));
 exports.MetadataClient = client.MetadataClient;
 exports.MultiCloudsMetadataClient = client.MultiCloudsMetadataClient;
+exports.MulticloudAlertsClient = client.MulticloudAlertsClient;
+exports.MulticloudPoliciesClient = client.MulticloudPoliciesClient;
 exports.MulticloudResourcesClient = client.MulticloudResourcesClient;
 exports.MulticloudsubscriptionsClient = client.MulticloudsubscriptionsClient;
 exports.OmhubNetworkAnchorClient = client.OmhubNetworkAnchorClient;

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/multicloud/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,6FAA+E;AAKjE,QAAA,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,6BAA6B,GAAG,MAAM,CAAC,6BAA6B,CAAC;AACrE,QAAA,wBAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,yBAAyB,GAAG,0BAA0B,CAAC,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/multicloud/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,6FAA+E;AAKjE,QAAA,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;AACvC,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,sBAAsB,GAAG,MAAM,CAAC,sBAAsB,CAAC;AACvD,QAAA,wBAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,6BAA6B,GAAG,MAAM,CAAC,6BAA6B,CAAC;AACrE,QAAA,wBAAwB,GAAG,MAAM,CAAC,wBAAwB,CAAC;AAC3D,QAAA,yBAAyB,GAAG,MAAM,CAAC,yBAAyB,CAAC;AAC7D,QAAA,yBAAyB,GAAG,0BAA0B,CAAC,yBAAyB,CAAC"}

package/lib/client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Oracle Multicloud API
- * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see <link to docs>.
+ * Use the Oracle Multicloud API to retrieve resource anchors and network anchors, and the metadata mappings related a Cloud Service Provider. For more information, see [Oracle Multicloud Hub](https://docs.oracle.com/iaas/Content/multicloud-hub/home.htm).
  * OpenAPI spec version: 20180828
  *
  *
@@ -91,7 +91,13 @@ export declare class MetadataClient {
      */
     listExternalLocationDetailsMetadata(listExternalLocationDetailsMetadataRequest: requests.ListExternalLocationDetailsMetadataRequest): Promise<responses.ListExternalLocationDetailsMetadataResponse>;
     /**
-     * List externalLocation metadata from OCI to the Cloud Service Provider for regions, Physical Availability Zones.
+     * List mapped partner cloud regions and zones across cloud service providers
+     * for the specified Multicloud base compartment and subscription service name.
+     * Each mapping includes the OCI region, logical availability domain, and physical availability domain,
+     * along with mapped partner cloud details that depend on the partner cloud.
+     * For example, Azure includes a logical zone while AWS doesn't.
+     * For more information, see
+     * [Cross-Cloud Region-Zone Mapping](https://docs.oracle.com/iaas/Content/multicloud-hub/view-cloud-mapping.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListExternalLocationMappingMetadataRequest
@@ -177,8 +183,10 @@ export declare class MultiCloudsMetadataClient {
      */
     close(): void;
     /**
-     * Gets information about the Multicloud base compartment for a given tenancy Id.
-     * A Multicloud base compartment is an OCI compartment that maps to a subscription in a Cloud Service Provider (such as Azure, AWS, or Google Cloud).
+     * Gets details for Multicloud metadata for the specified Multicloud subscription.
+     * Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).
+     * For more information, see
+     * [Getting Details for Multicloud Metadata](https://docs.oracle.com/iaas/Content/multicloud-hub/get-subscription-metadata.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetMultiCloudMetadataRequest
@@ -188,8 +196,10 @@ export declare class MultiCloudsMetadataClient {
      */
     getMultiCloudMetadata(getMultiCloudMetadataRequest: requests.GetMultiCloudMetadataRequest): Promise<responses.GetMultiCloudMetadataResponse>;
     /**
-     * Gets a list of multicloud metadata with pairs of Multicloud base compartment and subscription across Cloud Service Providers from a tenancy Id.
-     * A Multicloud base compartment is an OCI compartment that maps to a subscription in a Cloud Service Provider (such as Azure, AWS, or Google Cloud).
+     * Lists Multicloud metadata for Multicloud subscriptions in the specified compartment.
+     * Multicloud metadata for a subscription includes the Multicloud base compartment (top-level OCI compartment).
+     * For more information, see
+     * [Listing Multicloud Metadata for a Subscription](https://docs.oracle.com/iaas/Content/multicloud-hub/list-subscription-metadata.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListMultiCloudMetadataRequest
@@ -199,6 +209,160 @@ export declare class MultiCloudsMetadataClient {
      */
     listMultiCloudMetadata(listMultiCloudMetadataRequest: requests.ListMultiCloudMetadataRequest): Promise<responses.ListMultiCloudMetadataResponse>;
 }
+export declare enum MulticloudAlertsApiKeys {
+}
+/**
+ * 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 MulticloudAlertsClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    protected _authProvider: common.AuthenticationDetailsProvider | undefined;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * 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"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * 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}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Close the provider if possible which in turn shuts down any associated circuit breaker
+     */
+    closeProvider(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
+    /**
+     * Gets a list of Multicloud Alerts for a given root compartment.
+     * Optional query parameters can be used to filter alerts by resource,
+     * subscription, severity, lifecycle state, and alert status.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListMulticloudAlertsRequest
+     * @return ListMulticloudAlertsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/multicloud/ListMulticloudAlerts.ts.html |here} to see how to use ListMulticloudAlerts API.
+     */
+    listMulticloudAlerts(listMulticloudAlertsRequest: requests.ListMulticloudAlertsRequest): Promise<responses.ListMulticloudAlertsResponse>;
+}
+export declare enum MulticloudPoliciesApiKeys {
+}
+/**
+ * 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 MulticloudPoliciesClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    protected _authProvider: common.AuthenticationDetailsProvider | undefined;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * 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"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * 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}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Close the provider if possible which in turn shuts down any associated circuit breaker
+     */
+    closeProvider(): void;
+    /**
+     * Close the client once it is no longer needed
+     */
+    close(): void;
+    /**
+     * Gets a list of Multicloud IAM Policies.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListMulticloudPoliciesRequest
+     * @return ListMulticloudPoliciesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/multicloud/ListMulticloudPolicies.ts.html |here} to see how to use ListMulticloudPolicies API.
+     */
+    listMulticloudPolicies(listMulticloudPoliciesRequest: requests.ListMulticloudPoliciesRequest): Promise<responses.ListMulticloudPoliciesResponse>;
+}
 export declare enum MulticloudResourcesApiKeys {
 }
 /**
@@ -265,7 +429,10 @@ export declare class MulticloudResourcesClient {
      */
     close(): void;
     /**
-     * Gets a list of multicloud resources with multicloud base compartment and subscription across Cloud Service Providers.
+     * Lists Multicloud resources in the specified Multicloud subscription.
+     * Details for each resource include Multicloud base compartment, name, state, resource type, and network anchor.
+     * For more information, see
+     * [Multicloud Resources](https://docs.oracle.com/iaas/Content/multicloud-hub/list-resources.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListMulticloudResourcesRequest
@@ -341,7 +508,8 @@ export declare class MulticloudsubscriptionsClient {
      */
     close(): void;
     /**
-     * Gets a list of Multicloud Resources.
+     * Lists activated Multicloud subscriptions in the specified compartment. For more information, see
+     * [Listing Multicloud Subscriptions](https://docs.oracle.com/iaas/Content/multicloud-hub/list-subscriptions.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListMulticloudSubscriptionsRequest
@@ -417,7 +585,10 @@ export declare class OmhubNetworkAnchorClient {
      */
     close(): void;
     /**
-     * Gets information about a NetworkAnchor.
+     * Gets details for the specified network anchor. The subscription OCID and service name are required.
+     * For more information, see
+     * [Getting a Network Anchor's Details](https://docs.oracle.com/iaas/Content/multicloud-hub/get-network-anchor.htm).
+     *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetNetworkAnchorRequest
      * @return GetNetworkAnchorResponse
@@ -426,7 +597,10 @@ export declare class OmhubNetworkAnchorClient {
      */
     getNetworkAnchor(getNetworkAnchorRequest: requests.GetNetworkAnchorRequest): Promise<responses.GetNetworkAnchorResponse>;
     /**
-     * Gets a list of NetworkAnchors.
+     * Lists network anchors in the specified Multicloud subscription, Multicloud compartment, and partner cloud region.
+     * Details listed for each resource include name, state, VCN, and ODB network ID.
+     * For more information, see
+     * [Listing Network Anchors](https://docs.oracle.com/iaas/Content/multicloud-hub/list-network-anchors.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListNetworkAnchorsRequest
@@ -516,7 +690,10 @@ export declare class OmhubResourceAnchorClient {
      */
     close(): void;
     /**
-     * Gets information about a ResourceAnchor.
+     * Gets details for the specified resource anchor. The subscription OCID and service name are required.
+     * For more information, see
+     * [Getting a Resource Anchor's Details (OCI)](https://docs.oracle.com/iaas/Content/multicloud-hub/get-resource-anchor.htm).
+     *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetResourceAnchorRequest
      * @return GetResourceAnchorResponse
@@ -525,7 +702,10 @@ export declare class OmhubResourceAnchorClient {
      */
     getResourceAnchor(getResourceAnchorRequest: requests.GetResourceAnchorRequest): Promise<responses.GetResourceAnchorResponse>;
     /**
-     * Gets a list of ResourceAnchors.
+     * Lists resource anchors in the specified Multicloud subscription.
+     * Details listed for each resource anchor include name, state, and the related Multicloud compartment.
+     * For more information, see
+     * [Listing Resource Anchors](https://docs.oracle.com/iaas/Content/multicloud-hub/list-resource-anchors.htm).
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListResourceAnchorsRequest