import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Api resource in Oracle Cloud Infrastructure API Gateway service. * * Gets an API by identifier. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testApi = oci.apigateway.getApi({ * apiId: testApiOciApigatewayApi.id, * }); * ``` */ export declare function getApi(args: GetApiArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getApi. */ export interface GetApiArgs { /** * The ocid of the API. */ apiId: string; } /** * A collection of values returned by getApi. */ export interface GetApiResult { readonly apiId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ readonly compartmentId: string; readonly content: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: { [key: string]: string; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ readonly displayName: string; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource. */ readonly id: string; readonly isLockOverride: boolean; /** * A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: * * 'New' for just updated API Specifications * * 'Validating' for a document which is being validated. * * 'Valid' the document has been validated without any errors or warnings * * 'Warning' the document has been validated and contains warnings * * 'Error' the document has been validated and contains errors * * 'Failed' the document validation failed * * 'Canceled' the document validation was canceled */ readonly lifecycleDetails: string; /** * Locks associated with this resource. */ readonly locks: outputs.ApiGateway.GetApiLock[]; /** * Type of API Specification file. */ readonly specificationType: string; /** * The current state of the API. */ readonly state: string; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: { [key: string]: string; }; /** * The time this resource was created. An RFC3339 formatted datetime string. */ readonly timeCreated: string; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ readonly timeUpdated: string; /** * Status of each feature available from the API. */ readonly validationResults: outputs.ApiGateway.GetApiValidationResult[]; } /** * This data source provides details about a specific Api resource in Oracle Cloud Infrastructure API Gateway service. * * Gets an API by identifier. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testApi = oci.apigateway.getApi({ * apiId: testApiOciApigatewayApi.id, * }); * ``` */ export declare function getApiOutput(args: GetApiOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getApi. */ export interface GetApiOutputArgs { /** * The ocid of the API. */ apiId: pulumi.Input; } //# sourceMappingURL=getApi.d.ts.map