Local Administrator
207 lines
9.1 KiB
PHP
207 lines
9.1 KiB
PHP
<?php
|
|
/*
|
|
* Copyright 2014 Google Inc.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
|
* use this file except in compliance with the License. You may obtain a copy of
|
|
* the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations under
|
|
* the License.
|
|
*/
|
|
|
|
namespace Google\Service\FirebaseManagement\Resource;
|
|
|
|
use Google\Service\FirebaseManagement\AndroidApp;
|
|
use Google\Service\FirebaseManagement\AndroidAppConfig;
|
|
use Google\Service\FirebaseManagement\ListAndroidAppsResponse;
|
|
use Google\Service\FirebaseManagement\Operation;
|
|
use Google\Service\FirebaseManagement\RemoveAndroidAppRequest;
|
|
use Google\Service\FirebaseManagement\UndeleteAndroidAppRequest;
|
|
|
|
/**
|
|
* The "androidApps" collection of methods.
|
|
* Typical usage is:
|
|
* <code>
|
|
* $firebaseService = new Google\Service\FirebaseManagement(...);
|
|
* $androidApps = $firebaseService->projects_androidApps;
|
|
* </code>
|
|
*/
|
|
class ProjectsAndroidApps extends \Google\Service\Resource
|
|
{
|
|
/**
|
|
* Requests the creation of a new AndroidApp in the specified FirebaseProject.
|
|
* The result of this call is an `Operation` which can be used to track the
|
|
* provisioning process. The `Operation` is automatically deleted after
|
|
* completion, so there is no need to call `DeleteOperation`.
|
|
* (androidApps.create)
|
|
*
|
|
* @param string $parent The resource name of the parent FirebaseProject in
|
|
* which to create an AndroidApp, in the format:
|
|
* projects/PROJECT_IDENTIFIER/androidApps Refer to the `FirebaseProject`
|
|
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about
|
|
* PROJECT_IDENTIFIER values.
|
|
* @param AndroidApp $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Operation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function create($parent, AndroidApp $postBody, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('create', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Gets the specified AndroidApp. (androidApps.get)
|
|
*
|
|
* @param string $name The resource name of the AndroidApp, in the format:
|
|
* projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique
|
|
* identifier, the Unique Resource from Sub-Collection access pattern may be
|
|
* used here, in the format: projects/-/androidApps/APP_ID Refer to the
|
|
* `AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field
|
|
* for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
* @param array $optParams Optional parameters.
|
|
* @return AndroidApp
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function get($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('get', [$params], AndroidApp::class);
|
|
}
|
|
/**
|
|
* Gets the configuration artifact associated with the specified AndroidApp.
|
|
* (androidApps.getConfig)
|
|
*
|
|
* @param string $name The resource name of the AndroidApp configuration to
|
|
* download, in the format:
|
|
* projects/PROJECT_IDENTIFIER/androidApps/APP_ID/config Since an APP_ID is a
|
|
* unique identifier, the Unique Resource from Sub-Collection access pattern may
|
|
* be used here, in the format: projects/-/androidApps/APP_ID Refer to the
|
|
* `AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field
|
|
* for details about PROJECT_IDENTIFIER and APP_ID values.
|
|
* @param array $optParams Optional parameters.
|
|
* @return AndroidAppConfig
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function getConfig($name, $optParams = [])
|
|
{
|
|
$params = ['name' => $name];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('getConfig', [$params], AndroidAppConfig::class);
|
|
}
|
|
/**
|
|
* Lists each AndroidApp associated with the specified FirebaseProject. The
|
|
* elements are returned in no particular order, but will be a consistent view
|
|
* of the Apps when additional requests are made with a `pageToken`.
|
|
* (androidApps.listProjectsAndroidApps)
|
|
*
|
|
* @param string $parent The resource name of the parent FirebaseProject for
|
|
* which to list each associated AndroidApp, in the format:
|
|
* projects/PROJECT_IDENTIFIER /androidApps Refer to the `FirebaseProject`
|
|
* [`name`](../projects#FirebaseProject.FIELDS.name) field for details about
|
|
* PROJECT_IDENTIFIER values.
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param int pageSize The maximum number of Apps to return in the response.
|
|
* The server may return fewer than this at its discretion. If no value is
|
|
* specified (or too large a value is specified), then the server will impose
|
|
* its own limit.
|
|
* @opt_param string pageToken Token returned from a previous call to
|
|
* `ListAndroidApps` indicating where in the set of Apps to resume listing.
|
|
* @opt_param bool showDeleted Controls whether Apps in the DELETED state should
|
|
* be returned in the response. If not specified, only `ACTIVE` Apps will be
|
|
* returned.
|
|
* @return ListAndroidAppsResponse
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function listProjectsAndroidApps($parent, $optParams = [])
|
|
{
|
|
$params = ['parent' => $parent];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('list', [$params], ListAndroidAppsResponse::class);
|
|
}
|
|
/**
|
|
* Updates the attributes of the specified AndroidApp. (androidApps.patch)
|
|
*
|
|
* @param string $name The resource name of the AndroidApp, in the format:
|
|
* projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the
|
|
* parent Project's
|
|
* [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
|
|
* ***(recommended)*** or its
|
|
* [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more
|
|
* about using project identifiers in Google's [AIP 2510
|
|
* standard](https://google.aip.dev/cloud/2510). Note that the value for
|
|
* PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID:
|
|
* the globally unique, Firebase-assigned identifier for the App (see
|
|
* [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
|
|
* @param AndroidApp $postBody
|
|
* @param array $optParams Optional parameters.
|
|
*
|
|
* @opt_param string updateMask Specifies which fields of the AndroidApp to
|
|
* update. Note that the following fields are immutable: `name`, `app_id`,
|
|
* `project_id`, and `package_name`. To update `state`, use any of the following
|
|
* endpoints: RemoveAndroidApp or UndeleteAndroidApp.
|
|
* @return AndroidApp
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function patch($name, AndroidApp $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('patch', [$params], AndroidApp::class);
|
|
}
|
|
/**
|
|
* Removes the specified AndroidApp from the FirebaseProject.
|
|
* (androidApps.remove)
|
|
*
|
|
* @param string $name Required. The resource name of the AndroidApp, in the
|
|
* format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a
|
|
* unique identifier, the Unique Resource from Sub-Collection access pattern may
|
|
* be used here, in the format: projects/-/androidApps/APP_ID Refer to the
|
|
* AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field for
|
|
* details about PROJECT_IDENTIFIER and APP_ID values.
|
|
* @param RemoveAndroidAppRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Operation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function remove($name, RemoveAndroidAppRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('remove', [$params], Operation::class);
|
|
}
|
|
/**
|
|
* Restores the specified AndroidApp to the FirebaseProject.
|
|
* (androidApps.undelete)
|
|
*
|
|
* @param string $name Required. The resource name of the AndroidApp, in the
|
|
* format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a
|
|
* unique identifier, the Unique Resource from Sub-Collection access pattern may
|
|
* be used here, in the format: projects/-/androidApps/APP_ID Refer to the
|
|
* AndroidApp [name](../projects.androidApps#AndroidApp.FIELDS.name) field for
|
|
* details about PROJECT_IDENTIFIER and APP_ID values.
|
|
* @param UndeleteAndroidAppRequest $postBody
|
|
* @param array $optParams Optional parameters.
|
|
* @return Operation
|
|
* @throws \Google\Service\Exception
|
|
*/
|
|
public function undelete($name, UndeleteAndroidAppRequest $postBody, $optParams = [])
|
|
{
|
|
$params = ['name' => $name, 'postBody' => $postBody];
|
|
$params = array_merge($params, $optParams);
|
|
return $this->call('undelete', [$params], Operation::class);
|
|
}
|
|
}
|
|
|
|
// Adding a class alias for backwards compatibility with the previous class name.
|
|
class_alias(ProjectsAndroidApps::class, 'Google_Service_FirebaseManagement_Resource_ProjectsAndroidApps');
|