networkconnectivity

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: 5

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 networkconnectivity 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 HubMaxPage = -1
View Source 
const SpokeMaxPage = -1

Variables

View Source 
var YAML_hub []byte
View Source 
var YAML_spoke []byte

Functions

func DCLHubSchema added in v1.10.3 

func DCLHubSchema() *dcl.Schema

func DCLSpokeSchema added in v1.10.3 

func DCLSpokeSchema() *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) ApplyHub 

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

func (*Client) ApplySpoke 

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

func (*Client) DeleteAllHub 

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

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

func (*Client) DeleteAllSpoke 

func (c *Client) DeleteAllSpoke(ctx context.Context, project, location string, filter func(*Spoke) bool) error

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

func (*Client) DeleteHub 

func (c *Client) DeleteHub(ctx context.Context, r *Hub) error

func (*Client) DeleteSpoke 

func (c *Client) DeleteSpoke(ctx context.Context, r *Spoke) error

func (*Client) GetHub 

func (c *Client) GetHub(ctx context.Context, r *Hub) (*Hub, error)

func (*Client) GetSpoke 

func (c *Client) GetSpoke(ctx context.Context, r *Spoke) (*Spoke, error)

func (*Client) ListHub 

func (c *Client) ListHub(ctx context.Context, project string) (*HubList, error)

func (*Client) ListHubWithMaxResults 

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

func (*Client) ListSpoke 

func (c *Client) ListSpoke(ctx context.Context, project, location string) (*SpokeList, error)

func (*Client) ListSpokeWithMaxResults 

func (c *Client) ListSpokeWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*SpokeList, error)

type Hub 

type Hub struct {
	Name        *string           `json:"name"`
	CreateTime  *string           `json:"createTime"`
	UpdateTime  *string           `json:"updateTime"`
	Labels      map[string]string `json:"labels"`
	Description *string           `json:"description"`
	UniqueId    *string           `json:"uniqueId"`
	State       *HubStateEnum     `json:"state"`
	Project     *string           `json:"project"`
	RoutingVpcs []HubRoutingVpcs  `json:"routingVpcs"`
}

func (*Hub) Describe 

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

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

func (*Hub) ID 

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

func (*Hub) String 

func (r *Hub) String() string

type HubList 

type HubList struct {
	Items []*Hub
	// contains filtered or unexported fields
}

func (*HubList) HasNext 

func (l *HubList) HasNext() bool

func (*HubList) Next 

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

type HubRoutingVpcs 

type HubRoutingVpcs struct {
	Uri *string `json:"uri"`
	// contains filtered or unexported fields
}
var EmptyHubRoutingVpcs *HubRoutingVpcs = &HubRoutingVpcs{empty: true}

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

func (*HubRoutingVpcs) Empty 

func (r *HubRoutingVpcs) Empty() bool

func (*HubRoutingVpcs) HashCode 

func (r *HubRoutingVpcs) HashCode() string

func (*HubRoutingVpcs) String 

func (r *HubRoutingVpcs) String() string

func (*HubRoutingVpcs) UnmarshalJSON 

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

type HubStateEnum 

type HubStateEnum string

The enum HubStateEnum.

func HubStateEnumRef 

func HubStateEnumRef(s string) *HubStateEnum

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

func (HubStateEnum) Validate 

func (v HubStateEnum) Validate() error

type Spoke 

type Spoke struct {
	Name                           *string                              `json:"name"`
	CreateTime                     *string                              `json:"createTime"`
	UpdateTime                     *string                              `json:"updateTime"`
	Labels                         map[string]string                    `json:"labels"`
	Description                    *string                              `json:"description"`
	Hub                            *string                              `json:"hub"`
	LinkedVpnTunnels               *SpokeLinkedVpnTunnels               `json:"linkedVpnTunnels"`
	LinkedInterconnectAttachments  *SpokeLinkedInterconnectAttachments  `json:"linkedInterconnectAttachments"`
	LinkedRouterApplianceInstances *SpokeLinkedRouterApplianceInstances `json:"linkedRouterApplianceInstances"`
	LinkedVPCNetwork               *SpokeLinkedVPCNetwork               `json:"linkedVPCNetwork"`
	UniqueId                       *string                              `json:"uniqueId"`
	State                          *SpokeStateEnum                      `json:"state"`
	Project                        *string                              `json:"project"`
	Location                       *string                              `json:"location"`
}

func (*Spoke) Describe 

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

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

func (*Spoke) ID 

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

func (*Spoke) String 

func (r *Spoke) String() string

type SpokeLinkedInterconnectAttachments 

type SpokeLinkedInterconnectAttachments struct {
	Uris                   []string `json:"uris"`
	SiteToSiteDataTransfer *bool    `json:"siteToSiteDataTransfer"`
	// contains filtered or unexported fields
}
var EmptySpokeLinkedInterconnectAttachments *SpokeLinkedInterconnectAttachments = &SpokeLinkedInterconnectAttachments{empty: true}

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

