Class: Google::Cloud::Bigtable::V2::CheckAndMutateRowRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/bigtable/v2/bigtable.rb

Overview

Request message for Bigtable.CheckAndMutateRow.

Instance Attribute Summary collapse

Instance Attribute Details

#app_profile_id::String

Returns 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.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#authorized_view_name::String

Returns Optional. The unique name of the AuthorizedView to which the conditional mutation should be applied.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

Returns:

  • (::String)

    Optional. The unique name of the AuthorizedView to which the conditional mutation should be applied.

    Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#false_mutations::Array<::Google::Cloud::Bigtable::V2::Mutation>

Returns 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.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#predicate_filter::Google::Cloud::Bigtable::V2::RowFilter

Returns 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.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#row_key::String

Returns 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.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#table_name::String

Returns Optional. 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)

    Optional. 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>.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#true_mutations::Array<::Google::Cloud::Bigtable::V2::Mutation>

Returns 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.



419
420
421
422
# File 'proto_docs/google/bigtable/v2/bigtable.rb', line 419

class CheckAndMutateRowRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end