beta

package
v1.32.0 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2023 License: Apache-2.0 Imports: 11 Imported by: 2

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. Package beta 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. Package cloudbuild contains utility methods to serve the DCL in handling odd situations in the cloudbuild API.

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 WorkerPoolMaxPage = -1

Variables

View Source 
var YAML_worker_pool = []byte("info:\n  title: CloudBuild/WorkerPool\n  description: The CloudBuild WorkerPool resource\n  x-dcl-struct-name: WorkerPool\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a WorkerPool\n    parameters:\n    - name: workerPool\n      required: true\n      description: A full instance of a WorkerPool\n  apply:\n    description: The function used to apply information about a WorkerPool\n    parameters:\n    - name: workerPool\n      required: true\n      description: A full instance of a WorkerPool\n  delete:\n    description: The function used to delete a WorkerPool\n    parameters:\n    - name: workerPool\n      required: true\n      description: A full instance of a WorkerPool\n  deleteAll:\n    description: The function used to delete all WorkerPool\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n    - name: location\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many WorkerPool\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n    - name: location\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    WorkerPool:\n      title: WorkerPool\n      x-dcl-id: projects/{{project}}/locations/{{location}}/workerPools/{{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      - name\n      - project\n      - location\n      properties:\n        annotations:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Annotations\n          description: User specified annotations. See https://google.aip.dev/128#annotations\n            for more details such as format and size limitations.\n        createTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: CreateTime\n          readOnly: true\n          description: Output only. Time at which the request to create the `WorkerPool`\n            was received.\n          x-kubernetes-immutable: true\n        deleteTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: DeleteTime\n          readOnly: true\n          description: Output only. Time at which the request to delete the `WorkerPool`\n            was received.\n          x-kubernetes-immutable: true\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: A user-specified, human-readable name for the `WorkerPool`.\n            If provided, this value must be 1-63 characters.\n        etag:\n          type: string\n          x-dcl-go-name: Etag\n          readOnly: true\n          description: Output only. Checksum computed by the server. May be sent on\n            update and delete requests to ensure that the client has an up-to-date\n            value before proceeding.\n          x-kubernetes-immutable: true\n        location:\n          type: string\n          x-dcl-go-name: Location\n          description: The location for the resource\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: User-defined name of the `WorkerPool`.\n          x-kubernetes-immutable: true\n        networkConfig:\n          type: object\n          x-dcl-go-name: NetworkConfig\n          x-dcl-go-type: WorkerPoolNetworkConfig\n          description: Network configuration for the `WorkerPool`.\n          x-kubernetes-immutable: true\n          required:\n          - peeredNetwork\n          properties:\n            peeredNetwork:\n              type: string\n              x-dcl-go-name: PeeredNetwork\n              description: Required. Immutable. The network definition that the workers\n                are peered to. If this section is left empty, the workers will be\n                peered to `WorkerPool.project_id` on the service producer network.\n                Must be in the format `projects/{project}/global/networks/{network}`,\n                where `{project}` is a project number, such as `12345`, and `{network}`\n                is the name of a VPC network in the project. See [Understanding network\n                configuration options](https://cloud.google.com/cloud-build/docs/custom-workers/set-up-custom-worker-pool-environment#understanding_the_network_configuration_options)\n              x-kubernetes-immutable: true\n              x-dcl-references:\n              - resource: Compute/Network\n                field: selfLink\n            peeredNetworkIPRange:\n              type: string\n              x-dcl-go-name: PeeredNetworkIPRange\n              description: Optional. Immutable. Subnet IP range within the peered\n                network. This is specified in CIDR notation with a slash and the subnet\n                prefix size. You can optionally specify an IP address before the subnet\n                prefix value. e.g. `192.168.0.0/29` would specify an IP range starting\n                at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify\n                a prefix size of 16 bits, with an automatically determined IP within\n                the peered VPC. If unspecified, a value of `/24` will be used.\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        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: WorkerPoolStateEnum\n          readOnly: true\n          description: 'Output only. `WorkerPool` state. Possible values: STATE_UNSPECIFIED,\n            PENDING, APPROVED, REJECTED, CANCELLED'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - PENDING\n          - APPROVED\n          - REJECTED\n          - CANCELLED\n        uid:\n          type: string\n          x-dcl-go-name: Uid\n          readOnly: true\n          description: Output only. A unique identifier for the `WorkerPool`.\n          x-kubernetes-immutable: true\n        updateTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: UpdateTime\n          readOnly: true\n          description: Output only. Time at which the request to update the `WorkerPool`\n            was received.\n          x-kubernetes-immutable: true\n        workerConfig:\n          type: object\n          x-dcl-go-name: WorkerConfig\n          x-dcl-go-type: WorkerPoolWorkerConfig\n          description: Configuration to be used for a creating workers in the `WorkerPool`.\n          x-dcl-server-default: true\n          properties:\n            diskSizeGb:\n              type: integer\n              format: int64\n              x-dcl-go-name: DiskSizeGb\n              description: Size of the disk attached to the worker, in GB. See [Worker\n                pool config file](https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file).\n                Specify a value of up to 1000. If `0` is specified, Cloud Build will\n                use a standard disk size.\n            machineType:\n              type: string\n              x-dcl-go-name: MachineType\n              description: Machine type of a worker, such as `n1-standard-1`. See\n                [Worker pool config file](https://cloud.google.com/cloud-build/docs/custom-workers/worker-pool-config-file).\n                If left blank, Cloud Build will use `n1-standard-1`.\n            noExternalIP:\n              type: boolean\n              x-dcl-go-name: NoExternalIP\n              description: If true, workers are created without any public address,\n                which prevents network egress to public IPs.\n              x-dcl-server-default: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/cloudbuild/beta/worker_pool.yaml

Functions

func DCLWorkerPoolSchema added in v1.10.3 

func DCLWorkerPoolSchema() *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) 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 (c *Client) ListWorkerPool(ctx context.Context, project, location string) (*WorkerPoolList, error)

func (*Client) ListWorkerPoolWithMaxResults 

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

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"`
	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

func (*WorkerPoolList) Next 

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

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"`
	// 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 WorkerPoolPrivatePoolV1ConfigWorkerConfig 

type WorkerPoolPrivatePoolV1ConfigWorkerConfig struct {
	MachineType *string `json:"machineType"`
	DiskSizeGb  *int64  `json:"diskSizeGb"`
	// 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 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"`
	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

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.