oci-vbsinst 2.52.0

package/lib/client.d.ts

@@ -0,0 +1,167 @@
+/**
+ * VbsControlplaneInstance API
+ * A description of the VbsControlplaneInstance API
+ * OpenAPI spec version: 20180828
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2023, 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 { VbsInstanceWaiter } from "./vbsinstance-waiter";
+export declare enum VbsInstanceApiKeys {
+}
+/**
+ * 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 VbsInstanceClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": VbsInstanceWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpOptions: any;
+    targetService: string;
+    protected _httpClient: common.HttpClient;
+    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;
+    /**
+     * 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 VbsInstanceWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): VbsInstanceWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): VbsInstanceWaiter;
+    /**
+     * Moves a VbsInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ChangeVbsInstanceCompartmentRequest
+     * @return ChangeVbsInstanceCompartmentResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/ChangeVbsInstanceCompartment.ts.html |here} to see how to use ChangeVbsInstanceCompartment API.
+     */
+    changeVbsInstanceCompartment(changeVbsInstanceCompartmentRequest: requests.ChangeVbsInstanceCompartmentRequest): Promise<responses.ChangeVbsInstanceCompartmentResponse>;
+    /**
+     * Creates a new VbsInstance.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateVbsInstanceRequest
+     * @return CreateVbsInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/CreateVbsInstance.ts.html |here} to see how to use CreateVbsInstance API.
+     */
+    createVbsInstance(createVbsInstanceRequest: requests.CreateVbsInstanceRequest): Promise<responses.CreateVbsInstanceResponse>;
+    /**
+     * Deletes a VbsInstance resource by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteVbsInstanceRequest
+     * @return DeleteVbsInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/DeleteVbsInstance.ts.html |here} to see how to use DeleteVbsInstance API.
+     */
+    deleteVbsInstance(deleteVbsInstanceRequest: requests.DeleteVbsInstanceRequest): Promise<responses.DeleteVbsInstanceResponse>;
+    /**
+     * Gets a VbsInstance by identifier
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetVbsInstanceRequest
+     * @return GetVbsInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/GetVbsInstance.ts.html |here} to see how to use GetVbsInstance API.
+     */
+    getVbsInstance(getVbsInstanceRequest: requests.GetVbsInstanceRequest): Promise<responses.GetVbsInstanceResponse>;
+    /**
+     * 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.52.0/vbsinst/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Returns a list of VbsInstances.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListVbsInstancesRequest
+     * @return ListVbsInstancesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/ListVbsInstances.ts.html |here} to see how to use ListVbsInstances API.
+     */
+    listVbsInstances(listVbsInstancesRequest: requests.ListVbsInstancesRequest): Promise<responses.ListVbsInstancesResponse>;
+    /**
+     * 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.52.0/vbsinst/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     */
+    listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
+    /**
+     * 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.52.0/vbsinst/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     */
+    listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
+    /**
+     * 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.52.0/vbsinst/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates the VbsInstance
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateVbsInstanceRequest
+     * @return UpdateVbsInstanceResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.52.0/vbsinst/UpdateVbsInstance.ts.html |here} to see how to use UpdateVbsInstance API.
+     */
+    updateVbsInstance(updateVbsInstanceRequest: requests.UpdateVbsInstanceRequest): Promise<responses.UpdateVbsInstanceResponse>;
+}