alpha

Documentation

Overview

Copyright 2022 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 2022 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 2022 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 2022 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 DCLConnectorSchema() *dcl.Schema
• type Client
  • func NewClient(c *dcl.Config) *Client
  • func (c *Client) ApplyConnector(ctx context.Context, rawDesired *Connector, opts ...dcl.ApplyOption) (*Connector, error)
  • func (c *Client) DeleteAllConnector(ctx context.Context, project, location string, filter func(*Connector) bool) error
  • func (c *Client) DeleteConnector(ctx context.Context, r *Connector) error
  • func (c *Client) GetConnector(ctx context.Context, r *Connector) (*Connector, error)
  • func (c *Client) ListConnector(ctx context.Context, project, location string) (*ConnectorList, error)
  • func (c *Client) ListConnectorWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*ConnectorList, error)
• type Connector
  • func (r *Connector) Describe() dcl.ServiceTypeVersion
  • func (r *Connector) ID() (string, error)
  • func (r *Connector) String() string
• type ConnectorList
  • func (l *ConnectorList) HasNext() bool
  • func (l *ConnectorList) Next(ctx context.Context, c *Client) error
• type ConnectorStateEnum
  • func ConnectorStateEnumRef(s string) *ConnectorStateEnum
  • func (v ConnectorStateEnum) Validate() error
• type ConnectorSubnet
  • func (r *ConnectorSubnet) Empty() bool
  • func (r *ConnectorSubnet) HashCode() string
  • func (r *ConnectorSubnet) String() string
  • func (r *ConnectorSubnet) UnmarshalJSON(data []byte) error

Constants

const ConnectorMaxPage = -1

Variables

var YAML_connector = []byte("info:\n  title: VPCAccess/Connector\n  description: The VPCAccess Connector resource\n  x-dcl-struct-name: Connector\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Connector\n    parameters:\n    - name: Connector\n      required: true\n      description: A full instance of a Connector\n    timeoutSecs: 0\n  apply:\n    description: The function used to apply information about a Connector\n    parameters:\n    - name: Connector\n      required: true\n      description: A full instance of a Connector\n    timeoutSecs: 0\n  delete:\n    description: The function used to delete a Connector\n    parameters:\n    - name: Connector\n      required: true\n      description: A full instance of a Connector\n    timeoutSecs: 0\n  deleteAll:\n    description: The function used to delete all Connector\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    timeoutSecs: 0\n  list:\n    description: The function used to list information about many Connector\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    timeoutSecs: 0\ncomponents:\n  schemas:\n    Connector:\n      title: Connector\n      x-dcl-id: projects/{{project}}/locations/{{location}}/connectors/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-has-create: true\n      x-dcl-has-iam: false\n      type: object\n      required:\n      - name\n      - project\n      - location\n      properties:\n        connectedProjects:\n          type: array\n          x-dcl-go-name: ConnectedProjects\n          readOnly: true\n          description: Output only. List of projects using the connector.\n          x-kubernetes-immutable: true\n          x-dcl-list-type: list\n          items:\n            type: string\n            x-dcl-go-type: string\n        ipCidrRange:\n          type: string\n          x-dcl-go-name: IPCidrRange\n          description: 'The range of internal addresses that follows RFC 4632 notation.\n            Example: `10.132.0.0/28`.'\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        machineType:\n          type: string\n          x-dcl-go-name: MachineType\n          description: Machine type of VM Instance underlying connector. Default is\n            e2-micro\n          x-kubernetes-immutable: true\n        maxInstances:\n          type: integer\n          format: int64\n          x-dcl-go-name: MaxInstances\n          description: Maximum value of instances in autoscaling group underlying\n            the connector.\n          x-kubernetes-immutable: true\n        maxThroughput:\n          type: integer\n          format: int64\n          x-dcl-go-name: MaxThroughput\n          description: Maximum throughput of the connector in Mbps. Default is 200,\n            max is 1000.\n          x-kubernetes-immutable: true\n        minInstances:\n          type: integer\n          format: int64\n          x-dcl-go-name: MinInstances\n          description: Minimum value of instances in autoscaling group underlying\n            the connector.\n          x-kubernetes-immutable: true\n        minThroughput:\n          type: integer\n          format: int64\n          x-dcl-go-name: MinThroughput\n          description: Minimum throughput of the connector in Mbps. Default and min\n            is 200.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: The resource name in the format `projects/*/locations/*/connectors/*`.\n          x-kubernetes-immutable: true\n        network:\n          type: string\n          x-dcl-go-name: Network\n          description: Name of a VPC network.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Compute/Network\n            field: name\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: ConnectorStateEnum\n          readOnly: true\n          description: 'Output only. State of the VPC access connector. Possible values:\n            STATE_UNSPECIFIED, READY, CREATING, DELETING, ERROR, UPDATING'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - READY\n          - CREATING\n          - DELETING\n          - ERROR\n          - UPDATING\n        subnet:\n          type: object\n          x-dcl-go-name: Subnet\n          x-dcl-go-type: ConnectorSubnet\n          description: The subnet in which to house the VPC Access Connector.\n          x-kubernetes-immutable: true\n          properties:\n            name:\n              type: string\n              x-dcl-go-name: Name\n              description: 'Subnet name (relative, not fully qualified). E.g. if the\n                full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName}\n                the correct input for this field would be: {subnetName}'\n              x-kubernetes-immutable: true\n              x-dcl-references:\n              - resource: Compute/Subnetwork\n                field: name\n                parent: true\n            projectId:\n              type: string\n              x-dcl-go-name: ProjectId\n              description: Project in which the subnet exists. If not set, this project\n                is assumed to be the project for which the connector create request\n                was issued.\n              x-kubernetes-immutable: true\n              x-dcl-references:\n              - resource: Cloudresourcemanager/Project\n                field: name\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/vpcaccess/alpha/connector.yaml

Functions

func DCLConnectorSchema

func DCLConnectorSchema() *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) ApplyConnector

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

func (*Client) DeleteAllConnector

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

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

func (*Client) DeleteConnector

func (c *Client) DeleteConnector(ctx context.Context, r *Connector) error

func (*Client) GetConnector

func (c *Client) GetConnector(ctx context.Context, r *Connector) (*Connector, error)

func (*Client) ListConnector

func (c *Client) ListConnector(ctx context.Context, project, location string) (*ConnectorList, error)

func (*Client) ListConnectorWithMaxResults

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

type Connector

type Connector struct {
	Name              *string             `json:"name"`
	Network           *string             `json:"network"`
	IPCidrRange       *string             `json:"ipCidrRange"`
	State             *ConnectorStateEnum `json:"state"`
	MinThroughput     *int64              `json:"minThroughput"`
	MaxThroughput     *int64              `json:"maxThroughput"`
	ConnectedProjects []string            `json:"connectedProjects"`
	Subnet            *ConnectorSubnet    `json:"subnet"`
	MachineType       *string             `json:"machineType"`
	MinInstances      *int64              `json:"minInstances"`
	MaxInstances      *int64              `json:"maxInstances"`
	Project           *string             `json:"project"`
	Location          *string             `json:"location"`
}

func (*Connector) Describe

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

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

func (*Connector) ID

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

func (*Connector) String

func (r *Connector) String() string

type ConnectorList

type ConnectorList struct {
	Items []*Connector
	// contains filtered or unexported fields
}

func (*ConnectorList) HasNext

func (l *ConnectorList) HasNext() bool

func (*ConnectorList) Next

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

type ConnectorStateEnum

type ConnectorStateEnum string

The enum ConnectorStateEnum.

func ConnectorStateEnumRef

func ConnectorStateEnumRef(s string) *ConnectorStateEnum

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

func (ConnectorStateEnum) Validate

func (v ConnectorStateEnum) Validate() error

type ConnectorSubnet

type ConnectorSubnet struct {
	Name      *string `json:"name"`
	ProjectId *string `json:"projectId"`
	// contains filtered or unexported fields
}

var EmptyConnectorSubnet *ConnectorSubnet = &ConnectorSubnet{empty: true}

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

func (*ConnectorSubnet) Empty

func (r *ConnectorSubnet) Empty() bool

func (*ConnectorSubnet) HashCode

func (r *ConnectorSubnet) HashCode() string

func (*ConnectorSubnet) String

func (r *ConnectorSubnet) String() string

func (*ConnectorSubnet) UnmarshalJSON

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