Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -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="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.appProfiles.html">appProfiles</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 78 | <code><a href="#create">create(parent, body=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates an app profile within an instance.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, ignoreWarnings=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes an app profile from an instance.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets information about an app profile.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p> |
| 88 | <p class="firstline">Lists information about app profiles in an instance.</p> |
| 89 | <p class="toc_element"> |
| 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 | <p class="toc_element"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 93 | <code><a href="#patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">Updates an app profile within an instance.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 97 | <code class="details" id="create">create(parent, body=None, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 98 | <pre>Creates an app profile within an instance. |
| 99 | |
| 100 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 101 | parent: string, Required. The unique name of the instance in which to create the new app profile. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 103 | `projects/{project}/instances/{instance}`. (required) |
| 104 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | The object takes the form of: |
| 106 | |
| 107 | { # A configuration object describing how Cloud Bigtable should treat traffic |
| 108 | # from a particular end user application. |
| 109 | "description": "A String", # Optional long form description of the use case for this AppProfile. |
| 110 | "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the |
| 111 | # value returned from `GetAppProfile` when calling `UpdateAppProfile` to |
| 112 | # fail the request if there has been a modification in the mean time. The |
| 113 | # `update_mask` of the request need not include `etag` for this protection |
| 114 | # to apply. |
| 115 | # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and |
| 116 | # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more |
| 117 | # details. |
| 118 | "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 119 | # This option preserves read-your-writes consistency but does not improve |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | # availability. |
| 121 | "clusterId": "A String", # The cluster to which read/write requests should be routed. |
| 122 | "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are |
| 123 | # allowed by this app profile. It is unsafe to send these requests to |
| 124 | # the same table/row/column in multiple clusters. |
| 125 | }, |
| 126 | "name": "A String", # (`OutputOnly`) |
| 127 | # The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 128 | # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. |
| 129 | "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy. |
| 130 | # will fail over to the nearest cluster that is available in the event of |
| 131 | # transient errors or delays. Clusters in a region are considered |
| 132 | # equidistant. Choosing this option sacrifices read-your-writes consistency |
| 133 | # to improve availability. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | }, |
| 135 | } |
| 136 | |
| 137 | ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 138 | appProfileId: string, Required. The ID to be used when referring to the new app profile within its |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 139 | instance, e.g., just `myprofile` rather than |
| 140 | `projects/myproject/instances/myinstance/appProfiles/myprofile`. |
| 141 | x__xgafv: string, V1 error format. |
| 142 | Allowed values |
| 143 | 1 - v1 error format |
| 144 | 2 - v2 error format |
| 145 | |
| 146 | Returns: |
| 147 | An object of the form: |
| 148 | |
| 149 | { # A configuration object describing how Cloud Bigtable should treat traffic |
| 150 | # from a particular end user application. |
| 151 | "description": "A String", # Optional long form description of the use case for this AppProfile. |
| 152 | "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the |
| 153 | # value returned from `GetAppProfile` when calling `UpdateAppProfile` to |
| 154 | # fail the request if there has been a modification in the mean time. The |
| 155 | # `update_mask` of the request need not include `etag` for this protection |
| 156 | # to apply. |
| 157 | # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and |
| 158 | # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more |
| 159 | # details. |
| 160 | "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 161 | # This option preserves read-your-writes consistency but does not improve |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 162 | # availability. |
| 163 | "clusterId": "A String", # The cluster to which read/write requests should be routed. |
| 164 | "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are |
| 165 | # allowed by this app profile. It is unsafe to send these requests to |
| 166 | # the same table/row/column in multiple clusters. |
| 167 | }, |
| 168 | "name": "A String", # (`OutputOnly`) |
| 169 | # The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 170 | # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. |
| 171 | "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy. |
| 172 | # will fail over to the nearest cluster that is available in the event of |
| 173 | # transient errors or delays. Clusters in a region are considered |
| 174 | # equidistant. Choosing this option sacrifices read-your-writes consistency |
| 175 | # to improve availability. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 176 | }, |
| 177 | }</pre> |
| 178 | </div> |
| 179 | |
| 180 | <div class="method"> |
| 181 | <code class="details" id="delete">delete(name, ignoreWarnings=None, x__xgafv=None)</code> |
| 182 | <pre>Deletes an app profile from an instance. |
| 183 | |
| 184 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 185 | name: string, Required. The unique name of the app profile to be deleted. Values are of the form |
| 186 | `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required) |
| 187 | ignoreWarnings: boolean, Required. If true, ignore safety checks when deleting the app profile. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 188 | x__xgafv: string, V1 error format. |
| 189 | Allowed values |
| 190 | 1 - v1 error format |
| 191 | 2 - v2 error format |
| 192 | |
| 193 | Returns: |
| 194 | An object of the form: |
| 195 | |
| 196 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 197 | # empty messages in your APIs. A typical example is to use it as the request |
| 198 | # or the response type of an API method. For instance: |
| 199 | # |
| 200 | # service Foo { |
| 201 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 202 | # } |
| 203 | # |
| 204 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 205 | }</pre> |
| 206 | </div> |
| 207 | |
| 208 | <div class="method"> |
| 209 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 210 | <pre>Gets information about an app profile. |
| 211 | |
| 212 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 213 | name: string, Required. The unique name of the requested app profile. Values are of the form |
| 214 | `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. (required) |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 215 | x__xgafv: string, V1 error format. |
| 216 | Allowed values |
| 217 | 1 - v1 error format |
| 218 | 2 - v2 error format |
| 219 | |
| 220 | Returns: |
| 221 | An object of the form: |
| 222 | |
| 223 | { # A configuration object describing how Cloud Bigtable should treat traffic |
| 224 | # from a particular end user application. |
| 225 | "description": "A String", # Optional long form description of the use case for this AppProfile. |
| 226 | "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the |
| 227 | # value returned from `GetAppProfile` when calling `UpdateAppProfile` to |
| 228 | # fail the request if there has been a modification in the mean time. The |
| 229 | # `update_mask` of the request need not include `etag` for this protection |
| 230 | # to apply. |
| 231 | # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and |
| 232 | # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more |
| 233 | # details. |
| 234 | "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 235 | # This option preserves read-your-writes consistency but does not improve |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 236 | # availability. |
| 237 | "clusterId": "A String", # The cluster to which read/write requests should be routed. |
| 238 | "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are |
| 239 | # allowed by this app profile. It is unsafe to send these requests to |
| 240 | # the same table/row/column in multiple clusters. |
| 241 | }, |
| 242 | "name": "A String", # (`OutputOnly`) |
| 243 | # The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 244 | # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. |
| 245 | "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy. |
| 246 | # will fail over to the nearest cluster that is available in the event of |
| 247 | # transient errors or delays. Clusters in a region are considered |
| 248 | # equidistant. Choosing this option sacrifices read-your-writes consistency |
| 249 | # to improve availability. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 250 | }, |
| 251 | }</pre> |
| 252 | </div> |
| 253 | |
| 254 | <div class="method"> |
| 255 | <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> |
| 256 | <pre>Lists information about app profiles in an instance. |
| 257 | |
| 258 | Args: |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 259 | parent: string, Required. The unique name of the instance for which a list of app profiles is |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 260 | requested. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 261 | `projects/{project}/instances/{instance}`. |
| 262 | Use `{instance} = '-'` to list AppProfiles for all Instances in a project, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 263 | e.g., `projects/myproject/instances/-`. (required) |
| 264 | pageToken: string, The value of `next_page_token` returned by a previous call. |
| 265 | x__xgafv: string, V1 error format. |
| 266 | Allowed values |
| 267 | 1 - v1 error format |
| 268 | 2 - v2 error format |
| 269 | pageSize: integer, Maximum number of results per page. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 270 | |
| 271 | A page_size of zero lets the server choose the number of items to return. |
| 272 | A page_size which is strictly positive will return at most that many items. |
| 273 | A negative page_size will cause an error. |
| 274 | |
| 275 | Following the first request, subsequent paginated calls are not required |
| 276 | to pass a page_size. If a page_size is set in subsequent calls, it must |
| 277 | match the page_size given in the first request. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 278 | |
| 279 | Returns: |
| 280 | An object of the form: |
| 281 | |
| 282 | { # Response message for BigtableInstanceAdmin.ListAppProfiles. |
| 283 | "nextPageToken": "A String", # Set if not all app profiles could be returned in a single response. |
| 284 | # Pass this value to `page_token` in another request to get the next |
| 285 | # page of results. |
| 286 | "failedLocations": [ # Locations from which AppProfile information could not be retrieved, |
| 287 | # due to an outage or some other transient condition. |
| 288 | # AppProfiles from these locations may be missing from `app_profiles`. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 289 | # Values are of the form `projects/<project>/locations/<zone_id>` |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 290 | "A String", |
| 291 | ], |
| 292 | "appProfiles": [ # The list of requested app profiles. |
| 293 | { # A configuration object describing how Cloud Bigtable should treat traffic |
| 294 | # from a particular end user application. |
| 295 | "description": "A String", # Optional long form description of the use case for this AppProfile. |
| 296 | "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the |
| 297 | # value returned from `GetAppProfile` when calling `UpdateAppProfile` to |
| 298 | # fail the request if there has been a modification in the mean time. The |
| 299 | # `update_mask` of the request need not include `etag` for this protection |
| 300 | # to apply. |
| 301 | # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and |
| 302 | # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more |
| 303 | # details. |
| 304 | "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 305 | # This option preserves read-your-writes consistency but does not improve |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 306 | # availability. |
| 307 | "clusterId": "A String", # The cluster to which read/write requests should be routed. |
| 308 | "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are |
| 309 | # allowed by this app profile. It is unsafe to send these requests to |
| 310 | # the same table/row/column in multiple clusters. |
| 311 | }, |
| 312 | "name": "A String", # (`OutputOnly`) |
| 313 | # The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 314 | # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. |
| 315 | "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy. |
| 316 | # will fail over to the nearest cluster that is available in the event of |
| 317 | # transient errors or delays. Clusters in a region are considered |
| 318 | # equidistant. Choosing this option sacrifices read-your-writes consistency |
| 319 | # to improve availability. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 320 | }, |
| 321 | }, |
| 322 | ], |
| 323 | }</pre> |
| 324 | </div> |
| 325 | |
| 326 | <div class="method"> |
| 327 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 328 | <pre>Retrieves the next page of results. |
| 329 | |
| 330 | Args: |
| 331 | previous_request: The request for the previous page. (required) |
| 332 | previous_response: The response from the request for the previous page. (required) |
| 333 | |
| 334 | Returns: |
| 335 | A request object that you can call 'execute()' on to request the next |
| 336 | page. Returns None if there are no more items in the collection. |
| 337 | </pre> |
| 338 | </div> |
| 339 | |
| 340 | <div class="method"> |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 341 | <code class="details" id="patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code> |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 342 | <pre>Updates an app profile within an instance. |
| 343 | |
| 344 | Args: |
| 345 | name: string, (`OutputOnly`) |
| 346 | The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 347 | `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. (required) |
| 348 | body: object, The request body. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 349 | The object takes the form of: |
| 350 | |
| 351 | { # A configuration object describing how Cloud Bigtable should treat traffic |
| 352 | # from a particular end user application. |
| 353 | "description": "A String", # Optional long form description of the use case for this AppProfile. |
| 354 | "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the |
| 355 | # value returned from `GetAppProfile` when calling `UpdateAppProfile` to |
| 356 | # fail the request if there has been a modification in the mean time. The |
| 357 | # `update_mask` of the request need not include `etag` for this protection |
| 358 | # to apply. |
| 359 | # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and |
| 360 | # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more |
| 361 | # details. |
| 362 | "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 363 | # This option preserves read-your-writes consistency but does not improve |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 364 | # availability. |
| 365 | "clusterId": "A String", # The cluster to which read/write requests should be routed. |
| 366 | "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are |
| 367 | # allowed by this app profile. It is unsafe to send these requests to |
| 368 | # the same table/row/column in multiple clusters. |
| 369 | }, |
| 370 | "name": "A String", # (`OutputOnly`) |
| 371 | # The unique name of the app profile. Values are of the form |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 372 | # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. |
| 373 | "multiClusterRoutingUseAny": { # Read/write requests are routed to the nearest cluster in the instance, and # Use a multi-cluster routing policy. |
| 374 | # will fail over to the nearest cluster that is available in the event of |
| 375 | # transient errors or delays. Clusters in a region are considered |
| 376 | # equidistant. Choosing this option sacrifices read-your-writes consistency |
| 377 | # to improve availability. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 378 | }, |
| 379 | } |
| 380 | |
| 381 | ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 382 | updateMask: string, Required. The subset of app profile fields which should be replaced. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 383 | If unset, all fields will be replaced. |
| 384 | x__xgafv: string, V1 error format. |
| 385 | Allowed values |
| 386 | 1 - v1 error format |
| 387 | 2 - v2 error format |
| 388 | |
| 389 | Returns: |
| 390 | An object of the form: |
| 391 | |
| 392 | { # This resource represents a long-running operation that is the result of a |
| 393 | # network API call. |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 394 | "response": { # The normal response of the operation in case of success. If the original |
| 395 | # method returns no data on success, such as `Delete`, the response is |
| 396 | # `google.protobuf.Empty`. If the original method is standard |
| 397 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 398 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 399 | # is the original method name. For example, if the original method name |
| 400 | # is `TakeSnapshot()`, the inferred response type is |
| 401 | # `TakeSnapshotResponse`. |
| 402 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 403 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 404 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 405 | # contains progress information and common metadata such as create time. |
| 406 | # Some services might not provide such metadata. Any method that returns a |
| 407 | # long-running operation should document the metadata type, if any. |
| 408 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 409 | }, |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 410 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 411 | # If `true`, the operation is completed, and either `error` or `response` is |
| 412 | # available. |
| 413 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 414 | # originally returns it. If you use the default HTTP mapping, the |
| 415 | # `name` should be a resource name ending with `operations/{unique_id}`. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 416 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 417 | # different programming environments, including REST APIs and RPC APIs. It is |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 418 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 419 | # three pieces of data: error code, error message, and error details. |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 420 | # |
Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame^] | 421 | # You can find out more about this error model and how to work with it in the |
| 422 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 423 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 424 | # user-facing error message should be localized and sent in the |
| 425 | # google.rpc.Status.details field, or localized by the client. |
| 426 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 427 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 428 | # message types for APIs to use. |
| 429 | { |
| 430 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 431 | }, |
| 432 | ], |
| 433 | }, |
Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 434 | }</pre> |
| 435 | </div> |
| 436 | |
| 437 | </body></html> |