Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1c4cfdb76560f757cec9dbc56a290ee748a07ef0 / . / docs / dyn / logging_v2.projects.html
blob: 28d874f5d82f653b9b83b464e690d5675f5e7b77 [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]75<h1><a href="logging_v2.html">Cloud Logging API</a> . <a href="logging_v2.projects.html">projects</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="logging_v2.projects.exclusions.html">exclusions()</a></code>
79</p>
80<p class="firstline">Returns the exclusions Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]83 <code><a href="logging_v2.projects.locations.html">locations()</a></code>
84</p>
85<p class="firstline">Returns the locations Resource.</p>
86
87<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]88 <code><a href="logging_v2.projects.logs.html">logs()</a></code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]89</p>
90<p class="firstline">Returns the logs Resource.</p>
91
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]93 <code><a href="logging_v2.projects.metrics.html">metrics()</a></code>
94</p>
95<p class="firstline">Returns the metrics Resource.</p>
96
97<p class="toc_element">
98 <code><a href="logging_v2.projects.sinks.html">sinks()</a></code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99</p>
100<p class="firstline">Returns the sinks Resource.</p>
101
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]102<p class="toc_element">
103 <code><a href="#close">close()</a></code></p>
104<p class="firstline">Close httplib2 connections.</p>
yoshi-code-bot466c9a92021-11-22 23:24:31 -0800[diff] [blame]105<p class="toc_element">
106 <code><a href="#getCmekSettings">getCmekSettings(name, x__xgafv=None)</a></code></p>
107<p class="firstline">Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108<h3>Method Details</h3>
109<div class="method">
110 <code class="details" id="close">close()</code>
111 <pre>Close httplib2 connections.</pre>
112</div>
113
yoshi-code-bot466c9a92021-11-22 23:24:31 -0800[diff] [blame]114<div class="method">
115 <code class="details" id="getCmekSettings">getCmekSettings(name, x__xgafv=None)</code>
116 <pre>Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
117
118Args:
119 name: string, Required. The resource for which to retrieve CMEK settings. &quot;projects/[PROJECT_ID]/cmekSettings&quot; &quot;organizations/[ORGANIZATION_ID]/cmekSettings&quot; &quot;billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings&quot; &quot;folders/[FOLDER_ID]/cmekSettings&quot; For example:&quot;organizations/12345/cmekSettings&quot;Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. (required)
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
128 { # Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
129 &quot;kmsKeyName&quot;: &quot;A String&quot;, # The resource name for the configured Cloud KMS key.KMS key name format: &quot;projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]&quot; For example:&quot;projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key&quot;To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
130 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the CMEK settings.
131 &quot;serviceAccountId&quot;: &quot;A String&quot;, # Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
132}</pre>
133</div>
134
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]135</body></html>