oci-psa 2.121.0

package/lib/client.d.ts

@@ -0,0 +1,216 @@
+/**
+ * PrivateServiceAccess Control Plane API
+ * Use the PrivateServiceAccess Control Plane API to manage privateServiceAccess.
+ * OpenAPI spec version: 20240301
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2025, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { PrivateServiceAccessWaiter } from "./privateserviceaccess-waiter";
+declare const Breaker: any;
+export declare enum PrivateServiceAccessApiKeys {
+}
+/**
+ * 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 PrivateServiceAccessClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": PrivateServiceAccessWaiter;
+    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);
+    /**
+     * Creates a new PrivateServiceAccessWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): PrivateServiceAccessWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): PrivateServiceAccessWaiter;
+    /**
+     * 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;
+    /**
+     * Cancels a PrivateServiceAccess work request.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CancelPsaWorkRequestRequest
+     * @return CancelPsaWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/CancelPsaWorkRequest.ts.html |here} to see how to use CancelPsaWorkRequest API.
+     */
+    cancelPsaWorkRequest(cancelPsaWorkRequestRequest: requests.CancelPsaWorkRequestRequest): Promise<responses.CancelPsaWorkRequestResponse>;
+    /**
+     * Moves a PrivateServiceAccess into a different compartment within the same tenancy. For information about moving resources between
+     * compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ChangePrivateServiceAccessCompartmentRequest
+     * @return ChangePrivateServiceAccessCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ChangePrivateServiceAccessCompartment.ts.html |here} to see how to use ChangePrivateServiceAccessCompartment API.
+     */
+    changePrivateServiceAccessCompartment(changePrivateServiceAccessCompartmentRequest: requests.ChangePrivateServiceAccessCompartmentRequest): Promise<responses.ChangePrivateServiceAccessCompartmentResponse>;
+    /**
+     * Creates a private service access in the specified subnet (in the consumer's VCN) and the specified
+     * compartment for a particular service.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreatePrivateServiceAccessRequest
+     * @return CreatePrivateServiceAccessResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/CreatePrivateServiceAccess.ts.html |here} to see how to use CreatePrivateServiceAccess API.
+     */
+    createPrivateServiceAccess(createPrivateServiceAccessRequest: requests.CreatePrivateServiceAccessRequest): Promise<responses.CreatePrivateServiceAccessResponse>;
+    /**
+     * Deletes a PrivateServiceAccess.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeletePrivateServiceAccessRequest
+     * @return DeletePrivateServiceAccessResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/DeletePrivateServiceAccess.ts.html |here} to see how to use DeletePrivateServiceAccess API.
+     */
+    deletePrivateServiceAccess(deletePrivateServiceAccessRequest: requests.DeletePrivateServiceAccessRequest): Promise<responses.DeletePrivateServiceAccessResponse>;
+    /**
+     * Gets information about a PrivateServiceAccess.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetPrivateServiceAccessRequest
+     * @return GetPrivateServiceAccessResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/GetPrivateServiceAccess.ts.html |here} to see how to use GetPrivateServiceAccess API.
+     */
+    getPrivateServiceAccess(getPrivateServiceAccessRequest: requests.GetPrivateServiceAccessRequest): Promise<responses.GetPrivateServiceAccessResponse>;
+    /**
+     * Gets the details of a PrivateServiceAccess work request.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetPsaWorkRequestRequest
+     * @return GetPsaWorkRequestResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/GetPsaWorkRequest.ts.html |here} to see how to use GetPsaWorkRequest API.
+     */
+    getPsaWorkRequest(getPsaWorkRequestRequest: requests.GetPsaWorkRequestRequest): Promise<responses.GetPsaWorkRequestResponse>;
+    /**
+     * List the private service accesses in the specified compartment. You can optionally filter the list by
+     * specifying the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a subnet in the cunsumer's VCN.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPrivateServiceAccessesRequest
+     * @return ListPrivateServiceAccessesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ListPrivateServiceAccesses.ts.html |here} to see how to use ListPrivateServiceAccesses API.
+     */
+    listPrivateServiceAccesses(listPrivateServiceAccessesRequest: requests.ListPrivateServiceAccessesRequest): Promise<responses.ListPrivateServiceAccessesResponse>;
+    /**
+     * List the OCI services available for Private Service Access catalog in the region, sorted by service name.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPsaServicesRequest
+     * @return ListPsaServicesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ListPsaServices.ts.html |here} to see how to use ListPsaServices API.
+     */
+    listPsaServices(listPsaServicesRequest: requests.ListPsaServicesRequest): Promise<responses.ListPsaServicesResponse>;
+    /**
+     * Lists the errors for a PrivateServiceAccess work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPsaWorkRequestErrorsRequest
+     * @return ListPsaWorkRequestErrorsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ListPsaWorkRequestErrors.ts.html |here} to see how to use ListPsaWorkRequestErrors API.
+     */
+    listPsaWorkRequestErrors(listPsaWorkRequestErrorsRequest: requests.ListPsaWorkRequestErrorsRequest): Promise<responses.ListPsaWorkRequestErrorsResponse>;
+    /**
+     * Lists the logs for a PrivateServiceAccess work request.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPsaWorkRequestLogsRequest
+     * @return ListPsaWorkRequestLogsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ListPsaWorkRequestLogs.ts.html |here} to see how to use ListPsaWorkRequestLogs API.
+     */
+    listPsaWorkRequestLogs(listPsaWorkRequestLogsRequest: requests.ListPsaWorkRequestLogsRequest): Promise<responses.ListPsaWorkRequestLogsResponse>;
+    /**
+     * Lists the PrivateServiceAccess work requests in a compartment.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListPsaWorkRequestsRequest
+     * @return ListPsaWorkRequestsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/ListPsaWorkRequests.ts.html |here} to see how to use ListPsaWorkRequests API.
+     */
+    listPsaWorkRequests(listPsaWorkRequestsRequest: requests.ListPsaWorkRequestsRequest): Promise<responses.ListPsaWorkRequestsResponse>;
+    /**
+     * Updates a PrivateServiceAccess.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdatePrivateServiceAccessRequest
+     * @return UpdatePrivateServiceAccessResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/psa/UpdatePrivateServiceAccess.ts.html |here} to see how to use UpdatePrivateServiceAccess API.
+     */
+    updatePrivateServiceAccess(updatePrivateServiceAccessRequest: requests.UpdatePrivateServiceAccessRequest): Promise<responses.UpdatePrivateServiceAccessResponse>;
+}
+export {};