google_api_big_query_reservation v0.7.0 GoogleApi.BigQueryReservation.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Creates a new capacity commitment resource.
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
.
Returns information about the capacity commitment.
Lists all the capacity commitments for the admin project.
Merges capacity commitments of the same plan into a single commitment.
Updates an existing capacity commitment.
Splits capacity commitment to two commitments of the same plan and
commitment_end_time
.
Retrieves a BI reservation.
Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation.
Deletes a assignment. No expansion will happen.
Lists assignments.
Moves an assignment under a new reservation.
Creates a new reservation resource.
Deletes a reservation.
Returns google.rpc.Code.FAILED_PRECONDITION
when reservation has
assignments.
Returns information about the reservation.
Lists all the reservations for the project in the specified location.
Updates an existing reservation resource.
Looks up assignments for a specified resource for a particular region. If the request is about a project
Looks up assignments for a specified resource for a particular region. If the request is about a project
Link to this section Functions
bigqueryreservation_projects_locations_capacity_commitments_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_capacity_commitments_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_capacity_commitments_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_capacity_commitments_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_capacity_commitments_merge(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
-
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
bigqueryreservation_projects_locations_capacity_commitments_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_capacity_commitments_split(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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 would 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
bigqueryreservation_projects_locations_get_bi_reservation(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
bigqueryreservation_projects_locations_reservations_assignments_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
andproject2
. - Assignments for all three entities (
organizationA
,project1
, andproject2
) could all be created and mapped 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
bigqueryreservation_projects_locations_reservations_assignments_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
Deletes a assignment. No expansion will happen.
Example:
- Organization
organizationA
contains two projects,project1
andproject2
. - 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
-
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
bigqueryreservation_projects_locations_reservations_assignments_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
Lists assignments.
Only explicitly created assignments will be returned.
Example:
- Organization
organizationA
contains two projects,project1
andproject2
. - 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
connection
(type:GoogleApi.BigQueryReservation.V1.Connection.t
) - Connection to serverparent
(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 per page. -
: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
bigqueryreservation_projects_locations_reservations_assignments_move(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
-
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
bigqueryreservation_projects_locations_reservations_create(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_reservations_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
bigqueryreservation_projects_locations_reservations_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_reservations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
bigqueryreservation_projects_locations_reservations_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_reservations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
bigqueryreservation_projects_locations_reservations_list(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_reservations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.ListReservationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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 per page. -
: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
bigqueryreservation_projects_locations_reservations_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_reservations_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.Reservation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
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
bigqueryreservation_projects_locations_search_all_assignments(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_search_all_assignments( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.SearchAllAssignmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Looks up assignments for a specified resource for a particular region. If the request is about a project:
- Assignments created on the project will be returned if they exist.
- Otherwise assignments created on the closest ancestor will be returned.
- 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:
- permission on the assignee will be verified in this API.
- Hierarchy lookup (project->folder->organization) happens in this API.
- Parent here is
projects/*/locations/*
, instead ofprojects/*/locations/*reservations/*
.
Parameters
connection
(type:GoogleApi.BigQueryReservation.V1.Connection.t
) - Connection to serverparent
(type:String.t
) - Required. The resource name with location (project name could be the wildcard '-'), e.g.:projects/-/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 per page.: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.Examples:
assignee=projects/myproject
assignee=folders/123
assignee=organizations/456
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigQueryReservation.V1.Model.SearchAllAssignmentsResponse{}}
on success -
{:error, info}
on failure
bigqueryreservation_projects_locations_search_assignments(connection, parent, optional_params \\ [], opts \\ [])
View SourceSpecs
bigqueryreservation_projects_locations_search_assignments( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigQueryReservation.V1.Model.SearchAssignmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Looks up assignments for a specified resource for a particular region. If the request is about a project:
- Assignments created on the project will be returned if they exist.
- Otherwise assignments created on the closest ancestor will be returned.
- 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:
- permission on the assignee will be verified in this API.
- Hierarchy lookup (project->folder->organization) happens in this API.
- Parent here is
projects/*/locations/*
, instead ofprojects/*/locations/*reservations/*
.
Note "-" cannot be used for projects nor locations.
Parameters
connection
(type:GoogleApi.BigQueryReservation.V1.Connection.t
) - Connection to serverparent
(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 per page.: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.Examples:
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
bigqueryreservation_projects_locations_update_bi_reservation(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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, any()}
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
-
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 formprojects/{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