FailoverInstanceRequest

com.google.cloud.alloydb.v1.service.FailoverInstanceRequest
See theFailoverInstanceRequest companion object
final case class FailoverInstanceRequest(name: String, requestId: String, validateOnly: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[FailoverInstanceRequest]

Message for triggering failover on an Instance

Value parameters

name

Required. The name of the resource. For the required format, see the comment on the Instance.name field.

requestId

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

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.

Attributes

Companion
object
Source
FailoverInstanceRequest.scala
Graph
Supertypes
trait Updatable[FailoverInstanceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
FailoverInstanceRequest.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
FailoverInstanceRequest.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
FailoverInstanceRequest.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
FailoverInstanceRequest.scala
def withName(`__v`: String): FailoverInstanceRequest

Attributes

Source
FailoverInstanceRequest.scala
def withUnknownFields(`__v`: UnknownFieldSet): FailoverInstanceRequest

Attributes

Source
FailoverInstanceRequest.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
FailoverInstanceRequest.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala