Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigateway
  5. apigateway/v1
  6. getApi

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigateway/v1.getApi

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets details of a single Api.

    Using getApi

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApi(args: GetApiArgs, opts?: InvokeOptions): Promise<GetApiResult>
function getApiOutput(args: GetApiOutputArgs, opts?: InvokeOptions): Output<GetApiResult>
    def get_api(api_id: Optional[str] = None,
            location: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetApiResult
def get_api_output(api_id: Optional[pulumi.Input[str]] = None,
            location: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetApiResult]
    func LookupApi(ctx *Context, args *LookupApiArgs, opts ...InvokeOption) (*LookupApiResult, error)
func LookupApiOutput(ctx *Context, args *LookupApiOutputArgs, opts ...InvokeOption) LookupApiResultOutput

    > Note: This function is named LookupApi in the Go SDK.

    public static class GetApi 
{
    public static Task<GetApiResult> InvokeAsync(GetApiArgs args, InvokeOptions? opts = null)
    public static Output<GetApiResult> Invoke(GetApiInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiResult> getApi(GetApiArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:apigateway/v1:getApi
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiId string
    Location string
    Project string
    ApiId string
    Location string
    Project string
    apiId String
    location String
    project String
    apiId string
    location string
    project string
    apiId String
    location String
    project String

    getApi Result

    The following output properties are available:

    CreateTime string
    Created time.
    DisplayName string
    Optional. Display name.
    Labels Dictionary<string, string>
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    ManagedService string
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    Name string
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    State string
    State of the API.
    UpdateTime string
    Updated time.
    CreateTime string
    Created time.
    DisplayName string
    Optional. Display name.
    Labels map[string]string
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    ManagedService string
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    Name string
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    State string
    State of the API.
    UpdateTime string
    Updated time.
    createTime String
    Created time.
    displayName String
    Optional. Display name.
    labels Map<String,String>
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    managedService String
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    name String
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    state String
    State of the API.
    updateTime String
    Updated time.
    createTime string
    Created time.
    displayName string
    Optional. Display name.
    labels {[key: string]: string}
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    managedService string
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    name string
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    state string
    State of the API.
    updateTime string
    Updated time.
    create_time str
    Created time.
    display_name str
    Optional. Display name.
    labels Mapping[str, str]
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    managed_service str
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    name str
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    state str
    State of the API.
    update_time str
    Updated time.
    createTime String
    Created time.
    displayName String
    Optional. Display name.
    labels Map<String>
    Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
    managedService String
    Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API.
    name String
    Resource name of the API. Format: projects/{project}/locations/global/apis/{api}
    state String
    State of the API.
    updateTime String
    Updated time.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native