google_api_big_query_reservation v0.5.1 GoogleApi.BigQueryReservation.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

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.

Merges capacity commitments of the same plan into one. Resulting capacity commitment has the longer commitment_end_time out of the two. Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Splits capacity commitment to two commitments of the same plan and commitment_end_time. A common use case to do that is to perform a downgrade e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 capacity commitment to 2000 and 8000, change the plan of the first one to flex and then delete it.

Creates an 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 {job_type, location}, and that reservation will be used for all jobs of the matching type. Within the organization, different assignments can be created on projects, folders or organization level. 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. E.g: organizationA contains project1, project2. Assignments for organizationA, project1 and project2 could all be created, mapping to the same or different reservations. 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.

Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.

Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. 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.

Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected.

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

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

Updates a BI reservation. Only fields specified in the field_mask are updated. 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.

Link to this section Functions

Link to this function

bigqueryreservation_projects_locations_capacity_commitments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Creates a new capacity commitment resource.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :enforceSingleAdminProjectPerOrg (type: boolean()) - If true, fail the request if another project in the organization has a capacity commitment.
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_get(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Returns information about the capacity commitment.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryReservation.V1.Model.ListCapacityCommitmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists all the capacity commitments for the admin project.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.ListCapacityCommitmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_merge(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_merge(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Merges capacity commitments of the same plan into one. Resulting capacity commitment has the longer commitment_end_time out of the two. Attempting to merge capacity commitments of different plan will fail with the error code google.rpc.Code.FAILED_PRECONDITION.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Parent resource that identifies admin project and location e.g., projects/myproject/locations/us
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.MergeCapacityCommitmentsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Standard field mask for the set of fields to be updated.
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.CapacityCommitment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_capacity_commitments_split(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_capacity_commitments_split(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.BigQueryReservation.V1.Model.SplitCapacityCommitmentResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Splits capacity commitment to two commitments of the same plan and commitment_end_time. A common use case to do that is to perform a downgrade e.g., in order to downgrade from 10000 slots to 8000, one might split 10000 capacity commitment to 2000 and 8000, change the plan of the first one to flex and then delete it.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name e.g.,: projects/myproject/locations/US/capacityCommitments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.SplitCapacityCommitmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.SplitCapacityCommitmentResponse{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_get_bi_reservation(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_get_bi_reservation(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.BiReservation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves a BI reservation.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the requested reservation, for example: projects/{project_id}/locations/{location_id}/bireservation
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.BiReservation{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_assignments_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_assignments_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Assignment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Creates an 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 {job_type, location}, and that reservation will be used for all jobs of the matching type. Within the organization, different assignments can be created on projects, folders or organization level. 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. E.g: organizationA contains project1, project2. Assignments for organizationA, project1 and project2 could all be created, mapping to the same or different reservations. 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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.Assignment.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Assignment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_assignments_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_assignments_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Deletes a assignment. No expansion will happen. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then deletion of won't affect . After deletion of , queries from project1 will still use res1, while queries from project2 will use on-demand mode.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_assignments_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_assignments_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.ListAssignmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Lists assignments. Only explicitly created assignments will be returned. E.g: organizationA contains project1 and project2. Reservation res1 exists. CreateAssignment was invoked previously and following assignments were created explicitly: Then this API will just return the above two assignments for reservation res1, and no expansion/merge will happen. 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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/-
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.ListAssignmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_assignments_move(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_assignments_move(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Assignment.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Moves a assignment under a new reservation. Customers can do this by deleting the existing assignment followed by creating another assignment under the new reservation, but this method provides a transactional way to do so, to make sure the assignee always has an associated reservation. Without the method customers might see some queries run on-demand which might be unexpected.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.MoveAssignmentRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Assignment{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Creates a new reservation resource.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Project, location. E.g., projects/myproject/locations/US
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :reservationId (type: String.t) - The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters.
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.Reservation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Reservation{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_get(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Returns information about the reservation.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Reservation{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.ListReservationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource name containing project and location, e.g.: "projects/myproject/locations/US"
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.ListReservationsResponse{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_reservations_patch(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_reservations_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Updates an existing reservation resource.

Parameters

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the reservation, e.g., "projects//locations//reservations/team1-prod".
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Standard field mask for the set of fields to be updated.
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.Reservation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.Reservation{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_search_assignments(connection, parent, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_search_assignments(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.SearchAssignmentsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US".
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of items to return.
    • :pageToken (type: String.t) - The next_page_token value returned from a previous List request, if any.
    • :query (type: String.t) - Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject"

        "assignee=folders/123"
        "assignee=organizations/456"
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.SearchAssignmentsResponse{}} on success
  • {:error, info} on failure
Link to this function

bigqueryreservation_projects_locations_update_bi_reservation(connection, name, optional_params \\ [], opts \\ [])

View Source
bigqueryreservation_projects_locations_update_bi_reservation(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryReservation.V1.Model.BiReservation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Updates a BI reservation. Only fields specified in the field_mask are updated. 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

  • connection (type: GoogleApi.BigQueryReservation.V1.Connection.t) - Connection to server
  • name (type: String.t) - The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/bireservation.
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - A list of fields to be updated in this request.
    • :body (type: GoogleApi.BigQueryReservation.V1.Model.BiReservation.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.BigQueryReservation.V1.Model.BiReservation{}} on success
  • {:error, info} on failure