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

<h1><a href="firebasehosting_v1beta1.html">Firebase Hosting API</a> . <a href="firebasehosting_v1beta1.projects.html">projects</a> . <a href="firebasehosting_v1beta1.projects.sites.html">sites</a> . <a href="firebasehosting_v1beta1.projects.sites.domains.html">domains</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

84

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

85

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

86

87

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

88

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

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

93

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

94

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

95

<h3>Method Details</h3>

96

97

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

98

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

99

100

Args:

101

parent: string, Required. The parent to create the domain association for, in the format:

102

<code>sites/<var>site-name</var></code> (required)

103

body: object, The request body.

104

The object takes the form of:

105

106

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

107

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

108

# the path of the redirect but replace the requested domain with the one

109

# specified in the redirect configuration.

110

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

111

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

112

},

113

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

114

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

115

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

116

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

117

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

118

# health of the DNS resolution for the domain.

119

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

120

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

121

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

122

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

123

# satisfy the challenge.

124

},

125

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting

126

# provisions an SSL certificate for the domain.

127

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

# DNS fetch.

"A String",

],

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

132

"A String",

133

],

134

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

135

"A String",

136

],

137

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

138

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

139

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

140

# challenge.

141

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

142

# certificate challenge.

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

154

155

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

156

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

157

# the path of the redirect but replace the requested domain with the one

158

# specified in the redirect configuration.

159

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

160

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

161

},

162

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

163

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

164

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

165

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

166

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

167

# health of the DNS resolution for the domain.

168

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

169

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

170

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

171

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

172

# satisfy the challenge.

173

},

174

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting

175

# 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",

],

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

181

"A String",

182

],

183

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

184

"A String",

185

],

186

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

187

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

188

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

189

# challenge.

190

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

191

# certificate challenge.

},

},

}</pre>

</div>

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

199

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

200

201

Args:

202

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

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

211

{ # A generic empty message that you can re-use to avoid defining duplicated

212

# empty messages in your APIs. A typical example is to use it as the request

213

# or the response type of an API method. For instance:

214

#

215

# service Foo {

216

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

217

# }

218

#

219

# The JSON representation for `Empty` is empty JSON object `{}`.

}</pre>

</div>

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

225

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

226

227

Args:

228

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

229

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

236

237

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

238

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

239

# the path of the redirect but replace the requested domain with the one

240

# specified in the redirect configuration.

241

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

242

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

243

},

244

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

245

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

246

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

247

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

248

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

249

# health of the DNS resolution for the domain.

250

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

251

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

252

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

253

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

254

# satisfy the challenge.

255

},

256

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting

257

# provisions an SSL certificate for the domain.

258

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

# DNS fetch.

"A String",

],

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

263

"A String",

264

],

265

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

266

"A String",

267

],

268

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

269

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

270

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

271

# challenge.

272

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

273

# certificate challenge.

},

},

}</pre>

</div>

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

281

<pre>Lists the domains for the specified site.

282

283

Args:

284

parent: string, Required. The parent for which to list domains, in the format:

285

<code>sites/<var>site-name</var></code> (required)

286

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

287

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

288

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

295

296

{ # The response to listing Domains.

297

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

298

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

299

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

300

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

301

# the path of the redirect but replace the requested domain with the one

302

# specified in the redirect configuration.

303

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

304

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

305

},

306

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

307

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

308

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

309

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

310

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

311

# health of the DNS resolution for the domain.

312

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

313

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

314

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

315

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

316

# satisfy the challenge.

317

},

318

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting

319

# provisions an SSL certificate for the domain.

320

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

# DNS fetch.

"A String",

],

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

325

"A String",

326

],

327

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

328

"A String",

329

],

330

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

331

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

332

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

333

# challenge.

334

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

335

# certificate challenge.

},

},

},

],

}</pre>

</div>

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

345

<pre>Retrieves the next page of results.

346

347

Args:

348

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

349

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

350

351

Returns:

352

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

353

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>

359

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

not exist.

Args:

name: string, Required. The name of the domain association to update or create, if an

364

association doesn't already exist. (required)

365

body: object, The request body.

366

The object takes the form of:

367

368

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

369

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

370

# the path of the redirect but replace the requested domain with the one

371

# specified in the redirect configuration.

372

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

373

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

374

},

375

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

376

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

377

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

378

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

379

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

380

# health of the DNS resolution for the domain.

381

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

382

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

383

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

384

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

385

# satisfy the challenge.

386

},

387

"certStatus": "A String", # The certificate provisioning status; updated when Firebase Hosting

388

# provisions an SSL certificate for the domain.

389

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

# DNS fetch.

"A String",

],

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

394

"A String",

395

],

396

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

397

"A String",

398

],

399

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

400

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

401

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

402

# challenge.

403

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

404

# certificate challenge.

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

416

417

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

418

"domainRedirect": { # Defines the behavior of a domain-level redirect. Domain redirects preserve # If set, the domain should redirect with the provided parameters.

419

# the path of the redirect but replace the requested domain with the one

420

# specified in the redirect configuration.

421

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

422

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

423

},

424

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

425

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

426

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

427

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

428

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

429

# health of the DNS resolution for the domain.

430

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

431

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

432

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

433

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

434

# satisfy the challenge.