View Source GoogleApi.AlloyDB.V1.Api.Projects (google_api_alloy_db v0.6.0)
API calls for all endpoints tagged Projects
.
Summary
Functions
Creates a new Backup in a given project and location.
Deletes a single Backup.
Gets details of a single Backup.
Lists Backups in a given project and location.
Updates the parameters of a single Backup.
Creates a new Cluster in a given project and location.
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Deletes a single Cluster.
Gets details of a single Cluster.
Creates a new Instance in a given project and location.
Creates a new SECONDARY Instance in a given project and location.
Deletes a single Instance.
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
Gets details of a single Instance.
Get instance metadata used for a connection.
Injects fault in an instance. Imperative only.
Lists Instances in a given project and location.
Updates the parameters of a single Instance.
Restart an Instance in a cluster. Imperative only.
Lists Clusters in a given project and location.
Updates the parameters of a single Cluster.
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.
Creates a new User in a given project, location, and cluster.
Deletes a single User.
Gets details of a single User.
Lists Users in a given project and location.
Updates the parameters of a single User.
Gets information about a location.
Lists information about the supported locations for this service.
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.
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Lists SupportedDatabaseFlags for a given project and location.
Functions
alloydb_projects_locations_backups_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_backups_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Backup in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Value for parent. -
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. ID of the requesting object. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Backup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_backups_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_backups_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Backup.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the resource. For the required format, see the comment on the Backup.name field. -
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 Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_backups_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_backups_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Backup.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Backup.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the resource -
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.AlloyDB.V1.Model.Backup{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_backups_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_backups_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListBackupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Backups in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent value for ListBackupsRequest -
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
) - Filtering results -
:orderBy
(type:String.t
) - Hint for how to order the results -
:pageSize
(type:integer()
) - Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListBackupsResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_backups_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_backups_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single Backup.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The name of the backup resource with the format: projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression[a-z]([a-z0-9-]{0,61}[a-z0-9])?
, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: projects/{project}/locations/{region} -
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"). -
:allowMissing
(type:boolean()
) - Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created andupdate_mask
is ignored. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:updateMask
(type:String.t
) - Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Backup.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Cluster in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. -
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. ID of the requesting object. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_createsecondary(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_createsecondary( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. -
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. ID of the requesting object (the secondary cluster). -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Cluster.name field. -
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 Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned. -
:force
(type:boolean()
) - Optional. Whether to cascade delete child instances for given cluster. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Cluster.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Cluster.name field. -
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 view of the cluster to return. Returns all default fields if not set.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Cluster{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Instance in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. -
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"). -
:instanceId
(type:String.t
) - Required. ID of the requesting object. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_createsecondary(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_createsecondary( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new SECONDARY Instance in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. -
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"). -
:instanceId
(type:String.t
) - Required. ID of the requesting object. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single Instance.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Instance.name field. -
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 Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_failover(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_failover( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Instance.name field. -
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.AlloyDB.V1.Model.FailoverInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Instance.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single Instance.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Instance.name field. -
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 of the instance to return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Instance{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_get_connection_info(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_get_connection_info( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ConnectionInfo.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Get instance metadata used for a connection.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance} -
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"). -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ConnectionInfo{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_inject_fault(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_inject_fault( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Injects fault in an instance. Imperative only.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Instance.name field. -
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.AlloyDB.V1.Model.InjectFaultRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListInstancesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Instances in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: projects/{project}/locations/-/clusters/- projects/{project}/locations/{region}/clusters/- -
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
) - Optional. Filtering results -
:orderBy
(type:String.t
) - Optional. Hint for how to order the results -
:pageSize
(type:integer()
) - Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListInstancesResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single Instance.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The name of the instance resource with the format: projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression[a-z]([a-z0-9-]{0,61}[a-z0-9])?
, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: projects/{project}/locations/{region}/clusters/{cluster_id} -
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"). -
:allowMissing
(type:boolean()
) - Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created andupdate_mask
is ignored. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:updateMask
(type:String.t
) - Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Instance.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_instances_restart(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_instances_restart( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Restart an Instance in a cluster. Imperative only.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Instance.name field. -
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.AlloyDB.V1.Model.RestartInstanceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListClustersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Clusters in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project}/locations/- -
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
) - Optional. Filtering results -
:orderBy
(type:String.t
) - Optional. Hint for how to order the results -
:pageSize
(type:integer()
) - Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListClustersResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single Cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. The name of the cluster resource with the format: projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression[a-z0-9-]+
. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: projects/{project}/locations/{region} -
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"). -
:allowMissing
(type:boolean()
) - Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created andupdate_mask
is ignored. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:updateMask
(type:String.t
) - Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. -
:validateOnly
(type:boolean()
) - Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. -
:body
(type:GoogleApi.AlloyDB.V1.Model.Cluster.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_promote(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_promote( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Cluster.name field -
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.AlloyDB.V1.Model.PromoteClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_restore(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_restore( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. -
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.AlloyDB.V1.Model.RestoreClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_switchover(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_switchover( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the Cluster.name field -
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.AlloyDB.V1.Model.SwitchoverClusterRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_users_create(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_users_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a new User in a given project, location, and cluster.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Value for parent. -
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"). -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:userId
(type:String.t
) - Required. ID of the requesting object. -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it. -
:body
(type:GoogleApi.AlloyDB.V1.Model.User.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.User{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_users_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_users_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a single User.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the User.name field. -
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"). -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Empty{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_users_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_users_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets details of a single User.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The name of the resource. For the required format, see the comment on the User.name field. -
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.AlloyDB.V1.Model.User{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_users_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_users_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListUsersResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Users in a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Parent value for ListUsersRequest -
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
) - Optional. Filtering results -
:orderBy
(type:String.t
) - Optional. Hint for how to order the results -
:pageSize
(type:integer()
) - Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - Optional. A token identifying a page of results the server should return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListUsersResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_clusters_users_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_clusters_users_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.User.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates the parameters of a single User.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}. -
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"). -
:allowMissing
(type:boolean()
) - Optional. Allow missing fields in the update mask. -
:requestId
(type:String.t
) - Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). -
:updateMask
(type:String.t
) - Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. -
:validateOnly
(type:boolean()
) - Optional. If set, the backend validates the request, but doesn't actually execute it. -
:body
(type:GoogleApi.AlloyDB.V1.Model.User.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.User{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.GoogleCloudLocationLocation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets information about a location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Resource name for the location. -
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.AlloyDB.V1.Model.GoogleCloudLocationLocation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.GoogleCloudLocationListLocationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists information about the supported locations for this service.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - 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.AlloyDB.V1.Model.GoogleCloudLocationListLocationsResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be cancelled. -
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.AlloyDB.V1.Model.CancelOperationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.Empty{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource to be deleted. -
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.AlloyDB.V1.Model.Empty{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation resource. -
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.AlloyDB.V1.Model.Operation{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListOperationsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the operation's parent resource. -
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
) - The standard list filter. -
:pageSize
(type:integer()
) - The standard list page size. -
:pageToken
(type:String.t
) - The standard list page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListOperationsResponse{}}
on success -
{:error, info}
on failure
alloydb_projects_locations_supported_database_flags_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec alloydb_projects_locations_supported_database_flags_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AlloyDB.V1.Model.ListSupportedDatabaseFlagsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists SupportedDatabaseFlags for a given project and location.
Parameters
-
connection
(type:GoogleApi.AlloyDB.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. -
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()
) - Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. -
:pageToken
(type:String.t
) - A token identifying a page of results the server should return.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.AlloyDB.V1.Model.ListSupportedDatabaseFlagsResponse{}}
on success -
{:error, info}
on failure