trait AlloyDBAdmin[F[_]] extends AnyRef

Service describing handlers for resources

Source
AlloyDBAdmin.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AlloyDBAdmin
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def batchCreateInstances(request: BatchCreateInstancesRequest, ctx: Headers): F[Operation]

    Creates new instances under the given project, location and cluster.

    Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

  2. abstract def createBackup(request: CreateBackupRequest, ctx: Headers): F[Operation]

    Creates a new Backup in a given project and location.

  3. abstract def createCluster(request: CreateClusterRequest, ctx: Headers): F[Operation]

    Creates a new Cluster in a given project and location.

  4. abstract def createInstance(request: CreateInstanceRequest, ctx: Headers): F[Operation]

    Creates a new Instance in a given project and location.

  5. abstract def createSecondaryCluster(request: CreateSecondaryClusterRequest, ctx: Headers): F[Operation]

    Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

  6. abstract def createSecondaryInstance(request: CreateSecondaryInstanceRequest, ctx: Headers): F[Operation]

    Creates a new SECONDARY Instance in a given project and location.

  7. abstract def createUser(request: CreateUserRequest, ctx: Headers): F[User]

    Creates a new User in a given project, location, and cluster.

  8. abstract def deleteBackup(request: DeleteBackupRequest, ctx: Headers): F[Operation]

    Deletes a single Backup.

  9. abstract def deleteCluster(request: DeleteClusterRequest, ctx: Headers): F[Operation]

    Deletes a single Cluster.

  10. abstract def deleteInstance(request: DeleteInstanceRequest, ctx: Headers): F[Operation]

    Deletes a single Instance.

  11. abstract def deleteUser(request: DeleteUserRequest, ctx: Headers): F[Empty]

    Deletes a single User.

  12. abstract def failoverInstance(request: FailoverInstanceRequest, ctx: Headers): F[Operation]

    Forces a Failover for a highly available instance.

    Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

  13. abstract def generateClientCertificate(request: GenerateClientCertificateRequest, ctx: Headers): F[GenerateClientCertificateResponse]

    Generate a client certificate signed by a Cluster CA.

    Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

  14. abstract def getBackup(request: GetBackupRequest, ctx: Headers): F[Backup]

    Gets details of a single Backup.

  15. abstract def getCluster(request: GetClusterRequest, ctx: Headers): F[Cluster]

    Gets details of a single Cluster.

  16. abstract def getConnectionInfo(request: GetConnectionInfoRequest, ctx: Headers): F[ConnectionInfo]

    Get instance metadata used for a connection.

  17. abstract def getInstance(request: GetInstanceRequest, ctx: Headers): F[Instance]

    Gets details of a single Instance.

  18. abstract def getUser(request: GetUserRequest, ctx: Headers): F[User]

    Gets details of a single User.

  19. abstract def injectFault(request: InjectFaultRequest, ctx: Headers): F[Operation]

    Injects fault in an instance.

    Injects fault in an instance. Imperative only.

  20. abstract def listBackups(request: ListBackupsRequest, ctx: Headers): F[ListBackupsResponse]

    Lists Backups in a given project and location.

  21. abstract def listClusters(request: ListClustersRequest, ctx: Headers): F[ListClustersResponse]

    Lists Clusters in a given project and location.

  22. abstract def listInstances(request: ListInstancesRequest, ctx: Headers): F[ListInstancesResponse]

    Lists Instances in a given project and location.

  23. abstract def listSupportedDatabaseFlags(request: ListSupportedDatabaseFlagsRequest, ctx: Headers): F[ListSupportedDatabaseFlagsResponse]

    Lists SupportedDatabaseFlags for a given project and location.

  24. abstract def listUsers(request: ListUsersRequest, ctx: Headers): F[ListUsersResponse]

    Lists Users in a given project and location.

  25. abstract def promoteCluster(request: PromoteClusterRequest, ctx: Headers): F[Operation]

    Promotes a SECONDARY 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.

  26. abstract def restartInstance(request: RestartInstanceRequest, ctx: Headers): F[Operation]

    Restart an Instance in a cluster.

    Restart an Instance in a cluster. Imperative only.

  27. abstract def restoreCluster(request: RestoreClusterRequest, ctx: Headers): F[Operation]

    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.

  28. abstract def updateBackup(request: UpdateBackupRequest, ctx: Headers): F[Operation]

    Updates the parameters of a single Backup.

  29. abstract def updateCluster(request: UpdateClusterRequest, ctx: Headers): F[Operation]

    Updates the parameters of a single Cluster.

  30. abstract def updateInstance(request: UpdateInstanceRequest, ctx: Headers): F[Operation]

    Updates the parameters of a single Instance.

  31. abstract def updateUser(request: UpdateUserRequest, ctx: Headers): F[User]

    Updates the parameters of a single User.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped