def update_participant(
self,
request: gcd_participant.UpdateParticipantRequest = None,
*,
participant: gcd_participant.Participant = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcd_participant.Participant:
r"""Updates the specified participant.
Args:
request (google.cloud.dialogflow_v2.types.UpdateParticipantRequest):
The request object. The request message for
[Participants.UpdateParticipant][google.cloud.dialogflow.v2.Participants.UpdateParticipant].
participant (google.cloud.dialogflow_v2.types.Participant):
Required. The participant to update.
This corresponds to the ``participant`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Required. The mask to specify which
fields to update.
This corresponds to the ``update_mask`` 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.dialogflow_v2.types.Participant:
Represents a conversation participant
(human agent, virtual agent, end-user).
"""
# 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([participant, update_mask])
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 gcd_participant.UpdateParticipantRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, gcd_participant.UpdateParticipantRequest):
request = gcd_participant.UpdateParticipantRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if participant is not None:
request.participant = participant
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.update_participant]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("participant.name", request.participant.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def update_participant(
self,
request: Union[gcd_participant.UpdateParticipantRequest, dict] = None,
*,
participant: gcd_participant.Participant = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gcd_participant.Participant:
r"""Updates the specified participant.
.. code-block:: python
from google.cloud import dialogflow_v2
async def sample_update_participant():
# Create a client
client = dialogflow_v2.ParticipantsAsyncClient()
# Initialize request argument(s)
request = dialogflow_v2.UpdateParticipantRequest(
)
# Make the request
response = await client.update_participant(request=request)
# Handle the response
print(response)
Args:
request (Union[google.cloud.dialogflow_v2.types.UpdateParticipantRequest, dict]):
The request object. The request message for
[Participants.UpdateParticipant][google.cloud.dialogflow.v2.Participants.UpdateParticipant].
participant (:class:`google.cloud.dialogflow_v2.types.Participant`):
Required. The participant to update.
This corresponds to the ``participant`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Required. The mask to specify which
fields to update.
This corresponds to the ``update_mask`` 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.dialogflow_v2.types.Participant:
Represents a conversation participant
(human agent, virtual agent, end-user).
"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([participant, update_mask])
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 = gcd_participant.UpdateParticipantRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if participant is not None:
request.participant = participant
if update_mask is not None:
request.update_mask = update_mask
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.update_participant,
default_timeout=None,
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(
(("participant.name", request.participant.name),)
),
)
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response