def update_environment(
self,
request: gcdc_environment.UpdateEnvironmentRequest = None,
*,
environment: gcdc_environment.Environment = None,
update_mask: field_mask.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Updates the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
Args:
request (google.cloud.dialogflowcx_v3beta1.types.UpdateEnvironmentRequest):
The request object. The request message for
[Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3beta1.Environments.UpdateEnvironment].
environment (google.cloud.dialogflowcx_v3beta1.types.Environment):
Required. The environment to update.
This corresponds to the ``environment`` 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 control which
fields get updated.
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.api_core.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.dialogflowcx_v3beta1.types.Environment` Represents an environment for an agent. You can create multiple versions
of your agent and publish them to separate
environments. When you edit an agent, you are editing
the draft agent. At any point, you can save the draft
agent as an agent version, which is an immutable
snapshot of your agent. When you save the draft
agent, it is published to the default environment.
When you create agent versions, you can publish them
to custom environments. You can create a variety of
custom environments for testing, development,
production, etc.
"""
# 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([environment, 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 gcdc_environment.UpdateEnvironmentRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, gcdc_environment.UpdateEnvironmentRequest):
request = gcdc_environment.UpdateEnvironmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if environment is not None:
request.environment = environment
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_environment]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("environment.name", request.environment.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
gcdc_environment.Environment,
metadata_type=struct.Struct,
)
# Done; return the response.
return response
async def update_environment(
self,
request: Union[gcdc_environment.UpdateEnvironmentRequest, dict] = None,
*,
environment: gcdc_environment.Environment = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Updates the specified
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment].
This method is a `long-running
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
The returned ``Operation`` type has the following
method-specific fields:
- ``metadata``: An empty `Struct
message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`__
- ``response``:
[Environment][google.cloud.dialogflow.cx.v3beta1.Environment]
.. code-block::
from google.cloud import dialogflowcx_v3beta1
def sample_update_environment():
# Create a client
client = dialogflowcx_v3beta1.EnvironmentsClient()
# Initialize request argument(s)
environment = dialogflowcx_v3beta1.Environment()
environment.display_name = "display_name_value"
environment.version_configs.version = "version_value"
request = dialogflowcx_v3beta1.UpdateEnvironmentRequest(
environment=environment,
)
# Make the request
operation = client.update_environment(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.dialogflowcx_v3beta1.types.UpdateEnvironmentRequest, dict]):
The request object. The request message for
[Environments.UpdateEnvironment][google.cloud.dialogflow.cx.v3beta1.Environments.UpdateEnvironment].
environment (:class:`google.cloud.dialogflowcx_v3beta1.types.Environment`):
Required. The environment to update.
This corresponds to the ``environment`` 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 control which
fields get updated.
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.api_core.operation_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.dialogflowcx_v3beta1.types.Environment` Represents an environment for an agent. You can create multiple versions
of your agent and publish them to separate
environments. When you edit an agent, you are editing
the draft agent. At any point, you can save the draft
agent as an agent version, which is an immutable
snapshot of your agent. When you save the draft
agent, it is published to the default environment.
When you create agent versions, you can publish them
to custom environments. You can create a variety of
custom environments for testing, development,
production, etc.
"""
# 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([environment, 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 = gcdc_environment.UpdateEnvironmentRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if environment is not None:
request.environment = environment
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_environment,
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(
(("environment.name", request.environment.name),)
),
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Wrap the response in an operation future.
response = operation_async.from_gapic(
response,
self._client._transport.operations_client,
gcdc_environment.Environment,
metadata_type=struct_pb2.Struct,
)
# Done; return the response.
return response