alpha

package
v1.84.0 Latest Latest
Warning

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

 Go to latest Published: Feb 12, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Copyright 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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
View Source 
var YAML_apple_app []byte
View Source 
var YAML_firebase_project []byte
View Source 
var YAML_web_app []byte

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.