Show / Hide Table of Contents

Class ProjectsResource.LocationsResource.ReservationsResource

The "reservations" collection of methods.

Inheritance
object
ProjectsResource.LocationsResource.ReservationsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.BigQueryReservation.v1
Assembly: Google.Apis.BigQueryReservation.v1.dll
Syntax
public class ProjectsResource.LocationsResource.ReservationsResource

Constructors

ReservationsResource(IClientService)

Constructs a new resource.

Declaration
public ReservationsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Assignments

Gets the Assignments resource.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource Assignments { get; }
Property Value
Type Description
ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource

Methods

Create(Reservation, string)

Creates a new reservation resource.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.CreateRequest Create(Reservation body, string parent)
Parameters
Type Name Description
Reservation body

The body of the request.

string parent

Required. Project, location. E.g., projects/myproject/locations/US

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.CreateRequest

Delete(string)

Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.DeleteRequest

FailoverReservation(FailoverReservationRequest, string)

Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.FailoverReservationRequest FailoverReservation(FailoverReservationRequest body, string name)
Parameters
Type Name Description
FailoverReservationRequest body

The body of the request.

string name

Required. Resource name of the reservation to failover. E.g., projects/myproject/locations/US/reservations/team1-prod

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.FailoverReservationRequest

Get(string)

Returns information about the reservation.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. May return: * ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: - Reservations - ReservationAssignments To call this method, you must have the following Google IAM permissions: - bigqueryreservation.reservations.getIamPolicy to get policies on reservations.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.GetIamPolicyRequest GetIamPolicy(string resource)
Parameters
Type Name Description
string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.GetIamPolicyRequest

List(string)

Lists all the reservations for the project in the specified location.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. The parent resource name containing project and location, e.g.: projects/myproject/locations/US

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.ListRequest

Patch(Reservation, string)

Updates an existing reservation resource.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.PatchRequest Patch(Reservation body, string name)
Parameters
Type Name Description
Reservation body

The body of the request.

string name

Identifier. The resource name of the reservation, e.g., projects/*/locations/*/reservations/team1-prod. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.PatchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets an access control policy for a resource. Replaces any existing policy. Supported resources are:

  • Reservations To call this method, you must have the following Google IAM permissions: - bigqueryreservation.reservations.setIamPolicy to set policies on reservations.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.SetIamPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM permissions are required to call this method.

Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
ProjectsResource.LocationsResource.ReservationsResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX