| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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.tables.html">tables</a> . <a href="bigtableadmin_v2.projects.instances.tables.authorizedViews.html">authorizedViews</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, authorizedViewId=None, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new AuthorizedView in a table.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Permanently deletes a specified AuthorizedView.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets information from a specified AuthorizedView.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all AuthorizedViews from a specific table.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an AuthorizedView in a table.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, authorizedViewId=None, body=None, x__xgafv=None)</code> |
| <pre>Creates a new AuthorizedView in a table. |
| |
| Args: |
| parent: string, Required. This is the name of the table the AuthorizedView belongs to. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Placeholder for admin API work while we work out the internals. |
| "deletionProtection": True or False, # Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. |
| "etag": "A String", # The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. |
| "name": "A String", # Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}` |
| "subsetView": { # Defines a simple AuthorizedView that is a subset of the underlying Table. # An AuthorizedView permitting access to an explicit subset of a Table. |
| "familySubsets": { # Map from column family name to the columns in this family to be included in the AuthorizedView. |
| "a_key": { # Subsets of a column family that are included in this AuthorizedView. |
| "qualifierPrefixes": [ # Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). |
| "A String", |
| ], |
| "qualifiers": [ # Individual exact column qualifiers to be included in the AuthorizedView. |
| "A String", |
| ], |
| }, |
| }, |
| "rowPrefixes": [ # Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). |
| "A String", |
| ], |
| }, |
| } |
| |
| authorizedViewId: string, Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. The `authorized_view_id` appended to `parent` forms the full AuthorizedView name of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}`. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code> |
| <pre>Permanently deletes a specified AuthorizedView. |
| |
| Args: |
| name: string, Required. The unique name of the AuthorizedView to be deleted. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`. (required) |
| etag: string, Optional. The current etag of the AuthorizedView. If an etag is provided and does not match the current etag of the AuthorizedView, deletion will be blocked and an ABORTED error will be returned. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| <pre>Gets information from a specified AuthorizedView. |
| |
| Args: |
| name: string, Required. The unique name of the requested AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`. (required) |
| view: string, Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC. |
| Allowed values |
| RESPONSE_VIEW_UNSPECIFIED - Uses the default view for each method as documented in the request. |
| NAME_ONLY - Only populates `name`. |
| BASIC - Only populates the AuthorizedView's basic metadata. This includes: name, deletion_protection, etag. |
| FULL - Populates every fields. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Placeholder for admin API work while we work out the internals. |
| "deletionProtection": True or False, # Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. |
| "etag": "A String", # The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. |
| "name": "A String", # Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}` |
| "subsetView": { # Defines a simple AuthorizedView that is a subset of the underlying Table. # An AuthorizedView permitting access to an explicit subset of a Table. |
| "familySubsets": { # Map from column family name to the columns in this family to be included in the AuthorizedView. |
| "a_key": { # Subsets of a column family that are included in this AuthorizedView. |
| "qualifierPrefixes": [ # Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). |
| "A String", |
| ], |
| "qualifiers": [ # Individual exact column qualifiers to be included in the AuthorizedView. |
| "A String", |
| ], |
| }, |
| }, |
| "rowPrefixes": [ # Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). |
| "A String", |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> |
| <pre>Lists all AuthorizedViews from a specific table. |
| |
| Args: |
| parent: string, Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the form `projects/{project}/instances/{instance}/tables/{table}`. (required) |
| pageSize: integer, Optional. Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. |
| pageToken: string, Optional. The value of `next_page_token` returned by a previous call. |
| view: string, Optional. The resource_view to be applied to the returned views' fields. Default to NAME_ONLY. |
| Allowed values |
| RESPONSE_VIEW_UNSPECIFIED - Uses the default view for each method as documented in the request. |
| NAME_ONLY - Only populates `name`. |
| BASIC - Only populates the AuthorizedView's basic metadata. This includes: name, deletion_protection, etag. |
| FULL - Populates every fields. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews |
| "authorizedViews": [ # The AuthorizedViews present in the requested table. |
| { # Placeholder for admin API work while we work out the internals. |
| "deletionProtection": True or False, # Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. |
| "etag": "A String", # The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. |
| "name": "A String", # Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}` |
| "subsetView": { # Defines a simple AuthorizedView that is a subset of the underlying Table. # An AuthorizedView permitting access to an explicit subset of a Table. |
| "familySubsets": { # Map from column family name to the columns in this family to be included in the AuthorizedView. |
| "a_key": { # Subsets of a column family that are included in this AuthorizedView. |
| "qualifierPrefixes": [ # Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). |
| "A String", |
| ], |
| "qualifiers": [ # Individual exact column qualifiers to be included in the AuthorizedView. |
| "A String", |
| ], |
| }, |
| }, |
| "rowPrefixes": [ # Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Set if not all tables could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, ignoreWarnings=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an AuthorizedView in a table. |
| |
| Args: |
| name: string, Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Placeholder for admin API work while we work out the internals. |
| "deletionProtection": True or False, # Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set. |
| "etag": "A String", # The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag. |
| "name": "A String", # Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}` |
| "subsetView": { # Defines a simple AuthorizedView that is a subset of the underlying Table. # An AuthorizedView permitting access to an explicit subset of a Table. |
| "familySubsets": { # Map from column family name to the columns in this family to be included in the AuthorizedView. |
| "a_key": { # Subsets of a column family that are included in this AuthorizedView. |
| "qualifierPrefixes": [ # Prefixes for qualifiers to be included in the AuthorizedView. Every qualifier starting with one of these prefixes is included in the AuthorizedView. To provide access to all qualifiers, include the empty string as a prefix (""). |
| "A String", |
| ], |
| "qualifiers": [ # Individual exact column qualifiers to be included in the AuthorizedView. |
| "A String", |
| ], |
| }, |
| }, |
| "rowPrefixes": [ # Row prefixes to be included in the AuthorizedView. To provide access to all rows, include the empty string as a prefix (""). |
| "A String", |
| ], |
| }, |
| } |
| |
| ignoreWarnings: boolean, Optional. If true, ignore the safety checks when updating the AuthorizedView. |
| updateMask: string, Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value `*` means to overwrite all fields (including fields not set in the request). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a network API call. |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. |
| "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. |
| "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
