File: networksecurity_v1beta1.projects.locations.dnsThreatDetectors.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (292 lines) | stat: -rw-r--r-- 11,758 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
<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="networksecurity_v1beta1.html">Network Security API</a> . <a href="networksecurity_v1beta1.projects.html">projects</a> . <a href="networksecurity_v1beta1.projects.locations.html">locations</a> . <a href="networksecurity_v1beta1.projects.locations.dnsThreatDetectors.html">dnsThreatDetectors</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, dnsThreatDetectorId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new DnsThreatDetector in a given project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single DnsThreatDetector.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single DnsThreatDetector.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists DnsThreatDetectors in a given project and location.</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">Updates the parameters of a single DnsThreatDetector.</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, dnsThreatDetectorId=None, x__xgafv=None)</code>
  <pre>Creates a new DnsThreatDetector in a given project and location.

Args:
  parent: string, Required. Value for parent of the DnsThreatDetector resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing DnsThreatDetector object.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
  &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
    &quot;A String&quot;,
  ],
  &quot;labels&quot;: { # Optional. Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
  &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
}

  dnsThreatDetectorId: string, Optional. Id of the requesting DnsThreatDetector object. If this field is not supplied, the service will generate an identifier.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing DnsThreatDetector object.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
  &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
    &quot;A String&quot;,
  ],
  &quot;labels&quot;: { # Optional. Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
  &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single DnsThreatDetector.

Args:
  name: string, Required. Name of the DnsThreatDetector resource. (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>Gets details of a single DnsThreatDetector.

Args:
  name: string, Required. Name of the DnsThreatDetector resource (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing DnsThreatDetector object.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
  &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
    &quot;A String&quot;,
  ],
  &quot;labels&quot;: { # Optional. Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
  &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists DnsThreatDetectors in a given project and location.

Args:
  parent: string, Required. Parent value for ListDnsThreatDetectorsRequest (required)
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A page token, received from a previous `ListDnsThreatDetectorsRequest` 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:

    { # Message for response to listing DnsThreatDetectors.
  &quot;dnsThreatDetectors&quot;: [ # The list of DnsThreatDetector resources.
    { # Message describing DnsThreatDetector object.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
      &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
        &quot;A String&quot;,
      ],
      &quot;labels&quot;: { # Optional. Labels as key value pairs
        &quot;a_key&quot;: &quot;A String&quot;,
      },
      &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
      &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page.
  &quot;unreachable&quot;: [ # Unordered list. Unreachable `DnsThreatDetector` resources.
    &quot;A String&quot;,
  ],
}</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>Updates the parameters of a single DnsThreatDetector.

Args:
  name: string, Immutable. Identifier. Name of the DnsThreatDetector resource. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message describing DnsThreatDetector object.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
  &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
    &quot;A String&quot;,
  ],
  &quot;labels&quot;: { # Optional. Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
  &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
}

  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the DnsThreatDetector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not provided then all fields present in the request will be overwritten.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing DnsThreatDetector object.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
  &quot;excludedNetworks&quot;: [ # Optional. A list of Network resource names which are exempt from the configuration in this DnsThreatDetector. Example: `projects/PROJECT_ID/global/networks/NETWORK_NAME`.
    &quot;A String&quot;,
  ],
  &quot;labels&quot;: { # Optional. Labels as key value pairs
    &quot;a_key&quot;: &quot;A String&quot;,
  },
  &quot;name&quot;: &quot;A String&quot;, # Immutable. Identifier. Name of the DnsThreatDetector resource.
  &quot;provider&quot;: &quot;A String&quot;, # Required. The provider used for DNS threat analysis.
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. [Output only] Update time stamp
}</pre>
</div>

</body></html>