apigee

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: 13 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. Package apigee contains methods and types for handling apigee GCP resources.

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 apigee 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 EnvironmentMaxPage = -1
View Source 
const OrganizationMaxPage = -1

Variables

View Source 
var YAML_environment []byte
View Source 
var YAML_organization []byte

Functions

func DCLEnvironmentSchema added in v1.10.3 

func DCLEnvironmentSchema() *dcl.Schema

func DCLOrganizationSchema added in v1.10.3 

func DCLOrganizationSchema() *dcl.Schema

Types

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) ApplyEnvironment 

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

func (*Client) ApplyOrganization 

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

func (*Client) DeleteAllEnvironment 

func (c *Client) DeleteAllEnvironment(ctx context.Context, apigeeOrganization string, filter func(*Environment) bool) error

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

func (*Client) DeleteAllOrganization 

func (c *Client) DeleteAllOrganization(ctx context.Context, filter func(*Organization) bool) error

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

func (*Client) DeleteEnvironment 

func (c *Client) DeleteEnvironment(ctx context.Context, r *Environment) error

func (*Client) DeleteOrganization 

func (c *Client) DeleteOrganization(ctx context.Context, r *Organization) error

func (*Client) GetEnvironment 

func (c *Client) GetEnvironment(ctx context.Context, r *Environment) (*Environment, error)

func (*Client) GetOrganization 

func (c *Client) GetOrganization(ctx context.Context, r *Organization) (*Organization, error)

func (*Client) ListEnvironment 

func (c *Client) ListEnvironment(ctx context.Context, apigeeOrganization string) (*EnvironmentList, error)

ListEnvironment returns an EnvironmentList containing all Environment resources in the given organization.

func (*Client) ListEnvironmentWithMaxResults 

func (c *Client) ListEnvironmentWithMaxResults(ctx context.Context, apigeeOrganization string, pageSize int32) (*EnvironmentList, error)

ListEnvironmentWithMaxResults returns an EnvironmentList containing all Environment resources in the given organization.

func (*Client) ListOrganization 

func (c *Client) ListOrganization(ctx context.Context) (*OrganizationList, error)

ListOrganization returns a list of apigee organizations which the client has permission to access.

func (*Client) ListOrganizationWithMaxResults 

func (c *Client) ListOrganizationWithMaxResults(ctx context.Context, pageSize int32) (*OrganizationList, error)

ListOrganizationWithMaxResults returns a list of apigee organizations with the given page size.

type Environment 

type Environment struct {
	Name               *string               `json:"name"`
	Description        *string               `json:"description"`
	CreatedAt          *int64                `json:"createdAt"`
	LastModifiedAt     *int64                `json:"lastModifiedAt"`
	Properties         map[string]string     `json:"properties"`
	DisplayName        *string               `json:"displayName"`
	State              *EnvironmentStateEnum `json:"state"`
	ApigeeOrganization *string               `json:"apigeeOrganization"`
}

func (*Environment) Describe 

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

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

func (*Environment) GetPolicy 

func (r *Environment) GetPolicy(basePath string) (string, string, *bytes.Buffer, error)

func (*Environment) IAMPolicyVersion 

func (r *Environment) IAMPolicyVersion() int

func (*Environment) ID 

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

func (*Environment) SetPolicyURL 

func (r *Environment) SetPolicyURL(userBasePath string) string

func (*Environment) SetPolicyVerb 

func (r *Environment) SetPolicyVerb() string

func (*Environment) String 

func (r *Environment) String() string

type EnvironmentList 

type EnvironmentList struct {
	Items []*Environment
	// contains filtered or unexported fields
}

func (*EnvironmentList) HasNext 

func (l *EnvironmentList) HasNext() bool

HasNext returns an empty token.

func (*EnvironmentList) Next 

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

Next returns an error because environment list has no pages.

type EnvironmentStateEnum 

type EnvironmentStateEnum string

The enum EnvironmentStateEnum.

func EnvironmentStateEnumRef 

func EnvironmentStateEnumRef(s string) *EnvironmentStateEnum

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

func (EnvironmentStateEnum) Validate 

func (v EnvironmentStateEnum) Validate() error

type Organization 

type Organization struct {
	Name                             *string                           `json:"name"`
	DisplayName                      *string                           `json:"displayName"`
	Description                      *string                           `json:"description"`
	CreatedAt                        *int64                            `json:"createdAt"`
	LastModifiedAt                   *int64                            `json:"lastModifiedAt"`
	ExpiresAt                        *int64                            `json:"expiresAt"`
	Environments                     []string                          `json:"environments"`
	Properties                       map[string]string                 `json:"properties"`
	AnalyticsRegion                  *string                           `json:"analyticsRegion"`
	AuthorizedNetwork                *string                           `json:"authorizedNetwork"`
	RuntimeType                      *OrganizationRuntimeTypeEnum      `json:"runtimeType"`
	SubscriptionType                 *OrganizationSubscriptionTypeEnum `json:"subscriptionType"`
	BillingType                      *OrganizationBillingTypeEnum      `json:"billingType"`
	AddonsConfig                     *OrganizationAddonsConfig         `json:"addonsConfig"`
	CaCertificate                    *string                           `json:"caCertificate"`
	RuntimeDatabaseEncryptionKeyName *string                           `json:"runtimeDatabaseEncryptionKeyName"`
	ProjectId                        *string                           `json:"projectId"`
	State                            *OrganizationStateEnum            `json:"state"`
	Project                          *string                           `json:"project"`
}

