google_api_replica_pool v0.1.0 GoogleApi.ReplicaPool.V1beta1.Api.Replicas View Source

API calls for all endpoints tagged Replicas.

Link to this section Summary

Link to this section Functions

Link to this function

replicapool_replicas_delete(connection, project_name, zone, pool_name, replica_name, optional_params \\ [], opts \\ [])

View Source
replicapool_replicas_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta1.Model.Replica.t()}
  | {:error, Tesla.Env.t()}

Deletes a replica from the pool.

Parameters

  • connection (type: GoogleApi.ReplicaPool.V1beta1.Connection.t) - Connection to server
  • project_name (type: String.t) - The project ID for this request.
  • zone (type: String.t) - The zone where the replica lives.
  • pool_name (type: String.t) - The replica pool name for this request.
  • replica_name (type: String.t) - The name of the replica for this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :body (type: GoogleApi.ReplicaPool.V1beta1.Model.ReplicasDeleteRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReplicaPool.V1beta1.Model.Replica{}} on success
  • {:error, info} on failure
Link to this function

replicapool_replicas_get(connection, project_name, zone, pool_name, replica_name, optional_params \\ [], opts \\ [])

View Source
replicapool_replicas_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta1.Model.Replica.t()}
  | {:error, Tesla.Env.t()}

Gets information about a specific replica.

Parameters

  • connection (type: GoogleApi.ReplicaPool.V1beta1.Connection.t) - Connection to server
  • project_name (type: String.t) - The project ID for this request.
  • zone (type: String.t) - The zone where the replica lives.
  • pool_name (type: String.t) - The replica pool name for this request.
  • replica_name (type: String.t) - The name of the replica for this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReplicaPool.V1beta1.Model.Replica{}} on success
  • {:error, info} on failure
Link to this function

replicapool_replicas_list(connection, project_name, zone, pool_name, optional_params \\ [], opts \\ [])

View Source

Lists all replicas in a pool.

Parameters

  • connection (type: GoogleApi.ReplicaPool.V1beta1.Connection.t) - Connection to server
  • project_name (type: String.t) - The project ID for this request.
  • zone (type: String.t) - The zone where the replica pool lives.
  • pool_name (type: String.t) - The replica pool name for this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :maxResults (type: integer()) - Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50)
    • :pageToken (type: String.t) - Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReplicaPool.V1beta1.Model.ReplicasListResponse{}} on success
  • {:error, info} on failure
Link to this function

replicapool_replicas_restart(connection, project_name, zone, pool_name, replica_name, optional_params \\ [], opts \\ [])

View Source
replicapool_replicas_restart(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ReplicaPool.V1beta1.Model.Replica.t()}
  | {:error, Tesla.Env.t()}

Restarts a replica in a pool.

Parameters

  • connection (type: GoogleApi.ReplicaPool.V1beta1.Connection.t) - Connection to server
  • project_name (type: String.t) - The project ID for this request.
  • zone (type: String.t) - The zone where the replica lives.
  • pool_name (type: String.t) - The replica pool name for this request.
  • replica_name (type: String.t) - The name of the replica for this request.
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.ReplicaPool.V1beta1.Model.Replica{}} on success
  • {:error, info} on failure