DiffResponse

pulumirpc.provider.DiffResponse
See theDiffResponse companion object
final case class DiffResponse(replaces: Seq[String], stables: Seq[String], deleteBeforeReplace: Boolean, changes: DiffChanges, diffs: Seq[String], detailedDiff: Map[String, PropertyDiff], hasDetailedDiff: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DiffResponse]

Value parameters

changes

if true, this diff represents an actual difference and thus requires an update.

deleteBeforeReplace

if true, this resource must be deleted before replacing it.

detailedDiff

detailedDiff is an optional field that contains map from each changed property to the type of the change. The keys of this map are property paths. These paths are essentially Javascript property access expressions in which all elements are literals, and obey the following EBNF-ish grammar: propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] } quotedPropertyName := '"' ( '&92;' '"' | [^"] ) { ( '&92;' '"' | [^"] ) } '"' arrayIndex := { [0-9] } propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']' rootProperty := ( propertyName | propertyIndex ) propertyAccessor := ( ( '.' propertyName ) | propertyIndex ) path := rootProperty { propertyAccessor } Examples of valid keys:

  • root
  • root.nested
  • root["nested"]
  • root.double.nest
  • root["double"].nest
  • root["double"]["nest"]
  • root.array[0]
  • root.array[100]
  • root.array[0].nested
  • root.array[0][1].nested
  • root.nested.array[0].double[1]
  • root["key with &92;"escaped&92;" quotes"]
  • root["key with a ."]
  • ["root key with &92;"escaped&92;" quotes"].nested
  • ["root key with a ."][100] a detailed diff appropriate for display.
diffs

a list of the properties that changed. This should only contain top level property names, it does not support nested properties. For that use detailedDiff.

hasDetailedDiff

true if this response contains a detailed diff.

replaces

if this update requires a replacement, the set of properties triggering it.

stables

an optional list of properties that will not ever change.

Attributes

Companion
object
Graph
Supertypes
trait Updatable[DiffResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addDiffs(`__vs`: String*): DiffResponse
def addStables(`__vs`: String*): DiffResponse
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage

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.

def withUnknownFields(`__v`: UnknownFieldSet): DiffResponse
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Inherited methods

Attributes

Inherited from:
Product

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
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
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage

Attributes

Inherited from:
Updatable
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
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