Documentation

Google_Service_FirebaseRemoteConfig_Resource_Projects extends Google_Service_Resource
in package

The "projects" collection of methods.

Typical usage is: $firebaseremoteconfigService = new Google_Service_FirebaseRemoteConfig(...); $projects = $firebaseremoteconfigService->projects;

Table of Contents

$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.
getRemoteConfig()  : Google_Service_FirebaseRemoteConfig_RemoteConfig
Get the latest version Remote Configuration for a project. Returns the RemoteConfig as the payload, and also the eTag as a response header.
updateRemoteConfig()  : Google_Service_FirebaseRemoteConfig_RemoteConfig
Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages: * VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated. * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token). * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id). * VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag. * Internal error (HTTP status 500) for Database problems or other internal errors.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$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'))

Methods

__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
Tags
throws
Google_Exception
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>
Tags
static
Return values
string

$requestUrl

getRemoteConfig()

Get the latest version Remote Configuration for a project. Returns the RemoteConfig as the payload, and also the eTag as a response header.

public getRemoteConfig(string $project[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseRemoteConfig_RemoteConfig

(projects.getRemoteConfig)

Parameters
$project : string

The GMP project identifier. Required. See note at the beginning of this file regarding project ids.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_FirebaseRemoteConfig_RemoteConfig

updateRemoteConfig()

Update a RemoteConfig. We treat this as an always-existing resource (when it is not found in our data store, we treat it as version 0, a template with zero conditions and zero parameters). Hence there are no Create or Delete operations. Returns the updated template when successful (and the updated eTag as a response header), or an error if things go wrong. Possible error messages: * VALIDATION_ERROR (HTTP status 400) with additional details if the template being passed in can not be validated. * AUTHENTICATION_ERROR (HTTP status 401) if the request can not be authenticate (e.g. no access token, or invalid access token). * AUTHORIZATION_ERROR (HTTP status 403) if the request can not be authorized (e.g. the user has no access to the specified project id). * VERSION_MISMATCH (HTTP status 412) when trying to update when the expected eTag (passed in via the "If-match" header) is not specified, or is specified but does does not match the current eTag. * Internal error (HTTP status 500) for Database problems or other internal errors.

public updateRemoteConfig(string $project, Google_Service_FirebaseRemoteConfig_RemoteConfig $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_FirebaseRemoteConfig_RemoteConfig

(projects.updateRemoteConfig)

Parameters
$project : string

The GMP project identifier. Required. See note at the beginning of this file regarding project ids.

$postBody : Google_Service_FirebaseRemoteConfig_RemoteConfig
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

bool validateOnly Optional. Defaults to false (UpdateRemoteConfig call should update the backend if there are no validation/interal errors). May be set to true to indicate that, should no validation errors occur, the call should return a "200 OK" instead of performing the update. Note that other error messages (500 Internal Error, 412 Version Mismatch, etc) may still result after flipping to false, even if getting a "200 OK" when calling with true.

Return values
Google_Service_FirebaseRemoteConfig_RemoteConfig

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results