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-26 17:16:03 -0800

[diff] [blame^]

90

<code><a href="#list">list(parent, pageToken=None, pageSize=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-26 17:16:03 -0800

[diff] [blame^]

114

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

115

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

116

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

117

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

Bu Sun Kim

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

[diff] [blame]

118

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

119

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

120

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

121

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

122

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

123

"A String",

124

],

125

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

126

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

127

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

128

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

129

},

130

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

131

"A String",

132

],

133

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

134

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

135

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

136

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

137

},

138

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

139

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

140

"A String",

141

],

Yoshi Automation Bot

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

[diff] [blame]

142

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

143

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

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-26 17:16:03 -0800

[diff] [blame^]

155

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

156

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

157

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

158

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

Yoshi Automation Bot

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

[diff] [blame]

159

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

160

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

161

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

162

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

163

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

164

"A String",

165

],

166

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

167

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

168

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

169

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

170

},

171

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

172

"A String",

173

],

174

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

175

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

176

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

177

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

178

},

179

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

180

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

181

"A String",

182

],

Yoshi Automation Bot

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

[diff] [blame]

183

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

184

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

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-26 17:16:03 -0800

[diff] [blame^]

221

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

222

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

223

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

224

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

Bu Sun Kim

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

[diff] [blame]

225

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

226

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

227

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

228

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

229

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

230

"A String",

231

],

232

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

233

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

234

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

235

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

236

},

237

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

238

"A String",

239

],

240

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

241

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

242

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

243

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

244

},

245

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

246

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

247

"A String",

248

],

Bu Sun Kim

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

[diff] [blame]

249

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

250

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

251

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

255

<code class="details" id="list">list(parent, pageToken=None, pageSize=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)

Yoshi Automation Bot

0d561ef

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

[diff] [blame]

260

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

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

261

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

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-26 17:16:03 -0800

[diff] [blame^]

273

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

274

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

275

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

276

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

Bu Sun Kim

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

[diff] [blame]

277

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

278

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

279

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

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

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

282

"A String",

283

],

284

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

285

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

286

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

287

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

288

},

289

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

290

"A String",

291

],

292

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

293

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

294

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

295

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

296

},

297

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

298

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

299

"A String",

300

],

Bu Sun Kim

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

[diff] [blame]

301

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

302

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

Bu Sun Kim

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

[diff] [blame]

303

},

Bu Sun Kim

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

[diff] [blame]

304

],

Yoshi Automation Bot

0d561ef

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-26 17:16:03 -0800

[diff] [blame^]

333

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

334

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

335

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

336

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

Bu Sun Kim

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

[diff] [blame]

337

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

338

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

339

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

340

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

341

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

342

"A String",

343

],

344

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

345

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

346

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

347

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

348

},

349

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

350

"A String",

351

],

352

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

353

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

354

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

355

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

356

},

357

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

358

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

359

"A String",

360

],

Yoshi Automation Bot

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

[diff] [blame]

361

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame^]

362

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

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-26 17:16:03 -0800

[diff] [blame^]

374

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

375

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

376

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

377

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

Yoshi Automation Bot

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

[diff] [blame]

378

},

Yoshi Automation Bot