alpha

package
v1.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 5, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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. Package alpha defines operations in the declarative SDK.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Copyright 2023 Google LLC. All Rights Reserved.

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.

Index

Constants

View Source 
const AndroidAppMaxPage = -1
View Source 
const AppleAppMaxPage = -1
View Source 
const FirebaseProjectMaxPage = -1
View Source 
const WebAppMaxPage = -1

Variables

View Source 
var YAML_android_app = []byte("info:\n  title: Firebase/AndroidApp\n  description: \"\"\n  x-dcl-struct-name: AndroidApp\n  x-dcl-has-iam: false\n  x-dcl-ref:\n    text: Firebase AndroidApp API Documentation\n    url: https://firebase.google.com/docs/projects/api/reference/rest#rest-resource:-v1beta1.projects.androidapps\n  x-dcl-guides:\n  - text: Get started with Firebase Projects and Apps\n    url: https://firebase.google.com/docs/projects/api/workflow_set-up-and-manage-project\npaths:\n  get:\n    description: The function used to get information about a AndroidApp\n    parameters:\n    - name: androidApp\n      required: true\n      description: A full instance of a AndroidApp\n  apply:\n    description: The function used to apply information about a AndroidApp\n    parameters:\n    - name: androidApp\n      required: true\n      description: A full instance of a AndroidApp\n  delete:\n    description: The function used to delete a AndroidApp\n    parameters:\n    - name: androidApp\n      required: true\n      description: A full instance of a AndroidApp\n  deleteAll:\n    description: The function used to delete all AndroidApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many AndroidApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    AndroidApp:\n      title: AndroidApp\n      x-dcl-id: projects/{{project}}/androidApps/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      x-dcl-read-timeout: 0\n      x-dcl-apply-timeout: 0\n      x-dcl-delete-timeout: 0\n      type: object\n      required:\n      - packageName\n      - project\n      properties:\n        apiKeyId:\n          type: string\n          x-dcl-go-name: ApiKeyId\n          description: The key_id of the GCP ApiKey associated with this App. If set\n            must have no restrictions, or only have restrictions that are valid for\n            the associated Firebase App. Cannot be set in create requests, instead\n            an existing valid API Key will be chosen, or if no valid API Keys exist,\n            one will be provisioned for you. Cannot be set to an empty value in update\n            requests.\n          x-dcl-references:\n          - resource: Apikeys/Key\n            field: name\n        appId:\n          type: string\n          x-dcl-go-name: AppId\n          readOnly: true\n          description: Output only. Immutable. The globally unique, Firebase-assigned\n            identifier for the `AndroidApp`. This identifier should be treated as\n            an opaque token, as the data format is not specified.\n          x-kubernetes-immutable: true\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: The user-assigned display name for the `AndroidApp`.\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: 'The resource name of the AndroidApp, in the format: `projects/PROJECT_IDENTIFIER/androidApps/APP_ID`\n            * PROJECT_IDENTIFIER: the parent Project''s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)\n            ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).\n            Learn more about using project identifiers in Google''s [AIP 2510 standard](https://google.aip.dev/cloud/2510).\n            Note that the value for PROJECT_IDENTIFIER in any response body will be\n            the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier\n            for the App (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).'\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n        packageName:\n          type: string\n          x-dcl-go-name: PackageName\n          description: Immutable. The canonical package name of the Android app as\n            would appear in the Google Play Developer Console.\n          x-kubernetes-immutable: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: The project for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        projectId:\n          type: string\n          x-dcl-go-name: ProjectId\n          readOnly: true\n          description: Output only. Immutable. A user-assigned unique identifier of\n            the parent FirebaseProject for the `AndroidApp`.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/firebase/alpha/android_app.yaml

View Source 
var YAML_apple_app = []byte("info:\n  title: Firebase/AppleApp\n  description: \"\"\n  x-dcl-struct-name: AppleApp\n  x-dcl-has-iam: false\n  x-dcl-ref:\n    text: Firebase AppleApp API Documentation\n    url: https://firebase.google.com/docs/projects/api/reference/rest#rest-resource:-v1beta1.projects.iosapps\n  x-dcl-guides:\n  - text: Get started with Firebase Projects and Apps\n    url: https://firebase.google.com/docs/projects/api/workflow_set-up-and-manage-project\npaths:\n  get:\n    description: The function used to get information about a AppleApp\n    parameters:\n    - name: appleApp\n      required: true\n      description: A full instance of a AppleApp\n  apply:\n    description: The function used to apply information about a AppleApp\n    parameters:\n    - name: appleApp\n      required: true\n      description: A full instance of a AppleApp\n  delete:\n    description: The function used to delete a AppleApp\n    parameters:\n    - name: appleApp\n      required: true\n      description: A full instance of a AppleApp\n  deleteAll:\n    description: The function used to delete all AppleApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many AppleApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    AppleApp:\n      title: AppleApp\n      x-dcl-id: projects/{{project}}/iosApps/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      x-dcl-read-timeout: 0\n      x-dcl-apply-timeout: 0\n      x-dcl-delete-timeout: 0\n      type: object\n      required:\n      - bundleId\n      - project\n      properties:\n        apiKeyId:\n          type: string\n          x-dcl-go-name: ApiKeyId\n          description: The key_id of the GCP ApiKey associated with this App. If set\n            must have no restrictions, or only have restrictions that are valid for\n            the associated Firebase App. Cannot be set in create requests, instead\n            an existing valid API Key will be chosen, or if no valid API Keys exist,\n            one will be provisioned for you. Cannot be set to an empty value in update\n            requests.\n          x-dcl-references:\n          - resource: Apikeys/Key\n            field: name\n        appId:\n          type: string\n          x-dcl-go-name: AppId\n          readOnly: true\n          description: Output only. Immutable. The globally unique, Firebase-assigned\n            identifier for the `AppleApp`. This identifier should be treated as an\n            opaque token, as the data format is not specified.\n          x-kubernetes-immutable: true\n        appStoreId:\n          type: string\n          x-dcl-go-name: AppStoreId\n          description: The automatically generated Apple ID assigned to the Apple\n            app by Apple in the Apple App Store.\n        bundleId:\n          type: string\n          x-dcl-go-name: BundleId\n          description: Immutable. The canonical bundle ID of the Apple app as it would\n            appear in the Apple AppStore.\n          x-kubernetes-immutable: true\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: The user-assigned display name for the `AppleApp`.\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: 'The resource name of the AppleApp, in the format: `projects/PROJECT_IDENTIFIER/iosApps/APP_ID`\n            * PROJECT_IDENTIFIER: the parent Project''s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)\n            ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).\n            Learn more about using project identifiers in Google''s [AIP 2510 standard](https://google.aip.dev/cloud/2510).\n            Note that the value for PROJECT_IDENTIFIER in any response body will be\n            the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier\n            for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).'\n          x-dcl-server-generated-parameter: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: The project for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        projectId:\n          type: string\n          x-dcl-go-name: ProjectId\n          readOnly: true\n          description: Output only. Immutable. A user-assigned unique identifier of\n            the parent FirebaseProject for the `AppleApp`.\n          x-kubernetes-immutable: true\n        teamId:\n          type: string\n          x-dcl-go-name: TeamId\n          description: The Apple Developer Team ID associated with the App in the\n            App Store.\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/firebase/alpha/apple_app.yaml

View Source 
var YAML_firebase_project = []byte("info:\n  title: Firebase/FirebaseProject\n  description: \"\"\n  x-dcl-struct-name: FirebaseProject\n  x-dcl-has-iam: false\n  x-dcl-ref:\n    text: Firebase Project API Documentation\n    url: https://firebase.google.com/docs/projects/api/reference/rest#rest-resource:-v1beta1.projects\n  x-dcl-guides:\n  - text: Get started with Firebase Projects and Apps\n    url: https://firebase.google.com/docs/projects/api/workflow_set-up-and-manage-project\npaths:\n  get:\n    description: The function used to get information about a FirebaseProject\n    parameters:\n    - name: firebaseProject\n      required: true\n      description: A full instance of a FirebaseProject\n  apply:\n    description: The function used to apply information about a FirebaseProject\n    parameters:\n    - name: firebaseProject\n      required: true\n      description: A full instance of a FirebaseProject\n  list:\n    description: The function used to list information about many FirebaseProject\n    parameters: []\ncomponents:\n  schemas:\n    FirebaseProject:\n      title: FirebaseProject\n      x-dcl-id: projects/{{project}}\n      x-dcl-parent-container: project\n      x-dcl-labels: annotations\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      x-dcl-read-timeout: 0\n      x-dcl-apply-timeout: 0\n      x-dcl-delete-timeout: 0\n      type: object\n      required:\n      - project\n      properties:\n        annotations:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Annotations\n          description: '  // Set of user-defined annotations for the [FirebaseProject][]\n            as per [AIP-128](https://google.aip.dev/128#annotations).  These annotations\n            are intended solely for developers and client-side tools Firebase services\n            will not mutate this annotation set.  This field may only be assigned\n            on Update'\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: The user-assigned display name of the Project.  This field\n            may only be assigned on Update\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: The project for the resource.  FirebaseProjects are generally\n            referneced by the GCP Project they augment.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        projectId:\n          type: string\n          x-dcl-go-name: ProjectId\n          readOnly: true\n          description: Immutable. A user-assigned unique identifier for the Project.\n            This identifier may appear in URLs or names for some Firebase resources\n            associated with the Project, but it should generally be treated as a convenience\n            alias to reference the Project.\n          x-kubernetes-immutable: true\n        projectNumber:\n          type: integer\n          format: int64\n          x-dcl-go-name: ProjectNumber\n          readOnly: true\n          description: Immutable. The globally unique, Google-assigned canonical identifier\n            for the Project. Use this identifier when configuring integrations and/or\n            making API calls to Firebase or third-party services.\n          x-kubernetes-immutable: true\n        resources:\n          type: object\n          x-dcl-go-name: Resources\n          x-dcl-go-type: FirebaseProjectResources\n          readOnly: true\n          description: The default Firebase resources associated with the Project.\n          x-kubernetes-immutable: true\n          properties:\n            hostingSite:\n              type: string\n              x-dcl-go-name: HostingSite\n              readOnly: true\n              description: 'The default Firebase Hosting site name, in the format:\n                `PROJECT_ID` Though rare, your `projectId` might already be used as\n                the name for an existing Hosting site in another project (learn more\n                about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)).\n                In these cases, your `projectId` is appended with a hyphen then five\n                alphanumeric characters to create your default Hosting site name.\n                For example, if your `projectId` is `myproject123`, your default Hosting\n                site name might be: `myproject123-a5c16`'\n              x-kubernetes-immutable: true\n            locationId:\n              type: string\n              x-dcl-go-name: LocationId\n              readOnly: true\n              description: The ID of the Project's default GCP resource location.\n                The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations).\n                This field is omitted if the default GCP resource location has not\n                been finalized yet. To set a Project's default GCP resource location,\n                call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)\n                after you add Firebase resources to the Project.\n              x-kubernetes-immutable: true\n            realtimeDatabaseInstance:\n              type: string\n              x-dcl-go-name: RealtimeDatabaseInstance\n              readOnly: true\n              description: 'The default Firebase Realtime Database instance name,\n                in the format: `PROJECT_ID` Though rare, your `projectId` might already\n                be used as the name for an existing Realtime Database instance in\n                another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)).\n                In these cases, your `projectId` is appended with a hyphen then five\n                alphanumeric characters to create your default Realtime Database instance\n                name. For example, if your `projectId` is `myproject123`, your default\n                database instance name might be: `myproject123-a5c16`'\n              x-kubernetes-immutable: true\n            storageBucket:\n              type: string\n              x-dcl-go-name: StorageBucket\n              readOnly: true\n              description: 'The default Cloud Storage for Firebase storage bucket,\n                in the format: `PROJECT_ID.appspot.com`'\n              x-kubernetes-immutable: true\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: FirebaseProjectStateEnum\n          readOnly: true\n          description: 'Output only. The lifecycle state of the Project. Updates to\n            the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject\n            and com.google.cloudresourcemanager.v1.Projects.UndeleteProject Possible\n            values: STATE_UNSPECIFIED, ACTIVE, DELETED'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - ACTIVE\n          - DELETED\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/firebase/alpha/firebase_project.yaml

View Source 
var YAML_web_app = []byte("info:\n  title: Firebase/WebApp\n  description: \"\"\n  x-dcl-struct-name: WebApp\n  x-dcl-has-iam: false\n  x-dcl-ref:\n    text: Firebase WebApps API Documentation\n    url: https://firebase.google.com/docs/projects/api/reference/rest#rest-resource:-v1beta1.projects.webapps\n  x-dcl-guides:\n  - text: Get started with Firebase Projects and Apps\n    url: https://firebase.google.com/docs/projects/api/workflow_set-up-and-manage-project\npaths:\n  get:\n    description: The function used to get information about a WebApp\n    parameters:\n    - name: webApp\n      required: true\n      description: A full instance of a WebApp\n  apply:\n    description: The function used to apply information about a WebApp\n    parameters:\n    - name: webApp\n      required: true\n      description: A full instance of a WebApp\n  delete:\n    description: The function used to delete a WebApp\n    parameters:\n    - name: webApp\n      required: true\n      description: A full instance of a WebApp\n  deleteAll:\n    description: The function used to delete all WebApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many WebApp\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    WebApp:\n      title: WebApp\n      x-dcl-id: projects/{{project}}/webApps/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      x-dcl-read-timeout: 0\n      x-dcl-apply-timeout: 0\n      x-dcl-delete-timeout: 0\n      type: object\n      required:\n      - project\n      properties:\n        apiKeyId:\n          type: string\n          x-dcl-go-name: ApiKeyId\n          description: The key_id of the GCP ApiKey associated with this App. If set\n            must have no restrictions, or only have restrictions that are valid for\n            the associated Firebase App. Cannot be set in create requests, instead\n            an existing valid API Key will be chosen, or if no valid API Keys exist,\n            one will be provisioned for you. Cannot be set to an empty value in update\n            requests.\n          x-dcl-references:\n          - resource: Apikeys/Key\n            field: name\n        appId:\n          type: string\n          x-dcl-go-name: AppId\n          readOnly: true\n          description: Immutable. The globally unique, Firebase-assigned identifier\n            for the `WebApp`. This identifier should be treated as an opaque token,\n            as the data format is not specified.\n          x-kubernetes-immutable: true\n        appUrls:\n          type: array\n          x-dcl-go-name: AppUrls\n          description: The URLs where the `WebApp` is hosted.\n          x-dcl-send-empty: true\n          x-dcl-list-type: list\n          items:\n            type: string\n            x-dcl-go-type: string\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: The user-assigned display name for the `WebApp`.\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: 'Output Only.  The resource name of the WebApp, in the format:\n            `projects/PROJECT_IDENTIFIER/webApps/APP_ID` * PROJECT_IDENTIFIER: the\n            parent Project''s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)\n            ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).\n            Learn more about using project identifiers in Google''s [AIP 2510 standard](https://google.aip.dev/cloud/2510).\n            Note that the value for PROJECT_IDENTIFIER in any response body will be\n            the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned identifier\n            for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).'\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: The project for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        projectId:\n          type: string\n          x-dcl-go-name: ProjectId\n          readOnly: true\n          description: Immutable. A user-assigned unique identifier of the parent\n            FirebaseProject for the `WebApp`.\n          x-kubernetes-immutable: true\n        webId:\n          type: string\n          x-dcl-go-name: WebId\n          readOnly: true\n          description: Output only. Immutable. A unique, Firebase-assigned identifier\n            for the `WebApp`. This identifier is only used to populate the `namespace`\n            value for the `WebApp`. For most use cases, use `appId` to identify or\n            reference the App. The `webId` value is only unique within a `FirebaseProject`\n            and its associated Apps.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/firebase/alpha/web_app.yaml

Functions

func DCLAndroidAppSchema added in v1.17.0 

func DCLAndroidAppSchema() *dcl.Schema

func DCLAppleAppSchema added in v1.16.0 

func DCLAppleAppSchema() *dcl.Schema

func DCLFirebaseProjectSchema added in v1.16.0 

func DCLFirebaseProjectSchema() *dcl.Schema

func DCLWebAppSchema 

func DCLWebAppSchema() *dcl.Schema

Types

type AndroidApp added in v1.17.0 

type AndroidApp struct {
	Name        *string `json:"name"`
	AppId       *string `json:"appId"`
	DisplayName *string `json:"displayName"`
	ProjectId   *string `json:"projectId"`
	PackageName *string `json:"packageName"`
	ApiKeyId    *string `json:"apiKeyId"`
	Project     *string `json:"project"`
}

func (*AndroidApp) Describe added in v1.17.0 

func (r *AndroidApp) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*AndroidApp) ID added in v1.17.0 

func (r *AndroidApp) ID() (string, error)

func (*AndroidApp) String added in v1.17.0 

func (r *AndroidApp) String() string

type AndroidAppList added in v1.17.0 

type AndroidAppList struct {
	Items []*AndroidApp
	// contains filtered or unexported fields
}

func (*AndroidAppList) HasNext added in v1.17.0 

func (l *AndroidAppList) HasNext() bool

func (*AndroidAppList) Next added in v1.17.0 

func (l *AndroidAppList) Next(ctx context.Context, c *Client) error

type AppleApp added in v1.16.0 

type AppleApp struct {
	Name        *string `json:"name"`
	AppId       *string `json:"appId"`
	DisplayName *string `json:"displayName"`
	ProjectId   *string `json:"projectId"`
	BundleId    *string `json:"bundleId"`
	AppStoreId  *string `json:"appStoreId"`
	TeamId      *string `json:"teamId"`
	ApiKeyId    *string `json:"apiKeyId"`
	Project     *string `json:"project"`
}

func (*AppleApp) Describe added in v1.16.0 

func (r *AppleApp) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*AppleApp) ID added in v1.16.0 

func (r *AppleApp) ID() (string, error)

func (*AppleApp) String added in v1.16.0 

func (r *AppleApp) String() string

type AppleAppList added in v1.16.0 

type AppleAppList struct {
	Items []*AppleApp
	// contains filtered or unexported fields
}

func (*AppleAppList) HasNext added in v1.16.0 

func (l *AppleAppList) HasNext() bool

func (*AppleAppList) Next added in v1.16.0 

func (l *AppleAppList) Next(ctx context.Context, c *Client) error

type Client 

type Client struct {
	Config *dcl.Config
}

The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.

func NewClient 

func NewClient(c *dcl.Config) *Client

NewClient creates a client that retries all operations a few times each.

func (*Client) ApplyAndroidApp added in v1.17.0 

func (c *Client) ApplyAndroidApp(ctx context.Context, rawDesired *AndroidApp, opts ...dcl.ApplyOption) (*AndroidApp, error)

func (*Client) ApplyAppleApp added in v1.16.0 

func (c *Client) ApplyAppleApp(ctx context.Context, rawDesired *AppleApp, opts ...dcl.ApplyOption) (*AppleApp, error)

func (*Client) ApplyFirebaseProject added in v1.16.0 

func (c *Client) ApplyFirebaseProject(ctx context.Context, rawDesired *FirebaseProject, opts ...dcl.ApplyOption) (*FirebaseProject, error)

func (*Client) ApplyWebApp 

func (c *Client) ApplyWebApp(ctx context.Context, rawDesired *WebApp, opts ...dcl.ApplyOption) (*WebApp, error)

func (*Client) DeleteAllAndroidApp added in v1.17.0 

func (c *Client) DeleteAllAndroidApp(ctx context.Context, project string, filter func(*AndroidApp) bool) error

DeleteAllAndroidApp deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllAppleApp added in v1.16.0 

func (c *Client) DeleteAllAppleApp(ctx context.Context, project string, filter func(*AppleApp) bool) error

DeleteAllAppleApp deletes all resources that the filter functions returns true on.

func (*Client) DeleteAllWebApp 

func (c *Client) DeleteAllWebApp(ctx context.Context, project string, filter func(*WebApp) bool) error

DeleteAllWebApp deletes all resources that the filter functions returns true on.

func (*Client) DeleteAndroidApp added in v1.17.0 

func (c *Client) DeleteAndroidApp(ctx context.Context, r *AndroidApp) error

func (*Client) DeleteAppleApp added in v1.16.0 

func (c *Client) DeleteAppleApp(ctx context.Context, r *AppleApp) error

func (*Client) DeleteWebApp 

func (c *Client) DeleteWebApp(ctx context.Context, r *WebApp) error

func (*Client) GetAndroidApp added in v1.17.0 

func (c *Client) GetAndroidApp(ctx context.Context, r *AndroidApp) (*AndroidApp, error)

func (*Client) GetAppleApp added in v1.16.0 

func (c *Client) GetAppleApp(ctx context.Context, r *AppleApp) (*AppleApp, error)

func (*Client) GetFirebaseProject added in v1.16.0 

func (c *Client) GetFirebaseProject(ctx context.Context, r *FirebaseProject) (*FirebaseProject, error)

func (*Client) GetWebApp 

func (c *Client) GetWebApp(ctx context.Context, r *WebApp) (*WebApp, error)

func (*Client) ListAndroidApp added in v1.17.0 

func (c *Client) ListAndroidApp(ctx context.Context, project string) (*AndroidAppList, error)

func (*Client) ListAndroidAppWithMaxResults added in v1.17.0 

func (c *Client) ListAndroidAppWithMaxResults(ctx context.Context, project string, pageSize int32) (*AndroidAppList, error)

func (*Client) ListAppleApp added in v1.16.0 

func (c *Client) ListAppleApp(ctx context.Context, project string) (*AppleAppList, error)

func (*Client) ListAppleAppWithMaxResults added in v1.16.0 

func (c *Client) ListAppleAppWithMaxResults(ctx context.Context, project string, pageSize int32) (*AppleAppList, error)

func (*Client) ListFirebaseProject added in v1.16.0 

func (c *Client) ListFirebaseProject(ctx context.Context) (*FirebaseProjectList, error)

func (*Client) ListFirebaseProjectWithMaxResults added in v1.16.0 

func (c *Client) ListFirebaseProjectWithMaxResults(ctx context.Context, pageSize int32) (*FirebaseProjectList, error)

func (*Client) ListWebApp 

func (c *Client) ListWebApp(ctx context.Context, project string) (*WebAppList, error)

func (*Client) ListWebAppWithMaxResults 

func (c *Client) ListWebAppWithMaxResults(ctx context.Context, project string, pageSize int32) (*WebAppList, error)

type FirebaseProject added in v1.16.0 

type FirebaseProject struct {
	ProjectId     *string                   `json:"projectId"`
	ProjectNumber *int64                    `json:"projectNumber"`
	DisplayName   *string                   `json:"displayName"`
	Resources     *FirebaseProjectResources `json:"resources"`
	State         *FirebaseProjectStateEnum `json:"state"`
	Annotations   map[string]string         `json:"annotations"`
	Project       *string                   `json:"project"`
}

func (*FirebaseProject) Describe added in v1.16.0 

func (r *FirebaseProject) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*FirebaseProject) ID added in v1.16.0 

func (r *FirebaseProject) ID() (string, error)

func (*FirebaseProject) String added in v1.16.0 

func (r *FirebaseProject) String() string

type FirebaseProjectList added in v1.16.0 

type FirebaseProjectList struct {
	Items []*FirebaseProject
	// contains filtered or unexported fields
}

func (*FirebaseProjectList) HasNext added in v1.16.0 

func (l *FirebaseProjectList) HasNext() bool

func (*FirebaseProjectList) Next added in v1.16.0 

func (l *FirebaseProjectList) Next(ctx context.Context, c *Client) error

type FirebaseProjectResources added in v1.16.0 

type FirebaseProjectResources struct {
	HostingSite              *string `json:"hostingSite"`
	RealtimeDatabaseInstance *string `json:"realtimeDatabaseInstance"`
	StorageBucket            *string `json:"storageBucket"`
	LocationId               *string `json:"locationId"`
	// contains filtered or unexported fields
}
var EmptyFirebaseProjectResources *FirebaseProjectResources = &FirebaseProjectResources{empty: true}

This object is used to assert a desired state where this FirebaseProjectResources is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.

func (*FirebaseProjectResources) Empty added in v1.16.0 

func (r *FirebaseProjectResources) Empty() bool

func (*FirebaseProjectResources) HashCode added in v1.16.0 

func (r *FirebaseProjectResources) HashCode() string

func (*FirebaseProjectResources) String added in v1.16.0 

func (r *FirebaseProjectResources) String() string

func (*FirebaseProjectResources) UnmarshalJSON added in v1.16.0 

func (r *FirebaseProjectResources) UnmarshalJSON(data []byte) error

type FirebaseProjectStateEnum added in v1.16.0 

type FirebaseProjectStateEnum string

The enum FirebaseProjectStateEnum.

func FirebaseProjectStateEnumRef added in v1.16.0 

func FirebaseProjectStateEnumRef(s string) *FirebaseProjectStateEnum

FirebaseProjectStateEnumRef returns a *FirebaseProjectStateEnum with the value of string s If the empty string is provided, nil is returned.

func (FirebaseProjectStateEnum) Validate added in v1.16.0 

func (v FirebaseProjectStateEnum) Validate() error

type WebApp 

type WebApp struct {
	Name        *string  `json:"name"`
	AppId       *string  `json:"appId"`
	DisplayName *string  `json:"displayName"`
	ProjectId   *string  `json:"projectId"`
	AppUrls     []string `json:"appUrls"`
	WebId       *string  `json:"webId"`
	ApiKeyId    *string  `json:"apiKeyId"`
	Project     *string  `json:"project"`
}

func (*WebApp) Describe 

func (r *WebApp) Describe() dcl.ServiceTypeVersion

Describe returns a simple description of this resource to ensure that automated tools can identify it.

func (*WebApp) ID 

func (r *WebApp) ID() (string, error)

func (*WebApp) String 

func (r *WebApp) String() string

type WebAppList 

type WebAppList struct {
	Items []*WebApp
	// contains filtered or unexported fields
}

func (*WebAppList) HasNext 

func (l *WebAppList) HasNext() bool

func (*WebAppList) Next 

func (l *WebAppList) Next(ctx context.Context, c *Client) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.