Blame - docs/dyn/dns_v1beta2.policies.html - platform/external/python/google-api-python-client

2019-06-14 16:50:42 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

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>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

75

<h1><a href="dns_v1beta2.html">Cloud DNS API</a> . <a href="dns_v1beta2.policies.html">policies</a></h1>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

78

<code><a href="#create">create(project, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Create a new Policy</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

81

<code><a href="#delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Delete a previously created Policy. Will fail if the policy is still being</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

84

<code><a href="#get">get(project, policy, clientOperationId=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Fetch the representation of an existing Policy.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

87

<code><a href="#list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Enumerate all Policies associated with a project.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

93

<code><a href="#patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Apply a partial update to an existing Policy.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

96

<code><a href="#update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Update an existing Policy.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

98

<h3>Method Details</h3>

99

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

100

<code class="details" id="create">create(project, body=None, clientOperationId=None, x__xgafv=None)</code>

101

<pre>Create a new Policy

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

102

103

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

104

project: string, Identifies the project addressed by this request. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

105

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

The object takes the form of:

107

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

108

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

109

# Cloud resources.

110

"kind": "dns#policy",

111

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

112

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

114

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

115

# This should be formatted like

116

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

117

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

118

},

119

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

120

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

121

# for the user's convenience. Has no effect on the policy's function.

122

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

123

# applications over VPN connections. When enabled, a virtual IP address will

124

# be allocated from each of the sub-networks that are bound to this policy.

125

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

126

# specified, all DNS queries are forwarded to a name server that you

127

# choose. Names such as .internal are not available when an alternative

128

# name server is specified.

129

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

130

# specified, all DNS queries are forwarded to a name server that you

131

# choose. Names such as .internal are not available when an alternative

132

# name server is specified.

133

{

134

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

135

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

136

# Cloud DNS will make forwarding decision based on address ranges,

137

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

138

# Internet. When set to PRIVATE, Cloud DNS will always send queries

139

# through VPC for this target

140

"ipv4Address": "A String", # IPv4 address to forward to.

141

},

142

],

143

"kind": "dns#policyAlternativeNameServerConfig",

144

},

145

"name": "A String", # User assigned name for this policy.

146

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

147

# Defaults to no logging if not set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

148

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

149

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

150

clientOperationId: string, For mutating operation requests only. An optional identifier

151

specified by the client. Must be unique for operation resources in the

152

Operations collection.

153

x__xgafv: string, V1 error format.

154

Allowed values

155

1 - v1 error format

156

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

157

158

Returns:

159

An object of the form:

160

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

161

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

162

# Cloud resources.

163

"kind": "dns#policy",

164

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

165

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

166

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

167

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

168

# This should be formatted like

169

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

170

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

171

},

172

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

173

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

174

# for the user's convenience. Has no effect on the policy's function.

175

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

176

# applications over VPN connections. When enabled, a virtual IP address will

177

# be allocated from each of the sub-networks that are bound to this policy.

178

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

179

# specified, all DNS queries are forwarded to a name server that you

180

# choose. Names such as .internal are not available when an alternative

181

# name server is specified.

182

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

183

# specified, all DNS queries are forwarded to a name server that you

184

# choose. Names such as .internal are not available when an alternative

185

# name server is specified.

186

{

187

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

188

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

189

# Cloud DNS will make forwarding decision based on address ranges,

190

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

191

# Internet. When set to PRIVATE, Cloud DNS will always send queries

192

# through VPC for this target

193

"ipv4Address": "A String", # IPv4 address to forward to.

194

},

195

],

196

"kind": "dns#policyAlternativeNameServerConfig",

197

},

198

"name": "A String", # User assigned name for this policy.

199

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

200

# Defaults to no logging if not set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

201

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

205

<code class="details" id="delete">delete(project, policy, clientOperationId=None, x__xgafv=None)</code>

206

<pre>Delete a previously created Policy. Will fail if the policy is still being

207

referenced by a network.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

208

209

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

210

project: string, Identifies the project addressed by this request. (required)

211

policy: string, User given friendly name of the policy addressed by this request. (required)

212

clientOperationId: string, For mutating operation requests only. An optional identifier

213

specified by the client. Must be unique for operation resources in the

214

Operations collection.

215

x__xgafv: string, V1 error format.

216

Allowed values

217

1 - v1 error format

218

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

223

<code class="details" id="get">get(project, policy, clientOperationId=None, x__xgafv=None)</code>

224

<pre>Fetch the representation of an existing Policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

225

226

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

227

project: string, Identifies the project addressed by this request. (required)

228

policy: string, User given friendly name of the policy addressed by this request. (required)

229

clientOperationId: string, For mutating operation requests only. An optional identifier

230

specified by the client. Must be unique for operation resources in the

231

Operations collection.

232

x__xgafv: string, V1 error format.

233

Allowed values

234

1 - v1 error format

235

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

236

237

Returns:

238

An object of the form:

239

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

240

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

241

# Cloud resources.

242

"kind": "dns#policy",

243

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

244

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

245

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

246

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

247

# This should be formatted like

248

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

249

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

250

},

251

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

252

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

253

# for the user's convenience. Has no effect on the policy's function.

254

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

255

# applications over VPN connections. When enabled, a virtual IP address will

256

# be allocated from each of the sub-networks that are bound to this policy.

257

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

258

# specified, all DNS queries are forwarded to a name server that you

259

# choose. Names such as .internal are not available when an alternative

260

# name server is specified.

261

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

262

# specified, all DNS queries are forwarded to a name server that you

263

# choose. Names such as .internal are not available when an alternative

264

# name server is specified.

265

{

266

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

267

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

268

# Cloud DNS will make forwarding decision based on address ranges,

269

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

270

# Internet. When set to PRIVATE, Cloud DNS will always send queries

271

# through VPC for this target

272

"ipv4Address": "A String", # IPv4 address to forward to.

273

},

274

],

275

"kind": "dns#policyAlternativeNameServerConfig",

276

},

277

"name": "A String", # User assigned name for this policy.

278

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

279

# Defaults to no logging if not set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

280

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

284

<code class="details" id="list">list(project, pageToken=None, maxResults=None, x__xgafv=None)</code>

285

<pre>Enumerate all Policies associated with a project.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

286

287

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

288

project: string, Identifies the project addressed by this request. (required)

289

pageToken: string, Optional. A tag returned by a previous list request that was truncated.

290

Use this parameter to continue a previous list request.

291

maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the

292

server will decide how many results to return.

293

x__xgafv: string, V1 error format.

294

Allowed values

295

1 - v1 error format

296

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

297

298

Returns:

299

An object of the form:

300

301

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

302

"header": { # Elements common to every response.

303

"operationId": "A String", # For mutating operation requests that completed successfully.

304

# This is the client_operation_id if the client specified it,

305

# otherwise it is generated by the server (output only).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

306

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

307

"policies": [ # The policy resources.

308

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

309

# Cloud resources.

310

"kind": "dns#policy",

311

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

312

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

313

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

314

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

315

# This should be formatted like

316

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

317

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

318

},

319

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

320

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

321

# for the user's convenience. Has no effect on the policy's function.

322

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

323

# applications over VPN connections. When enabled, a virtual IP address will

324

# be allocated from each of the sub-networks that are bound to this policy.

325

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

326

# specified, all DNS queries are forwarded to a name server that you

327

# choose. Names such as .internal are not available when an alternative

328

# name server is specified.

329

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

330

# specified, all DNS queries are forwarded to a name server that you

331

# choose. Names such as .internal are not available when an alternative

332

# name server is specified.

333

{

334

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

335

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

336

# Cloud DNS will make forwarding decision based on address ranges,

337

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

338

# Internet. When set to PRIVATE, Cloud DNS will always send queries

339

# through VPC for this target

340

"ipv4Address": "A String", # IPv4 address to forward to.

341

},

342

],

343

"kind": "dns#policyAlternativeNameServerConfig",

344

},

345

"name": "A String", # User assigned name for this policy.

346

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

347

# Defaults to no logging if not set.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

348

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

349

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

350

