BigQuery Reservation v1 API - Class ReservationService.ReservationServiceClient (2.4.0) 

public class ReservationService.ReservationServiceClient : ClientBase<ReservationService.ReservationServiceClient>

Reference documentation and code samples for the BigQuery Reservation v1 API class ReservationService.ReservationServiceClient.

Client for ReservationService

Inheritance

object > ClientBase > ClientBaseReservationServiceReservationServiceClient > ReservationService.ReservationServiceClient

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

ReservationServiceClient()

protected ReservationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

ReservationServiceClient(CallInvoker)

public ReservationServiceClient(CallInvoker callInvoker)

Creates a new client for ReservationService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ReservationServiceClient(ChannelBase)

public ReservationServiceClient(ChannelBase channel)

Creates a new client for ReservationService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ReservationServiceClient(ClientBaseConfiguration)

protected ReservationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateAssignment(CreateAssignmentRequest, CallOptions)

public virtual Assignment CreateAssignment(CreateAssignmentRequest request, CallOptions options)

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type.

Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query.

When creating assignments, it does not matter if other assignments exist at higher levels.

Example:

  • The organization organizationA contains two projects, project1 and project2.
  • Assignments for all three entities (organizationA, project1, and project2) could all be created and mapped to the same or different reservations.

"None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: projects/myproject/locations/US/reservations/none.

Returns google.rpc.Code.PERMISSION_DENIED if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation.

Returns google.rpc.Code.INVALID_ARGUMENT when location of the assignment does not match location of the reservation.

Parameters
Name Description
request CreateAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Assignment

The response received from the server.

