def mutate_row(
self,
request: bigtable.MutateRowRequest = None,
*,
table_name: str = None,
row_key: bytes = None,
mutations: Sequence[data.Mutation] = None,
app_profile_id: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> bigtable.MutateRowResponse:
r"""Mutates a row atomically. Cells already present in the row are
left unchanged unless explicitly changed by ``mutation``.
Args:
request (google.cloud.bigtable_v2.types.MutateRowRequest):
The request object. Request message for
Bigtable.MutateRow.
table_name (str):
Required. The unique name of the table to which the
mutation should be applied. Values are of the form
``projects/<project>/instances/<instance>/tables/<table>``.
This corresponds to the ``table_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
row_key (bytes):
Required. The key of the row to which
the mutation should be applied.
This corresponds to the ``row_key`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
mutations (Sequence[google.cloud.bigtable_v2.types.Mutation]):
Required. Changes to be atomically
applied to the specified row. Entries
are applied in order, meaning that
earlier mutations can be masked by later
ones. Must contain at least one entry
and at most 100000.
This corresponds to the ``mutations`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
app_profile_id (str):
This value specifies routing for
replication. If not specified, the
"default" application profile will be
used.
This corresponds to the ``app_profile_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.bigtable_v2.types.MutateRowResponse:
Response message for
Bigtable.MutateRow.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any(
[table_name, row_key, mutations, app_profile_id])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a bigtable.MutateRowRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, bigtable.MutateRowRequest):
request = bigtable.MutateRowRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if table_name is not None:
request.table_name = table_name
if row_key is not None:
request.row_key = row_key
if mutations is not None:
request.mutations = mutations
if app_profile_id is not None:
request.app_profile_id = app_profile_id
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.mutate_row]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("table_name", request.table_name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def mutate_row(
self,
request: bigtable.MutateRowRequest = None,
*,
table_name: str = None,
row_key: bytes = None,
mutations: Sequence[data.Mutation] = None,
app_profile_id: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> bigtable.MutateRowResponse:
r"""Mutates a row atomically. Cells already present in the row are
left unchanged unless explicitly changed by ``mutation``.
Args:
request (:class:`google.cloud.bigtable_v2.types.MutateRowRequest`):
The request object. Request message for
Bigtable.MutateRow.
table_name (:class:`str`):
Required. The unique name of the table to which the
mutation should be applied. Values are of the form
``projects/<project>/instances/<instance>/tables/<table>``.
This corresponds to the ``table_name`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
row_key (:class:`bytes`):
Required. The key of the row to which
the mutation should be applied.
This corresponds to the ``row_key`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
mutations (:class:`Sequence[google.cloud.bigtable_v2.types.Mutation]`):
Required. Changes to be atomically
applied to the specified row. Entries
are applied in order, meaning that
earlier mutations can be masked by later
ones. Must contain at least one entry
and at most 100000.
This corresponds to the ``mutations`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
app_profile_id (:class:`str`):
This value specifies routing for
replication. If not specified, the
"default" application profile will be
used.
This corresponds to the ``app_profile_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.cloud.bigtable_v2.types.MutateRowResponse:
Response message for
Bigtable.MutateRow.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any(
[table_name, row_key, mutations, app_profile_id])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = bigtable.MutateRowRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if table_name is not None:
request.table_name = table_name
if row_key is not None:
request.row_key = row_key
if app_profile_id is not None:
request.app_profile_id = app_profile_id
if mutations:
request.mutations.extend(mutations)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.mutate_row,
default_retry=retries.Retry(
initial=0.01,
maximum=60.0,
multiplier=2,
predicate=retries.if_exception_type(
exceptions.DeadlineExceeded,
exceptions.ServiceUnavailable,
),
),
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("table_name", request.table_name), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response