func (*Organization) Describe 

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

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

func (*Organization) ID 

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

func (*Organization) String 

func (r *Organization) String() string

type OrganizationAddonsConfig 

type OrganizationAddonsConfig struct {
	AdvancedApiOpsConfig *OrganizationAddonsConfigAdvancedApiOpsConfig `json:"advancedApiOpsConfig"`
	MonetizationConfig   *OrganizationAddonsConfigMonetizationConfig   `json:"monetizationConfig"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfig *OrganizationAddonsConfig = &OrganizationAddonsConfig{empty: true}

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

func (*OrganizationAddonsConfig) Empty 

func (r *OrganizationAddonsConfig) Empty() bool

func (*OrganizationAddonsConfig) HashCode 

func (r *OrganizationAddonsConfig) HashCode() string

func (*OrganizationAddonsConfig) String 

func (r *OrganizationAddonsConfig) String() string

func (*OrganizationAddonsConfig) UnmarshalJSON 

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

type OrganizationAddonsConfigAdvancedApiOpsConfig 

type OrganizationAddonsConfigAdvancedApiOpsConfig struct {
	Enabled *bool `json:"enabled"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfigAdvancedApiOpsConfig *OrganizationAddonsConfigAdvancedApiOpsConfig = &OrganizationAddonsConfigAdvancedApiOpsConfig{empty: true}

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

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) Empty 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) Empty() bool

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) HashCode 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) HashCode() string

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) String 

func (r *OrganizationAddonsConfigAdvancedApiOpsConfig) String() string

func (*OrganizationAddonsConfigAdvancedApiOpsConfig) UnmarshalJSON 

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

type OrganizationAddonsConfigMonetizationConfig 

type OrganizationAddonsConfigMonetizationConfig struct {
	Enabled *bool `json:"enabled"`
	// contains filtered or unexported fields
}
var EmptyOrganizationAddonsConfigMonetizationConfig *OrganizationAddonsConfigMonetizationConfig = &OrganizationAddonsConfigMonetizationConfig{empty: true}

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

func (*OrganizationAddonsConfigMonetizationConfig) Empty 

func (r *OrganizationAddonsConfigMonetizationConfig) Empty() bool

func (*OrganizationAddonsConfigMonetizationConfig) HashCode 

func (r *OrganizationAddonsConfigMonetizationConfig) HashCode() string

func (*OrganizationAddonsConfigMonetizationConfig) String 

func (r *OrganizationAddonsConfigMonetizationConfig) String() string

func (*OrganizationAddonsConfigMonetizationConfig) UnmarshalJSON 

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

type OrganizationBillingTypeEnum 

type OrganizationBillingTypeEnum string

The enum OrganizationBillingTypeEnum.

func OrganizationBillingTypeEnumRef 

func OrganizationBillingTypeEnumRef(s string) *OrganizationBillingTypeEnum

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

func (OrganizationBillingTypeEnum) Validate 

func (v OrganizationBillingTypeEnum) Validate() error

type OrganizationList 

type OrganizationList struct {
	Items []*Organization
	// contains filtered or unexported fields
}

func (*OrganizationList) HasNext 

func (l *OrganizationList) HasNext() bool

HasNext returns whether the list has a next page.

func (*OrganizationList) Next 

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

Next advances the list to its next page.

type OrganizationRuntimeTypeEnum 

type OrganizationRuntimeTypeEnum string

The enum OrganizationRuntimeTypeEnum.

func OrganizationRuntimeTypeEnumRef 

func OrganizationRuntimeTypeEnumRef(s string) *OrganizationRuntimeTypeEnum

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

func (OrganizationRuntimeTypeEnum) Validate 

func (v OrganizationRuntimeTypeEnum) Validate() error

type OrganizationStateEnum 

type OrganizationStateEnum string

The enum OrganizationStateEnum.

func OrganizationStateEnumRef 

func OrganizationStateEnumRef(s string) *OrganizationStateEnum

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

func (OrganizationStateEnum) Validate 

func (v OrganizationStateEnum) Validate() error

type OrganizationSubscriptionTypeEnum 

type OrganizationSubscriptionTypeEnum string

The enum OrganizationSubscriptionTypeEnum.

func OrganizationSubscriptionTypeEnumRef 

func OrganizationSubscriptionTypeEnumRef(s string) *OrganizationSubscriptionTypeEnum

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

func (OrganizationSubscriptionTypeEnum) Validate 

func (v OrganizationSubscriptionTypeEnum) Validate() error

Source Files

View all Source files

Directories

Path Synopsis

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.