2.41.0 (latest) 2.40.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.1 2.29.0 2.28.1 2.26.0 2.25.0 2.24.0 2.23.1 2.22.0 2.21.0 2.20.0 2.19.0 2.18.1 2.17.0 2.16.0 2.15.0 2.14.1 2.13.2 2.12.0 2.11.3 2.10.1 2.9.0 2.8.1 2.7.1 2.6.0 2.5.2 2.4.0 2.3.3 2.2.0 2.1.0 2.0.0 1.7.3 1.6.1 1.5.1 1.4.0 1.3.0 1.2.1 1.1.0 1.0.0 0.34.0 BigtableInstanceAdminClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, typing.Callable[ [...], google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables. ## Properties ### api_endpoint Return the API endpoint used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The API endpoint used by the client instance. | ### transport Returns the transport used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `BigtableInstanceAdminTransport` | The transport used by the client instance. | ### universe_domain Return the universe domain used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The universe domain used by the client instance. | ## Methods ### BigtableInstanceAdminClient BigtableInstanceAdminClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, typing.Callable[ [...], google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.transports.base.BigtableInstanceAdminTransport, ], ] ] = None, client_options: typing.Optional[ typing.Union[google.api_core.client_options.ClientOptions, dict] ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Instantiates the bigtable instance admin client. | **Parameters** || |---|---| | **Name** | **Description** | | `credentials` | `Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. | | `transport` | `Optional[Union[str,BigtableInstanceAdminTransport,Callable[..., BigtableInstanceAdminTransport]]]` The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the BigtableInstanceAdminTransport constructor. If set to None, a transport is chosen automatically. | | `client_options` | `Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that the `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS. | | `client_info` | `google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If mutual TLS transport creation failed for any reason. | ### __exit__ __exit__(type, value, traceback) Releases underlying transport's resources. > [!WARNING] > **Warning:** ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients! ### app_profile_path app_profile_path(project: str, instance: str, app_profile: str) -> str Returns a fully-qualified app_profile string. ### cluster_path cluster_path(project: str, instance: str, cluster: str) -> str Returns a fully-qualified cluster string. ### common_billing_account_path common_billing_account_path(billing_account: str) -> str Returns a fully-qualified billing_account string. ### common_folder_path common_folder_path(folder: str) -> str Returns a fully-qualified folder string. ### common_location_path common_location_path(project: str, location: str) -> str Returns a fully-qualified location string. ### common_organization_path common_organization_path(organization: str) -> str Returns a fully-qualified organization string. ### common_project_path common_project_path(project: str) -> str Returns a fully-qualified project string. ### create_app_profile create_app_profile( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateAppProfileRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, app_profile_id: typing.Optional[str] = None, app_profile: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.AppProfile ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile Creates an app profile within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_create_app_profile(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) app_profile = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile.html() app_profile.priority = "PRIORITY_HIGH" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateAppProfileRequest.html( parent="parent_value", app_profile_id="app_profile_id_value", app_profile=app_profile, ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_create_app_profile(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateAppProfileRequest, dict]` The request object. Request message for BigtableInstanceAdmin.CreateAppProfile. | | `parent` | `str` Required. The unique name of the instance in which to create the new app profile. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `app_profile_id` | `str` Required. The ID to be used when referring to the new app profile within its instance, e.g., just `myprofile` rather than `projects/myproject/instances/myinstance/appProfiles/myprofile`. This corresponds to the `app_profile_id` field on the `request` instance; if `request` is provided, this should not be set. | | `app_profile` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile` Required. The app profile to be created. Fields marked `OutputOnly` will be ignored. This corresponds to the `app_profile` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile` | A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. | ### create_cluster create_cluster( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateClusterRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, cluster_id: typing.Optional[str] = None, cluster: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.Cluster ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Creates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_create_cluster(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateClusterRequest.html( parent="parent_value", cluster_id="cluster_id_value", ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_create_cluster(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateClusterRequest, dict]` The request object. Request message for BigtableInstanceAdmin.CreateCluster. | | `parent` | `str` Required. The unique name of the instance in which to create the new cluster. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `cluster_id` | `str` Required. The ID to be used when referring to the new cluster within its instance, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. This corresponds to the `cluster_id` field on the `request` instance; if `request` is provided, this should not be set. | | `cluster` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster` Required. The cluster to be created. Fields marked `OutputOnly` must be left blank. This corresponds to the `cluster` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Cluster](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster) A resizable group of nodes in a particular cloud location, capable of serving all `Tables][google.bigtable.admin.v2.Table]` in the parent `Instance][google.bigtable.admin.v2.Instance]`. | ### create_instance create_instance( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateInstanceRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, instance_id: typing.Optional[str] = None, instance: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.Instance ] = None, clusters: typing.Optional[ typing.MutableMapping[ str, google.cloud.bigtable_admin_v2.types.instance.Cluster ] ] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Create an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_create_instance(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) instance = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance.html() instance.display_name = "display_name_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateInstanceRequest.html( parent="parent_value", instance_id="instance_id_value", instance=instance, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_create_instance(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateInstanceRequest, dict]` The request object. Request message for BigtableInstanceAdmin.CreateInstance. | | `parent` | `str` Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `instance_id` | `str` Required. The ID to be used when referring to the new instance within its project, e.g., just `myinstance` rather than `projects/myproject/instances/myinstance`. This corresponds to the `instance_id` field on the `request` instance; if `request` is provided, this should not be set. | | `instance` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance` Required. The instance to create. Fields marked `OutputOnly` must be left blank. This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set. | | `clusters` | `MutableMapping[str, https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster]` Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just `mycluster` rather than `projects/myproject/instances/myinstance/clusters/mycluster`. Fields marked `OutputOnly` must be left blank. This corresponds to the `clusters` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Instance](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance) A collection of Bigtable `Tables][google.bigtable.admin.v2.Table]` and the resources that serve them. All tables in an instance are served from all `Clusters][google.bigtable.admin.v2.Cluster]` in the instance. | ### create_logical_view create_logical_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateLogicalViewRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, logical_view: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.LogicalView ] = None, logical_view_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Creates a logical view within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_create_logical_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) logical_view = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView.html() logical_view.query = "query_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateLogicalViewRequest.html( parent="parent_value", logical_view_id="logical_view_id_value", logical_view=logical_view, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_create_logical_view(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateLogicalViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.CreateLogicalView. | | `parent` | `str` Required. The parent instance where this logical view will be created. Format: `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `logical_view` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView` Required. The logical view to create. This corresponds to the `logical_view` field on the `request` instance; if `request` is provided, this should not be set. | | `logical_view_id` | `str` Required. The ID to use for the logical view, which will become the final component of the logical view's resource name. This corresponds to the `logical_view_id` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [LogicalView](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView) A SQL logical view object that can be referenced in SQL queries. | ### create_materialized_view create_materialized_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.CreateMaterializedViewRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, materialized_view: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.MaterializedView ] = None, materialized_view_id: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Creates a materialized view within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_create_materialized_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) materialized_view = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView.html() materialized_view.query = "query_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateMaterializedViewRequest.html( parent="parent_value", materialized_view_id="materialized_view_id_value", materialized_view=materialized_view, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_create_materialized_view(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.CreateMaterializedViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.CreateMaterializedView. | | `parent` | `str` Required. The parent instance where this materialized view will be created. Format: `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `materialized_view` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView` Required. The materialized view to create. This corresponds to the `materialized_view` field on the `request` instance; if `request` is provided, this should not be set. | | `materialized_view_id` | `str` Required. The ID to use for the materialized view, which will become the final component of the materialized view's resource name. This corresponds to the `materialized_view_id` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [MaterializedView](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView) A materialized view object that can be referenced in SQL queries. | ### crypto_key_path crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str Returns a fully-qualified crypto_key string. ### delete_app_profile delete_app_profile( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteAppProfileRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, ignore_warnings: typing.Optional[bool] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Deletes an app profile from an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_delete_app_profile(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteAppProfileRequest.html( name="name_value", ignore_warnings=True, ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_delete_app_profile(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteAppProfileRequest, dict]` The request object. Request message for BigtableInstanceAdmin.DeleteAppProfile. | | `name` | `str` Required. The unique name of the app profile to be deleted. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `ignore_warnings` | `bool` Required. If true, ignore safety checks when deleting the app profile. This corresponds to the `ignore_warnings` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### delete_cluster delete_cluster( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteClusterRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Deletes a cluster from an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_delete_cluster(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteClusterRequest.html( name="name_value", ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_delete_cluster(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteClusterRequest, dict]` The request object. Request message for BigtableInstanceAdmin.DeleteCluster. | | `name` | `str` Required. The unique name of the cluster to be deleted. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### delete_instance delete_instance( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteInstanceRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Delete an instance from a project. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_delete_instance(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteInstanceRequest.html( name="name_value", ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_delete_instance(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteInstanceRequest, dict]` The request object. Request message for BigtableInstanceAdmin.DeleteInstance. | | `name` | `str` Required. The unique name of the instance to be deleted. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### delete_logical_view delete_logical_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteLogicalViewRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Deletes a logical view from an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_delete_logical_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteLogicalViewRequest.html( name="name_value", ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_delete_logical_view(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteLogicalViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.DeleteLogicalView. | | `name` | `str` Required. The unique name of the logical view to be deleted. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### delete_materialized_view delete_materialized_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.DeleteMaterializedViewRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> None Deletes a materialized view from an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_delete_materialized_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteMaterializedViewRequest.html( name="name_value", ) # Make the request client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_delete_materialized_view(request=request) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.DeleteMaterializedViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.DeleteMaterializedView. | | `name` | `str` Required. The unique name of the materialized view to be deleted. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### from_service_account_file from_service_account_file(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `BigtableInstanceAdminClient` | The constructed client. | ### from_service_account_info from_service_account_info(info: dict, *args, **kwargs) Creates an instance of this client using the provided credentials info. | **Parameter** || |---|---| | **Name** | **Description** | | `info` | `dict` The service account private key info. | | **Returns** || |---|---| | **Type** | **Description** | | `BigtableInstanceAdminClient` | The constructed client. | ### from_service_account_json from_service_account_json(filename: str, *args, **kwargs) Creates an instance of this client using the provided credentials file. | **Parameter** || |---|---| | **Name** | **Description** | | `filename` | `str` The path to the service account private key json file. | | **Returns** || |---|---| | **Type** | **Description** | | `BigtableInstanceAdminClient` | The constructed client. | ### get_app_profile get_app_profile( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetAppProfileRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.AppProfile Gets information about an app profile. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_get_app_profile(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetAppProfileRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_app_profile(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetAppProfileRequest, dict]` The request object. Request message for BigtableInstanceAdmin.GetAppProfile. | | `name` | `str` Required. The unique name of the requested app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile` | A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. | ### get_cluster get_cluster( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetClusterRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.Cluster Gets information about a cluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_get_cluster(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetClusterRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_cluster(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetClusterRequest, dict]` The request object. Request message for BigtableInstanceAdmin.GetCluster. | | `name` | `str` Required. The unique name of the requested cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster` | A resizable group of nodes in a particular cloud location, capable of serving all `Tables][google.bigtable.admin.v2.Table]` in the parent `Instance][google.bigtable.admin.v2.Instance]`. | ### get_iam_policy get_iam_policy( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict] ] = None, *, resource: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.policy_pb2.Policy Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 import google.iam.v1.iam_policy_pb2 as iam_policy_pb2 # type: ignore def sample_get_iam_policy(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = iam_policy_pb2.GetIamPolicyRequest( resource="resource_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_iam_policy(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[http://github.com/googleapis/python-grpc-google-iam-v1/blob/8e73b45993f030f521c0169b380d0fbafe66630b/google/iam/v1/iam_policy_pb2_grpc.py#L111-L118, dict]` The request object. Request message for `GetIamPolicy` method. | | `resource` | `str` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.iam.v1.policy_pb2.Policy` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the \[IAM documentation\](https://cloud.google.com/iam/help/conditions/resource-policies). \*\*JSON example:\*\* :literal:` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">`\\ \\` **YAML example:** :literal:` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:"\>`\ \` For a description of IAM and its features, see the \[IAM documentation\](https://cloud.google.com/iam/docs/). | ### get_instance get_instance( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetInstanceRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.Instance Gets information about an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_get_instance(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetInstanceRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_instance(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetInstanceRequest, dict]` The request object. Request message for BigtableInstanceAdmin.GetInstance. | | `name` | `str` Required. The unique name of the requested instance. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance` | A collection of Bigtable `Tables][google.bigtable.admin.v2.Table]` and the resources that serve them. All tables in an instance are served from all `Clusters][google.bigtable.admin.v2.Cluster]` in the instance. | ### get_logical_view get_logical_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetLogicalViewRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.LogicalView Gets information about a logical view. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_get_logical_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetLogicalViewRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_logical_view(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetLogicalViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.GetLogicalView. | | `name` | `str` Required. The unique name of the requested logical view. Values are of the form `projects/{project}/instances/{instance}/logicalViews/{logical_view}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView` | A SQL logical view object that can be referenced in SQL queries. | ### get_materialized_view get_materialized_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.GetMaterializedViewRequest, dict, ] ] = None, *, name: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.MaterializedView Gets information about a materialized view. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_get_materialized_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetMaterializedViewRequest.html( name="name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_get_materialized_view(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.GetMaterializedViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.GetMaterializedView. | | `name` | `str` Required. The unique name of the requested materialized view. Values are of the form `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView` | A materialized view object that can be referenced in SQL queries. | ### get_mtls_endpoint_and_cert_source get_mtls_endpoint_and_cert_source( client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, ) Deprecated. Return the API endpoint and client cert source for mutual TLS. The client cert source is determined in the following order: (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the client cert source is None. (2) if `client_options.client_cert_source` is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None. The API endpoint is determined in the following order: (1) if `client_options.api_endpoint` if provided, use the provided one. (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint. More details can be found at . | **Parameter** || |---|---| | **Name** | **Description** | | `client_options` | `google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTLSChannelError` | If any errors happen. | | **Returns** || |---|---| | **Type** | **Description** | | `Tuple[str, Callable[[], Tuple[bytes, bytes]]]` | returns the API endpoint and the client cert source to use. | ### hot_tablet_path hot_tablet_path(project: str, instance: str, cluster: str, hot_tablet: str) -> str Returns a fully-qualified hot_tablet string. ### instance_path instance_path(project: str, instance: str) -> str Returns a fully-qualified instance string. ### list_app_profiles list_app_profiles( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListAppProfilesRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesPager ) Lists information about app profiles in an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_app_profiles(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListAppProfilesRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_app_profiles(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListAppProfilesRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListAppProfiles. | | `parent` | `str` Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list AppProfiles for all Instances in a project, e.g., `projects/myproject/instances/-`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListAppProfilesPager` | Response message for BigtableInstanceAdmin.ListAppProfiles. Iterating over this object will yield results and resolve additional pages automatically. | ### list_clusters list_clusters( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListClustersResponse Lists information about clusters in an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_clusters(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListClustersRequest.html( parent="parent_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_clusters(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListClustersRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListClusters. | | `parent` | `str` Required. The unique name of the instance for which a list of clusters is requested. Values are of the form `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list Clusters for all Instances in a project, e.g., `projects/myproject/instances/-`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListClustersResponse` | Response message for BigtableInstanceAdmin.ListClusters. | ### list_hot_tablets list_hot_tablets( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListHotTabletsRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsPager ) Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_hot_tablets(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListHotTabletsRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_hot_tablets(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListHotTabletsRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListHotTablets. | | `parent` | `str` Required. The cluster name to list hot tablets. Value is in the following form: `projects/{project}/instances/{instance}/clusters/{cluster}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListHotTabletsPager` | Response message for BigtableInstanceAdmin.ListHotTablets. Iterating over this object will yield results and resolve additional pages automatically. | ### list_instances list_instances( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListInstancesResponse Lists information about instances in a project. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_instances(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListInstancesRequest.html( parent="parent_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_instances(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListInstancesRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListInstances. | | `parent` | `str` Required. The unique name of the project for which a list of instances is requested. Values are of the form `projects/{project}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListInstancesResponse` | Response message for BigtableInstanceAdmin.ListInstances. | ### list_logical_views list_logical_views( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListLogicalViewsRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsPager ) Lists information about logical views in an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_logical_views(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListLogicalViewsRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_logical_views(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListLogicalViewsRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListLogicalViews. | | `parent` | `str` Required. The unique name of the instance for which the list of logical views is requested. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListLogicalViewsPager` | Response message for BigtableInstanceAdmin.ListLogicalViews. Iterating over this object will yield results and resolve additional pages automatically. | ### list_materialized_views list_materialized_views( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.ListMaterializedViewsRequest, dict, ] ] = None, *, parent: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> ( google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsPager ) Lists information about materialized views in an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_list_materialized_views(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListMaterializedViewsRequest.html( parent="parent_value", ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_list_materialized_views(request=request) # Handle the response for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.ListMaterializedViewsRequest, dict]` The request object. Request message for BigtableInstanceAdmin.ListMaterializedViews. | | `parent` | `str` Required. The unique name of the instance for which the list of materialized views is requested. Values are of the form `projects/{project}/instances/{instance}`. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers.ListMaterializedViewsPager` | Response message for BigtableInstanceAdmin.ListMaterializedViews. Iterating over this object will yield results and resolve additional pages automatically. | ### logical_view_path logical_view_path(project: str, instance: str, logical_view: str) -> str Returns a fully-qualified logical_view string. ### materialized_view_path materialized_view_path(project: str, instance: str, materialized_view: str) -> str Returns a fully-qualified materialized_view string. ### parse_app_profile_path parse_app_profile_path(path: str) -> typing.Dict[str, str] Parses a app_profile path into its component segments. ### parse_cluster_path parse_cluster_path(path: str) -> typing.Dict[str, str] Parses a cluster path into its component segments. ### parse_common_billing_account_path parse_common_billing_account_path(path: str) -> typing.Dict[str, str] Parse a billing_account path into its component segments. ### parse_common_folder_path parse_common_folder_path(path: str) -> typing.Dict[str, str] Parse a folder path into its component segments. ### parse_common_location_path parse_common_location_path(path: str) -> typing.Dict[str, str] Parse a location path into its component segments. ### parse_common_organization_path parse_common_organization_path(path: str) -> typing.Dict[str, str] Parse a organization path into its component segments. ### parse_common_project_path parse_common_project_path(path: str) -> typing.Dict[str, str] Parse a project path into its component segments. ### parse_crypto_key_path parse_crypto_key_path(path: str) -> typing.Dict[str, str] Parses a crypto_key path into its component segments. ### parse_hot_tablet_path parse_hot_tablet_path(path: str) -> typing.Dict[str, str] Parses a hot_tablet path into its component segments. ### parse_instance_path parse_instance_path(path: str) -> typing.Dict[str, str] Parses a instance path into its component segments. ### parse_logical_view_path parse_logical_view_path(path: str) -> typing.Dict[str, str] Parses a logical_view path into its component segments. ### parse_materialized_view_path parse_materialized_view_path(path: str) -> typing.Dict[str, str] Parses a materialized_view path into its component segments. ### parse_table_path parse_table_path(path: str) -> typing.Dict[str, str] Parses a table path into its component segments. ### partial_update_cluster partial_update_cluster( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateClusterRequest, dict, ] ] = None, *, cluster: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.Cluster ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Partially updates a cluster within a project. This method is the preferred way to update a Cluster. To enable and update autoscaling, set cluster_config.cluster_autoscaling_config. When autoscaling is enabled, serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it are ignored. Note that an update cannot simultaneously set serve_nodes to non-zero and cluster_config.cluster_autoscaling_config to non-empty, and also specify both in the update_mask. To disable autoscaling, clear cluster_config.cluster_autoscaling_config, and explicitly set a serve_node count via the update_mask. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_partial_update_cluster(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.PartialUpdateClusterRequest.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_partial_update_cluster(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.PartialUpdateClusterRequest, dict]` The request object. Request message for BigtableInstanceAdmin.PartialUpdateCluster. | | `cluster` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster` Required. The Cluster which contains the partial updates to be applied, subject to the update_mask. This corresponds to the `cluster` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `google.protobuf.field_mask_pb2.FieldMask` Required. The subset of Cluster fields which should be replaced. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Cluster](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster) A resizable group of nodes in a particular cloud location, capable of serving all `Tables][google.bigtable.admin.v2.Table]` in the parent `Instance][google.bigtable.admin.v2.Instance]`. | ### partial_update_instance partial_update_instance( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.PartialUpdateInstanceRequest, dict, ] ] = None, *, instance: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.Instance ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_partial_update_instance(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) instance = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance.html() instance.display_name = "display_name_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.PartialUpdateInstanceRequest.html( instance=instance, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_partial_update_instance(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.PartialUpdateInstanceRequest, dict]` The request object. Request message for BigtableInstanceAdmin.PartialUpdateInstance. | | `instance` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance` Required. The Instance which will (partially) replace the current value. This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `google.protobuf.field_mask_pb2.FieldMask` Required. The subset of Instance fields which should be replaced. Must be explicitly set. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Instance](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance) A collection of Bigtable `Tables][google.bigtable.admin.v2.Table]` and the resources that serve them. All tables in an instance are served from all `Clusters][google.bigtable.admin.v2.Cluster]` in the instance. | ### set_iam_policy set_iam_policy( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict] ] = None, *, resource: typing.Optional[str] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.policy_pb2.Policy Sets the access control policy on an instance resource. Replaces any existing policy. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 import google.iam.v1.iam_policy_pb2 as iam_policy_pb2 # type: ignore def sample_set_iam_policy(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = iam_policy_pb2.SetIamPolicyRequest( resource="resource_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_set_iam_policy(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[http://github.com/googleapis/python-grpc-google-iam-v1/blob/8e73b45993f030f521c0169b380d0fbafe66630b/google/iam/v1/iam_policy_pb2_grpc.py#L103-L109, dict]` The request object. Request message for `SetIamPolicy` method. | | `resource` | `str` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.iam.v1.policy_pb2.Policy` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the \[IAM documentation\](https://cloud.google.com/iam/help/conditions/resource-policies). \*\*JSON example:\*\* :literal:` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">`\\ \\` **YAML example:** :literal:` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:"\>`\ \` For a description of IAM and its features, see the \[IAM documentation\](https://cloud.google.com/iam/docs/). | ### table_path table_path(project: str, instance: str, table: str) -> str Returns a fully-qualified table string. ### test_iam_permissions test_iam_permissions( request: typing.Optional[ typing.Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict] ] = None, *, resource: typing.Optional[str] = None, permissions: typing.Optional[typing.MutableSequence[str]] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse Returns permissions that the caller has on the specified instance resource. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 import google.iam.v1.iam_policy_pb2 as iam_policy_pb2 # type: ignore def sample_test_iam_permissions(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = iam_policy_pb2.TestIamPermissionsRequest( resource="resource_value", permissions=['permissions_value1', 'permissions_value2'], ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_test_iam_permissions(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[http://github.com/googleapis/python-grpc-google-iam-v1/blob/8e73b45993f030f521c0169b380d0fbafe66630b/google/iam/v1/iam_policy_pb2_grpc.py#L120-L131, dict]` The request object. Request message for `TestIamPermissions` method. | | `resource` | `str` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set. | | `permissions` | `MutableSequence[str]` The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.* ') are not allowed. For more information see `IAM Overview https://cloud.google.com/iam/docs/overview#permissions`__. This corresponds to the `permissions` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `http://github.com/googleapis/python-grpc-google-iam-v1/blob/8e73b45993f030f521c0169b380d0fbafe66630b/google/iam/v1/iam_policy_pb2_grpc.py#L120-L131` | Response message for TestIamPermissions method. | ### update_app_profile update_app_profile( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateAppProfileRequest, dict, ] ] = None, *, app_profile: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.AppProfile ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates an app profile within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_update_app_profile(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) app_profile = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile.html() app_profile.priority = "PRIORITY_HIGH" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateAppProfileRequest.html( app_profile=app_profile, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_update_app_profile(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateAppProfileRequest, dict]` The request object. Request message for BigtableInstanceAdmin.UpdateAppProfile. | | `app_profile` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile` Required. The app profile which will (partially) replace the current value. This corresponds to the `app_profile` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `google.protobuf.field_mask_pb2.FieldMask` Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [AppProfile](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.AppProfile) A configuration object describing how Cloud Bigtable should treat traffic from a particular end user application. | ### update_cluster update_cluster( request: typing.Optional[ typing.Union[google.cloud.bigtable_admin_v2.types.instance.Cluster, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you must use PartialUpdateCluster. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_update_cluster(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster.html( ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_update_cluster(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster, dict]` The request object. A resizable group of nodes in a particular cloud location, capable of serving all `Tables][google.bigtable.admin.v2.Table]` in the parent `Instance][google.bigtable.admin.v2.Instance]`. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [Cluster](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Cluster) A resizable group of nodes in a particular cloud location, capable of serving all `Tables][google.bigtable.admin.v2.Table]` in the parent `Instance][google.bigtable.admin.v2.Instance]`. | ### update_instance update_instance( request: typing.Optional[ typing.Union[google.cloud.bigtable_admin_v2.types.instance.Instance, dict] ] = None, *, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.cloud.bigtable_admin_v2.types.instance.Instance Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_update_instance(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance.html( display_name="display_name_value", ) # Make the request response = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_update_instance(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance, dict]` The request object. A collection of Bigtable `Tables][google.bigtable.admin.v2.Table]` and the resources that serve them. All tables in an instance are served from all `Clusters][google.bigtable.admin.v2.Cluster]` in the instance. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.Instance` | A collection of Bigtable `Tables][google.bigtable.admin.v2.Table]` and the resources that serve them. All tables in an instance are served from all `Clusters][google.bigtable.admin.v2.Cluster]` in the instance. | ### update_logical_view update_logical_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateLogicalViewRequest, dict, ] ] = None, *, logical_view: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.LogicalView ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates a logical view within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_update_logical_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) logical_view = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView.html() logical_view.query = "query_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateLogicalViewRequest.html( logical_view=logical_view, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_update_logical_view(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateLogicalViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.UpdateLogicalView. | | `logical_view` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView` Required. The logical view to update. The logical view's `name` field is used to identify the view to update. Format: `projects/{project}/instances/{instance}/logicalViews/{logical_view}`. This corresponds to the `logical_view` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `google.protobuf.field_mask_pb2.FieldMask` Optional. The list of fields to update. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [LogicalView](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.LogicalView) A SQL logical view object that can be referenced in SQL queries. | ### update_materialized_view update_materialized_view( request: typing.Optional[ typing.Union[ google.cloud.bigtable_admin_v2.types.bigtable_instance_admin.UpdateMaterializedViewRequest, dict, ] ] = None, *, materialized_view: typing.Optional[ google.cloud.bigtable_admin_v2.types.instance.MaterializedView ] = None, update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: typing.Optional[ typing.Union[ google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault, ] ] = _MethodDefault._DEFAULT_VALUE, timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = () ) -> google.api_core.operation.Operation Updates a materialized view within an instance. # This snippet has been automatically generated and should be regarded as a # code template only. # It will require modifications to work: # - It may require correct/in-range values for request initialization. # - It may require specifying regional endpoints when creating the service # client as shown in: # https://googleapis.dev/python/google-api-core/latest/client_options.html from google.cloud import bigtable_admin_v2 def sample_update_materialized_view(): # Create a client client = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html() # Initialize request argument(s) materialized_view = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView.html() materialized_view.query = "query_value" request = bigtable_admin_v2.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateMaterializedViewRequest.html( materialized_view=materialized_view, ) # Make the request operation = client.https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.BigtableInstanceAdminClient.html#google_cloud_bigtable_admin_v2_services_bigtable_instance_admin_BigtableInstanceAdminClient_update_materialized_view(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Union[https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.UpdateMaterializedViewRequest, dict]` The request object. Request message for BigtableInstanceAdmin.UpdateMaterializedView. | | `materialized_view` | `https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView` Required. The materialized view to update. The materialized view's `name` field is used to identify the view to update. Format: `projects/{project}/instances/{instance}/materializedViews/{materialized_view}`. This corresponds to the `materialized_view` field on the `request` instance; if `request` is provided, this should not be set. | | `update_mask` | `google.protobuf.field_mask_pb2.FieldMask` Optional. The list of fields to update. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set. | | `retry` | `google.api_core.retry.Retry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `google.api_core.operation.Operation` | An object representing a long-running operation. The result type for the operation will be [MaterializedView](https://docs.cloud.google.com/python/docs/reference/bigtable/latest/google.cloud.bigtable_admin_v2.types.MaterializedView) A materialized view object that can be referenced in SQL queries. |