| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <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></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="firebasehosting_v1beta1.projects.sites.channels.html">channels()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the channels Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="firebasehosting_v1beta1.projects.sites.domains.html">domains()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the domains Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="firebasehosting_v1beta1.projects.sites.releases.html">releases()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the releases Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="firebasehosting_v1beta1.projects.sites.versions.html">versions()</a></code> |
| 94 | </p> |
| 95 | <p class="firstline">Returns the versions Resource.</p> |
| 96 | |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p> |
| 99 | <p class="firstline">Gets the Hosting metadata for a specific site.</p> |
| 100 | <p class="toc_element"> |
| 101 | <code><a href="#updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 102 | <p class="firstline">Sets the Hosting metadata for a specific site.</p> |
| 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| 105 | <code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code> |
| 106 | <pre>Gets the Hosting metadata for a specific site. |
| 107 | |
| 108 | Args: |
| 109 | name: string, Required. The site for which to get the SiteConfig, in the format: |
| 110 | <code>sites/<var>site-name</var>/config</code> (required) |
| 111 | x__xgafv: string, V1 error format. |
| 112 | Allowed values |
| 113 | 1 - v1 error format |
| 114 | 2 - v2 error format |
| 115 | |
| 116 | Returns: |
| 117 | An object of the form: |
| 118 | |
| 119 | { # A `SiteConfig` contains metadata associated with a specific site that |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 120 | # controls Firebase Hosting serving behavior |
| 121 | "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before |
| 122 | # automatic deletion. When a new version is deployed, content for versions |
| 123 | # in storage in excess of this number will be deleted, and will no longer be |
| 124 | # billed for storage usage. Oldest versions will be deleted first; sites are |
| 125 | # created with an unlimited number of max_versions by default. |
| 126 | "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud |
| 127 | # Logging. |
| 128 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | </div> |
| 130 | |
| 131 | <div class="method"> |
| 132 | <code class="details" id="updateConfig">updateConfig(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 133 | <pre>Sets the Hosting metadata for a specific site. |
| 134 | |
| 135 | Args: |
| 136 | name: string, Required. The site for which to update the SiteConfig, in the format: |
| 137 | <code>sites/<var>site-name</var>/config</code> (required) |
| 138 | body: object, The request body. |
| 139 | The object takes the form of: |
| 140 | |
| 141 | { # A `SiteConfig` contains metadata associated with a specific site that |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 142 | # controls Firebase Hosting serving behavior |
| 143 | "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before |
| 144 | # automatic deletion. When a new version is deployed, content for versions |
| 145 | # in storage in excess of this number will be deleted, and will no longer be |
| 146 | # billed for storage usage. Oldest versions will be deleted first; sites are |
| 147 | # created with an unlimited number of max_versions by default. |
| 148 | "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud |
| 149 | # Logging. |
| 150 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | |
| 152 | updateMask: string, A set of field names from your [site configuration](../sites.SiteConfig) |
| 153 | that you want to update. |
| 154 | <br>A field will be overwritten if, and only if, it's in the mask. |
| 155 | <br>If a mask is not provided then a default mask of only |
| 156 | [`max_versions`](../sites.SiteConfig.max_versions) will be used. |
| 157 | x__xgafv: string, V1 error format. |
| 158 | Allowed values |
| 159 | 1 - v1 error format |
| 160 | 2 - v2 error format |
| 161 | |
| 162 | Returns: |
| 163 | An object of the form: |
| 164 | |
| 165 | { # A `SiteConfig` contains metadata associated with a specific site that |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 166 | # controls Firebase Hosting serving behavior |
| 167 | "maxVersions": "A String", # The number of FINALIZED versions that will be held for a site before |
| 168 | # automatic deletion. When a new version is deployed, content for versions |
| 169 | # in storage in excess of this number will be deleted, and will no longer be |
| 170 | # billed for storage usage. Oldest versions will be deleted first; sites are |
| 171 | # created with an unlimited number of max_versions by default. |
| 172 | "cloudLoggingEnabled": True or False, # Whether or not web requests made by site visitors are logged via Cloud |
| 173 | # Logging. |
| 174 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | </div> |
| 176 | |
| 177 | </body></html> |