gameservices

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 gameservices 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.

Index

• Constants
• Variables
• func DCLRealmSchema() *dcl.Schema
• type Client
  • func NewClient(c *dcl.Config) *Client
  • func (c *Client) ApplyRealm(ctx context.Context, rawDesired *Realm, opts ...dcl.ApplyOption) (*Realm, error)
  • func (c *Client) DeleteAllRealm(ctx context.Context, project, location string, filter func(*Realm) bool) error
  • func (c *Client) DeleteRealm(ctx context.Context, r *Realm) error
  • func (c *Client) GetRealm(ctx context.Context, r *Realm) (*Realm, error)
  • func (c *Client) ListRealm(ctx context.Context, project, location string) (*RealmList, error)
  • func (c *Client) ListRealmWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*RealmList, error)
• type Realm
  • func (r *Realm) Describe() dcl.ServiceTypeVersion
  • func (r *Realm) ID() (string, error)
  • func (r *Realm) String() string
• type RealmList
  • func (l *RealmList) HasNext() bool
  • func (l *RealmList) Next(ctx context.Context, c *Client) error

Constants

const RealmMaxPage = -1

Variables

var YAML_realm = []byte("info:\n  title: GameServices/Realm\n  description: The GameServices Realm resource\n  x-dcl-struct-name: Realm\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Realm\n    parameters:\n    - name: realm\n      required: true\n      description: A full instance of a Realm\n  apply:\n    description: The function used to apply information about a Realm\n    parameters:\n    - name: realm\n      required: true\n      description: A full instance of a Realm\n  delete:\n    description: The function used to delete a Realm\n    parameters:\n    - name: realm\n      required: true\n      description: A full instance of a Realm\n  deleteAll:\n    description: The function used to delete all Realm\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 Realm\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    Realm:\n      title: Realm\n      x-dcl-id: projects/{{project}}/locations/{{location}}/realms/{{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      - name\n      - timeZone\n      - location\n      - project\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 creation time.\n          x-kubernetes-immutable: true\n        description:\n          type: string\n          x-dcl-go-name: Description\n          description: Human readable description of the realm.\n        labels:\n          type: object\n          additionalProperties:\n            type: string\n          x-dcl-go-name: Labels\n          description: The labels associated with this realm. Each label is a key-value\n            pair.\n        location:\n          type: string\n          x-dcl-go-name: Location\n          description: The location for this realm.\n          x-kubernetes-immutable: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: The resource name of the realm.\n          x-kubernetes-immutable: true\n        project:\n          type: string\n          x-dcl-go-name: Project\n          description: The project for this realm.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n            parent: true\n        timeZone:\n          type: string\n          x-dcl-go-name: TimeZone\n          description: 'Required. Time zone where all policies targeting this realm\n            are evaluated. The value of this field must be from the IANA time zone\n            database: https://www.iana.org/time-zones.'\n        updateTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: UpdateTime\n          readOnly: true\n          description: Output only. The last-modified time.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/gameservices/realm.yaml

Functions

func DCLRealmSchema

func DCLRealmSchema() *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) ApplyRealm

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

func (*Client) DeleteAllRealm

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

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

func (*Client) DeleteRealm

func (c *Client) DeleteRealm(ctx context.Context, r *Realm) error

func (*Client) GetRealm

func (c *Client) GetRealm(ctx context.Context, r *Realm) (*Realm, error)

func (*Client) ListRealm

func (c *Client) ListRealm(ctx context.Context, project, location string) (*RealmList, error)

func (*Client) ListRealmWithMaxResults

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

type Realm

type Realm struct {
	Name        *string           `json:"name"`
	CreateTime  *string           `json:"createTime"`
	UpdateTime  *string           `json:"updateTime"`
	Labels      map[string]string `json:"labels"`
	TimeZone    *string           `json:"timeZone"`
	Description *string           `json:"description"`
	Location    *string           `json:"location"`
	Project     *string           `json:"project"`
}

func (*Realm) Describe

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

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

func (*Realm) ID

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

func (*Realm) String

func (r *Realm) String() string

type RealmList

type RealmList struct {
	Items []*Realm
	// contains filtered or unexported fields
}

func (*RealmList) HasNext

func (l *RealmList) HasNext() bool

func (*RealmList) Next

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