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 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. Package cloudbuild contains utility methods to serve the DCL in handling odd situations in the cloudbuild API.
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
- Variables
- func DCLWorkerPoolSchema() *dcl.Schema
- type Client
- func (c *Client) ApplyWorkerPool(ctx context.Context, rawDesired *WorkerPool, opts ...dcl.ApplyOption) (*WorkerPool, error)
- func (c *Client) DeleteAllWorkerPool(ctx context.Context, project, location string, filter func(*WorkerPool) bool) error
- func (c *Client) DeleteWorkerPool(ctx context.Context, r *WorkerPool) error
- func (c *Client) GetWorkerPool(ctx context.Context, r *WorkerPool) (*WorkerPool, error)
- func (c *Client) ListWorkerPool(ctx context.Context, project, location string) (*WorkerPoolList, error)
- func (c *Client) ListWorkerPoolWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*WorkerPoolList, error)
- type WorkerPool
- type WorkerPoolList
- type WorkerPoolNetworkConfig
- type WorkerPoolPrivatePoolV1Config
- type WorkerPoolPrivatePoolV1ConfigNetworkConfig
- type WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum
- type WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect
- func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) Empty() bool
- func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) HashCode() string
- func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) String() string
- func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) UnmarshalJSON(data []byte) error
- type WorkerPoolPrivatePoolV1ConfigWorkerConfig
- type WorkerPoolPrivateServiceConnect
- type WorkerPoolStateEnum
- type WorkerPoolWorkerConfig
Constants ¶
const WorkerPoolMaxPage = -1
Variables ¶
var YAML_worker_pool []byte
Functions ¶
func DCLWorkerPoolSchema ¶ added in v1.10.3
Types ¶
type Client ¶
The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.
func (*Client) ApplyWorkerPool ¶
func (c *Client) ApplyWorkerPool(ctx context.Context, rawDesired *WorkerPool, opts ...dcl.ApplyOption) (*WorkerPool, error)
func (*Client) DeleteAllWorkerPool ¶
func (c *Client) DeleteAllWorkerPool(ctx context.Context, project, location string, filter func(*WorkerPool) bool) error
DeleteAllWorkerPool deletes all resources that the filter functions returns true on.
func (*Client) DeleteWorkerPool ¶
func (c *Client) DeleteWorkerPool(ctx context.Context, r *WorkerPool) error
func (*Client) GetWorkerPool ¶
func (c *Client) GetWorkerPool(ctx context.Context, r *WorkerPool) (*WorkerPool, error)
func (*Client) ListWorkerPool ¶
func (*Client) ListWorkerPoolWithMaxResults ¶
type WorkerPool ¶
type WorkerPool struct {
Name *string `json:"name"`
DisplayName *string `json:"displayName"`
Uid *string `json:"uid"`
Annotations map[string]string `json:"annotations"`
CreateTime *string `json:"createTime"`
UpdateTime *string `json:"updateTime"`
DeleteTime *string `json:"deleteTime"`
State *WorkerPoolStateEnum `json:"state"`
PrivatePoolV1Config *WorkerPoolPrivatePoolV1Config `json:"privatePoolV1Config"`
Etag *string `json:"etag"`
WorkerConfig *WorkerPoolWorkerConfig `json:"workerConfig"`
NetworkConfig *WorkerPoolNetworkConfig `json:"networkConfig"`
PrivateServiceConnect *WorkerPoolPrivateServiceConnect `json:"privateServiceConnect"`
Project *string `json:"project"`
Location *string `json:"location"`
}
func (*WorkerPool) Describe ¶
func (r *WorkerPool) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
func (*WorkerPool) ID ¶
func (r *WorkerPool) ID() (string, error)
func (*WorkerPool) String ¶
func (r *WorkerPool) String() string
type WorkerPoolList ¶
type WorkerPoolList struct {
Items []*WorkerPool
// contains filtered or unexported fields
}
func (*WorkerPoolList) HasNext ¶
func (l *WorkerPoolList) HasNext() bool
type WorkerPoolNetworkConfig ¶
type WorkerPoolNetworkConfig struct {
PeeredNetwork *string `json:"peeredNetwork"`
PeeredNetworkIPRange *string `json:"peeredNetworkIPRange"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolNetworkConfig *WorkerPoolNetworkConfig = &WorkerPoolNetworkConfig{empty: true}
This object is used to assert a desired state where this WorkerPoolNetworkConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolNetworkConfig) Empty ¶
func (r *WorkerPoolNetworkConfig) Empty() bool
func (*WorkerPoolNetworkConfig) HashCode ¶
func (r *WorkerPoolNetworkConfig) HashCode() string
func (*WorkerPoolNetworkConfig) String ¶
func (r *WorkerPoolNetworkConfig) String() string
func (*WorkerPoolNetworkConfig) UnmarshalJSON ¶
func (r *WorkerPoolNetworkConfig) UnmarshalJSON(data []byte) error
type WorkerPoolPrivatePoolV1Config ¶
type WorkerPoolPrivatePoolV1Config struct {
WorkerConfig *WorkerPoolPrivatePoolV1ConfigWorkerConfig `json:"workerConfig"`
NetworkConfig *WorkerPoolPrivatePoolV1ConfigNetworkConfig `json:"networkConfig"`
PrivateServiceConnect *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect `json:"privateServiceConnect"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolPrivatePoolV1Config *WorkerPoolPrivatePoolV1Config = &WorkerPoolPrivatePoolV1Config{empty: true}
This object is used to assert a desired state where this WorkerPoolPrivatePoolV1Config is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolPrivatePoolV1Config) Empty ¶
func (r *WorkerPoolPrivatePoolV1Config) Empty() bool
func (*WorkerPoolPrivatePoolV1Config) HashCode ¶
func (r *WorkerPoolPrivatePoolV1Config) HashCode() string
func (*WorkerPoolPrivatePoolV1Config) String ¶
func (r *WorkerPoolPrivatePoolV1Config) String() string
func (*WorkerPoolPrivatePoolV1Config) UnmarshalJSON ¶
func (r *WorkerPoolPrivatePoolV1Config) UnmarshalJSON(data []byte) error
type WorkerPoolPrivatePoolV1ConfigNetworkConfig ¶
type WorkerPoolPrivatePoolV1ConfigNetworkConfig struct {
PeeredNetwork *string `json:"peeredNetwork"`
PeeredNetworkIPRange *string `json:"peeredNetworkIPRange"`
EgressOption *WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum `json:"egressOption"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolPrivatePoolV1ConfigNetworkConfig *WorkerPoolPrivatePoolV1ConfigNetworkConfig = &WorkerPoolPrivatePoolV1ConfigNetworkConfig{empty: true}
This object is used to assert a desired state where this WorkerPoolPrivatePoolV1ConfigNetworkConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolPrivatePoolV1ConfigNetworkConfig) Empty ¶
func (r *WorkerPoolPrivatePoolV1ConfigNetworkConfig) Empty() bool
func (*WorkerPoolPrivatePoolV1ConfigNetworkConfig) HashCode ¶
func (r *WorkerPoolPrivatePoolV1ConfigNetworkConfig) HashCode() string
func (*WorkerPoolPrivatePoolV1ConfigNetworkConfig) String ¶
func (r *WorkerPoolPrivatePoolV1ConfigNetworkConfig) String() string
func (*WorkerPoolPrivatePoolV1ConfigNetworkConfig) UnmarshalJSON ¶
func (r *WorkerPoolPrivatePoolV1ConfigNetworkConfig) UnmarshalJSON(data []byte) error
type WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum ¶
type WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum string
The enum WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum.
func WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnumRef ¶
func WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnumRef(s string) *WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum
WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnumRef returns a *WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum with the value of string s If the empty string is provided, nil is returned.
func (WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum) Validate ¶
func (v WorkerPoolPrivatePoolV1ConfigNetworkConfigEgressOptionEnum) Validate() error
type WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect ¶ added in v1.67.0
type WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect struct {
NetworkAttachment *string `json:"networkAttachment"`
PublicIPAddressDisabled *bool `json:"publicIPAddressDisabled"`
RouteAllTraffic *bool `json:"routeAllTraffic"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolPrivatePoolV1ConfigPrivateServiceConnect *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect = &WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect{empty: true}
This object is used to assert a desired state where this WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) Empty ¶ added in v1.67.0
func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) Empty() bool
func (*WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) HashCode ¶ added in v1.67.0
func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) HashCode() string
func (*WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) String ¶ added in v1.67.0
func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) String() string
func (*WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) UnmarshalJSON ¶ added in v1.67.0
func (r *WorkerPoolPrivatePoolV1ConfigPrivateServiceConnect) UnmarshalJSON(data []byte) error
type WorkerPoolPrivatePoolV1ConfigWorkerConfig ¶
type WorkerPoolPrivatePoolV1ConfigWorkerConfig struct {
MachineType *string `json:"machineType"`
DiskSizeGb *int64 `json:"diskSizeGb"`
EnableNestedVirtualization *bool `json:"enableNestedVirtualization"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolPrivatePoolV1ConfigWorkerConfig *WorkerPoolPrivatePoolV1ConfigWorkerConfig = &WorkerPoolPrivatePoolV1ConfigWorkerConfig{empty: true}
This object is used to assert a desired state where this WorkerPoolPrivatePoolV1ConfigWorkerConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolPrivatePoolV1ConfigWorkerConfig) Empty ¶
func (r *WorkerPoolPrivatePoolV1ConfigWorkerConfig) Empty() bool
func (*WorkerPoolPrivatePoolV1ConfigWorkerConfig) HashCode ¶
func (r *WorkerPoolPrivatePoolV1ConfigWorkerConfig) HashCode() string
func (*WorkerPoolPrivatePoolV1ConfigWorkerConfig) String ¶
func (r *WorkerPoolPrivatePoolV1ConfigWorkerConfig) String() string
func (*WorkerPoolPrivatePoolV1ConfigWorkerConfig) UnmarshalJSON ¶
func (r *WorkerPoolPrivatePoolV1ConfigWorkerConfig) UnmarshalJSON(data []byte) error
type WorkerPoolPrivateServiceConnect ¶ added in v1.67.0
type WorkerPoolPrivateServiceConnect struct {
NetworkAttachment *string `json:"networkAttachment"`
RouteAllTraffic *bool `json:"routeAllTraffic"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolPrivateServiceConnect *WorkerPoolPrivateServiceConnect = &WorkerPoolPrivateServiceConnect{empty: true}
This object is used to assert a desired state where this WorkerPoolPrivateServiceConnect is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolPrivateServiceConnect) Empty ¶ added in v1.67.0
func (r *WorkerPoolPrivateServiceConnect) Empty() bool
func (*WorkerPoolPrivateServiceConnect) HashCode ¶ added in v1.67.0
func (r *WorkerPoolPrivateServiceConnect) HashCode() string
func (*WorkerPoolPrivateServiceConnect) String ¶ added in v1.67.0
func (r *WorkerPoolPrivateServiceConnect) String() string
func (*WorkerPoolPrivateServiceConnect) UnmarshalJSON ¶ added in v1.67.0
func (r *WorkerPoolPrivateServiceConnect) UnmarshalJSON(data []byte) error
type WorkerPoolStateEnum ¶
type WorkerPoolStateEnum string
The enum WorkerPoolStateEnum.
func WorkerPoolStateEnumRef ¶
func WorkerPoolStateEnumRef(s string) *WorkerPoolStateEnum
WorkerPoolStateEnumRef returns a *WorkerPoolStateEnum with the value of string s If the empty string is provided, nil is returned.
func (WorkerPoolStateEnum) Validate ¶
func (v WorkerPoolStateEnum) Validate() error
type WorkerPoolWorkerConfig ¶
type WorkerPoolWorkerConfig struct {
MachineType *string `json:"machineType"`
DiskSizeGb *int64 `json:"diskSizeGb"`
EnableNestedVirtualization *bool `json:"enableNestedVirtualization"`
NoExternalIP *bool `json:"noExternalIP"`
// contains filtered or unexported fields
}
var EmptyWorkerPoolWorkerConfig *WorkerPoolWorkerConfig = &WorkerPoolWorkerConfig{empty: true}
This object is used to assert a desired state where this WorkerPoolWorkerConfig is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*WorkerPoolWorkerConfig) Empty ¶
func (r *WorkerPoolWorkerConfig) Empty() bool
func (*WorkerPoolWorkerConfig) HashCode ¶
func (r *WorkerPoolWorkerConfig) HashCode() string
func (*WorkerPoolWorkerConfig) String ¶
func (r *WorkerPoolWorkerConfig) String() string
func (*WorkerPoolWorkerConfig) UnmarshalJSON ¶
func (r *WorkerPoolWorkerConfig) UnmarshalJSON(data []byte) error
Source Files