AndroidApp.yaml

# Copyright 2024 Google Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

---
name: 'AndroidApp'
description: |
  A Google Cloud Firebase Android application instance
min_version: 'beta'
references:
  guides:
    'Official Documentation': 'https://firebase.google.com/docs/android/setup'
  api: 'https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.androidApps'
docs:
base_url: 'projects/{{project}}/androidApps'
self_link: 'projects/{{project}}/androidApps/{{app_id}}'
update_verb: 'PATCH'
update_mask: true
delete_url: 'projects/{{project}}/androidApps/{{app_id}}:remove'
delete_verb: 'POST'
import_format:
  - '{{project}} projects/{{project}}/androidApps/{{app_id}}'
  - 'projects/{{project}}/androidApps/{{app_id}}'
  - 'androidApps/{{app_id}}'
  - '{{app_id}}'
timeouts:
  insert_minutes: 20
  update_minutes: 20
  delete_minutes: 20
autogen_async: true
async:
  actions: ['create', 'delete']
  type: 'OpAsync'
  operation:
    base_url: '{{op_id}}'
  result:
    resource_inside_response: true
identity:
  - appId
  - name
custom_code:
  custom_delete: 'templates/terraform/custom_delete/firebase_app_deletion_policy.tmpl'
deletion_policy_exclude: true
# Sweeper skipped as this resource has customized deletion.
exclude_sweeper: true
examples:
  - name: 'firebase_android_app_basic'
    primary_resource_id: 'basic'
    min_version: 'beta'
    vars:
      display_name: 'Display Name Basic'
      package_name: 'android.package.app'
    test_env_vars:
      project_id: 'PROJECT_NAME'
    test_vars_overrides:
      'package_name': '"android.package.app" + acctest.RandString(t, 4)'
      'display_name': '"tf-test Display Name Basic"'
    ignore_read_extra:
      - 'project'
      - 'deletion_policy'
  - name: 'firebase_android_app_custom_api_key'
    primary_resource_id: 'default'
    min_version: 'beta'
    vars:
      display_name: 'Display Name'
      api_key_name: 'api-key'
      package_name: 'android.package.app'
    test_env_vars:
      project_id: 'PROJECT_NAME'
    test_vars_overrides:
      'package_name': '"android.package.app" + acctest.RandString(t, 4)'
      'display_name': '"tf-test Display Name"'
    ignore_read_extra:
      - 'project'
      - 'deletion_policy'
virtual_fields:
  - name: 'deletion_policy'
    description: |
      (Optional) Set to `ABANDON` to allow the AndroidApp to be untracked from terraform state
      rather than deleted upon `terraform destroy`. This is useful because the AndroidApp may be
      serving traffic. Set to `DELETE` to delete the AndroidApp. Defaults to `DELETE`.
    type: String
    default_value: "DELETE"
parameters:
properties:
  - name: 'name'
    type: String
    description: |
      The fully qualified resource name of the AndroidApp, for example:
      projects/projectId/androidApps/appId
    min_version: 'beta'
    output: true
  - name: 'displayName'
    type: String
    description: |
      The user-assigned display name of the AndroidApp.
    min_version: 'beta'
    required: true
  - name: 'appId'
    type: String
    description: |
      The globally unique, Firebase-assigned identifier of the AndroidApp.
      This identifier should be treated as an opaque token, as the data format is not specified.
    min_version: 'beta'
    output: true
  - name: 'packageName'
    type: String
    description: |
      The canonical package name of the Android app as would appear in the Google Play
      Developer Console.
    min_version: 'beta'
    required: true
    immutable: true
  - name: 'sha1Hashes'
    type: Array
    description: |
      The SHA1 certificate hashes for the AndroidApp.
    min_version: 'beta'
    item_type:
      type: String
  - name: 'sha256Hashes'
    type: Array
    description: |
      The SHA256 certificate hashes for the AndroidApp.
    min_version: 'beta'
    item_type:
      type: String
  - name: 'apiKeyId'
    type: String
    description: |
      The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp.
      If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp.
      This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.
    min_version: 'beta'
    default_from_api: true
  - name: 'etag'
    type: Fingerprint
    description: |
      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.
    min_version: 'beta'
    output: true