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

90

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

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.

Bu Sun Kim

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

[diff] [blame^]

114

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

115

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

116

"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.

117

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

118

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

119

},

120

"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.

121

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

122

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

123

"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]

124

},

Bu Sun Kim

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

[diff] [blame^]

125

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

126

"A String",

127

],

128

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

129

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

130

"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]

131

},

Bu Sun Kim

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

[diff] [blame^]

132

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

133

"A String",

134

],

135

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

136

"A String",

137

],

138

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

139

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

140

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

141

},

142

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

143

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

144

}

Bu Sun Kim

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

[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.

Bu Sun Kim

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

[diff] [blame^]

155

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

156

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

157

"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.

158

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

159

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

160

},

161

"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.

162

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

163

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

164

"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]

165

},

Bu Sun Kim

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

[diff] [blame^]

166

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

167

"A String",

168

],

169

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

170

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

171

"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]

172

},

Bu Sun Kim

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

[diff] [blame^]

173

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

174

"A String",

175

],

176

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

177

"A String",

178

],

179

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

180

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

181

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

182

},

183

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

184

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

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.

Bu Sun Kim

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

[diff] [blame^]

221

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

222

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

223

"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.

224

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

225

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

226

},

227

"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.

228

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

229

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

230

"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]

231

},

Bu Sun Kim

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

[diff] [blame^]

232

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

233

"A String",

234

],

235

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

236

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

237

"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]

238

},

Bu Sun Kim

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

[diff] [blame^]

239

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

240

"A String",

241

],

242

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

243

"A String",

244

],

245

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

246

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

247

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

248

},

249

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

250

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

251

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

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

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

261

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

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.

Dmitry Frenkel

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

[diff] [blame]

271

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

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

Bu Sun Kim

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

[diff] [blame^]

274

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

275

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

276

"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.

277

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

278

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

Bu Sun Kim

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

[diff] [blame]

279

},

Bu Sun Kim

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

[diff] [blame^]

280

"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.

281

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

282

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

283

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

284

},

285

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

286

"A String",

287

],

288

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

289

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

290

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

291

},

292

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

293

"A String",

294

],

295

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

296

"A String",

297

],

298

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

299

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

300

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

301

},

302

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

303

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

304

},

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.

Bu Sun Kim

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

[diff] [blame^]

333

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

334

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

335

"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.

336

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

337

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

338

},

339

"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.

340

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

341

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

342

"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]

343

},

Bu Sun Kim

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

[diff] [blame^]

344

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

345

"A String",

346

],

347

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

348

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

349

"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]

350

},

Bu Sun Kim

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

[diff] [blame^]

351

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

352

"A String",

353

],

354

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

355

"A String",

356

],

357

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

358

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

359

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

360

},

361

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

362

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

363

}

Bu Sun Kim

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

[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.

Bu Sun Kim

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

[diff] [blame^]

374

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

375

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

376

"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.

377

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

378

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

379

},

380

"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.

381

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

382

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

383

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

Bu Sun Kim