alpha

package
v1.44.0 Latest Latest
Warning

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

Go to latest
Published: Jun 23, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

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 alpha 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 cloudidentity contains support for DCL Cloud Identity.

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 GroupMaxPage = -1
View Source
const MembershipMaxPage = -1

Variables

View Source
var YAML_group = []byte("info:\n  title: Cloudidentity/Group\n  description: The Cloudidentity Group resource\n  x-dcl-struct-name: Group\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Group\n    parameters:\n    - name: group\n      required: true\n      description: A full instance of a Group\n  apply:\n    description: The function used to apply information about a Group\n    parameters:\n    - name: group\n      required: true\n      description: A full instance of a Group\n  delete:\n    description: The function used to delete a Group\n    parameters:\n    - name: group\n      required: true\n      description: A full instance of a Group\n  deleteAll:\n    description: The function used to delete all Group\n    parameters:\n    - name: parent\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Group\n    parameters:\n    - name: parent\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Group:\n      title: Group\n      x-dcl-id: groups/{{name}}\n      x-dcl-uses-state-hint: true\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      - groupKey\n      - parent\n      - labels\n      properties:\n        additionalGroupKeys:\n          type: array\n          x-dcl-go-name: AdditionalGroupKeys\n          description: Optional. Additional entity key aliases for a Group.\n          x-kubernetes-immutable: true\n          x-dcl-send-empty: true\n          x-dcl-list-type: list\n          items:\n            type: object\n            x-dcl-go-type: GroupAdditionalGroupKeys\n            required:\n            - id\n            properties:\n              id:\n                type: string\n                x-dcl-go-name: Id\n                description: The ID of the entity. For Google-managed entities, the\n                  `id` must be the email address of a group or user. For external-identity-mapped\n                  entities, the `id` must be a string conforming to the Identity Source's\n                  requirements. Must be unique within a `namespace`.\n                x-kubernetes-immutable: true\n              namespace:\n                type: string\n                x-dcl-go-name: Namespace\n                description: The namespace in which the entity exists. If not specified,\n                  the `EntityKey` represents a Google-managed entity such as a Google\n                  user or a Google Group. If specified, the `EntityKey` represents\n                  an external-identity-mapped group. The namespace must correspond\n                  to an identity source created in Admin Console and must be in the\n                  form of `identitysources/{identity_source_id}`.\n                x-kubernetes-immutable: true\n          x-dcl-mutable-unreadable: true\n        createTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: CreateTime\n          readOnly: true\n          description: Output only. The time when the `Group` was created.\n          x-kubernetes-immutable: true\n        derivedAliases:\n          type: array\n          x-dcl-go-name: DerivedAliases\n          readOnly: true\n          description: Output only. Aliases for groups derived from domain aliases.\n          x-kubernetes-immutable: true\n          x-dcl-list-type: list\n          items:\n            type: object\n            x-dcl-go-type: GroupDerivedAliases\n            required:\n            - id\n            properties:\n              id:\n                type: string\n                x-dcl-go-name: Id\n                description: The ID of the entity. For Google-managed entities, the\n                  `id` must be the email address of a group or user. For external-identity-mapped\n                  entities, the `id` must be a string conforming to the Identity Source's\n                  requirements. Must be unique within a `namespace`.\n                x-kubernetes-immutable: true\n              namespace:\n                type: string\n                x-dcl-go-name: Namespace\n                description: The namespace in which the entity exists. If not specified,\n                  the `EntityKey` represents a Google-managed entity such as a Google\n                  user or a Google Group. If specified, the `EntityKey` represents\n                  an external-identity-mapped group. The namespace must correspond\n                  to an identity source created in Admin Console and must be in the\n                  form of `identitysources/{identity_source_id}`.\n                x-kubernetes-immutable: true\n        description:\n          type: string\n          x-dcl-go-name: Description\n          description: An extended description to help users determine the purpose\n            of a `Group`. Must not be longer than 4,096 characters.\n        directMemberCount:\n          type: integer\n          format: int64\n          x-dcl-go-name: DirectMemberCount\n          readOnly: true\n          description: 'Output only. The number of all direct members. Including groups\n            and users, The special member: all-user-in-domain will be counted as one\n            member. Output only.'\n          x-kubernetes-immutable: true\n        directMemberCountPerType:\n          type: object\n          x-dcl-go-name: DirectMemberCountPerType\n          x-dcl-go-type: GroupDirectMemberCountPerType\n          readOnly: true\n          description: Output only. Direct membership counts grouped by user/group\n            type\n          x-kubernetes-immutable: true\n          properties:\n            groupCount:\n              type: integer\n              format: int64\n              x-dcl-go-name: GroupCount\n              readOnly: true\n              description: Output only. Direct group type membership count\n              x-kubernetes-immutable: true\n            userCount:\n              type: integer\n              format: int64\n              x-dcl-go-name: UserCount\n              readOnly: true\n              description: Output only. Direct user type membership count\n              x-kubernetes-immutable: true\n        displayName:\n          type: string\n          x-dcl-go-name: DisplayName\n          description: The display name of the `Group`.\n          x-dcl-server-default: true\n        dynamicGroupMetadata:\n          type: object\n          x-dcl-go-name: DynamicGroupMetadata\n          x-dcl-go-type: GroupDynamicGroupMetadata\n          description: Optional. Dynamic group metadata like queries and status.\n          properties:\n            queries:\n              type: array\n              x-dcl-go-name: Queries\n              description: Only one entry is supported for now. Memberships will be\n                the union of all queries. Customers can create up to 100 dynamic groups.\n              x-dcl-send-empty: true\n              x-dcl-list-type: list\n              items:\n                type: object\n                x-dcl-go-type: GroupDynamicGroupMetadataQueries\n                properties:\n                  query:\n                    type: string\n                    x-dcl-go-name: Query\n                    description: Query that determines the memberships of the dynamic\n                      group.\n                  resourceType:\n                    type: string\n                    x-dcl-go-name: ResourceType\n                    x-dcl-go-type: GroupDynamicGroupMetadataQueriesResourceTypeEnum\n                    description: ' Possible values: RESOURCE_TYPE_UNSPECIFIED, USER'\n                    enum:\n                    - RESOURCE_TYPE_UNSPECIFIED\n                    - USER\n            status:\n              type: object\n              x-dcl-go-name: Status\n              x-dcl-go-type: GroupDynamicGroupMetadataStatus\n              readOnly: true\n              description: Status of the dynamic group. Output only.\n              properties:\n                status:\n                  type: string\n                  x-dcl-go-name: Status\n                  x-dcl-go-type: GroupDynamicGroupMetadataStatusStatusEnum\n                  description: 'Status of the dynamic group. Possible values: STATUS_UNSPECIFIED,\n                    UP_TO_DATE, UPDATING_MEMBERSHIPS, INVALID_QUERY'\n                  enum:\n                  - STATUS_UNSPECIFIED\n                  - UP_TO_DATE\n                  - UPDATING_MEMBERSHIPS\n                  - INVALID_QUERY\n                statusTime:\n                  type: string\n                  format: date-time\n                  x-dcl-go-name: StatusTime\n                  description: 'The latest time at which the dynamic group is guaranteed\n                    to be in the given status. For example, if status is: UP_TO_DATE\n                    - The latest time at which this dynamic group was confirmed to\n                    be up to date. UPDATING_MEMBERSHIPS - The time at which dynamic\n                    group was created.'\n        groupKey:\n          type: object\n          x-dcl-go-name: GroupKey\n          x-dcl-go-type: GroupGroupKey\n          description: Required. Immutable. The `EntityKey` of the `Group`.\n          x-kubernetes-immutable: true\n          required:\n          - id\n          properties:\n            id:\n              type: string\n              x-dcl-go-name: Id\n              description: The ID of the entity. For Google-managed entities, the\n                `id` must be the email address of a group or user. For external-identity-mapped\n                entities, the `id` must be a string conforming to the Identity Source's\n                requirements. Must be unique within a `namespace`.\n              x-kubernetes-immutable: true\n            namespace:\n              type: string\n              x-dcl-go-name: Namespace\n              description: The namespace in which the entity exists. If not specified,\n                the `EntityKey` represents a Google-managed entity such as a Google\n                user or a Google Group. If specified, the `EntityKey` represents an\n                external-identity-mapped group. The namespace must correspond to an\n                identity source created in Admin Console and must be in the form of\n                `identitysources/{identity_source_id}`.\n              x-kubernetes-immutable: true\n        initialGroupConfig:\n          type: string\n          x-dcl-go-name: InitialGroupConfig\n          x-dcl-go-type: GroupInitialGroupConfigEnum\n          description: 'The initial configuration option for the `Group`. Possible\n            values: INITIAL_GROUP_CONFIG_UNSPECIFIED, WITH_INITIAL_OWNER, EMPTY'\n          x-kubernetes-immutable: true\n          enum:\n          - INITIAL_GROUP_CONFIG_UNSPECIFIED\n          - WITH_INITIAL_OWNER\n          - EMPTY\n        labels:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Labels\n          description: Required. One or more label entries that apply to the Group.\n            Currently supported labels contain a key with an empty value. Google Groups\n            are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum`\n            and an empty value. Existing Google Groups can have an additional label\n            with a key of `cloudidentity.googleapis.com/groups.security` and an empty\n            value added to them. **This is an immutable change and the security label\n            cannot be removed once added.** Dynamic groups have a label with a key\n            of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups\n            for Cloud Search have a label with a key of `system/groups/external` and\n            an empty value.\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. The [resource name](https://cloud.google.com/apis/design/resource_names)\n            of the `Group`. Shall be of the form `groups/{group}`.\n          x-dcl-server-generated-parameter: true\n        parent:\n          type: string\n          x-dcl-go-name: Parent\n          description: Required. Immutable. The resource name of the entity under\n            which this `Group` resides in the Cloud Identity resource hierarchy. Must\n            be of the form `identitysources/{identity_source}` for external- identity-mapped\n            groups or `customers/{customer}` for Google Groups. The `customer` must\n            begin with \"C\" (for example, 'C046psxkn').\n          x-kubernetes-immutable: true\n        posixGroups:\n          type: array\n          x-dcl-go-name: PosixGroups\n          description: The POSIX groups associated with the `Group`.\n          x-dcl-send-empty: true\n          x-dcl-list-type: list\n          items:\n            type: object\n            x-dcl-go-type: GroupPosixGroups\n            properties:\n              gid:\n                type: string\n                x-dcl-go-name: Gid\n                description: GID of the POSIX group.\n              name:\n                type: string\n                x-dcl-go-name: Name\n                description: Name of the POSIX group.\n              systemId:\n                type: string\n                x-dcl-go-name: SystemId\n                description: System identifier for which group name and gid apply\n                  to. If not specified it will default to empty value.\n        updateTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: UpdateTime\n          readOnly: true\n          description: Output only. The time when the `Group` was last updated.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/cloudidentity/alpha/group.yaml

View Source
var YAML_membership = []byte("info:\n  title: Cloudidentity/Membership\n  description: The Cloudidentity Membership resource\n  x-dcl-struct-name: Membership\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Membership\n    parameters:\n    - name: membership\n      required: true\n      description: A full instance of a Membership\n  apply:\n    description: The function used to apply information about a Membership\n    parameters:\n    - name: membership\n      required: true\n      description: A full instance of a Membership\n  delete:\n    description: The function used to delete a Membership\n    parameters:\n    - name: membership\n      required: true\n      description: A full instance of a Membership\n  deleteAll:\n    description: The function used to delete all Membership\n    parameters:\n    - name: group\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Membership\n    parameters:\n    - name: group\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Membership:\n      title: Membership\n      x-dcl-id: groups/{{group}}/memberships/{{name}}\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      - preferredMemberKey\n      - roles\n      - group\n      properties:\n        createTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: CreateTime\n          readOnly: true\n          description: Output only. The time when the `Membership` was created.\n          x-kubernetes-immutable: true\n        deliverySetting:\n          type: string\n          x-dcl-go-name: DeliverySetting\n          x-dcl-go-type: MembershipDeliverySettingEnum\n          readOnly: true\n          description: 'Output only. Delivery setting associated with the membership.\n            Possible values: DELIVERY_SETTING_UNSPECIFIED, ALL_MAIL, DIGEST, DAILY,\n            NONE, DISABLED'\n          x-kubernetes-immutable: true\n          enum:\n          - DELIVERY_SETTING_UNSPECIFIED\n          - ALL_MAIL\n          - DIGEST\n          - DAILY\n          - NONE\n          - DISABLED\n        displayName:\n          type: object\n          x-dcl-go-name: DisplayName\n          x-dcl-go-type: MembershipDisplayName\n          readOnly: true\n          description: Output only. The display name of this member, if available\n          x-kubernetes-immutable: true\n          properties:\n            familyName:\n              type: string\n              x-dcl-go-name: FamilyName\n              readOnly: true\n              description: Output only. Member's family name\n              x-kubernetes-immutable: true\n            fullName:\n              type: string\n              x-dcl-go-name: FullName\n              readOnly: true\n              description: Output only. Localized UTF-16 full name for the member.\n                Localization is done based on the language in the request and the\n                language of the stored display name.\n              x-kubernetes-immutable: true\n            givenName:\n              type: string\n              x-dcl-go-name: GivenName\n              readOnly: true\n              description: Output only. Member's given name\n              x-kubernetes-immutable: true\n        group:\n          type: string\n          x-dcl-go-name: Group\n          description: The group for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudidentity/Group\n            field: name\n            parent: true\n        memberKey:\n          type: object\n          x-dcl-go-name: MemberKey\n          x-dcl-go-type: MembershipMemberKey\n          description: Immutable. The `EntityKey` of the member. Either `member_key`\n            or `preferred_member_key` must be set when calling MembershipsService.CreateMembership\n            but not both; both shall be set when returned.\n          x-dcl-server-default: true\n          properties:\n            id:\n              type: string\n              x-dcl-go-name: Id\n              description: The ID of the entity. For Google-managed entities, the\n                `id` must be the email address of an existing group or user. For external-identity-mapped\n                entities, the `id` must be a string conforming to the Identity Source's\n                requirements. Must be unique within a `namespace`.\n            namespace:\n              type: string\n              x-dcl-go-name: Namespace\n              description: The namespace in which the entity exists. If not specified,\n                the `EntityKey` represents a Google-managed entity such as a Google\n                user or a Google Group. If specified, the `EntityKey` represents an\n                external-identity-mapped group. The namespace must correspond to an\n                identity source created in Admin Console and must be in the form of\n                `identitysources/{identity_source_id}`.\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. The [resource name](https://cloud.google.com/apis/design/resource_names)\n            of the `Membership`. Shall be of the form `groups/{group}/memberships/{membership}`.\n          x-dcl-server-generated-parameter: true\n        preferredMemberKey:\n          type: object\n          x-dcl-go-name: PreferredMemberKey\n          x-dcl-go-type: MembershipPreferredMemberKey\n          description: Required. Immutable. The `EntityKey` of the member.\n          x-kubernetes-immutable: true\n          required:\n          - id\n          properties:\n            id:\n              type: string\n              x-dcl-go-name: Id\n              description: The ID of the entity. For Google-managed entities, the\n                `id` must be the email address of a group or user. For external-identity-mapped\n                entities, the `id` must be a string conforming to the Identity Source's\n                requirements. Must be unique within a `namespace`.\n              x-kubernetes-immutable: true\n            namespace:\n              type: string\n              x-dcl-go-name: Namespace\n              description: The namespace in which the entity exists. If not specified,\n                the `EntityKey` represents a Google-managed entity such as a Google\n                user or a Google Group. If specified, the `EntityKey` represents an\n                external-identity-mapped group. The namespace must correspond to an\n                identity source created in Admin Console and must be in the form of\n                `identitysources/{identity_source_id}`.\n              x-kubernetes-immutable: true\n        roles:\n          type: array\n          x-dcl-go-name: Roles\n          description: The `MembershipRole`s that apply to the `Membership`. If unspecified,\n            defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain\n            duplicate `MembershipRole`s with the same `name`.\n          x-dcl-send-empty: true\n          x-dcl-list-type: set\n          items:\n            type: object\n            x-dcl-go-type: MembershipRoles\n            required:\n            - name\n            properties:\n              expiryDetail:\n                type: object\n                x-dcl-go-name: ExpiryDetail\n                x-dcl-go-type: MembershipRolesExpiryDetail\n                description: The expiry details of the `MembershipRole`. Expiry details\n                  are only supported for `MEMBER` `MembershipRoles`. May be set if\n                  `name` is `MEMBER`. Must not be set if `name` is any other value.\n                x-dcl-send-empty: true\n                properties:\n                  expireTime:\n                    type: string\n                    format: date-time\n                    x-dcl-go-name: ExpireTime\n                    description: The time at which the `MembershipRole` will expire.\n              name:\n                type: string\n                x-dcl-go-name: Name\n              restrictionEvaluations:\n                type: object\n                x-dcl-go-name: RestrictionEvaluations\n                x-dcl-go-type: MembershipRolesRestrictionEvaluations\n                description: Evaluations of restrictions applied to parent group on\n                  this membership.\n                properties:\n                  memberRestrictionEvaluation:\n                    type: object\n                    x-dcl-go-name: MemberRestrictionEvaluation\n                    x-dcl-go-type: MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation\n                    description: Evaluation of the member restriction applied to this\n                      membership. Empty if the user lacks permission to view the restriction\n                      evaluation.\n                    properties:\n                      state:\n                        type: string\n                        x-dcl-go-name: State\n                        x-dcl-go-type: MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum\n                        readOnly: true\n                        description: 'Output only. The current state of the restriction\n                          Possible values: ENCRYPTION_STATE_UNSPECIFIED, UNSUPPORTED_BY_DEVICE,\n                          ENCRYPTED, NOT_ENCRYPTED'\n                        enum:\n                        - ENCRYPTION_STATE_UNSPECIFIED\n                        - UNSUPPORTED_BY_DEVICE\n                        - ENCRYPTED\n                        - NOT_ENCRYPTED\n        type:\n          type: string\n          x-dcl-go-name: Type\n          x-dcl-go-type: MembershipTypeEnum\n          readOnly: true\n          description: 'Output only. The type of the membership. Possible values:\n            OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_CUSTOMER, OWNER_TYPE_PARTNER'\n          x-kubernetes-immutable: true\n          enum:\n          - OWNER_TYPE_UNSPECIFIED\n          - OWNER_TYPE_CUSTOMER\n          - OWNER_TYPE_PARTNER\n        updateTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: UpdateTime\n          readOnly: true\n          description: Output only. The time when the `Membership` was last updated.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/cloudidentity/alpha/membership.yaml

Functions

func DCLGroupSchema added in v1.10.3

func DCLGroupSchema() *dcl.Schema

func DCLMembershipSchema added in v1.10.3

func DCLMembershipSchema() *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) ApplyGroup

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

func (*Client) ApplyMembership

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

func (*Client) DeleteAllGroup

func (c *Client) DeleteAllGroup(ctx context.Context, parent string, filter func(*Group) bool) error

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

func (*Client) DeleteAllMembership

func (c *Client) DeleteAllMembership(ctx context.Context, group string, filter func(*Membership) bool) error

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

func (*Client) DeleteGroup

func (c *Client) DeleteGroup(ctx context.Context, r *Group) error

func (*Client) DeleteMembership

func (c *Client) DeleteMembership(ctx context.Context, r *Membership) error

func (*Client) GetGroup

func (c *Client) GetGroup(ctx context.Context, r *Group) (*Group, error)

func (*Client) GetMembership

func (c *Client) GetMembership(ctx context.Context, r *Membership) (*Membership, error)

func (*Client) ListGroup

func (c *Client) ListGroup(ctx context.Context, parent string) (*GroupList, error)

func (*Client) ListGroupWithMaxResults

func (c *Client) ListGroupWithMaxResults(ctx context.Context, parent string, pageSize int32) (*GroupList, error)

func (*Client) ListMembership

func (c *Client) ListMembership(ctx context.Context, group string) (*MembershipList, error)

func (*Client) ListMembershipWithMaxResults

func (c *Client) ListMembershipWithMaxResults(ctx context.Context, group string, pageSize int32) (*MembershipList, error)

type Group

type Group struct {
	Name                     *string                        `json:"name"`
	GroupKey                 *GroupGroupKey                 `json:"groupKey"`
	AdditionalGroupKeys      []GroupAdditionalGroupKeys     `json:"additionalGroupKeys"`
	Parent                   *string                        `json:"parent"`
	DisplayName              *string                        `json:"displayName"`
	Description              *string                        `json:"description"`
	CreateTime               *string                        `json:"createTime"`
	UpdateTime               *string                        `json:"updateTime"`
	Labels                   map[string]string              `json:"labels"`
	DirectMemberCount        *int64                         `json:"directMemberCount"`
	DirectMemberCountPerType *GroupDirectMemberCountPerType `json:"directMemberCountPerType"`
	DerivedAliases           []GroupDerivedAliases          `json:"derivedAliases"`
	DynamicGroupMetadata     *GroupDynamicGroupMetadata     `json:"dynamicGroupMetadata"`
	PosixGroups              []GroupPosixGroups             `json:"posixGroups"`
	InitialGroupConfig       *GroupInitialGroupConfigEnum   `json:"initialGroupConfig"`
}

func (*Group) Describe

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

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

func (*Group) ID

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

func (*Group) String

func (r *Group) String() string

type GroupAdditionalGroupKeys

type GroupAdditionalGroupKeys struct {
	Id        *string `json:"id"`
	Namespace *string `json:"namespace"`
	// contains filtered or unexported fields
}
var EmptyGroupAdditionalGroupKeys *GroupAdditionalGroupKeys = &GroupAdditionalGroupKeys{empty: true}

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

func (*GroupAdditionalGroupKeys) Empty

func (r *GroupAdditionalGroupKeys) Empty() bool

func (*GroupAdditionalGroupKeys) HashCode

func (r *GroupAdditionalGroupKeys) HashCode() string

func (*GroupAdditionalGroupKeys) String

func (r *GroupAdditionalGroupKeys) String() string

func (*GroupAdditionalGroupKeys) UnmarshalJSON

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

type GroupDerivedAliases added in v1.8.0

type GroupDerivedAliases struct {
	Id        *string `json:"id"`
	Namespace *string `json:"namespace"`
	// contains filtered or unexported fields
}
var EmptyGroupDerivedAliases *GroupDerivedAliases = &GroupDerivedAliases{empty: true}

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

func (*GroupDerivedAliases) Empty added in v1.8.0

func (r *GroupDerivedAliases) Empty() bool

func (*GroupDerivedAliases) HashCode added in v1.8.0

func (r *GroupDerivedAliases) HashCode() string

func (*GroupDerivedAliases) String added in v1.8.0

func (r *GroupDerivedAliases) String() string

func (*GroupDerivedAliases) UnmarshalJSON added in v1.8.0

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

type GroupDirectMemberCountPerType added in v1.8.0

type GroupDirectMemberCountPerType struct {
	UserCount  *int64 `json:"userCount"`
	GroupCount *int64 `json:"groupCount"`
	// contains filtered or unexported fields
}
var EmptyGroupDirectMemberCountPerType *GroupDirectMemberCountPerType = &GroupDirectMemberCountPerType{empty: true}

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

func (*GroupDirectMemberCountPerType) Empty added in v1.8.0

func (*GroupDirectMemberCountPerType) HashCode added in v1.8.0

func (r *GroupDirectMemberCountPerType) HashCode() string

func (*GroupDirectMemberCountPerType) String added in v1.8.0

func (*GroupDirectMemberCountPerType) UnmarshalJSON added in v1.8.0

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

type GroupDynamicGroupMetadata

type GroupDynamicGroupMetadata struct {
	Queries []GroupDynamicGroupMetadataQueries `json:"queries"`
	Status  *GroupDynamicGroupMetadataStatus   `json:"status"`
	// contains filtered or unexported fields
}
var EmptyGroupDynamicGroupMetadata *GroupDynamicGroupMetadata = &GroupDynamicGroupMetadata{empty: true}

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

func (*GroupDynamicGroupMetadata) Empty

func (r *GroupDynamicGroupMetadata) Empty() bool

func (*GroupDynamicGroupMetadata) HashCode

func (r *GroupDynamicGroupMetadata) HashCode() string

func (*GroupDynamicGroupMetadata) String

func (r *GroupDynamicGroupMetadata) String() string

func (*GroupDynamicGroupMetadata) UnmarshalJSON

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

type GroupDynamicGroupMetadataQueries

type GroupDynamicGroupMetadataQueries struct {
	ResourceType *GroupDynamicGroupMetadataQueriesResourceTypeEnum `json:"resourceType"`
	Query        *string                                           `json:"query"`
	// contains filtered or unexported fields
}
var EmptyGroupDynamicGroupMetadataQueries *GroupDynamicGroupMetadataQueries = &GroupDynamicGroupMetadataQueries{empty: true}

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

func (*GroupDynamicGroupMetadataQueries) Empty

func (*GroupDynamicGroupMetadataQueries) HashCode

func (*GroupDynamicGroupMetadataQueries) String

func (*GroupDynamicGroupMetadataQueries) UnmarshalJSON

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

type GroupDynamicGroupMetadataQueriesResourceTypeEnum

type GroupDynamicGroupMetadataQueriesResourceTypeEnum string

The enum GroupDynamicGroupMetadataQueriesResourceTypeEnum.

func GroupDynamicGroupMetadataQueriesResourceTypeEnumRef

func GroupDynamicGroupMetadataQueriesResourceTypeEnumRef(s string) *GroupDynamicGroupMetadataQueriesResourceTypeEnum

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

func (GroupDynamicGroupMetadataQueriesResourceTypeEnum) Validate

type GroupDynamicGroupMetadataStatus

type GroupDynamicGroupMetadataStatus struct {
	Status     *GroupDynamicGroupMetadataStatusStatusEnum `json:"status"`
	StatusTime *string                                    `json:"statusTime"`
	// contains filtered or unexported fields
}
var EmptyGroupDynamicGroupMetadataStatus *GroupDynamicGroupMetadataStatus = &GroupDynamicGroupMetadataStatus{empty: true}

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

func (*GroupDynamicGroupMetadataStatus) Empty

func (*GroupDynamicGroupMetadataStatus) HashCode

func (*GroupDynamicGroupMetadataStatus) String

func (*GroupDynamicGroupMetadataStatus) UnmarshalJSON

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

type GroupDynamicGroupMetadataStatusStatusEnum

type GroupDynamicGroupMetadataStatusStatusEnum string

The enum GroupDynamicGroupMetadataStatusStatusEnum.

func GroupDynamicGroupMetadataStatusStatusEnumRef

func GroupDynamicGroupMetadataStatusStatusEnumRef(s string) *GroupDynamicGroupMetadataStatusStatusEnum

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

func (GroupDynamicGroupMetadataStatusStatusEnum) Validate

type GroupGroupKey

type GroupGroupKey struct {
	Id        *string `json:"id"`
	Namespace *string `json:"namespace"`
	// contains filtered or unexported fields
}
var EmptyGroupGroupKey *GroupGroupKey = &GroupGroupKey{empty: true}

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

func (*GroupGroupKey) Empty

func (r *GroupGroupKey) Empty() bool

func (*GroupGroupKey) HashCode

func (r *GroupGroupKey) HashCode() string

func (*GroupGroupKey) String

func (r *GroupGroupKey) String() string

func (*GroupGroupKey) UnmarshalJSON

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

type GroupInitialGroupConfigEnum

type GroupInitialGroupConfigEnum string

The enum GroupInitialGroupConfigEnum.

func GroupInitialGroupConfigEnumRef

func GroupInitialGroupConfigEnumRef(s string) *GroupInitialGroupConfigEnum

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

func (GroupInitialGroupConfigEnum) Validate

func (v GroupInitialGroupConfigEnum) Validate() error

type GroupList

type GroupList struct {
	Items []*Group
	// contains filtered or unexported fields
}

func (*GroupList) HasNext

func (l *GroupList) HasNext() bool

func (*GroupList) Next

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

type GroupPosixGroups

type GroupPosixGroups struct {
	Name     *string `json:"name"`
	Gid      *string `json:"gid"`
	SystemId *string `json:"systemId"`
	// contains filtered or unexported fields
}
var EmptyGroupPosixGroups *GroupPosixGroups = &GroupPosixGroups{empty: true}

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

func (*GroupPosixGroups) Empty

func (r *GroupPosixGroups) Empty() bool

func (*GroupPosixGroups) HashCode

func (r *GroupPosixGroups) HashCode() string

func (*GroupPosixGroups) String

func (r *GroupPosixGroups) String() string

func (*GroupPosixGroups) UnmarshalJSON

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

type Membership

type Membership struct {
	Name               *string                        `json:"name"`
	PreferredMemberKey *MembershipPreferredMemberKey  `json:"preferredMemberKey"`
	CreateTime         *string                        `json:"createTime"`
	UpdateTime         *string                        `json:"updateTime"`
	Roles              []MembershipRoles              `json:"roles"`
	Type               *MembershipTypeEnum            `json:"type"`
	DeliverySetting    *MembershipDeliverySettingEnum `json:"deliverySetting"`
	DisplayName        *MembershipDisplayName         `json:"displayName"`
	MemberKey          *MembershipMemberKey           `json:"memberKey"`
	Group              *string                        `json:"group"`
}

func (*Membership) Describe

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

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

func (*Membership) ID

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

func (*Membership) String

func (r *Membership) String() string

type MembershipDeliverySettingEnum added in v1.8.0

type MembershipDeliverySettingEnum string

The enum MembershipDeliverySettingEnum.

func MembershipDeliverySettingEnumRef added in v1.8.0

func MembershipDeliverySettingEnumRef(s string) *MembershipDeliverySettingEnum

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

func (MembershipDeliverySettingEnum) Validate added in v1.8.0

func (v MembershipDeliverySettingEnum) Validate() error

type MembershipDisplayName added in v1.8.0

type MembershipDisplayName struct {
	GivenName  *string `json:"givenName"`
	FamilyName *string `json:"familyName"`
	FullName   *string `json:"fullName"`
	// contains filtered or unexported fields
}
var EmptyMembershipDisplayName *MembershipDisplayName = &MembershipDisplayName{empty: true}

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

func (*MembershipDisplayName) Empty added in v1.8.0

func (r *MembershipDisplayName) Empty() bool

func (*MembershipDisplayName) HashCode added in v1.8.0

func (r *MembershipDisplayName) HashCode() string

func (*MembershipDisplayName) String added in v1.8.0

func (r *MembershipDisplayName) String() string

func (*MembershipDisplayName) UnmarshalJSON added in v1.8.0

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

type MembershipList

type MembershipList struct {
	Items []*Membership
	// contains filtered or unexported fields
}

func (*MembershipList) HasNext

func (l *MembershipList) HasNext() bool

func (*MembershipList) Next

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

type MembershipMemberKey

type MembershipMemberKey struct {
	Id        *string `json:"id"`
	Namespace *string `json:"namespace"`
	// contains filtered or unexported fields
}
var EmptyMembershipMemberKey *MembershipMemberKey = &MembershipMemberKey{empty: true}

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

func (*MembershipMemberKey) Empty

func (r *MembershipMemberKey) Empty() bool

func (*MembershipMemberKey) HashCode

func (r *MembershipMemberKey) HashCode() string

func (*MembershipMemberKey) String

func (r *MembershipMemberKey) String() string

func (*MembershipMemberKey) UnmarshalJSON

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

type MembershipPreferredMemberKey

type MembershipPreferredMemberKey struct {
	Id        *string `json:"id"`
	Namespace *string `json:"namespace"`
	// contains filtered or unexported fields
}
var EmptyMembershipPreferredMemberKey *MembershipPreferredMemberKey = &MembershipPreferredMemberKey{empty: true}

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

func (*MembershipPreferredMemberKey) Empty

func (*MembershipPreferredMemberKey) HashCode

func (r *MembershipPreferredMemberKey) HashCode() string

func (*MembershipPreferredMemberKey) String

func (*MembershipPreferredMemberKey) UnmarshalJSON

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

type MembershipRoles

type MembershipRoles struct {
	Name                   *string                                `json:"name"`
	ExpiryDetail           *MembershipRolesExpiryDetail           `json:"expiryDetail"`
	RestrictionEvaluations *MembershipRolesRestrictionEvaluations `json:"restrictionEvaluations"`
	// contains filtered or unexported fields
}
var EmptyMembershipRoles *MembershipRoles = &MembershipRoles{empty: true}

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

func (*MembershipRoles) Empty

func (r *MembershipRoles) Empty() bool

func (*MembershipRoles) HashCode

func (r *MembershipRoles) HashCode() string

func (*MembershipRoles) String

func (r *MembershipRoles) String() string

func (*MembershipRoles) UnmarshalJSON

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

type MembershipRolesExpiryDetail

type MembershipRolesExpiryDetail struct {
	ExpireTime *string `json:"expireTime"`
	// contains filtered or unexported fields
}
var EmptyMembershipRolesExpiryDetail *MembershipRolesExpiryDetail = &MembershipRolesExpiryDetail{empty: true}

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

func (*MembershipRolesExpiryDetail) Empty

func (r *MembershipRolesExpiryDetail) Empty() bool

func (*MembershipRolesExpiryDetail) HashCode

func (r *MembershipRolesExpiryDetail) HashCode() string

func (*MembershipRolesExpiryDetail) String

func (r *MembershipRolesExpiryDetail) String() string

func (*MembershipRolesExpiryDetail) UnmarshalJSON

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

type MembershipRolesRestrictionEvaluations

type MembershipRolesRestrictionEvaluations struct {
	MemberRestrictionEvaluation *MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation `json:"memberRestrictionEvaluation"`
	// contains filtered or unexported fields
}
var EmptyMembershipRolesRestrictionEvaluations *MembershipRolesRestrictionEvaluations = &MembershipRolesRestrictionEvaluations{empty: true}

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

func (*MembershipRolesRestrictionEvaluations) Empty

func (*MembershipRolesRestrictionEvaluations) HashCode

func (*MembershipRolesRestrictionEvaluations) String

func (*MembershipRolesRestrictionEvaluations) UnmarshalJSON

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

type MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation

type MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation struct {
	State *MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum `json:"state"`
	// contains filtered or unexported fields
}
var EmptyMembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation *MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation = &MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation{empty: true}

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

func (*MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation) Empty

func (*MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation) HashCode

func (*MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation) String

func (*MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluation) UnmarshalJSON

type MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum

type MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum string

The enum MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum.

func MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnumRef

func MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnumRef(s string) *MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum

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

func (MembershipRolesRestrictionEvaluationsMemberRestrictionEvaluationStateEnum) Validate

type MembershipTypeEnum

type MembershipTypeEnum string

The enum MembershipTypeEnum.

func MembershipTypeEnumRef

func MembershipTypeEnumRef(s string) *MembershipTypeEnum

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

func (MembershipTypeEnum) Validate

func (v MembershipTypeEnum) Validate() error

Jump to

Keyboard shortcuts

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