"kind": "dns#policiesListResponse", # Type of resource.

351

"nextPageToken": "A String", # The presence of this field indicates that there exist more results

352

# following your last page of results in pagination order. To fetch them,

353

# make another list request using this value as your page token.

354

#

355

# In this way you can retrieve the complete contents of even very large

356

# collections one page at a time. However, if the contents of the collection

357

# change between the first and last paginated list request, the set of all

358

# elements returned will be an inconsistent view of the collection. There is

359

# no way to retrieve a consistent snapshot of a collection larger than the

360

# maximum page size.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

366

<pre>Retrieves the next page of results.

367

368

Args:

369

previous_request: The request for the previous page. (required)

370

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

371

372

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

374

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

379

<code class="details" id="patch">patch(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>

380

<pre>Apply a partial update to an existing Policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

381

382

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

383

project: string, Identifies the project addressed by this request. (required)

384

policy: string, User given friendly name of the policy addressed by this request. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

385

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

386

The object takes the form of:

387

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

388

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

389

# Cloud resources.

390

"kind": "dns#policy",

391

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

392

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

393

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

394

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

395

# This should be formatted like

396

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

397

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

398

},

399

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

400

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

401

# for the user's convenience. Has no effect on the policy's function.

402

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

403

# applications over VPN connections. When enabled, a virtual IP address will

404

# be allocated from each of the sub-networks that are bound to this policy.

405

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

406

# specified, all DNS queries are forwarded to a name server that you

407

# choose. Names such as .internal are not available when an alternative

408

# name server is specified.

409

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

410

# specified, all DNS queries are forwarded to a name server that you

411

# choose. Names such as .internal are not available when an alternative

412

# name server is specified.

413

{

414

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

415

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

416

# Cloud DNS will make forwarding decision based on address ranges,

417

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

418

# Internet. When set to PRIVATE, Cloud DNS will always send queries

419

# through VPC for this target

420

"ipv4Address": "A String", # IPv4 address to forward to.

421

},

422

],

423

"kind": "dns#policyAlternativeNameServerConfig",

424

},

425

"name": "A String", # User assigned name for this policy.

426

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

427

# Defaults to no logging if not set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

428

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

429

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

430

clientOperationId: string, For mutating operation requests only. An optional identifier

431

specified by the client. Must be unique for operation resources in the

432

Operations collection.

433

x__xgafv: string, V1 error format.

434

Allowed values

435

1 - v1 error format

436

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

437

438

Returns:

439

An object of the form:

440

441

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

442

"policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private

443

# Cloud resources.

444

"kind": "dns#policy",

445

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

446

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

447

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

448

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

449

# This should be formatted like

450

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

451

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

452

},

453

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

454

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

455

# for the user's convenience. Has no effect on the policy's function.

456

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

457

# applications over VPN connections. When enabled, a virtual IP address will

458

# be allocated from each of the sub-networks that are bound to this policy.

459

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

460

# specified, all DNS queries are forwarded to a name server that you

461

# choose. Names such as .internal are not available when an alternative

462

# name server is specified.

463

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

464

# specified, all DNS queries are forwarded to a name server that you

465

# choose. Names such as .internal are not available when an alternative

466

# name server is specified.

467

{

468

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

469

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

470

# Cloud DNS will make forwarding decision based on address ranges,

471

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

472

# Internet. When set to PRIVATE, Cloud DNS will always send queries

473

# through VPC for this target

474

"ipv4Address": "A String", # IPv4 address to forward to.

475

},

476

],

477

"kind": "dns#policyAlternativeNameServerConfig",

478

},

479

"name": "A String", # User assigned name for this policy.

480

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

481

# Defaults to no logging if not set.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

482

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

483