func (*SpokeLinkedInterconnectAttachments) Empty 

func (r *SpokeLinkedInterconnectAttachments) Empty() bool

func (*SpokeLinkedInterconnectAttachments) HashCode 

func (r *SpokeLinkedInterconnectAttachments) HashCode() string

func (*SpokeLinkedInterconnectAttachments) String 

func (r *SpokeLinkedInterconnectAttachments) String() string

func (*SpokeLinkedInterconnectAttachments) UnmarshalJSON 

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

type SpokeLinkedRouterApplianceInstances 

type SpokeLinkedRouterApplianceInstances struct {
	Instances              []SpokeLinkedRouterApplianceInstancesInstances `json:"instances"`
	SiteToSiteDataTransfer *bool                                          `json:"siteToSiteDataTransfer"`
	// contains filtered or unexported fields
}
var EmptySpokeLinkedRouterApplianceInstances *SpokeLinkedRouterApplianceInstances = &SpokeLinkedRouterApplianceInstances{empty: true}

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

func (*SpokeLinkedRouterApplianceInstances) Empty 

func (r *SpokeLinkedRouterApplianceInstances) Empty() bool

func (*SpokeLinkedRouterApplianceInstances) HashCode 

func (r *SpokeLinkedRouterApplianceInstances) HashCode() string

func (*SpokeLinkedRouterApplianceInstances) String 

func (r *SpokeLinkedRouterApplianceInstances) String() string

func (*SpokeLinkedRouterApplianceInstances) UnmarshalJSON 

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

type SpokeLinkedRouterApplianceInstancesInstances 

type SpokeLinkedRouterApplianceInstancesInstances struct {
	VirtualMachine *string `json:"virtualMachine"`
	IPAddress      *string `json:"ipAddress"`
	// contains filtered or unexported fields
}
var EmptySpokeLinkedRouterApplianceInstancesInstances *SpokeLinkedRouterApplianceInstancesInstances = &SpokeLinkedRouterApplianceInstancesInstances{empty: true}

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

func (*SpokeLinkedRouterApplianceInstancesInstances) Empty 

func (r *SpokeLinkedRouterApplianceInstancesInstances) Empty() bool

func (*SpokeLinkedRouterApplianceInstancesInstances) HashCode 

func (r *SpokeLinkedRouterApplianceInstancesInstances) HashCode() string

func (*SpokeLinkedRouterApplianceInstancesInstances) String 

func (r *SpokeLinkedRouterApplianceInstancesInstances) String() string

func (*SpokeLinkedRouterApplianceInstancesInstances) UnmarshalJSON 

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

type SpokeLinkedVPCNetwork added in v1.51.0 

type SpokeLinkedVPCNetwork struct {
	Uri                 *string  `json:"uri"`
	ExcludeExportRanges []string `json:"excludeExportRanges"`
	// contains filtered or unexported fields
}
var EmptySpokeLinkedVPCNetwork *SpokeLinkedVPCNetwork = &SpokeLinkedVPCNetwork{empty: true}

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

func (*SpokeLinkedVPCNetwork) Empty added in v1.51.0 

func (r *SpokeLinkedVPCNetwork) Empty() bool

func (*SpokeLinkedVPCNetwork) HashCode added in v1.51.0 

func (r *SpokeLinkedVPCNetwork) HashCode() string

func (*SpokeLinkedVPCNetwork) String added in v1.51.0 

func (r *SpokeLinkedVPCNetwork) String() string

func (*SpokeLinkedVPCNetwork) UnmarshalJSON added in v1.51.0 

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

type SpokeLinkedVpnTunnels 

type SpokeLinkedVpnTunnels struct {
	Uris                   []string `json:"uris"`
	SiteToSiteDataTransfer *bool    `json:"siteToSiteDataTransfer"`
	// contains filtered or unexported fields
}
var EmptySpokeLinkedVpnTunnels *SpokeLinkedVpnTunnels = &SpokeLinkedVpnTunnels{empty: true}

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

func (*SpokeLinkedVpnTunnels) Empty 

func (r *SpokeLinkedVpnTunnels) Empty() bool

func (*SpokeLinkedVpnTunnels) HashCode 

func (r *SpokeLinkedVpnTunnels) HashCode() string

func (*SpokeLinkedVpnTunnels) String 

func (r *SpokeLinkedVpnTunnels) String() string

func (*SpokeLinkedVpnTunnels) UnmarshalJSON 

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

type SpokeList 

type SpokeList struct {
	Items []*Spoke
	// contains filtered or unexported fields
}

func (*SpokeList) HasNext 

func (l *SpokeList) HasNext() bool

func (*SpokeList) Next 

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

type SpokeStateEnum 

type SpokeStateEnum string

The enum SpokeStateEnum.

func SpokeStateEnumRef 

func SpokeStateEnumRef(s string) *SpokeStateEnum

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

func (SpokeStateEnum) Validate 

func (v SpokeStateEnum) 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.