bigqueryreservation

package
v1.51.0 Latest Latest
Warning

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

 Go to latest Published: Sep 5, 2023 License: Apache-2.0 Imports: 9 Imported by: 4

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.

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 bigqueryreservation defines types and methods for working with bigqueryreservation GCP resources.

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 bigqueryreservation 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

View Source 
const AssignmentMaxPage = -1
View Source 
const ReservationMaxPage = -1

Variables

View Source 
var YAML_assignment = []byte("info:\n  title: BigqueryReservation/Assignment\n  description: The BigqueryReservation Assignment resource\n  x-dcl-struct-name: Assignment\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Assignment\n    parameters:\n    - name: assignment\n      required: true\n      description: A full instance of a Assignment\n  apply:\n    description: The function used to apply information about a Assignment\n    parameters:\n    - name: assignment\n      required: true\n      description: A full instance of a Assignment\n  delete:\n    description: The function used to delete a Assignment\n    parameters:\n    - name: assignment\n      required: true\n      description: A full instance of a Assignment\n  deleteAll:\n    description: The function used to delete all Assignment\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    - name: reservation\n      required: true\n      schema:\n        type: string\n  list:\n    description: The function used to list information about many Assignment\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    - name: reservation\n      required: true\n      schema:\n        type: string\ncomponents:\n  schemas:\n    Assignment:\n      title: Assignment\n      x-dcl-id: projects/{{project}}/locations/{{location}}/reservations/{{reservation}}/assignments/{{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      - assignee\n      - jobType\n      - reservation\n      properties:\n        assignee:\n          type: string\n          x-dcl-go-name: Assignee\n          description: The resource which will use the reservation. E.g. projects/myproject,\n            folders/123, organizations/456.\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Cloudresourcemanager/Project\n            field: name\n          - resource: Cloudresourcemanager/Folder\n            field: name\n          - resource: Cloudresourcemanager/Organization\n            field: name\n        jobType:\n          type: string\n          x-dcl-go-name: JobType\n          x-dcl-go-type: AssignmentJobTypeEnum\n          description: 'Types of job, which could be specified when using the reservation.\n            Possible values: JOB_TYPE_UNSPECIFIED, PIPELINE, QUERY'\n          x-kubernetes-immutable: true\n          enum:\n          - JOB_TYPE_UNSPECIFIED\n          - PIPELINE\n          - QUERY\n        location:\n          type: string\n          x-dcl-go-name: Location\n          description: The location for the resource\n          x-kubernetes-immutable: true\n          x-dcl-extract-if-empty: true\n        name:\n          type: string\n          x-dcl-go-name: Name\n          description: Output only. The resource name of the assignment.\n          x-kubernetes-immutable: true\n          x-dcl-server-generated-parameter: 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-extract-if-empty: true\n        reservation:\n          type: string\n          x-dcl-go-name: Reservation\n          description: The reservation for the resource\n          x-kubernetes-immutable: true\n          x-dcl-references:\n          - resource: Bigqueryreservation/Reservation\n            field: name\n            parent: true\n        state:\n          type: string\n          x-dcl-go-name: State\n          x-dcl-go-type: AssignmentStateEnum\n          readOnly: true\n          description: 'Assignment will remain in PENDING state if no active capacity\n            commitment is present. It will become ACTIVE when some capacity commitment\n            becomes active. Possible values: STATE_UNSPECIFIED, PENDING, ACTIVE'\n          x-kubernetes-immutable: true\n          enum:\n          - STATE_UNSPECIFIED\n          - PENDING\n          - ACTIVE\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/bigqueryreservation/assignment.yaml

View Source 
var YAML_reservation = []byte("info:\n  title: BigqueryReservation/Reservation\n  description: The BigqueryReservation Reservation resource\n  x-dcl-struct-name: Reservation\n  x-dcl-has-iam: false\npaths:\n  get:\n    description: The function used to get information about a Reservation\n    parameters:\n    - name: reservation\n      required: true\n      description: A full instance of a Reservation\n  apply:\n    description: The function used to apply information about a Reservation\n    parameters:\n    - name: reservation\n      required: true\n      description: A full instance of a Reservation\n  delete:\n    description: The function used to delete a Reservation\n    parameters:\n    - name: reservation\n      required: true\n      description: A full instance of a Reservation\n  deleteAll:\n    description: The function used to delete all Reservation\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 Reservation\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    Reservation:\n      title: Reservation\n      x-dcl-id: projects/{{project}}/locations/{{location}}/reservations/{{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      - name\n      - project\n      - location\n      properties:\n        creationTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: CreationTime\n          readOnly: true\n          description: Output only. Creation time of the reservation.\n          x-kubernetes-immutable: true\n        ignoreIdleSlots:\n          type: boolean\n          x-dcl-go-name: IgnoreIdleSlots\n          description: If false, any query using this reservation will use idle slots\n            from other reservations within the same admin project. If true, a query\n            using this reservation will execute with the slot capacity specified above\n            at most.\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 resource name of the reservation.\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        slotCapacity:\n          type: integer\n          format: int64\n          x-dcl-go-name: SlotCapacity\n          description: Minimum slots available to this reservation. A slot is a unit\n            of computational power in BigQuery, and serves as the unit of parallelism.\n            Queries using this reservation might use more slots during runtime if\n            ignore_idle_slots is set to false. If the new reservation's slot capacity\n            exceed the parent's slot capacity or if total slot capacity of the new\n            reservation and its siblings exceeds the parent's slot capacity, the request\n            will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.\n        updateTime:\n          type: string\n          format: date-time\n          x-dcl-go-name: UpdateTime\n          readOnly: true\n          description: Output only. Last update time of the reservation.\n          x-kubernetes-immutable: true\n")

blaze-out/k8-fastbuild/genfiles/cloud/graphite/mmv2/services/google/bigqueryreservation/reservation.yaml

Functions

func DCLAssignmentSchema added in v1.10.3 

func DCLAssignmentSchema() *dcl.Schema

func DCLReservationSchema added in v1.10.3 

func DCLReservationSchema() *dcl.Schema

Types

type Assignment 

type Assignment struct {
	Name        *string                `json:"name"`
	Assignee    *string                `json:"assignee"`
	JobType     *AssignmentJobTypeEnum `json:"jobType"`
	State       *AssignmentStateEnum   `json:"state"`
	Project     *string                `json:"project"`
	Location    *string                `json:"location"`
	Reservation *string                `json:"reservation"`
}

func (*Assignment) Describe 

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

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

func (*Assignment) ID 

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

func (*Assignment) String 

func (r *Assignment) String() string

type AssignmentJobTypeEnum 

type AssignmentJobTypeEnum string

The enum AssignmentJobTypeEnum.

func AssignmentJobTypeEnumRef 

func AssignmentJobTypeEnumRef(s string) *AssignmentJobTypeEnum

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

func (AssignmentJobTypeEnum) Validate 

func (v AssignmentJobTypeEnum) Validate() error

type AssignmentList 

type AssignmentList struct {
	Items []*Assignment
	// contains filtered or unexported fields
}

func (*AssignmentList) HasNext 

func (l *AssignmentList) HasNext() bool

func (*AssignmentList) Next 

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

type AssignmentStateEnum 

type AssignmentStateEnum string

The enum AssignmentStateEnum.

func AssignmentStateEnumRef 

func AssignmentStateEnumRef(s string) *AssignmentStateEnum

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

func (AssignmentStateEnum) Validate 

func (v AssignmentStateEnum) Validate() 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) ApplyAssignment 

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

