1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\Firebaseappcheck\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Firebaseappcheck\GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse;
|
---|
21 | use Google\Service\Firebaseappcheck\GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "recaptchaEnterpriseConfig" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $firebaseappcheckService = new Google\Service\Firebaseappcheck(...);
|
---|
28 | * $recaptchaEnterpriseConfig = $firebaseappcheckService->projects_apps_recaptchaEnterpriseConfig;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class ProjectsAppsRecaptchaEnterpriseConfig extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Atomically gets the RecaptchaEnterpriseConfigs for the specified list of
|
---|
35 | * apps. (recaptchaEnterpriseConfig.batchGet)
|
---|
36 | *
|
---|
37 | * @param string $parent Required. The parent project name shared by all
|
---|
38 | * RecaptchaEnterpriseConfigs being retrieved, in the format ```
|
---|
39 | * projects/{project_number} ``` The parent collection in the `name` field of
|
---|
40 | * any resource being retrieved must match this field, or the entire batch
|
---|
41 | * fails.
|
---|
42 | * @param array $optParams Optional parameters.
|
---|
43 | *
|
---|
44 | * @opt_param string names Required. The relative resource names of the
|
---|
45 | * RecaptchaEnterpriseConfigs to retrieve, in the format: ```
|
---|
46 | * projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ``` A
|
---|
47 | * maximum of 100 objects can be retrieved in a batch.
|
---|
48 | * @return GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse
|
---|
49 | * @throws \Google\Service\Exception
|
---|
50 | */
|
---|
51 | public function batchGet($parent, $optParams = [])
|
---|
52 | {
|
---|
53 | $params = ['parent' => $parent];
|
---|
54 | $params = array_merge($params, $optParams);
|
---|
55 | return $this->call('batchGet', [$params], GoogleFirebaseAppcheckV1BatchGetRecaptchaEnterpriseConfigsResponse::class);
|
---|
56 | }
|
---|
57 | /**
|
---|
58 | * Gets the RecaptchaEnterpriseConfig for the specified app.
|
---|
59 | * (recaptchaEnterpriseConfig.get)
|
---|
60 | *
|
---|
61 | * @param string $name Required. The relative resource name of the
|
---|
62 | * RecaptchaEnterpriseConfig, in the format: ```
|
---|
63 | * projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```
|
---|
64 | * @param array $optParams Optional parameters.
|
---|
65 | * @return GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
|
---|
66 | * @throws \Google\Service\Exception
|
---|
67 | */
|
---|
68 | public function get($name, $optParams = [])
|
---|
69 | {
|
---|
70 | $params = ['name' => $name];
|
---|
71 | $params = array_merge($params, $optParams);
|
---|
72 | return $this->call('get', [$params], GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::class);
|
---|
73 | }
|
---|
74 | /**
|
---|
75 | * Updates the RecaptchaEnterpriseConfig for the specified app. While this
|
---|
76 | * configuration is incomplete or invalid, the app will be unable to exchange
|
---|
77 | * reCAPTCHA Enterprise tokens for App Check tokens.
|
---|
78 | * (recaptchaEnterpriseConfig.patch)
|
---|
79 | *
|
---|
80 | * @param string $name Required. The relative resource name of the reCAPTCHA
|
---|
81 | * Enterprise configuration object, in the format: ```
|
---|
82 | * projects/{project_number}/apps/{app_id}/recaptchaEnterpriseConfig ```
|
---|
83 | * @param GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig $postBody
|
---|
84 | * @param array $optParams Optional parameters.
|
---|
85 | *
|
---|
86 | * @opt_param string updateMask Required. A comma-separated list of names of
|
---|
87 | * fields in the RecaptchaEnterpriseConfig to update. Example: `site_key`.
|
---|
88 | * @return GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig
|
---|
89 | * @throws \Google\Service\Exception
|
---|
90 | */
|
---|
91 | public function patch($name, GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig $postBody, $optParams = [])
|
---|
92 | {
|
---|
93 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
94 | $params = array_merge($params, $optParams);
|
---|
95 | return $this->call('patch', [$params], GoogleFirebaseAppcheckV1RecaptchaEnterpriseConfig::class);
|
---|
96 | }
|
---|
97 | }
|
---|
98 |
|
---|
99 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
100 | class_alias(ProjectsAppsRecaptchaEnterpriseConfig::class, 'Google_Service_Firebaseappcheck_Resource_ProjectsAppsRecaptchaEnterpriseConfig');
|
---|