google_api_spanner v0.1.0 GoogleApi.Spanner.V1.Api.Projects View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Lists the supported instance configurations for a given project
Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: Cancelling the operation renders the instance immediately unreadable via the API. The instance can be deleted. All other attempts to modify the instance are rejected. Upon completion of the returned operation: Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). Databases can be created in the instance. The instance's allocated resource levels are readable via the API. The instance's state becomes `READY`. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful
Drops (aka deletes) a Cloud Spanner database
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource
Lists Cloud Spanner databases
Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect
Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session
Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`
Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead
Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB
Lists all sessions in a given database
Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction
Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction
Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead
Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`
Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB
Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource
Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response
Lists all instances in the given project
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service
Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. All other attempts to modify the instance are rejected. Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name
Link to this section Functions
spanner_projects_instance_configs_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.ListInstanceConfigsResponse.t()} | {:error, Tesla.Env.t()}
Lists the supported instance configurations for a given project.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- parent (String.t): Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/<project>`.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :pageToken (String.t): If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigsResponse.
- :pageSize (integer()): Number of instance configurations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ListInstanceConfigsResponse{}} on success {:error, info} on failure
spanner_projects_instances_create(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Spanner.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: Cancelling the operation renders the instance immediately unreadable via the API. The instance can be deleted. All other attempts to modify the instance are rejected. Upon completion of the returned operation: Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). Databases can be created in the instance. The instance's allocated resource levels are readable via the API. The instance's state becomes `READY`. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- parent (String.t): Required. The name of the project in which to create the instance. Values are of the form `projects/<project>`.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (CreateInstanceRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Operation{}} on success {:error, info} on failure
spanner_projects_instances_databases_create( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- parent (String.t): Required. The name of the instance that will serve the new database. Values are of the form `projects/<project>/instances/<instance>`.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (CreateDatabaseRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Operation{}} on success {:error, info} on failure
spanner_projects_instances_databases_drop_database( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Drops (aka deletes) a Cloud Spanner database.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- database (String.t): Required. The database to be dropped.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Empty{}} on success {:error, info} on failure
spanner_projects_instances_databases_get_ddl( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.GetDatabaseDdlResponse.t()} | {:error, Tesla.Env.t()}
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- database (String.t): Required. The database whose schema we wish to get.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.GetDatabaseDdlResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_get_iam_policy( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- resource (String.t): REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (GetIamPolicyRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Policy{}} on success {:error, info} on failure
spanner_projects_instances_databases_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.ListDatabasesResponse.t()} | {:error, Tesla.Env.t()}
Lists Cloud Spanner databases.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- parent (String.t): Required. The instance whose databases should be listed. Values are of the form `projects/<project>/instances/<instance>`.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :pageToken (String.t): If non-empty, `page_token` should contain a next_page_token from a previous ListDatabasesResponse.
- :pageSize (integer()): Number of databases to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ListDatabasesResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_begin_transaction( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Transaction.t()} | {:error, Tesla.Env.t()}
Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the transaction runs.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (BeginTransactionRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Transaction{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_commit( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.CommitResponse.t()} | {:error, Tesla.Env.t()}
Commits a transaction. The request includes the mutations to be applied to rows in the database. `Commit` might return an `ABORTED` error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If `Commit` returns `ABORTED`, the caller should re-attempt the transaction from the beginning, re-using the same session.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the transaction to be committed is running.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (CommitRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.CommitResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_create( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Session.t()} | {:error, Tesla.Env.t()}
Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- database (String.t): Required. The database in which the new session is created.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (CreateSessionRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Session{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_execute_sql( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.ResultSet.t()} | {:error, Tesla.Env.t()}
Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the SQL query should be performed.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (ExecuteSqlRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ResultSet{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_execute_streaming_sql( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.PartialResultSet.t()} | {:error, Tesla.Env.t()}
Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the SQL query should be performed.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (ExecuteSqlRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.PartialResultSet{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_list( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.ListSessionsResponse.t()} | {:error, Tesla.Env.t()}
Lists all sessions in a given database.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- database (String.t): Required. The database in which to list sessions.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :pageToken (String.t): If non-empty, `page_token` should contain a next_page_token from a previous ListSessionsResponse.
- :pageSize (integer()): Number of sessions to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- :filter (String.t): An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: `labels.key` where key is the name of a label Some examples of using filters are: `labels.env:` —> The session has the label "env". `labels.env:dev` —> The session has the label "env" and the value of the label contains the string "dev".
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ListSessionsResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_partition_query( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.PartitionResponse.t()} | {:error, Tesla.Env.t()}
Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session used to create the partitions.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (PartitionQueryRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.PartitionResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_partition_read( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.PartitionResponse.t()} | {:error, Tesla.Env.t()}
Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted or begins a new transaction.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session used to create the partitions.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (PartitionReadRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.PartitionResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_read( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.ResultSet.t()} | {:error, Tesla.Env.t()}
Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the read should be performed.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (ReadRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ResultSet{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_rollback( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit. `Rollback` returns `OK` if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. `Rollback` never returns `ABORTED`.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the transaction to roll back is running.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (RollbackRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Empty{}} on success {:error, info} on failure
spanner_projects_instances_databases_sessions_streaming_read( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.PartialResultSet.t()} | {:error, Tesla.Env.t()}
Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- session (String.t): Required. The session in which the read should be performed.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (ReadRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.PartialResultSet{}} on success {:error, info} on failure
spanner_projects_instances_databases_set_iam_policy( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Sets the access control policy on a database resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- resource (String.t): REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for databases resources.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (SetIamPolicyRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Policy{}} on success {:error, info} on failure
spanner_projects_instances_databases_test_iam_permissions( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
Returns permissions that the caller has on the specified database resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- resource (String.t): REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/<project ID>/instances/<instance ID>` for instance resources and `projects/<project ID>/instances/<instance ID>/databases/<database ID>` for database resources.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (TestIamPermissionsRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure
spanner_projects_instances_databases_update_ddl( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc. The returned long-running operation will have a name of the format `<database_name>/operations/<operation_id>` and can be used to track execution of the schema change(s). The metadata field type is UpdateDatabaseDdlMetadata. The operation has no response.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- database (String.t): Required. The database to update.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (UpdateDatabaseDdlRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Operation{}} on success {:error, info} on failure
spanner_projects_instances_list(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Spanner.V1.Model.ListInstancesResponse.t()} | {:error, Tesla.Env.t()}
Lists all instances in the given project.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- parent (String.t): Required. The name of the project for which a list of instances is requested. Values are of the form `projects/<project>`.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :pageToken (String.t): If non-empty, `page_token` should contain a next_page_token from a previous ListInstancesResponse.
- :pageSize (integer()): Number of instances to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- :filter (String.t): An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: `name` `display_name` `labels.key` where key is the name of a label Some examples of using filters are: `name:` —> The instance has a name. `name:Howl` —> The instance's name contains the string "howl". `name:HOWL` —> Equivalent to above. `NAME:howl` —> Equivalent to above. `labels.env:` —> The instance has the label "env". `labels.env:dev` —> The instance has the label "env" and the value of the label contains the string "dev". `name:howl labels.env:dev` —> The instance's name contains "howl" and it has the label "env" with its value containing "dev".
Returns
{:ok, %GoogleApi.Spanner.V1.Model.ListInstancesResponse{}} on success {:error, info} on failure
spanner_projects_instances_operations_cancel( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- name (String.t): The name of the operation resource to be cancelled.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Empty{}} on success {:error, info} on failure
spanner_projects_instances_operations_delete( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- name (String.t): The name of the operation resource to be deleted.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Empty{}} on success {:error, info} on failure
spanner_projects_instances_operations_get( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, GoogleApi.Spanner.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- name (String.t): The name of the operation resource.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :pageToken (String.t): The standard list page token.
- :pageSize (integer()): The standard list page size.
- :filter (String.t): The standard list filter.
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Operation{}} on success {:error, info} on failure
spanner_projects_instances_patch(Tesla.Env.client(), String.t(), keyword()) :: {:ok, GoogleApi.Spanner.V1.Model.Operation.t()} | {:error, Tesla.Env.t()}
Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. All other attempts to modify the instance are rejected. Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `<instance_name>/operations/<operation_id>` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on resource name.
Parameters
- connection (GoogleApi.Spanner.V1.Connection): Connection to server
- name (String.t): Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects/<project>/instances/a-z*[a-z0-9]`. The final segment of the name must be between 6 and 30 characters in length.
opts (KeywordList): [optional] Optional parameters
- :alt (String.t): Data format for response.
- :key (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.
- :access_token (String.t): OAuth access token.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :quotaUser (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.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :callback (String.t): JSONP
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :$.xgafv (String.t): V1 error format.
- :body (UpdateInstanceRequest):
Returns
{:ok, %GoogleApi.Spanner.V1.Model.Operation{}} on success {:error, info} on failure