"header": { # Elements common to every response.

484

"operationId": "A String", # For mutating operation requests that completed successfully.

485

# This is the client_operation_id if the client specified it,

486

# otherwise it is generated by the server (output only).

487

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

492

<code class="details" id="update">update(project, policy, body=None, clientOperationId=None, x__xgafv=None)</code>

493

<pre>Update an existing Policy.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

494

495

Args:

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

496

project: string, Identifies the project addressed by this request. (required)

497

policy: string, User given friendly name of the policy addressed by this request. (required)

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

498

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

499

The object takes the form of:

500

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

501

{ # A policy is a collection of DNS rules applied to one or more Virtual Private

502

# Cloud resources.

503

"kind": "dns#policy",

504

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

505

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

506

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

507

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

508

# This should be formatted like

509

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

510

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

511

},

512

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

513

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

514

# for the user's convenience. Has no effect on the policy's function.

515

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

516

# applications over VPN connections. When enabled, a virtual IP address will

517

# be allocated from each of the sub-networks that are bound to this policy.

518

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

519

# specified, all DNS queries are forwarded to a name server that you

520

# choose. Names such as .internal are not available when an alternative

521

# name server is specified.

522

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

523

# specified, all DNS queries are forwarded to a name server that you

524

# choose. Names such as .internal are not available when an alternative

525

# name server is specified.

526

{

527

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

528

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

529

# Cloud DNS will make forwarding decision based on address ranges,

530

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

531

# Internet. When set to PRIVATE, Cloud DNS will always send queries

532

# through VPC for this target

533

"ipv4Address": "A String", # IPv4 address to forward to.

534

},

535

],

536

"kind": "dns#policyAlternativeNameServerConfig",

537

},

538

"name": "A String", # User assigned name for this policy.

539

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

540

# Defaults to no logging if not set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

541

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

542

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

543

clientOperationId: string, For mutating operation requests only. An optional identifier

544

specified by the client. Must be unique for operation resources in the

545

Operations collection.

546

x__xgafv: string, V1 error format.

547

Allowed values

548

1 - v1 error format

549

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

550

551

Returns:

552

An object of the form:

553

554

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

555

"policy": { # A policy is a collection of DNS rules applied to one or more Virtual Private

556

# Cloud resources.

557

"kind": "dns#policy",

558

"id": "A String", # Unique identifier for the resource; defined by the server (output only).

559

"networks": [ # List of network names specifying networks to which this policy is applied.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

560

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

561

"networkUrl": "A String", # The fully qualified URL of the VPC network to bind to.

562

# This should be formatted like

563

# https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}

564

"kind": "dns#policyNetwork",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

565

},

566

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

567

"description": "A String", # A mutable string of at most 1024 characters associated with this resource

568

# for the user's convenience. Has no effect on the policy's function.

569

"enableInboundForwarding": True or False, # Allows networks bound to this policy to receive DNS queries sent by VMs or

570

# applications over VPN connections. When enabled, a virtual IP address will

571

# be allocated from each of the sub-networks that are bound to this policy.

572

"alternativeNameServerConfig": { # Sets an alternative name server for the associated networks. When

573

# specified, all DNS queries are forwarded to a name server that you

574

# choose. Names such as .internal are not available when an alternative

575

# name server is specified.

576

"targetNameServers": [ # Sets an alternative name server for the associated networks. When

577

# specified, all DNS queries are forwarded to a name server that you

578

# choose. Names such as .internal are not available when an alternative

579

# name server is specified.

580

{

581

"kind": "dns#policyAlternativeNameServerConfigTargetNameServer",

582

"forwardingPath": "A String", # Forwarding path for this TargetNameServer, if unset or set to DEFAULT,

583

# Cloud DNS will make forwarding decision based on address ranges,

584

# i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the

585

# Internet. When set to PRIVATE, Cloud DNS will always send queries

586

# through VPC for this target

587

"ipv4Address": "A String", # IPv4 address to forward to.

588

},

589

],

590

"kind": "dns#policyAlternativeNameServerConfig",

591

},

592

"name": "A String", # User assigned name for this policy.

593

"enableLogging": True or False, # Controls whether logging is enabled for the networks bound to this policy.

594

# Defaults to no logging if not set.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

595

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

596

"header": { # Elements common to every response.

597

"operationId": "A String", # For mutating operation requests that completed successfully.

598

# This is the client_operation_id if the client specified it,

599

# otherwise it is generated by the server (output only).

600

},

Bu Sun Kim