Documentation

Google_Service_BigQueryReservation_Resource_ProjectsLocations extends Google_Service_Resource
in package

Application

The "locations" collection of methods.

Typical usage is: $bigqueryreservationService = new Google_Service_BigQueryReservation(...); $locations = $bigqueryreservationService->locations;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
getBiReservation() : Google_Service_BigQueryReservation_BiReservation: Retrieves a BI reservation. (locations.getBiReservation)
searchAllAssignments() : Google_Service_BigQueryReservation_SearchAllAssignmentsResponse: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).
searchAssignments() : Google_Service_BigQueryReservation_SearchAssignmentsResponse: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).
updateBiReservation() : Google_Service_BigQueryReservation_BiReservation: 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.
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

getBiReservation()

Retrieves a BI reservation. (locations.getBiReservation)


    public
                getBiReservation(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryReservation_BiReservation

Parameters

$name : string: Required. Name of the requested reservation, for example: projects/{project_id}/locations/{location_id}/bireservation
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigQueryReservation_BiReservation —

searchAllAssignments()

Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for different JobTypes will all be returned. The same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors).


    public
                searchAllAssignments(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryReservation_SearchAllAssignmentsResponse

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/locationsreservations. (locations.searchAllAssignments)

Parameters

$parent : string: Required. The resource name with location (project name could be the wildcard '-'), e.g.: projects/-/locations/US.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigQueryReservation_SearchAllAssignmentsResponse —

searchAssignments()


    public
                searchAssignments(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryReservation_SearchAssignmentsResponse

Parameters

$parent : string: Required. The resource name of the admin project(containing project and location), e.g.: projects/myproject/locations/US.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigQueryReservation_SearchAssignmentsResponse —

updateBiReservation()

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.


    public
                updateBiReservation(string $name, Google_Service_BigQueryReservation_BiReservation $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_BigQueryReservation_BiReservation

(locations.updateBiReservation)

Parameters

$name : string: The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/bireservation.
$postBody : Google_Service_BigQueryReservation_BiReservation
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_BigQueryReservation_BiReservation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —