Blame - docs/dyn/firebasehosting_v1beta1.projects.sites.domains.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

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

[diff] [blame]

81

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

82

<p class="firstline">Creates a domain mapping on the specified site.</p>

83

84

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

85

<p class="firstline">Deletes the existing domain mapping on the specified site.</p>

86

87

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

88

<p class="firstline">Gets a domain mapping on the specified site.</p>

89

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

90

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

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Lists the domains for the specified site.</p>

92

93

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

94

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

95

96

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<p class="firstline">Updates the specified domain mapping, creating the mapping as if it does not exist.</p>

Bu Sun Kim

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

[diff] [blame]

98

<h3>Method Details</h3>

99

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

105

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

106

<pre>Creates a domain mapping on the specified site.

107

108

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

109

parent: string, Required. The parent to create the domain association for, in the format: sites/site-name (required)

Bu Sun Kim

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

[diff] [blame]

110

body: object, The request body.

111

The object takes the form of:

112

113

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

114

"updateTime": "A String", # Output only. The time at which the domain was last updated.

115

"domainName": "A String", # Required. The domain name of the association.

116

"site": "A String", # Required. The site name of the association.

117

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

118

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

119

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

120

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

121

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

122

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

123

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

124

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

125

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

126

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

127

"A String",

128

],

129

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

130

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

131

"discoveredIps": [ # The IPs found at the last DNS fetch.

132

"A String",

133

],

134

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

135

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

"A String",

],

},

"status": "A String", # Output only. Additional status of the domain association.

140

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

141

"domainName": "A String", # Required. The domain name to redirect to.

142

"type": "A String", # Required. The redirect status code.

143

},

144

}

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

145

146

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

153

154

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

155

"updateTime": "A String", # Output only. The time at which the domain was last updated.

156

"domainName": "A String", # Required. The domain name of the association.

157

"site": "A String", # Required. The site name of the association.

158

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

159

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

160

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

161

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

162

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

163

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

164

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

165

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

166

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

167

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

168

"A String",

169

],

170

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

171

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

172

"discoveredIps": [ # The IPs found at the last DNS fetch.

173

"A String",

174

],

175

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

176

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

"A String",

],

},

"status": "A String", # Output only. Additional status of the domain association.

181

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

182

"domainName": "A String", # Required. The domain name to redirect to.

183

"type": "A String", # Required. The redirect status code.

184

},

185

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

190

<pre>Deletes the existing domain mapping on the specified site.

191

192

Args:

193

name: string, Required. The name of the domain association to delete. (required)

194

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

201

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

202

{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

208

<pre>Gets a domain mapping on the specified site.

209

210

Args:

211

name: string, Required. The name of the domain configuration to get. (required)

212

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

219

220

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

221

"updateTime": "A String", # Output only. The time at which the domain was last updated.

222

"domainName": "A String", # Required. The domain name of the association.

223

"site": "A String", # Required. The site name of the association.

224

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

225

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

226

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

227

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Bu Sun Kim

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

[diff] [blame]

228

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

229

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

230

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

231

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Bu Sun Kim

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

[diff] [blame]

232

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

233

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

234

"A String",

235

],

236

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

237

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

238

"discoveredIps": [ # The IPs found at the last DNS fetch.

239

"A String",

240

],

241

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

242

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

"A String",

],

},

"status": "A String", # Output only. Additional status of the domain association.

247

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

248

"domainName": "A String", # Required. The domain name to redirect to.

249

"type": "A String", # Required. The redirect status code.

250

},

251

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

255

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

Bu Sun Kim

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

[diff] [blame]

256

<pre>Lists the domains for the specified site.

257

258

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

259

parent: string, Required. The parent for which to list domains, in the format: sites/ site-name (required)

Bu Sun Kim

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

[diff] [blame]

260

pageSize: integer, The page size to return. Defaults to 50.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

261

pageToken: string, The next_page_token from a previous request, if provided.

Bu Sun Kim

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

[diff] [blame]

262

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

269

270

{ # The response to listing Domains.

Bu Sun Kim

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

[diff] [blame]

271

"domains": [ # The list of domains, if any exist.

272

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

273

"updateTime": "A String", # Output only. The time at which the domain was last updated.

274

"domainName": "A String", # Required. The domain name of the association.

275

"site": "A String", # Required. The site name of the association.

276

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

277

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

278

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

279

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

280

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

281

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

282

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

283

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

284

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

285

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

286

"A String",

287

],

288

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

289

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

290

"discoveredIps": [ # The IPs found at the last DNS fetch.

291

"A String",

292

],

293

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

294

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

295

"A String",

296

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

297

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

298

"status": "A String", # Output only. Additional status of the domain association.

299

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

300

"domainName": "A String", # Required. The domain name to redirect to.

301

"type": "A String", # Required. The redirect status code.

302

},

303

},

Bu Sun Kim

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

[diff] [blame]

304

],

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

305

"nextPageToken": "A String", # The pagination token, if more results exist.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

311

<pre>Retrieves the next page of results.

312

313

Args:

314

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

315

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

316

317

Returns:

318

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

319

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

</pre>

</div>

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

325

<pre>Updates the specified domain mapping, creating the mapping as if it does not exist.

Bu Sun Kim

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

[diff] [blame]

326

327

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

328

name: string, Required. The name of the domain association to update or create, if an association doesn't already exist. (required)

Bu Sun Kim

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

[diff] [blame]

329

body: object, The request body.

330

The object takes the form of:

331

332

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

333

"updateTime": "A String", # Output only. The time at which the domain was last updated.

334

"domainName": "A String", # Required. The domain name of the association.

335

"site": "A String", # Required. The site name of the association.

336

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

337

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

338

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

339

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

340

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

341

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

342

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

343

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

344

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

345

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

346

"A String",

347

],

348

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

349

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

350

"discoveredIps": [ # The IPs found at the last DNS fetch.

351

"A String",

352

],

353

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

354

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

"A String",

],

},

"status": "A String", # Output only. Additional status of the domain association.

359

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

360

"domainName": "A String", # Required. The domain name to redirect to.

361

"type": "A String", # Required. The redirect status code.

362

},

363

}

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

364

365

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

372

373

{ # The intended behavior and status information of a domain.

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

374

"updateTime": "A String", # Output only. The time at which the domain was last updated.

375

"domainName": "A String", # Required. The domain name of the association.

376

"site": "A String", # Required. The site name of the association.

377

"provisioning": { # The current certificate provisioning status information for a domain. # Output only. Information about the provisioning of certificates and the health of the DNS resolution for the domain.

378

"certChallengeDns": { # Represents a DNS certificate challenge. # The DNS challenge for generating a certificate.

379

"domainName": "A String", # The domain name upon which the DNS challenge must be satisfied.

380

"token": "A String", # The value that must be present as a TXT record on the domain name to satisfy the challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

381

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

382

"certChallengeHttp": { # Represents an HTTP certificate challenge. # The HTTP challenge for generating a certificate.

383

"path": "A String", # The URL path on which to serve the specified token to satisfy the certificate challenge.

384

"token": "A String", # The token to serve at the specified URL path to satisfy the certificate challenge.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

385

},

Yoshi Automation Bot

2020-11-25 07:50:41 -0800

[diff] [blame^]

386

"expectedIps": [ # The list of IPs to which the domain is expected to resolve.

387

"A String",

388

],

389

"dnsStatus": "A String", # The DNS record match status as of the last DNS fetch.

390

"dnsFetchTime": "A String", # The time at which the last DNS fetch occurred.

391

"discoveredIps": [ # The IPs found at the last DNS fetch.

392

"A String",

393

],

394

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting provisions an SSL certificate for the domain.

395

"certChallengeDiscoveredTxt": [ # The TXT records (for the certificate challenge) that were found at the last DNS fetch.

"A String",

],

},

"status": "A String", # Output only. Additional status of the domain association.

400

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration. # If set, the domain should redirect with the provided parameters.

401

"domainName": "A String", # Required. The domain name to redirect to.

402

"type": "A String", # Required. The redirect status code.

403

},

404

}</pre>

Bu Sun Kim