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\Logging\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\Logging\CmekSettings;
|
---|
21 | use Google\Service\Logging\Settings;
|
---|
22 |
|
---|
23 | /**
|
---|
24 | * The "folders" collection of methods.
|
---|
25 | * Typical usage is:
|
---|
26 | * <code>
|
---|
27 | * $loggingService = new Google\Service\Logging(...);
|
---|
28 | * $folders = $loggingService->folders;
|
---|
29 | * </code>
|
---|
30 | */
|
---|
31 | class Folders extends \Google\Service\Resource
|
---|
32 | {
|
---|
33 | /**
|
---|
34 | * Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log
|
---|
35 | * Router can be configured for Google Cloud projects, folders, organizations,
|
---|
36 | * and billing accounts. Once configured for an organization, it applies to all
|
---|
37 | * projects and folders in the Google Cloud organization.See Enabling CMEK for
|
---|
38 | * Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption)
|
---|
39 | * for more information. (folders.getCmekSettings)
|
---|
40 | *
|
---|
41 | * @param string $name Required. The resource for which to retrieve CMEK
|
---|
42 | * settings. "projects/[PROJECT_ID]/cmekSettings"
|
---|
43 | * "organizations/[ORGANIZATION_ID]/cmekSettings"
|
---|
44 | * "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings"
|
---|
45 | * "folders/[FOLDER_ID]/cmekSettings" For
|
---|
46 | * example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can
|
---|
47 | * be configured for Google Cloud projects, folders, organizations, and billing
|
---|
48 | * accounts. Once configured for an organization, it applies to all projects and
|
---|
49 | * folders in the Google Cloud organization.
|
---|
50 | * @param array $optParams Optional parameters.
|
---|
51 | * @return CmekSettings
|
---|
52 | * @throws \Google\Service\Exception
|
---|
53 | */
|
---|
54 | public function getCmekSettings($name, $optParams = [])
|
---|
55 | {
|
---|
56 | $params = ['name' => $name];
|
---|
57 | $params = array_merge($params, $optParams);
|
---|
58 | return $this->call('getCmekSettings', [$params], CmekSettings::class);
|
---|
59 | }
|
---|
60 | /**
|
---|
61 | * Gets the settings for the given resource.Note: Settings can be retrieved for
|
---|
62 | * Google Cloud projects, folders, organizations, and billing accounts.See View
|
---|
63 | * default resource settings for Logging
|
---|
64 | * (https://cloud.google.com/logging/docs/default-settings#view-org-settings)
|
---|
65 | * for more information. (folders.getSettings)
|
---|
66 | *
|
---|
67 | * @param string $name Required. The resource for which to retrieve settings.
|
---|
68 | * "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings"
|
---|
69 | * "billingAccounts/[BILLING_ACCOUNT_ID]/settings"
|
---|
70 | * "folders/[FOLDER_ID]/settings" For
|
---|
71 | * example:"organizations/12345/settings"Note: Settings can be retrieved for
|
---|
72 | * Google Cloud projects, folders, organizations, and billing accounts.
|
---|
73 | * @param array $optParams Optional parameters.
|
---|
74 | * @return Settings
|
---|
75 | * @throws \Google\Service\Exception
|
---|
76 | */
|
---|
77 | public function getSettings($name, $optParams = [])
|
---|
78 | {
|
---|
79 | $params = ['name' => $name];
|
---|
80 | $params = array_merge($params, $optParams);
|
---|
81 | return $this->call('getSettings', [$params], Settings::class);
|
---|
82 | }
|
---|
83 | /**
|
---|
84 | * Updates the settings for the given resource. This method applies to all
|
---|
85 | * feature configurations for organization and folders.UpdateSettings fails when
|
---|
86 | * any of the following are true: The value of storage_location either isn't
|
---|
87 | * supported by Logging or violates the location OrgPolicy. The
|
---|
88 | * default_sink_config field is set, but it has an unspecified filter write
|
---|
89 | * mode. The value of kms_key_name is invalid. The associated service account
|
---|
90 | * doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role
|
---|
91 | * assigned for the key. Access to the key is disabled.See Configure default
|
---|
92 | * settings for organizations and folders
|
---|
93 | * (https://cloud.google.com/logging/docs/default-settings) for more
|
---|
94 | * information. (folders.updateSettings)
|
---|
95 | *
|
---|
96 | * @param string $name Required. The resource name for the settings to update.
|
---|
97 | * "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For
|
---|
98 | * example:"organizations/12345/settings"
|
---|
99 | * @param Settings $postBody
|
---|
100 | * @param array $optParams Optional parameters.
|
---|
101 | *
|
---|
102 | * @opt_param string updateMask Optional. Field mask identifying which fields
|
---|
103 | * from settings should be updated. A field will be overwritten if and only if
|
---|
104 | * it is in the update mask. Output only fields cannot be updated.See FieldMask
|
---|
105 | * for more information.For example: "updateMask=kmsKeyName"
|
---|
106 | * @return Settings
|
---|
107 | * @throws \Google\Service\Exception
|
---|
108 | */
|
---|
109 | public function updateSettings($name, Settings $postBody, $optParams = [])
|
---|
110 | {
|
---|
111 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
112 | $params = array_merge($params, $optParams);
|
---|
113 | return $this->call('updateSettings', [$params], Settings::class);
|
---|
114 | }
|
---|
115 | }
|
---|
116 |
|
---|
117 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
118 | class_alias(Folders::class, 'Google_Service_Logging_Resource_Folders');
|
---|