View Source GoogleApi.BigtableAdmin.V2.Api.Projects (google_api_bigtable_admin v0.22.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
Creates an app profile within an instance.
Deletes an app profile from an instance.
Gets information about an app profile.
Lists information about app profiles in an instance.
Updates an app profile within an instance.
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
Deletes a pending or completed Cloud Bigtable backup.
Gets metadata on a pending or completed Cloud Bigtable Backup.
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
Lists Cloud Bigtable backups. Returns both completed and pending backups.
Updates a pending or completed Cloud Bigtable Backup.
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
Returns permissions that the caller has on the specified Table or Backup resource.
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.
Deletes a cluster from an instance.
Gets information about a cluster.
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
Lists information about clusters in an instance.
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.
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.
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.
Delete an instance from a project.
Gets information about an instance.
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Lists information about instances in a project.
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.
Sets the access control policy on an instance resource. Replaces any existing policy.
Creates a new AuthorizedView in a table.
Permanently deletes a specified AuthorizedView.
Gets information from a specified AuthorizedView.
Lists all AuthorizedViews from a specific table.
Updates an AuthorizedView in a table.
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
Permanently deletes a specified table and all of its data.
Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice.
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
Gets metadata information about the specified table.
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
Lists all tables served from a specified instance.
Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
Updates a specified table.
Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
Returns permissions that the caller has on the specified Table or Backup resource.
Restores a specified table which was accidentally deleted.
Returns permissions that the caller has on the specified instance resource.
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.
Lists information about the supported locations for this service.
Functions
bigtableadmin_projects_instances_app_profiles_create(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_app_profiles_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.AppProfile.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an app profile within an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance in which to create the new app profile. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:appProfileId
(type:String.t
) - Required. The ID to be used when referring to the new app profile within its instance, e.g., justmyprofile
rather thanprojects/myproject/instances/myinstance/appProfiles/myprofile
. -
:ignoreWarnings
(type:boolean()
) - If true, ignore safety checks when creating the app profile. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.AppProfile.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.AppProfile{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_app_profiles_delete(connection, projects_id, instances_id, app_profiles_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_app_profiles_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an app profile from an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the app profile to be deleted. Values are of the formprojects/{project}/instances/{instance}/appProfiles/{app_profile}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
app_profiles_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:ignoreWarnings
(type:boolean()
) - Required. If true, ignore safety checks when deleting the app profile.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_app_profiles_get(connection, projects_id, instances_id, app_profiles_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_app_profiles_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.AppProfile.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about an app profile.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the requested app profile. Values are of the formprojects/{project}/instances/{instance}/appProfiles/{app_profile}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
app_profiles_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.AppProfile{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_app_profiles_list(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_app_profiles_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListAppProfilesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about app profiles in an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance for which a list of app profiles is requested. Values are of the formprojects/{project}/instances/{instance}
. Use{instance} = '-'
to list AppProfiles for all Instances in a project, e.g.,projects/myproject/instances/-
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -
:pageToken
(type:String.t
) - The value ofnext_page_token
returned by a previous call.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListAppProfilesResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_app_profiles_patch(connection, projects_id, instances_id, app_profiles_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_app_profiles_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an app profile within an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofappProfile.name
. The unique name of the app profile. Values are of the formprojects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*
. -
instances_id
(type:String.t
) - Part ofappProfile.name
. See documentation ofprojectsId
. -
app_profiles_id
(type:String.t
) - Part ofappProfile.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:ignoreWarnings
(type:boolean()
) - If true, ignore safety checks when updating the app profile. -
:updateMask
(type:String.t
) - Required. The subset of app profile fields which should be replaced. If unset, all fields will be replaced. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.AppProfile.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_copy(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_copy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Copy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form:projects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.CopyBackupRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_create(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:backupId
(type:String.t
) - Required. The id of the backup to be created. Thebackup_id
along with the parentparent
are combined as {parent}/backups/{backup_id} to create the full backup name, of the form:projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}
. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Backup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_delete(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a pending or completed Cloud Bigtable backup.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. Name of the backup to delete. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_get(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Backup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metadata on a pending or completed Cloud Bigtable Backup.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. Name of the backup. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Backup{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_get_iam_policy(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.GetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_list(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListBackupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Cloud Bigtable backups. Returns both completed and pending backups.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The cluster to list backups from. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. Use{cluster} = '-'
to list backups for all clusters in an instance, e.g.,projects/{project}/instances/{instance}/clusters/-
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A filter expression that filters backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are:name
source_table
state
start_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)end_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)expire_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)size_bytes
To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are:name:"exact"
--> The backup's name is the string "exact".name:howl
--> The backup's name contains the string "howl".source_table:prod
--> The source_table's name contains the string "prod".state:CREATING
--> The backup is pending creation.state:READY
--> The backup is fully created and ready for use.(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")
--> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.size_bytes > 10000000000
--> The backup's size is greater than 10GB -
:orderBy
(type:String.t
) - An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: name source_table expire_time start_time end_time size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted bystart_time
in descending order starting from the most recently created backup. -
:pageSize
(type:integer()
) - Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. -
:pageToken
(type:String.t
) - If non-empty,page_token
should contain a next_page_token from a previous ListBackupsResponse to the sameparent
and with the samefilter
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListBackupsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_patch(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Backup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a pending or completed Cloud Bigtable Backup.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofbackup.name
. A globally unique identifier for the backup which cannot be changed. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*
The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofbackup.name
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofbackup.name
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofbackup.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. A mask specifying which fields (e.g.expire_time
) in the Backup resource should be updated. This mask is relative to the Backup resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally by clients that do not know about them. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Backup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Backup{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_set_iam_policy(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_backups_test_iam_permissions(connection, projects_id, instances_id, clusters_id, backups_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_backups_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns permissions that the caller has on the specified Table or Backup resource.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
backups_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_create(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance in which to create the new cluster. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:clusterId
(type:String.t
) - Required. The ID to be used when referring to the new cluster within its instance, e.g., justmycluster
rather thanprojects/myproject/instances/myinstance/clusters/mycluster
. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_delete(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a cluster from an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the cluster to be deleted. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_get(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Cluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a cluster.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the requested cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Cluster{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_hot_tablets_list(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_hot_tablets_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListHotTabletsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The cluster name to list hot tablets. Value is in the following form:projects/{project}/instances/{instance}/clusters/{cluster}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:endTime
(type:DateTime.t
) - The end time to list hot tablets. -
:pageSize
(type:integer()
) - Maximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -
:pageToken
(type:String.t
) - The value ofnext_page_token
returned by a previous call. -
:startTime
(type:DateTime.t
) - The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListHotTabletsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_list(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about clusters in an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance for which a list of clusters is requested. Values are of the formprojects/{project}/instances/{instance}
. Use{instance} = '-'
to list Clusters for all Instances in a project, e.g.,projects/myproject/instances/-
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageToken
(type:String.t
) - DEPRECATED: This field is unused and ignored.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListClustersResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_partial_update_cluster(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_partial_update_cluster( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofcluster.name
. The unique name of the cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/a-z*
. -
instances_id
(type:String.t
) - Part ofcluster.name
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofcluster.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The subset of Cluster fields which should be replaced. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_clusters_update(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_clusters_update( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The unique name of the cluster. Values are of the formprojects/{project}/instances/{instance}/clusters/a-z*
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_create(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the project in which to create the new instance. Values are of the formprojects/{project}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.CreateInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_delete(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_delete( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Delete an instance from a project.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the instance to be deleted. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_get(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Instance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about an instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the requested instance. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Instance{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_get_iam_policy(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.GetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListInstancesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about instances in a project.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the project for which a list of instances is requested. Values are of the formprojects/{project}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageToken
(type:String.t
) - DEPRECATED: This field is unused and ignored.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListInstancesResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_partial_update_instance(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_partial_update_instance( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofinstance.name
. The unique name of the instance. Values are of the formprojects/{project}/instances/a-z+[a-z0-9]
. -
instances_id
(type:String.t
) - Part ofinstance.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The subset of Instance fields which should be replaced. Must be explicitly set. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_set_iam_policy(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on an instance resource. Replaces any existing policy.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_authorized_views_create(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_authorized_views_create( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new AuthorizedView in a table.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. This is the name of the table the AuthorizedView belongs to. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:authorizedViewId
(type:String.t
) - Required. The id of the AuthorizedView to create. This AuthorizedView must not already exist. Theauthorized_view_id
appended toparent
forms the full AuthorizedView name of the formprojects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}
. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.AuthorizedView.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_authorized_views_delete(connection, projects_id, instances_id, tables_id, authorized_views_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_authorized_views_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Permanently deletes a specified AuthorizedView.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the AuthorizedView to be deleted. Values are of the formprojects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
authorized_views_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:etag
(type:String.t
) - Optional. The current etag of the AuthorizedView. If an etag is provided and does not match the current etag of the AuthorizedView, deletion will be blocked and an ABORTED error will be returned.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_authorized_views_get(connection, projects_id, instances_id, tables_id, authorized_views_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_authorized_views_get( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.AuthorizedView.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information from a specified AuthorizedView.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the requested AuthorizedView. Values are of the formprojects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
authorized_views_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - Optional. The resource_view to be applied to the returned AuthorizedView's fields. Default to BASIC.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.AuthorizedView{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_authorized_views_list(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_authorized_views_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListAuthorizedViewsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all AuthorizedViews from a specific table.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the table for which AuthorizedViews should be listed. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Optional. Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -
:pageToken
(type:String.t
) - Optional. The value ofnext_page_token
returned by a previous call. -
:view
(type:String.t
) - Optional. The resource_view to be applied to the returned views' fields. Default to NAME_ONLY.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListAuthorizedViewsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_authorized_views_patch(connection, projects_id, instances_id, tables_id, authorized_views_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_authorized_views_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an AuthorizedView in a table.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofauthorizedView.name
. Identifier. The name of this AuthorizedView. Values are of the formprojects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
-
instances_id
(type:String.t
) - Part ofauthorizedView.name
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofauthorizedView.name
. See documentation ofprojectsId
. -
authorized_views_id
(type:String.t
) - Part ofauthorizedView.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:ignoreWarnings
(type:boolean()
) - Optional. If true, ignore the safety checks when updating the AuthorizedView. -
:updateMask
(type:String.t
) - Optional. The list of fields to update. A mask specifying which fields in the AuthorizedView resource should be updated. This mask is relative to the AuthorizedView resource, not to the request message. A field will be overwritten if it is in the mask. If empty, all fields set in the request will be overwritten. A special value*
means to overwrite all fields (including fields not set in the request). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.AuthorizedView.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_check_consistency(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_check_consistency( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.CheckConsistencyResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the Table for which to check replication consistency. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.CheckConsistencyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.CheckConsistencyResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_create(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Table.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance in which to create the table. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.CreateTableRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Table{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_delete(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Permanently deletes a specified table and all of its data.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the table to be deleted. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_drop_row_range(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_drop_row_range( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix. Note that row key prefixes used here are treated as service data. For more information about how service data is handled, see the Google Cloud Privacy Notice.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the table on which to drop a range of rows. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.DropRowRangeRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Empty{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_generate_consistency_token(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_generate_consistency_token( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.GenerateConsistencyTokenResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the Table for which to create a consistency token. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.GenerateConsistencyTokenRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.GenerateConsistencyTokenResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_get(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Table.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets metadata information about the specified table.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the requested table. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:view
(type:String.t
) - The view to be applied to the returned table's fields. Defaults toSCHEMA_VIEW
if unspecified.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Table{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_get_iam_policy(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_get_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.GetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_list(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListTablesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists all tables served from a specified instance.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The unique name of the instance for which tables should be listed. Values are of the formprojects/{project}/instances/{instance}
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:pageSize
(type:integer()
) - Maximum number of results per page. A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request. -
:pageToken
(type:String.t
) - The value ofnext_page_token
returned by a previous call. -
:view
(type:String.t
) - The view to be applied to the returned tables' fields. Only NAME_ONLY view (default), REPLICATION_VIEW and ENCRYPTION_VIEW are supported.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListTablesResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_modify_column_families(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_modify_column_families( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Table.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the table whose families should be modified. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.ModifyColumnFamiliesRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Table{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_patch(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_patch( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a specified table.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part oftable.name
. The unique name of the table. Values are of the formprojects/{project}/instances/{instance}/tables/_a-zA-Z0-9*
. Views:NAME_ONLY
,SCHEMA_VIEW
,REPLICATION_VIEW
,STATS_VIEW
,FULL
-
instances_id
(type:String.t
) - Part oftable.name
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part oftable.name
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The list of fields to update. A mask specifying which fields (e.g.change_stream_config
) in thetable
field should be updated. This mask is relative to thetable
field, not to the request message. The wildcard () path is currently not supported. Currently UpdateTable is only supported for the following fields:change_stream_config
change_stream_config.retention_period
deletion_protection
Ifcolumn_families
is set inupdate_mask
, it will return an UNIMPLEMENTED error. -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Table.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_restore(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_restore( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Create a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The name of the instance in which to create the restored table. Values are of the formprojects//instances/
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.RestoreTableRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_set_iam_policy(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_set_iam_policy( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Policy.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Sets the access control policy on a Table or Backup resource. Replaces any existing policy.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.SetIamPolicyRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Policy{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_test_iam_permissions(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns permissions that the caller has on the specified Table or Backup resource.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_tables_undelete(connection, projects_id, instances_id, tables_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_tables_undelete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Restores a specified table which was accidentally deleted.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. Required. The unique name of the table to be restored. Values are of the formprojects/{project}/instances/{instance}/tables/{table}
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
tables_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.UndeleteTableRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Operation{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_test_iam_permissions(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_test_iam_permissions( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns permissions that the caller has on the specified instance resource.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofresource
. REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field. -
instances_id
(type:String.t
) - Part ofresource
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.TestIamPermissionsResponse{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_instances_update(connection, projects_id, instances_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_instances_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.Instance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The unique name of the instance. Values are of the formprojects/{project}/instances/a-z+[a-z0-9]
. -
instances_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.BigtableAdmin.V2.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.Instance{}}
on success -
{:error, info}
on failure
bigtableadmin_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Source@spec bigtableadmin_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofname
. The resource that owns the locations collection, if applicable. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like"displayName=tokyo"
, and is documented in more detail in AIP-160. -
:pageSize
(type:integer()
) - The maximum number of results to return. If not set, the service selects a default. -
:pageToken
(type:String.t
) - A page token received from thenext_page_token
field in the response. Send that page token to receive the subsequent page.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListLocationsResponse{}}
on success -
{:error, info}
on failure