1. Pulumi Registry
  2. Google Cloud Native
  3. API Docs
  4. firebase
  5. firebase/v1beta1
  6. getWebApp
google-native logo
Google Cloud Native v0.28.0, Feb 2 23

google-native.firebase/v1beta1.getWebApp

Gets the specified WebApp.

Using getWebApp

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 getWebApp(args: GetWebAppArgs, opts?: InvokeOptions): Promise<GetWebAppResult>
function getWebAppOutput(args: GetWebAppOutputArgs, opts?: InvokeOptions): Output<GetWebAppResult>
def get_web_app(project: Optional[str] = None,
                web_app_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetWebAppResult
def get_web_app_output(project: Optional[pulumi.Input[str]] = None,
                web_app_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetWebAppResult]
func LookupWebApp(ctx *Context, args *LookupWebAppArgs, opts ...InvokeOption) (*LookupWebAppResult, error)
func LookupWebAppOutput(ctx *Context, args *LookupWebAppOutputArgs, opts ...InvokeOption) LookupWebAppResultOutput

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

public static class GetWebApp 
{
    public static Task<GetWebAppResult> InvokeAsync(GetWebAppArgs args, InvokeOptions? opts = null)
    public static Output<GetWebAppResult> Invoke(GetWebAppInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWebAppResult> getWebApp(GetWebAppArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:firebase/v1beta1:getWebApp
  arguments:
    # arguments dictionary

The following arguments are supported:

WebAppId string
Project string
WebAppId string
Project string
webAppId String
project String
webAppId string
project string
webAppId String
project String

getWebApp Result

The following output properties are available:

ApiKeyId string

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

AppId string

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

AppUrls List<string>

The URLs where the WebApp is hosted.

DisplayName string

The user-assigned display name for the WebApp.

Etag string

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

Name string

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

Project string

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

State string

The lifecycle state of the App.

WebId string

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

ApiKeyId string

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

AppId string

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

AppUrls []string

The URLs where the WebApp is hosted.

DisplayName string

The user-assigned display name for the WebApp.

Etag string

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

Name string

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

Project string

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

State string

The lifecycle state of the App.

WebId string

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

apiKeyId String

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

appId String

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

appUrls List<String>

The URLs where the WebApp is hosted.

displayName String

The user-assigned display name for the WebApp.

etag String

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

name String

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

project String

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

state String

The lifecycle state of the App.

webId String

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

apiKeyId string

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

appId string

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

appUrls string[]

The URLs where the WebApp is hosted.

displayName string

The user-assigned display name for the WebApp.

etag string

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

name string

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

project string

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

state string

The lifecycle state of the App.

webId string

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

api_key_id str

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

app_id str

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

app_urls Sequence[str]

The URLs where the WebApp is hosted.

display_name str

The user-assigned display name for the WebApp.

etag str

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

name str

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

project str

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

state str

The lifecycle state of the App.

web_id str

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

apiKeyId String

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.

appId String

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.

appUrls List<String>

The URLs where the WebApp is hosted.

displayName String

The user-assigned display name for the WebApp.

etag String

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.

name String

The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).

project String

Immutable. A user-assigned unique identifier of the parent FirebaseProject for the WebApp.

state String

The lifecycle state of the App.

webId String

Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

Package Details

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