Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest (v0.17.2)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest.

Request message for Bigtable.CheckAndMutateRow.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_profile_id

def app_profile_id() -> ::String
Returns
  • (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.

#app_profile_id=

def app_profile_id=(value) -> ::String
Parameter
  • value (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.
Returns
  • (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.

#false_mutations

def false_mutations() -> ::Array<::Google::Cloud::Bigtable::V2::Mutation>
Returns
  • (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.

#false_mutations=

def false_mutations=(value) -> ::Array<::Google::Cloud::Bigtable::V2::Mutation>
Parameter
  • value (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.
Returns
  • (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter does not yield any cells when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if true_mutations is empty, and at most 100000.

#predicate_filter

def predicate_filter() -> ::Google::Cloud::Bigtable::V2::RowFilter
Returns
  • (::Google::Cloud::Bigtable::V2::RowFilter) — The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.

#predicate_filter=

def predicate_filter=(value) -> ::Google::Cloud::Bigtable::V2::RowFilter
Parameter
  • value (::Google::Cloud::Bigtable::V2::RowFilter) — The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.
Returns
  • (::Google::Cloud::Bigtable::V2::RowFilter) — The filter to be applied to the contents of the specified row. Depending on whether or not any results are yielded, either true_mutations or false_mutations will be executed. If unset, checks that the row contains any values at all.

#row_key

def row_key() -> ::String
Returns
  • (::String) — Required. The key of the row to which the conditional mutation should be applied.

#row_key=

def row_key=(value) -> ::String
Parameter
  • value (::String) — Required. The key of the row to which the conditional mutation should be applied.
Returns
  • (::String) — Required. The key of the row to which the conditional mutation should be applied.

#table_name

def table_name() -> ::String
Returns
  • (::String) — Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

#table_name=

def table_name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
Returns
  • (::String) — Required. The unique name of the table to which the conditional mutation should be applied. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

#true_mutations

def true_mutations() -> ::Array<::Google::Cloud::Bigtable::V2::Mutation>
Returns
  • (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.

#true_mutations=

def true_mutations=(value) -> ::Array<::Google::Cloud::Bigtable::V2::Mutation>
Parameter
  • value (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.
Returns
  • (::Array<::Google::Cloud::Bigtable::V2::Mutation>) — Changes to be atomically applied to the specified row if predicate_filter yields at least one cell when applied to row_key. Entries are applied in order, meaning that earlier mutations can be masked by later ones. Must contain at least one entry if false_mutations is empty, and at most 100000.