1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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"> 78 <code><a href="#create">create(parent, body, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</a></code></p> 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"> 93 <code><a href="#patch">patch(name, body, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates an app profile within an instance.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="create">create(parent, body, ignoreWarnings=None, appProfileId=None, x__xgafv=None)</code> 98 <pre>Creates an app profile within an instance. 99 100Args: 101 parent: string, The unique name of the instance in which to create the new app profile. 102Values are of the form 103`projects/<project>/instances/<instance>`. (required) 104 body: object, The request body. (required) 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. 119 # This option preserves read-your-writes consistency, but does not improve 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 128 # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. 129 "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster. 130 # fail over to another cluster in the event of transient errors or delays. 131 # Choosing this option sacrifices read-your-writes consistency to improve 132 # availability. 133 }, 134 } 135 136 ignoreWarnings: boolean, If true, ignore safety checks when creating the app profile. 137 appProfileId: string, The ID to be used when referring to the new app profile within its 138instance, e.g., just `myprofile` rather than 139`projects/myproject/instances/myinstance/appProfiles/myprofile`. 140 x__xgafv: string, V1 error format. 141 Allowed values 142 1 - v1 error format 143 2 - v2 error format 144 145Returns: 146 An object of the form: 147 148 { # A configuration object describing how Cloud Bigtable should treat traffic 149 # from a particular end user application. 150 "description": "A String", # Optional long form description of the use case for this AppProfile. 151 "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the 152 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to 153 # fail the request if there has been a modification in the mean time. The 154 # `update_mask` of the request need not include `etag` for this protection 155 # to apply. 156 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and 157 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more 158 # details. 159 "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. 160 # This option preserves read-your-writes consistency, but does not improve 161 # availability. 162 "clusterId": "A String", # The cluster to which read/write requests should be routed. 163 "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are 164 # allowed by this app profile. It is unsafe to send these requests to 165 # the same table/row/column in multiple clusters. 166 }, 167 "name": "A String", # (`OutputOnly`) 168 # The unique name of the app profile. Values are of the form 169 # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. 170 "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster. 171 # fail over to another cluster in the event of transient errors or delays. 172 # Choosing this option sacrifices read-your-writes consistency to improve 173 # availability. 174 }, 175 }</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="delete">delete(name, ignoreWarnings=None, x__xgafv=None)</code> 180 <pre>Deletes an app profile from an instance. 181 182Args: 183 name: string, The unique name of the app profile to be deleted. Values are of the form 184`projects/<project>/instances/<instance>/appProfiles/<app_profile>`. (required) 185 ignoreWarnings: boolean, If true, ignore safety checks when deleting the app profile. 186 x__xgafv: string, V1 error format. 187 Allowed values 188 1 - v1 error format 189 2 - v2 error format 190 191Returns: 192 An object of the form: 193 194 { # A generic empty message that you can re-use to avoid defining duplicated 195 # empty messages in your APIs. A typical example is to use it as the request 196 # or the response type of an API method. For instance: 197 # 198 # service Foo { 199 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 200 # } 201 # 202 # The JSON representation for `Empty` is empty JSON object `{}`. 203 }</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="get">get(name, x__xgafv=None)</code> 208 <pre>Gets information about an app profile. 209 210Args: 211 name: string, The unique name of the requested app profile. Values are of the form 212`projects/<project>/instances/<instance>/appProfiles/<app_profile>`. (required) 213 x__xgafv: string, V1 error format. 214 Allowed values 215 1 - v1 error format 216 2 - v2 error format 217 218Returns: 219 An object of the form: 220 221 { # A configuration object describing how Cloud Bigtable should treat traffic 222 # from a particular end user application. 223 "description": "A String", # Optional long form description of the use case for this AppProfile. 224 "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the 225 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to 226 # fail the request if there has been a modification in the mean time. The 227 # `update_mask` of the request need not include `etag` for this protection 228 # to apply. 229 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and 230 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more 231 # details. 232 "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. 233 # This option preserves read-your-writes consistency, but does not improve 234 # availability. 235 "clusterId": "A String", # The cluster to which read/write requests should be routed. 236 "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are 237 # allowed by this app profile. It is unsafe to send these requests to 238 # the same table/row/column in multiple clusters. 239 }, 240 "name": "A String", # (`OutputOnly`) 241 # The unique name of the app profile. Values are of the form 242 # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. 243 "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster. 244 # fail over to another cluster in the event of transient errors or delays. 245 # Choosing this option sacrifices read-your-writes consistency to improve 246 # availability. 247 }, 248 }</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code> 253 <pre>Lists information about app profiles in an instance. 254 255Args: 256 parent: string, The unique name of the instance for which a list of app profiles is 257requested. Values are of the form 258`projects/<project>/instances/<instance>`. 259Use `<instance> = '-'` to list AppProfiles for all Instances in a project, 260e.g., `projects/myproject/instances/-`. (required) 261 pageToken: string, The value of `next_page_token` returned by a previous call. 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 pageSize: integer, Maximum number of results per page. 267CURRENTLY UNIMPLEMENTED AND IGNORED. 268 269Returns: 270 An object of the form: 271 272 { # Response message for BigtableInstanceAdmin.ListAppProfiles. 273 "nextPageToken": "A String", # Set if not all app profiles could be returned in a single response. 274 # Pass this value to `page_token` in another request to get the next 275 # page of results. 276 "failedLocations": [ # Locations from which AppProfile information could not be retrieved, 277 # due to an outage or some other transient condition. 278 # AppProfiles from these locations may be missing from `app_profiles`. 279 # Values are of the form `projects/<project>/locations/<zone_id>` 280 "A String", 281 ], 282 "appProfiles": [ # The list of requested app profiles. 283 { # A configuration object describing how Cloud Bigtable should treat traffic 284 # from a particular end user application. 285 "description": "A String", # Optional long form description of the use case for this AppProfile. 286 "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the 287 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to 288 # fail the request if there has been a modification in the mean time. The 289 # `update_mask` of the request need not include `etag` for this protection 290 # to apply. 291 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and 292 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more 293 # details. 294 "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. 295 # This option preserves read-your-writes consistency, but does not improve 296 # availability. 297 "clusterId": "A String", # The cluster to which read/write requests should be routed. 298 "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are 299 # allowed by this app profile. It is unsafe to send these requests to 300 # the same table/row/column in multiple clusters. 301 }, 302 "name": "A String", # (`OutputOnly`) 303 # The unique name of the app profile. Values are of the form 304 # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. 305 "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster. 306 # fail over to another cluster in the event of transient errors or delays. 307 # Choosing this option sacrifices read-your-writes consistency to improve 308 # availability. 309 }, 310 }, 311 ], 312 }</pre> 313</div> 314 315<div class="method"> 316 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 317 <pre>Retrieves the next page of results. 318 319Args: 320 previous_request: The request for the previous page. (required) 321 previous_response: The response from the request for the previous page. (required) 322 323Returns: 324 A request object that you can call 'execute()' on to request the next 325 page. Returns None if there are no more items in the collection. 326 </pre> 327</div> 328 329<div class="method"> 330 <code class="details" id="patch">patch(name, body, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code> 331 <pre>Updates an app profile within an instance. 332 333Args: 334 name: string, (`OutputOnly`) 335The unique name of the app profile. Values are of the form 336`projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. (required) 337 body: object, The request body. (required) 338 The object takes the form of: 339 340{ # A configuration object describing how Cloud Bigtable should treat traffic 341 # from a particular end user application. 342 "description": "A String", # Optional long form description of the use case for this AppProfile. 343 "etag": "A String", # Strongly validated etag for optimistic concurrency control. Preserve the 344 # value returned from `GetAppProfile` when calling `UpdateAppProfile` to 345 # fail the request if there has been a modification in the mean time. The 346 # `update_mask` of the request need not include `etag` for this protection 347 # to apply. 348 # See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and 349 # [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more 350 # details. 351 "singleClusterRouting": { # Unconditionally routes all read/write requests to a specific cluster. # Use a single-cluster routing policy. 352 # This option preserves read-your-writes consistency, but does not improve 353 # availability. 354 "clusterId": "A String", # The cluster to which read/write requests should be routed. 355 "allowTransactionalWrites": True or False, # Whether or not `CheckAndMutateRow` and `ReadModifyWriteRow` requests are 356 # allowed by this app profile. It is unsafe to send these requests to 357 # the same table/row/column in multiple clusters. 358 }, 359 "name": "A String", # (`OutputOnly`) 360 # The unique name of the app profile. Values are of the form 361 # `projects/<project>/instances/<instance>/appProfiles/_a-zA-Z0-9*`. 362 "multiClusterRoutingUseAny": { # Read/write requests may be routed to any cluster in the instance, and will # Use a multi-cluster routing policy that may pick any cluster. 363 # fail over to another cluster in the event of transient errors or delays. 364 # Choosing this option sacrifices read-your-writes consistency to improve 365 # availability. 366 }, 367 } 368 369 ignoreWarnings: boolean, If true, ignore safety checks when updating the app profile. 370 updateMask: string, The subset of app profile fields which should be replaced. 371If unset, all fields will be replaced. 372 x__xgafv: string, V1 error format. 373 Allowed values 374 1 - v1 error format 375 2 - v2 error format 376 377Returns: 378 An object of the form: 379 380 { # This resource represents a long-running operation that is the result of a 381 # network API call. 382 "metadata": { # Service-specific metadata associated with the operation. It typically 383 # contains progress information and common metadata such as create time. 384 # Some services might not provide such metadata. Any method that returns a 385 # long-running operation should document the metadata type, if any. 386 "a_key": "", # Properties of the object. Contains field @type with type URL. 387 }, 388 "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. 389 # different programming environments, including REST APIs and RPC APIs. It is 390 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 391 # 392 # - Simple to use and understand for most users 393 # - Flexible enough to meet unexpected needs 394 # 395 # # Overview 396 # 397 # The `Status` message contains three pieces of data: error code, error 398 # message, and error details. The error code should be an enum value of 399 # google.rpc.Code, but it may accept additional error codes if needed. The 400 # error message should be a developer-facing English message that helps 401 # developers *understand* and *resolve* the error. If a localized user-facing 402 # error message is needed, put the localized message in the error details or 403 # localize it in the client. The optional error details may contain arbitrary 404 # information about the error. There is a predefined set of error detail types 405 # in the package `google.rpc` that can be used for common error conditions. 406 # 407 # # Language mapping 408 # 409 # The `Status` message is the logical representation of the error model, but it 410 # is not necessarily the actual wire format. When the `Status` message is 411 # exposed in different client libraries and different wire protocols, it can be 412 # mapped differently. For example, it will likely be mapped to some exceptions 413 # in Java, but more likely mapped to some error codes in C. 414 # 415 # # Other uses 416 # 417 # The error model and the `Status` message can be used in a variety of 418 # environments, either with or without APIs, to provide a 419 # consistent developer experience across different environments. 420 # 421 # Example uses of this error model include: 422 # 423 # - Partial errors. If a service needs to return partial errors to the client, 424 # it may embed the `Status` in the normal response to indicate the partial 425 # errors. 426 # 427 # - Workflow errors. A typical workflow has multiple steps. Each step may 428 # have a `Status` message for error reporting. 429 # 430 # - Batch operations. If a client uses batch request and batch response, the 431 # `Status` message should be used directly inside batch response, one for 432 # each error sub-response. 433 # 434 # - Asynchronous operations. If an API call embeds asynchronous operation 435 # results in its response, the status of those operations should be 436 # represented directly using the `Status` message. 437 # 438 # - Logging. If some API errors are stored in logs, the message `Status` could 439 # be used directly after any stripping needed for security/privacy reasons. 440 "message": "A String", # A developer-facing error message, which should be in English. Any 441 # user-facing error message should be localized and sent in the 442 # google.rpc.Status.details field, or localized by the client. 443 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 444 "details": [ # A list of messages that carry the error details. There is a common set of 445 # message types for APIs to use. 446 { 447 "a_key": "", # Properties of the object. Contains field @type with type URL. 448 }, 449 ], 450 }, 451 "done": True or False, # If the value is `false`, it means the operation is still in progress. 452 # If `true`, the operation is completed, and either `error` or `response` is 453 # available. 454 "response": { # The normal response of the operation in case of success. If the original 455 # method returns no data on success, such as `Delete`, the response is 456 # `google.protobuf.Empty`. If the original method is standard 457 # `Get`/`Create`/`Update`, the response should be the resource. For other 458 # methods, the response should have the type `XxxResponse`, where `Xxx` 459 # is the original method name. For example, if the original method name 460 # is `TakeSnapshot()`, the inferred response type is 461 # `TakeSnapshotResponse`. 462 "a_key": "", # Properties of the object. Contains field @type with type URL. 463 }, 464 "name": "A String", # The server-assigned name, which is only unique within the same service that 465 # originally returns it. If you use the default HTTP mapping, the 466 # `name` should have the format of `operations/some/unique/name`. 467 }</pre> 468</div> 469 470</body></html>