Documentation
¶
Overview ¶
Copyright 2026 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 2026 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 2026 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 2026 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 2026 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 2026 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 beta defines operations in the declarative SDK.
Copyright 2026 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 2026 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 2026 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 2026 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 DCLAssignmentSchema() *dcl.Schema
- func DCLReservationSchema() *dcl.Schema
- type Assignment
- type AssignmentJobTypeEnum
- type AssignmentList
- type AssignmentStateEnum
- type Client
- func (c *Client) ApplyAssignment(ctx context.Context, rawDesired *Assignment, opts ...dcl.ApplyOption) (*Assignment, error)
- func (c *Client) ApplyReservation(ctx context.Context, rawDesired *Reservation, opts ...dcl.ApplyOption) (*Reservation, error)
- func (c *Client) DeleteAllAssignment(ctx context.Context, project, location, reservation string, ...) error
- func (c *Client) DeleteAllReservation(ctx context.Context, project, location string, filter func(*Reservation) bool) error
- func (c *Client) DeleteAssignment(ctx context.Context, r *Assignment) error
- func (c *Client) DeleteReservation(ctx context.Context, r *Reservation) error
- func (c *Client) GetAssignment(ctx context.Context, r *Assignment) (*Assignment, error)
- func (c *Client) GetReservation(ctx context.Context, r *Reservation) (*Reservation, error)
- func (c *Client) ListAssignment(ctx context.Context, project, location, reservation string) (*AssignmentList, error)
- func (c *Client) ListAssignmentWithMaxResults(ctx context.Context, project, location, reservation string, pageSize int32) (*AssignmentList, error)
- func (c *Client) ListReservation(ctx context.Context, project, location string) (*ReservationList, error)
- func (c *Client) ListReservationWithMaxResults(ctx context.Context, project, location string, pageSize int32) (*ReservationList, error)
- type Reservation
- type ReservationList
Constants ¶
const AssignmentMaxPage = -1
const ReservationMaxPage = -1
Variables ¶
var YAML_assignment []byte
var YAML_reservation []byte
Functions ¶
func DCLAssignmentSchema ¶ added in v1.10.3
func DCLReservationSchema ¶ added in v1.10.3
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
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 ¶
The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.
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 (*Client) ListAssignmentWithMaxResults ¶
func (*Client) ListReservation ¶
func (*Client) ListReservationWithMaxResults ¶
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"`
MaxConcurrency *int64 `json:"maxConcurrency"`
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