File: apigee_v1.organizations.securityMonitoringConditions.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (332 lines) | stat: -rw-r--r-- 16,737 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.securityMonitoringConditions.html">securityMonitoringConditions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a security monitoring condition.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a security monitoring condition.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get a security monitoring condition.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List security monitoring conditions.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update a security monitoring condition.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)</code>
  <pre>Create a security monitoring condition.

Args:
  parent: string, Required. The parent resource name. Format: `organizations/{org}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Security monitoring condition for risk assessment version 2.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
  &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
      },
    ],
  },
  &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
  &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
  &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
}

  securityMonitoringConditionId: string, Optional. Optional: The security monitoring condition id. If not specified, a monitoring condition uuid will be generated by the backend. This value should be 4-63 characters, and valid characters are /a-z-/.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
  &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
      },
    ],
  },
  &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
  &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
  &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Delete a security monitoring condition.

Args:
  name: string, Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Get a security monitoring condition.

Args:
  name: string, Required. The name of the security monitoring condition to get. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
  &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
      },
    ],
  },
  &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
  &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
  &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List security monitoring conditions.

Args:
  parent: string, Required. For a specific organization, list all the security monitoring conditions. Format: `organizations/{org}` (required)
  filter: string, Optional. Filter for the monitoring conditions. For example: `profile=profile1 AND scope=env1`
  pageSize: integer, Optional. The maximum number of monitoring conditions to return.
  pageToken: string, Optional. A page token, received from a previous `ListSecurityMonitoringConditions` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListSecurityMonitoringConditions.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  &quot;securityMonitoringConditions&quot;: [ # List of security monitoring conditions in the organization.
    { # Security monitoring condition for risk assessment version 2.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
      &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
        &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
          { # Resource for which we are computing security assessment.
            &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
            &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
          },
        ],
      },
      &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
      },
      &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
      &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
      &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
      &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
      &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Update a security monitoring condition.

Args:
  name: string, Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition} (required)
  body: object, The request body.
    The object takes the form of:

{ # Security monitoring condition for risk assessment version 2.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
  &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
      },
    ],
  },
  &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
  &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
  &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
}

  updateMask: string, Optional. The list of fields to update. Valid fields to update are `include_all_resources` and `include`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition creation.
  &quot;include&quot;: { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    &quot;resources&quot;: [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        &quot;name&quot;: &quot;A String&quot;, # Required. Name of this resource.
        &quot;type&quot;: &quot;A String&quot;, # Required. Type of this resource.
      },
    ],
  },
  &quot;includeAllResources&quot;: { # Message for include_all_resources option. # Include all resources under the scope.
  },
  &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  &quot;profile&quot;: &quot;A String&quot;, # Required. ID of security profile of the security monitoring condition.
  &quot;scope&quot;: &quot;A String&quot;, # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  &quot;totalDeployedResources&quot;: 42, # Output only. Total number of deployed resources within scope.
  &quot;totalMonitoredResources&quot;: 42, # Output only. Total number of monitored resources within this condition.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time of the security monitoring condition update.
}</pre>
</div>

</body></html>