CreateAssignment(CreateAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Assignment CreateAssignment(CreateAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type.

Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query.

When creating assignments, it does not matter if other assignments exist at higher levels.

Example:

  • The organization organizationA contains two projects, project1 and project2.
  • Assignments for all three entities (organizationA, project1, and project2) could all be created and mapped to the same or different reservations.

"None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: projects/myproject/locations/US/reservations/none.

Returns google.rpc.Code.PERMISSION_DENIED if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation.

Returns google.rpc.Code.INVALID_ARGUMENT when location of the assignment does not match location of the reservation.

Parameters
Name Description
request CreateAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Assignment

The response received from the server.

CreateAssignmentAsync(CreateAssignmentRequest, CallOptions)

public virtual AsyncUnaryCall<Assignment> CreateAssignmentAsync(CreateAssignmentRequest request, CallOptions options)

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type.

Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query.

When creating assignments, it does not matter if other assignments exist at higher levels.

Example:

  • The organization organizationA contains two projects, project1 and project2.
  • Assignments for all three entities (organizationA, project1, and project2) could all be created and mapped to the same or different reservations.

"None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: projects/myproject/locations/US/reservations/none.

Returns google.rpc.Code.PERMISSION_DENIED if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation.

Returns google.rpc.Code.INVALID_ARGUMENT when location of the assignment does not match location of the reservation.

Parameters
Name Description
request CreateAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

CreateAssignmentAsync(CreateAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Assignment> CreateAssignmentAsync(CreateAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.

Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location) combination, and that reservation will be used for all jobs of the matching type.

Different assignments can be created on different levels of the projects, folders or organization hierarchy. During query execution, the assignment is looked up at the project, folder and organization levels in that order. The first assignment found is applied to the query.

When creating assignments, it does not matter if other assignments exist at higher levels.

Example:

  • The organization organizationA contains two projects, project1 and project2.
  • Assignments for all three entities (organizationA, project1, and project2) could all be created and mapped to the same or different reservations.

"None" assignments represent an absence of the assignment. Projects assigned to None use on-demand pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example parent: projects/myproject/locations/US/reservations/none.

Returns google.rpc.Code.PERMISSION_DENIED if user does not have 'bigquery.admin' permissions on the project using the reservation and the project that owns this reservation.

Returns google.rpc.Code.INVALID_ARGUMENT when location of the assignment does not match location of the reservation.

Parameters
Name Description
request CreateAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

CreateCapacityCommitment(CreateCapacityCommitmentRequest, CallOptions)

public virtual CapacityCommitment CreateCapacityCommitment(CreateCapacityCommitmentRequest request, CallOptions options)

Creates a new capacity commitment resource.

Parameters
Name Description
request CreateCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

CreateCapacityCommitment(CreateCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual CapacityCommitment CreateCapacityCommitment(CreateCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new capacity commitment resource.

Parameters
Name Description
request CreateCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

CreateCapacityCommitmentAsync(CreateCapacityCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<CapacityCommitment> CreateCapacityCommitmentAsync(CreateCapacityCommitmentRequest request, CallOptions options)

Creates a new capacity commitment resource.

Parameters
Name Description
request CreateCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

CreateCapacityCommitmentAsync(CreateCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CapacityCommitment> CreateCapacityCommitmentAsync(CreateCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new capacity commitment resource.

Parameters
Name Description
request CreateCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

CreateReservation(CreateReservationRequest, CallOptions)

public virtual Reservation CreateReservation(CreateReservationRequest request, CallOptions options)

Creates a new reservation resource.

Parameters
Name Description
request CreateReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Reservation

The response received from the server.

CreateReservation(CreateReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual Reservation CreateReservation(CreateReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new reservation resource.

Parameters
Name Description
request CreateReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Reservation

The response received from the server.

CreateReservationAsync(CreateReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Reservation> CreateReservationAsync(CreateReservationRequest request, CallOptions options)

Creates a new reservation resource.

Parameters
Name Description
request CreateReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.

CreateReservationAsync(CreateReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Reservation> CreateReservationAsync(CreateReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new reservation resource.

Parameters
Name Description
request CreateReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.

DeleteAssignment(DeleteAssignmentRequest, CallOptions)

public virtual Empty DeleteAssignment(DeleteAssignmentRequest request, CallOptions options)

Deletes a assignment. No expansion will happen.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, deletion of the <organizationA, res1> assignment won't affect the other assignment <project1, res1>. After said deletion, queries from project1 will still use res1 while queries from project2 will switch to use on-demand mode.

Parameters
Name Description
request DeleteAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteAssignment(DeleteAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteAssignment(DeleteAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a assignment. No expansion will happen.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, deletion of the <organizationA, res1> assignment won't affect the other assignment <project1, res1>. After said deletion, queries from project1 will still use res1 while queries from project2 will switch to use on-demand mode.

Parameters
Name Description
request DeleteAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Empty

The response received from the server.

DeleteAssignmentAsync(DeleteAssignmentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteAssignmentAsync(DeleteAssignmentRequest request, CallOptions options)

Deletes a assignment. No expansion will happen.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, deletion of the <organizationA, res1> assignment won't affect the other assignment <project1, res1>. After said deletion, queries from project1 will still use res1 while queries from project2 will switch to use on-demand mode.

Parameters
Name Description
request DeleteAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteAssignmentAsync(DeleteAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteAssignmentAsync(DeleteAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a assignment. No expansion will happen.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, deletion of the <organizationA, res1> assignment won't affect the other assignment <project1, res1>. After said deletion, queries from project1 will still use res1 while queries from project2 will switch to use on-demand mode.

Parameters
Name Description
request DeleteAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteCapacityCommitment(DeleteCapacityCommitmentRequest, CallOptions)

public virtual Empty DeleteCapacityCommitment(DeleteCapacityCommitmentRequest request, CallOptions options)

Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request DeleteCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteCapacityCommitment(DeleteCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteCapacityCommitment(DeleteCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request DeleteCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Empty

The response received from the server.

DeleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest request, CallOptions options)

Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request DeleteCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteCapacityCommitmentAsync(DeleteCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request DeleteCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteReservation(DeleteReservationRequest, CallOptions)

public virtual Empty DeleteReservation(DeleteReservationRequest request, CallOptions options)

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

Parameters
Name Description
request DeleteReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteReservation(DeleteReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteReservation(DeleteReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DeleteReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Empty

The response received from the server.

DeleteReservationAsync(DeleteReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteReservationAsync(DeleteReservationRequest request, CallOptions options)

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

Parameters
Name Description
request DeleteReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteReservationAsync(DeleteReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteReservationAsync(DeleteReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request DeleteReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

GetBiReservation(GetBiReservationRequest, CallOptions)

public virtual BiReservation GetBiReservation(GetBiReservationRequest request, CallOptions options)

Retrieves a BI reservation.

Parameters
Name Description
request GetBiReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BiReservation

The response received from the server.

GetBiReservation(GetBiReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual BiReservation GetBiReservation(GetBiReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a BI reservation.

Parameters
Name Description
request GetBiReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BiReservation

The response received from the server.

GetBiReservationAsync(GetBiReservationRequest, CallOptions)

public virtual AsyncUnaryCall<BiReservation> GetBiReservationAsync(GetBiReservationRequest request, CallOptions options)

Retrieves a BI reservation.

Parameters
Name Description
request GetBiReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBiReservation

The call object.

GetBiReservationAsync(GetBiReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BiReservation> GetBiReservationAsync(GetBiReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves a BI reservation.

Parameters
Name Description
request GetBiReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBiReservation

The call object.

GetCapacityCommitment(GetCapacityCommitmentRequest, CallOptions)

public virtual CapacityCommitment GetCapacityCommitment(GetCapacityCommitmentRequest request, CallOptions options)

Returns information about the capacity commitment.

Parameters
Name Description
request GetCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

GetCapacityCommitment(GetCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual CapacityCommitment GetCapacityCommitment(GetCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about the capacity commitment.

Parameters
Name Description
request GetCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

GetCapacityCommitmentAsync(GetCapacityCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<CapacityCommitment> GetCapacityCommitmentAsync(GetCapacityCommitmentRequest request, CallOptions options)

Returns information about the capacity commitment.

Parameters
Name Description
request GetCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

GetCapacityCommitmentAsync(GetCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CapacityCommitment> GetCapacityCommitmentAsync(GetCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about the capacity commitment.

Parameters
Name Description
request GetCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

GetReservation(GetReservationRequest, CallOptions)

public virtual Reservation GetReservation(GetReservationRequest request, CallOptions options)

Returns information about the reservation.

Parameters
Name Description
request GetReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Reservation

The response received from the server.

GetReservation(GetReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual Reservation GetReservation(GetReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about the reservation.

Parameters
Name Description
request GetReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Reservation

The response received from the server.

GetReservationAsync(GetReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Reservation> GetReservationAsync(GetReservationRequest request, CallOptions options)

Returns information about the reservation.

Parameters
Name Description
request GetReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.

GetReservationAsync(GetReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Reservation> GetReservationAsync(GetReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns information about the reservation.

Parameters
Name Description
request GetReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.

ListAssignments(ListAssignmentsRequest, CallOptions)

public virtual ListAssignmentsResponse ListAssignments(ListAssignmentsRequest request, CallOptions options)

Lists assignments.

Only explicitly created assignments will be returned.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, ListAssignments will just return the above two assignments for reservation res1, and no expansion/merge will happen.

The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request ListAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListAssignmentsResponse

The response received from the server.

ListAssignments(ListAssignmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListAssignmentsResponse ListAssignments(ListAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists assignments.

Only explicitly created assignments will be returned.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, ListAssignments will just return the above two assignments for reservation res1, and no expansion/merge will happen.

The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request ListAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListAssignmentsResponse

The response received from the server.

ListAssignmentsAsync(ListAssignmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListAssignmentsResponse> ListAssignmentsAsync(ListAssignmentsRequest request, CallOptions options)

Lists assignments.

Only explicitly created assignments will be returned.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, ListAssignments will just return the above two assignments for reservation res1, and no expansion/merge will happen.

The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request ListAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListAssignmentsResponse

The call object.

ListAssignmentsAsync(ListAssignmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListAssignmentsResponse> ListAssignmentsAsync(ListAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists assignments.

Only explicitly created assignments will be returned.

Example:

  • Organization organizationA contains two projects, project1 and project2.
  • Reservation res1 exists and was created previously.
  • CreateAssignment was used previously to define the following associations between entities and reservations: <organizationA, res1> and <project1, res1>

In this example, ListAssignments will just return the above two assignments for reservation res1, and no expansion/merge will happen.

The wildcard "-" can be used for reservations in the request. In that case all assignments belongs to the specified project and location will be listed.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request ListAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListAssignmentsResponse

The call object.

ListCapacityCommitments(ListCapacityCommitmentsRequest, CallOptions)

public virtual ListCapacityCommitmentsResponse ListCapacityCommitments(ListCapacityCommitmentsRequest request, CallOptions options)

Lists all the capacity commitments for the admin project.

Parameters
Name Description
request ListCapacityCommitmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListCapacityCommitmentsResponse

The response received from the server.

ListCapacityCommitments(ListCapacityCommitmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCapacityCommitmentsResponse ListCapacityCommitments(ListCapacityCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the capacity commitments for the admin project.

Parameters
Name Description
request ListCapacityCommitmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListCapacityCommitmentsResponse

The response received from the server.

ListCapacityCommitmentsAsync(ListCapacityCommitmentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCapacityCommitmentsResponse> ListCapacityCommitmentsAsync(ListCapacityCommitmentsRequest request, CallOptions options)

Lists all the capacity commitments for the admin project.

Parameters
Name Description
request ListCapacityCommitmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListCapacityCommitmentsResponse

The call object.

ListCapacityCommitmentsAsync(ListCapacityCommitmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCapacityCommitmentsResponse> ListCapacityCommitmentsAsync(ListCapacityCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the capacity commitments for the admin project.

Parameters
Name Description
request ListCapacityCommitmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListCapacityCommitmentsResponse

The call object.

ListReservations(ListReservationsRequest, CallOptions)

public virtual ListReservationsResponse ListReservations(ListReservationsRequest request, CallOptions options)

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

Parameters
Name Description
request ListReservationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListReservationsResponse

The response received from the server.

ListReservations(ListReservationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListReservationsResponse ListReservations(ListReservationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListReservationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListReservationsResponse

The response received from the server.

ListReservationsAsync(ListReservationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReservationsResponse> ListReservationsAsync(ListReservationsRequest request, CallOptions options)

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

Parameters
Name Description
request ListReservationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListReservationsResponse

The call object.

ListReservationsAsync(ListReservationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListReservationsResponse> ListReservationsAsync(ListReservationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name Description
request ListReservationsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallListReservationsResponse

The call object.

MergeCapacityCommitments(MergeCapacityCommitmentsRequest, CallOptions)

public virtual CapacityCommitment MergeCapacityCommitments(MergeCapacityCommitmentsRequest request, CallOptions options)

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.

Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request MergeCapacityCommitmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

MergeCapacityCommitments(MergeCapacityCommitmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual CapacityCommitment MergeCapacityCommitments(MergeCapacityCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.

Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request MergeCapacityCommitmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

MergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest, CallOptions)

public virtual AsyncUnaryCall<CapacityCommitment> MergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest request, CallOptions options)

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.

Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request MergeCapacityCommitmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

MergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CapacityCommitment> MergeCapacityCommitmentsAsync(MergeCapacityCommitmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Merges capacity commitments of the same plan into a single commitment.

The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments.

Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request MergeCapacityCommitmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

MoveAssignment(MoveAssignmentRequest, CallOptions)

public virtual Assignment MoveAssignment(MoveAssignmentRequest request, CallOptions options)

Moves an assignment under a new reservation.

This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Parameters
Name Description
request MoveAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Assignment

The response received from the server.

MoveAssignment(MoveAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Assignment MoveAssignment(MoveAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Moves an assignment under a new reservation.

This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Parameters
Name Description
request MoveAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Assignment

The response received from the server.

MoveAssignmentAsync(MoveAssignmentRequest, CallOptions)

public virtual AsyncUnaryCall<Assignment> MoveAssignmentAsync(MoveAssignmentRequest request, CallOptions options)

Moves an assignment under a new reservation.

This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Parameters
Name Description
request MoveAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

MoveAssignmentAsync(MoveAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Assignment> MoveAssignmentAsync(MoveAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Moves an assignment under a new reservation.

This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Parameters
Name Description
request MoveAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

NewInstance(ClientBaseConfiguration)

protected override ReservationService.ReservationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ReservationServiceReservationServiceClient
Overrides

SearchAllAssignments(SearchAllAssignmentsRequest, CallOptions)

public virtual SearchAllAssignmentsResponse SearchAllAssignments(SearchAllAssignmentsRequest request, CallOptions options)

Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.
Parameters
Name Description
request SearchAllAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchAllAssignmentsResponse

The response received from the server.

SearchAllAssignments(SearchAllAssignmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual SearchAllAssignmentsResponse SearchAllAssignments(SearchAllAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.
Parameters
Name Description
request SearchAllAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SearchAllAssignmentsResponse

The response received from the server.

SearchAllAssignmentsAsync(SearchAllAssignmentsRequest, CallOptions)

public virtual AsyncUnaryCall<SearchAllAssignmentsResponse> SearchAllAssignmentsAsync(SearchAllAssignmentsRequest request, CallOptions options)

Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.
Parameters
Name Description
request SearchAllAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchAllAssignmentsResponse

The call object.

SearchAllAssignmentsAsync(SearchAllAssignmentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SearchAllAssignmentsResponse> SearchAllAssignmentsAsync(SearchAllAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.
Parameters
Name Description
request SearchAllAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSearchAllAssignmentsResponse

The call object.

SearchAssignments(SearchAssignmentsRequest, CallOptions)

[Obsolete]
public virtual SearchAssignmentsResponse SearchAssignments(SearchAssignmentsRequest request, CallOptions options)

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request SearchAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SearchAssignmentsResponse

The response received from the server.

SearchAssignments(SearchAssignmentsRequest, Metadata, DateTime?, CancellationToken)

[Obsolete]
public virtual SearchAssignmentsResponse SearchAssignments(SearchAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request SearchAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SearchAssignmentsResponse

The response received from the server.

SearchAssignmentsAsync(SearchAssignmentsRequest, CallOptions)

[Obsolete]
public virtual AsyncUnaryCall<SearchAssignmentsResponse> SearchAssignmentsAsync(SearchAssignmentsRequest request, CallOptions options)

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request SearchAssignmentsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSearchAssignmentsResponse

The call object.

SearchAssignmentsAsync(SearchAssignmentsRequest, Metadata, DateTime?, CancellationToken)

[Obsolete]
public virtual AsyncUnaryCall<SearchAssignmentsResponse> SearchAssignmentsAsync(SearchAssignmentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project:

  1. Assignments created on the project will be returned if they exist.
  2. Otherwise assignments created on the closest ancestor will be returned.
  3. Assignments for different JobTypes will all be returned.

The same logic applies if the request is about a folder.

If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).

Comparing to ListAssignments, there are some behavior differences:

  1. permission on the assignee will be verified in this API.
  2. Hierarchy lookup (project->folder->organization) happens in this API.
  3. Parent here is projects/*/locations/*, instead of projects/*/locations/*reservations/*.

Note "-" cannot be used for projects nor locations.

Parameters
Name Description
request SearchAssignmentsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSearchAssignmentsResponse

The call object.

SplitCapacityCommitment(SplitCapacityCommitmentRequest, CallOptions)

public virtual SplitCapacityCommitmentResponse SplitCapacityCommitment(SplitCapacityCommitmentRequest request, CallOptions options)

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments.

For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

Parameters
Name Description
request SplitCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
SplitCapacityCommitmentResponse

The response received from the server.

SplitCapacityCommitment(SplitCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual SplitCapacityCommitmentResponse SplitCapacityCommitment(SplitCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments.

For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

Parameters
Name Description
request SplitCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
SplitCapacityCommitmentResponse

The response received from the server.

SplitCapacityCommitmentAsync(SplitCapacityCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<SplitCapacityCommitmentResponse> SplitCapacityCommitmentAsync(SplitCapacityCommitmentRequest request, CallOptions options)

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments.

For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

Parameters
Name Description
request SplitCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallSplitCapacityCommitmentResponse

The call object.

SplitCapacityCommitmentAsync(SplitCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SplitCapacityCommitmentResponse> SplitCapacityCommitmentAsync(SplitCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Splits capacity commitment to two commitments of the same plan and commitment_end_time.

A common use case is to enable downgrading commitments.

For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into commitments of 2000 and 8000. Then, you delete the first one after the commitment end time passes.

Parameters
Name Description
request SplitCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallSplitCapacityCommitmentResponse

The call object.

UpdateAssignment(UpdateAssignmentRequest, CallOptions)

public virtual Assignment UpdateAssignment(UpdateAssignmentRequest request, CallOptions options)

Updates an existing assignment.

Only the priority field can be updated.

Parameters
Name Description
request UpdateAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Assignment

The response received from the server.

UpdateAssignment(UpdateAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual Assignment UpdateAssignment(UpdateAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing assignment.

Only the priority field can be updated.

Parameters
Name Description
request UpdateAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Assignment

The response received from the server.

UpdateAssignmentAsync(UpdateAssignmentRequest, CallOptions)

public virtual AsyncUnaryCall<Assignment> UpdateAssignmentAsync(UpdateAssignmentRequest request, CallOptions options)

Updates an existing assignment.

Only the priority field can be updated.

Parameters
Name Description
request UpdateAssignmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

UpdateAssignmentAsync(UpdateAssignmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Assignment> UpdateAssignmentAsync(UpdateAssignmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing assignment.

Only the priority field can be updated.

Parameters
Name Description
request UpdateAssignmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallAssignment

The call object.

UpdateBiReservation(UpdateBiReservationRequest, CallOptions)

public virtual BiReservation UpdateBiReservation(UpdateBiReservationRequest request, CallOptions options)

Updates a BI reservation.

Only fields specified in the field_mask are updated.

A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Parameters
Name Description
request UpdateBiReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
BiReservation

The response received from the server.

UpdateBiReservation(UpdateBiReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual BiReservation UpdateBiReservation(UpdateBiReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a BI reservation.

Only fields specified in the field_mask are updated.

A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Parameters
Name Description
request UpdateBiReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
BiReservation

The response received from the server.

UpdateBiReservationAsync(UpdateBiReservationRequest, CallOptions)

public virtual AsyncUnaryCall<BiReservation> UpdateBiReservationAsync(UpdateBiReservationRequest request, CallOptions options)

Updates a BI reservation.

Only fields specified in the field_mask are updated.

A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Parameters
Name Description
request UpdateBiReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallBiReservation

The call object.

UpdateBiReservationAsync(UpdateBiReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BiReservation> UpdateBiReservationAsync(UpdateBiReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a BI reservation.

Only fields specified in the field_mask are updated.

A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity reservation size must be set to 0.

Parameters
Name Description
request UpdateBiReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallBiReservation

The call object.

UpdateCapacityCommitment(UpdateCapacityCommitmentRequest, CallOptions)

public virtual CapacityCommitment UpdateCapacityCommitment(UpdateCapacityCommitmentRequest request, CallOptions options)

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated.

Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request UpdateCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

UpdateCapacityCommitment(UpdateCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual CapacityCommitment UpdateCapacityCommitment(UpdateCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated.

Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request UpdateCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
CapacityCommitment

The response received from the server.

UpdateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest, CallOptions)

public virtual AsyncUnaryCall<CapacityCommitment> UpdateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest request, CallOptions options)

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated.

Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request UpdateCapacityCommitmentRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

UpdateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CapacityCommitment> UpdateCapacityCommitmentAsync(UpdateCapacityCommitmentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing capacity commitment.

Only plan and renewal_plan fields can be updated.

Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters
Name Description
request UpdateCapacityCommitmentRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallCapacityCommitment

The call object.

UpdateReservation(UpdateReservationRequest, CallOptions)

public virtual Reservation UpdateReservation(UpdateReservationRequest request, CallOptions options)

Updates an existing reservation resource.

Parameters
Name Description
request UpdateReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Reservation

The response received from the server.

UpdateReservation(UpdateReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual Reservation UpdateReservation(UpdateReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing reservation resource.

Parameters
Name Description
request UpdateReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Reservation

The response received from the server.

UpdateReservationAsync(UpdateReservationRequest, CallOptions)

public virtual AsyncUnaryCall<Reservation> UpdateReservationAsync(UpdateReservationRequest request, CallOptions options)

Updates an existing reservation resource.

Parameters
Name Description
request UpdateReservationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.

UpdateReservationAsync(UpdateReservationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Reservation> UpdateReservationAsync(UpdateReservationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates an existing reservation resource.

Parameters
Name Description
request UpdateReservationRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCallReservation

The call object.