alpha

package
v1.76.0 Latest Latest
Warning

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

Go to latest
Published: Nov 14, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Copyright 2024 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 2024 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 2024 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 2024 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 2024 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 2024 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 2024 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 BrandMaxPage = -1
View Source
const IdentityAwareProxyClientMaxPage = -1

Variables

View Source
var YAML_brand = []byte("info:\n  title: Iap/Brand\n  description: The Iap Brand resource\n  x-dcl-struct-name: Brand\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Brand\n    parameters:\n    - name: brand\n      required: true\n      description: A full instance of a Brand\n  apply:\n    description: The function used to apply information about a Brand\n    parameters:\n    - name: brand\n      required: true\n      description: A full instance of a Brand\n  list:\n    description: The function used to list information about many Brand\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Brand:\n      title: Brand\n      x-dcl-id: projects/{{project}}/brands/{{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      properties:\n        applicationTitle:\n          type: string\n          x-dcl-go-name: ApplicationTitle\n          description: Application name displayed on OAuth consent screen.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: 'Output only. Identifier of the brand. NOTE: GCP project number\n            achieves the same brand identification purpose as only one brand per project\n            can be created.'\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n          x-dcl-has-long-form: true\n        orgInternalOnly:\n          type: boolean\n          x-dcl-go-name: OrgInternalOnly\n          readOnly: true\n          description: Output only. Whether the brand is only intended for usage inside\n            the G Suite organization only.\n          x-kubernetes-immutable: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: GCP Project id under which the brand is to be created.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n          x-dcl-parameter: true\n        supportEmail:\n          type: string\n          x-dcl-go-name: SupportEmail\n          description: Support email displayed on the OAuth consent screen.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/iap/alpha/brand.yaml

View Source
var YAML_identity_aware_proxy_client = []byte("info:\n  title: Iap/IdentityAwareProxyClient\n  description: The Iap IdentityAwareProxyClient resource\n  x-dcl-struct-name: IdentityAwareProxyClient\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a IdentityAwareProxyClient\n    parameters:\n    - name: identityAwareProxyClient\n      required: true\n      description: A full instance of a IdentityAwareProxyClient\n  apply:\n    description: The function used to apply information about a IdentityAwareProxyClient\n    parameters:\n    - name: identityAwareProxyClient\n      required: true\n      description: A full instance of a IdentityAwareProxyClient\n  delete:\n    description: The function used to delete a IdentityAwareProxyClient\n    parameters:\n    - name: identityAwareProxyClient\n      required: true\n      description: A full instance of a IdentityAwareProxyClient\n  deleteAll:\n    description: The function used to delete all IdentityAwareProxyClient\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n    - name: brand\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many IdentityAwareProxyClient\n    parameters:\n    - name: project\n      required: true\n      schema:\n        type: string\n    - name: brand\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    IdentityAwareProxyClient:\n      title: IdentityAwareProxyClient\n      x-dcl-id: projects/{{project}}/brands/{{brand}}/identityAwareProxyClients/{{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      - project\n      - brand\n      properties:\n        brand:\n          type: string\n          x-dcl-go-name: Brand\n          description: The brand for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Iap/Brand\n            field: name\n            parent: true\n          x-dcl-parameter: true\n          x-dcl-has-long-form: true\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: Human-friendly name given to the OAuth client.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. Unique identifier of the OAuth client.\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: true\n          x-dcl-has-long-form: 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          x-dcl-parameter: true\n          x-dcl-has-long-form: true\n        secret:\n          type: string\n          x-dcl-go-name: Secret\n          readOnly: true\n          description: Output only. Client secret of the OAuth client.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/iap/alpha/identity_aware_proxy_client.yaml

Functions

func DCLBrandSchema added in v1.10.3

func DCLBrandSchema() *dcl.Schema

func DCLIdentityAwareProxyClientSchema added in v1.10.3

func DCLIdentityAwareProxyClientSchema() *dcl.Schema

Types

type Brand

type Brand struct {
	ApplicationTitle *string `json:"applicationTitle"`
	Name             *string `json:"name"`
	OrgInternalOnly  *bool   `json:"orgInternalOnly"`
	SupportEmail     *string `json:"supportEmail"`
	Project          *string `json:"project"`
}

func (*Brand) Describe

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

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

func (*Brand) ID

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

func (*Brand) String

func (r *Brand) String() string

type BrandList

type BrandList struct {
	Items []*Brand
	// contains filtered or unexported fields
}

func (*BrandList) HasNext

func (l *BrandList) HasNext() bool

func (*BrandList) Next

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

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) ApplyBrand

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

func (*Client) ApplyIdentityAwareProxyClient

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

func (*Client) DeleteAllIdentityAwareProxyClient

func (c *Client) DeleteAllIdentityAwareProxyClient(ctx context.Context, project, brand string, filter func(*IdentityAwareProxyClient) bool) error

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

func (*Client) DeleteIdentityAwareProxyClient

func (c *Client) DeleteIdentityAwareProxyClient(ctx context.Context, r *IdentityAwareProxyClient) error

func (*Client) GetBrand

func (c *Client) GetBrand(ctx context.Context, r *Brand) (*Brand, error)

func (*Client) GetIdentityAwareProxyClient

func (c *Client) GetIdentityAwareProxyClient(ctx context.Context, r *IdentityAwareProxyClient) (*IdentityAwareProxyClient, error)

func (*Client) ListBrand

func (c *Client) ListBrand(ctx context.Context, project string) (*BrandList, error)

func (*Client) ListBrandWithMaxResults

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

func (*Client) ListIdentityAwareProxyClient

func (c *Client) ListIdentityAwareProxyClient(ctx context.Context, project, brand string) (*IdentityAwareProxyClientList, error)

func (*Client) ListIdentityAwareProxyClientWithMaxResults

func (c *Client) ListIdentityAwareProxyClientWithMaxResults(ctx context.Context, project, brand string, pageSize int32) (*IdentityAwareProxyClientList, error)

type IdentityAwareProxyClient

type IdentityAwareProxyClient struct {
	Name        *string `json:"name"`
	Secret      *string `json:"secret"`
	DisplayName *string `json:"displayName"`
	Project     *string `json:"project"`
	Brand       *string `json:"brand"`
}

func (*IdentityAwareProxyClient) Describe

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

func (*IdentityAwareProxyClient) ID

func (*IdentityAwareProxyClient) String

func (r *IdentityAwareProxyClient) String() string

type IdentityAwareProxyClientList

type IdentityAwareProxyClientList struct {
	Items []*IdentityAwareProxyClient
	// contains filtered or unexported fields
}

func (*IdentityAwareProxyClientList) HasNext

func (l *IdentityAwareProxyClientList) HasNext() bool

func (*IdentityAwareProxyClientList) Next

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL