Class: Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRuleAction

Inherits:

Object

• Object
• Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRuleAction

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/gkebackup/v1/restore.rb

Overview

TransformationRuleAction defines a TransformationRule action based on the JSON Patch RFC (https://www.rfc-editor.org/rfc/rfc6902)

Defined Under Namespace

Modules: Op

Instance Attribute Summary

• #from_path ⇒ ::String

  Optional.

• #op ⇒ ::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRuleAction::Op

  Required.

• #path ⇒ ::String

  Optional.

• #value ⇒ ::String

  Optional.

Instance Attribute Details

#from_path ⇒ ::String

Returns Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.

Returns:

• (::String) —

  Optional. A string containing a JSON Pointer value that references the location in the target document to move the value from.

# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 374

class TransformationRuleAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible values for operations of a transformation rule action.
  module Op
    # Unspecified operation
    OP_UNSPECIFIED = 0

    # The "remove" operation removes the value at the target location.
    REMOVE = 1

    # The "move" operation removes the value at a specified location and
    # adds it to the target location.
    MOVE = 2

    # The "copy" operation copies the value at a specified location to the
    # target location.
    COPY = 3

    # The "add" operation performs one of the following functions,
    # depending upon what the target location references:
    # 1. If the target location specifies an array index, a new value is
    # inserted into the array at the specified index.
    # 2. If the target location specifies an object member that does not
    # already exist, a new member is added to the object.
    # 3. If the target location specifies an object member that does exist,
    # that member's value is replaced.
    ADD = 4

    # The "test" operation tests that a value at the target location is
    # equal to a specified value.
    TEST = 5

    # The "replace" operation replaces the value at the target location
    # with a new value.  The operation object MUST contain a "value" member
    # whose content specifies the replacement value.
    REPLACE = 6
  end
end

#op ⇒ ::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRuleAction::Op

Returns Required. op specifies the operation to perform.

Returns:

• (::Google::Cloud::GkeBackup::V1::RestoreConfig::TransformationRuleAction::Op) —

  Required. op specifies the operation to perform.

# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 374

class TransformationRuleAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible values for operations of a transformation rule action.
  module Op
    # Unspecified operation
    OP_UNSPECIFIED = 0

    # The "remove" operation removes the value at the target location.
    REMOVE = 1

    # The "move" operation removes the value at a specified location and
    # adds it to the target location.
    MOVE = 2

    # The "copy" operation copies the value at a specified location to the
    # target location.
    COPY = 3

    # The "add" operation performs one of the following functions,
    # depending upon what the target location references:
    # 1. If the target location specifies an array index, a new value is
    # inserted into the array at the specified index.
    # 2. If the target location specifies an object member that does not
    # already exist, a new member is added to the object.
    # 3. If the target location specifies an object member that does exist,
    # that member's value is replaced.
    ADD = 4

    # The "test" operation tests that a value at the target location is
    # equal to a specified value.
    TEST = 5

    # The "replace" operation replaces the value at the target location
    # with a new value.  The operation object MUST contain a "value" member
    # whose content specifies the replacement value.
    REPLACE = 6
  end
end

#path ⇒ ::String

Returns Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.

Returns:

• (::String) —

  Optional. A string containing a JSON-Pointer value that references a location within the target document where the operation is performed.

# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 374

class TransformationRuleAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible values for operations of a transformation rule action.
  module Op
    # Unspecified operation
    OP_UNSPECIFIED = 0

    # The "remove" operation removes the value at the target location.
    REMOVE = 1

    # The "move" operation removes the value at a specified location and
    # adds it to the target location.
    MOVE = 2

    # The "copy" operation copies the value at a specified location to the
    # target location.
    COPY = 3

    # The "add" operation performs one of the following functions,
    # depending upon what the target location references:
    # 1. If the target location specifies an array index, a new value is
    # inserted into the array at the specified index.
    # 2. If the target location specifies an object member that does not
    # already exist, a new member is added to the object.
    # 3. If the target location specifies an object member that does exist,
    # that member's value is replaced.
    ADD = 4

    # The "test" operation tests that a value at the target location is
    # equal to a specified value.
    TEST = 5

    # The "replace" operation replaces the value at the target location
    # with a new value.  The operation object MUST contain a "value" member
    # whose content specifies the replacement value.
    REPLACE = 6
  end
end

#value ⇒ ::String

Returns Optional. A string that specifies the desired value in string format to use for transformation.

Returns:

• (::String) —

  Optional. A string that specifies the desired value in string format to use for transformation.

# File 'proto_docs/google/cloud/gkebackup/v1/restore.rb', line 374

class TransformationRuleAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Possible values for operations of a transformation rule action.
  module Op
    # Unspecified operation
    OP_UNSPECIFIED = 0

    # The "remove" operation removes the value at the target location.
    REMOVE = 1

    # The "move" operation removes the value at a specified location and
    # adds it to the target location.
    MOVE = 2

    # The "copy" operation copies the value at a specified location to the
    # target location.
    COPY = 3

    # The "add" operation performs one of the following functions,
    # depending upon what the target location references:
    # 1. If the target location specifies an array index, a new value is
    # inserted into the array at the specified index.
    # 2. If the target location specifies an object member that does not
    # already exist, a new member is added to the object.
    # 3. If the target location specifies an object member that does exist,
    # that member's value is replaced.
    ADD = 4

    # The "test" operation tests that a value at the target location is
    # equal to a specified value.
    TEST = 5

    # The "replace" operation replaces the value at the target location
    # with a new value.  The operation object MUST contain a "value" member
    # whose content specifies the replacement value.
    REPLACE = 6
  end
end