gkehub

package
v1.39.0 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 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 gkehub 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.

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. Package gkehub includes all of the code for gkehub.

Index

Constants

View Source 
const FeatureMaxPage = -1

Variables

View Source 
var YAML_feature = []byte("info:\n  title: GkeHub/Feature\n  description: The GkeHub Feature resource\n  x-dcl-struct-name: Feature\n  x-dcl-has-iam: false\n  x-dcl-mutex: '{{project}}/{{location}}/{{feature}}'\npaths:\n  get:\n    description: The function used to get information about a Feature\n    parameters:\n    - name: feature\n      required: true\n      description: A full instance of a Feature\n  apply:\n    description: The function used to apply information about a Feature\n    parameters:\n    - name: feature\n      required: true\n      description: A full instance of a Feature\n  delete:\n    description: The function used to delete a Feature\n    parameters:\n    - name: feature\n      required: true\n      description: A full instance of a Feature\n  deleteAll:\n    description: The function used to delete all Feature\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 Feature\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    Feature:\n      title: Feature\n      x-dcl-id: projects/{{project}}/locations/{{location}}/features/{{name}}\n      x-dcl-parent-container: project\n      x-dcl-labels: labels\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      - project\n      - location\n      properties:\n        createTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: CreateTime\n          readOnly: true\n          description: Output only. When the Feature resource was created.\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. When the Feature resource was deleted.\n          x-kubernetes-immutable: true\n        labels:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Labels\n          description: GCP labels for this Feature.\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: The full, unique name of this Feature resource\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        resourceState:\n          type: object\n          x-dcl-go-name: ResourceState\n          x-dcl-go-type: FeatureResourceState\n          readOnly: true\n          description: State of the Feature resource itself.\n          x-kubernetes-immutable: true\n          properties:\n            hasResources:\n              type: boolean\n              x-dcl-go-name: HasResources\n              readOnly: true\n              description: Whether this Feature has outstanding resources that need\n                to be cleaned up before it can be disabled.\n              x-kubernetes-immutable: true\n            state:\n              type: string\n              x-dcl-go-name: State\n              x-dcl-go-type: FeatureResourceStateStateEnum\n              readOnly: true\n              description: 'The current state of the Feature resource in the Hub API.\n                Possible values: STATE_UNSPECIFIED, ENABLING, ACTIVE, DISABLING, UPDATING,\n                SERVICE_UPDATING'\n              x-kubernetes-immutable: true\n              enum:\n              - STATE_UNSPECIFIED\n              - ENABLING\n              - ACTIVE\n              - DISABLING\n              - UPDATING\n              - SERVICE_UPDATING\n        spec:\n          type: object\n          x-dcl-go-name: Spec\n          x-dcl-go-type: FeatureSpec\n          description: Optional. Hub-wide Feature configuration. If this Feature does\n            not support any Hub-wide configuration, this field may be unused.\n          properties:\n            multiclusteringress:\n              type: object\n              x-dcl-go-name: Multiclusteringress\n              x-dcl-go-type: FeatureSpecMulticlusteringress\n              description: Multicluster Ingress-specific spec.\n              required:\n              - configMembership\n              properties:\n                configMembership:\n                  type: string\n                  x-dcl-go-name: ConfigMembership\n                  description: 'Fully-qualified Membership name which hosts the MultiClusterIngress\n                    CRD. Example: `projects/foo-proj/locations/global/memberships/bar`'\n                  x-dcl-references:\n                  - resource: Gkehub/Membership\n                    field: name\n        state:\n          type: object\n          x-dcl-go-name: State\n          x-dcl-go-type: FeatureState\n          readOnly: true\n          description: Output only. The Hub-wide Feature state\n          x-kubernetes-immutable: true\n          properties:\n            state:\n              type: object\n              x-dcl-go-name: State\n              x-dcl-go-type: FeatureStateState\n              readOnly: true\n              description: Output only. The \"running state\" of the Feature in this\n                Hub.\n              x-kubernetes-immutable: true\n              properties:\n                code:\n                  type: string\n                  x-dcl-go-name: Code\n                  x-dcl-go-type: FeatureStateStateCodeEnum\n                  readOnly: true\n                  description: 'The high-level, machine-readable status of this Feature.\n                    Possible values: CODE_UNSPECIFIED, OK, WARNING, ERROR'\n                  x-kubernetes-immutable: true\n                  enum:\n                  - CODE_UNSPECIFIED\n                  - OK\n                  - WARNING\n                  - ERROR\n                description:\n                  type: string\n                  x-dcl-go-name: Description\n                  readOnly: true\n                  description: A human-readable description of the current status.\n                  x-kubernetes-immutable: true\n                updateTime:\n                  type: string\n                  x-dcl-go-name: UpdateTime\n                  readOnly: true\n                  description: 'The time this status and any related Feature-specific\n                    details were updated. A timestamp in RFC3339 UTC \"Zulu\" format,\n                    with nanosecond resolution and up to nine fractional digits. Examples:\n                    \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\"'\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. When the Feature resource was last updated.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/gkehub/feature.yaml

Functions

func DCLFeatureSchema 

func DCLFeatureSchema() *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) ApplyFeature 

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

func (*Client) DeleteAllFeature 

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

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

func (*Client) DeleteFeature 

func (c *Client) DeleteFeature(ctx context.Context, r *Feature) error

func (*Client) GetFeature 

func (c *Client) GetFeature(ctx context.Context, r *Feature) (*Feature, error)

func (*Client) ListFeature 

func (c *Client) ListFeature(ctx context.Context, project, location string) (*FeatureList, error)

func (*Client) ListFeatureWithMaxResults 

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

type Feature 

type Feature struct {
	Name          *string               `json:"name"`
	Labels        map[string]string     `json:"labels"`
	ResourceState *FeatureResourceState `json:"resourceState"`
	Spec          *FeatureSpec          `json:"spec"`
	State         *FeatureState         `json:"state"`
	CreateTime    *string               `json:"createTime"`
	UpdateTime    *string               `json:"updateTime"`
	DeleteTime    *string               `json:"deleteTime"`
	Project       *string               `json:"project"`
	Location      *string               `json:"location"`
}

func (*Feature) Describe 

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

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

func (*Feature) ID 

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

func (*Feature) String 

func (r *Feature) String() string

type FeatureList 

type FeatureList struct {
	Items []*Feature
	// contains filtered or unexported fields
}

func (*FeatureList) HasNext 

func (l *FeatureList) HasNext() bool

func (*FeatureList) Next 

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

type FeatureResourceState 

type FeatureResourceState struct {
	State        *FeatureResourceStateStateEnum `json:"state"`
	HasResources *bool                          `json:"hasResources"`
	// contains filtered or unexported fields
}
var EmptyFeatureResourceState *FeatureResourceState = &FeatureResourceState{empty: true}

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

func (*FeatureResourceState) Empty 

func (r *FeatureResourceState) Empty() bool

func (*FeatureResourceState) HashCode 

func (r *FeatureResourceState) HashCode() string

func (*FeatureResourceState) String 

func (r *FeatureResourceState) String() string

func (*FeatureResourceState) UnmarshalJSON 

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

type FeatureResourceStateStateEnum 

type FeatureResourceStateStateEnum string

The enum FeatureResourceStateStateEnum.

func FeatureResourceStateStateEnumRef 

func FeatureResourceStateStateEnumRef(s string) *FeatureResourceStateStateEnum

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

func (FeatureResourceStateStateEnum) Validate 

func (v FeatureResourceStateStateEnum) Validate() error

type FeatureSpec 

type FeatureSpec struct {
	Multiclusteringress *FeatureSpecMulticlusteringress `json:"multiclusteringress"`
	// contains filtered or unexported fields
}
var EmptyFeatureSpec *FeatureSpec = &FeatureSpec{empty: true}

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

func (*FeatureSpec) Empty 

func (r *FeatureSpec) Empty() bool

func (*FeatureSpec) HashCode 

func (r *FeatureSpec) HashCode() string

func (*FeatureSpec) String 

func (r *FeatureSpec) String() string

func (*FeatureSpec) UnmarshalJSON 

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

type FeatureSpecMulticlusteringress 

type FeatureSpecMulticlusteringress struct {
	ConfigMembership *string `json:"configMembership"`
	// contains filtered or unexported fields
}
var EmptyFeatureSpecMulticlusteringress *FeatureSpecMulticlusteringress = &FeatureSpecMulticlusteringress{empty: true}

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

func (*FeatureSpecMulticlusteringress) Empty 

func (r *FeatureSpecMulticlusteringress) Empty() bool

func (*FeatureSpecMulticlusteringress) HashCode 

func (r *FeatureSpecMulticlusteringress) HashCode() string

func (*FeatureSpecMulticlusteringress) String 

func (r *FeatureSpecMulticlusteringress) String() string

func (*FeatureSpecMulticlusteringress) UnmarshalJSON 

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

type FeatureState 

type FeatureState struct {
	State *FeatureStateState `json:"state"`
	// contains filtered or unexported fields
}
var EmptyFeatureState *FeatureState = &FeatureState{empty: true}

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

func (*FeatureState) Empty 

func (r *FeatureState) Empty() bool

func (*FeatureState) HashCode 

func (r *FeatureState) HashCode() string

func (*FeatureState) String 

func (r *FeatureState) String() string

func (*FeatureState) UnmarshalJSON 

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

type FeatureStateState 

type FeatureStateState struct {
	Code        *FeatureStateStateCodeEnum `json:"code"`
	Description *string                    `json:"description"`
	UpdateTime  *string                    `json:"updateTime"`
	// contains filtered or unexported fields
}
var EmptyFeatureStateState *FeatureStateState = &FeatureStateState{empty: true}

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

func (*FeatureStateState) Empty 

func (r *FeatureStateState) Empty() bool

func (*FeatureStateState) HashCode 

func (r *FeatureStateState) HashCode() string

func (*FeatureStateState) String 

func (r *FeatureStateState) String() string

func (*FeatureStateState) UnmarshalJSON 

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

type FeatureStateStateCodeEnum 

type FeatureStateStateCodeEnum string

The enum FeatureStateStateCodeEnum.

func FeatureStateStateCodeEnumRef 

func FeatureStateStateCodeEnumRef(s string) *FeatureStateStateCodeEnum

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

func (FeatureStateStateCodeEnum) Validate 

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