func (*Client) ApplyReservation 

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

func (*Client) DeleteAllAssignment 

func (c *Client) DeleteAllAssignment(ctx context.Context, project, location, reservation string, filter func(*Assignment) bool) error

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

func (*Client) DeleteAllReservation 

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

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

func (*Client) DeleteAssignment 

func (c *Client) DeleteAssignment(ctx context.Context, r *Assignment) error

func (*Client) DeleteReservation 

func (c *Client) DeleteReservation(ctx context.Context, r *Reservation) error

func (*Client) GetAssignment 

func (c *Client) GetAssignment(ctx context.Context, r *Assignment) (*Assignment, error)

func (*Client) GetReservation 

func (c *Client) GetReservation(ctx context.Context, r *Reservation) (*Reservation, error)

func (*Client) ListAssignment 

func (c *Client) ListAssignment(ctx context.Context, project, location, reservation string) (*AssignmentList, error)

func (*Client) ListAssignmentWithMaxResults 

func (c *Client) ListAssignmentWithMaxResults(ctx context.Context, project, location, reservation string, pageSize int32) (*AssignmentList, error)

func (*Client) ListReservation 

func (c *Client) ListReservation(ctx context.Context, project, location string) (*ReservationList, error)

func (*Client) ListReservationWithMaxResults 

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

type Reservation 

type Reservation struct {
	Name            *string `json:"name"`
	SlotCapacity    *int64  `json:"slotCapacity"`
	IgnoreIdleSlots *bool   `json:"ignoreIdleSlots"`
	CreationTime    *string `json:"creationTime"`
	UpdateTime      *string `json:"updateTime"`
	Project         *string `json:"project"`
	Location        *string `json:"location"`
}

func (*Reservation) Describe 

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

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

func (*Reservation) ID 

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

func (*Reservation) String 

func (r *Reservation) String() string

type ReservationList 

type ReservationList struct {
	Items []*Reservation
	// contains filtered or unexported fields
}

func (*ReservationList) HasNext 

func (l *ReservationList) HasNext() bool

func (*ReservationList) Next 

func (l *ReservationList) Next(ctx context.Context, c *Client) 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.