def test_update_sink(self):
# Setup Expected Response
name = "name3373707"
destination = "destination-1429847026"
filter_ = "filter-1274492040"
writer_identity = "writerIdentity775638794"
include_children = True
expected_response = {
"name": name,
"destination": destination,
"filter": filter_,
"writer_identity": writer_identity,
"include_children": include_children,
}
expected_response = logging_config_pb2.LogSink(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = logging_v2.ConfigServiceV2Client()
# Setup Request
sink_name = client.sink_path("[PROJECT]", "[SINK]")
sink = {}
response = client.update_sink(sink_name, sink)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = logging_config_pb2.UpdateSinkRequest(
sink_name=sink_name, sink=sink)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_update_sink(self):
# Setup Expected Response
name = 'name3373707'
destination = 'destination-1429847026'
filter_ = 'filter-1274492040'
writer_identity = 'writerIdentity775638794'
include_children = True
expected_response = {
'name': name,
'destination': destination,
'filter': filter_,
'writer_identity': writer_identity,
'include_children': include_children
}
expected_response = logging_config_pb2.LogSink(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch('google.api_core.grpc_helpers.create_channel')
with patch as create_channel:
create_channel.return_value = channel
client = logging_v2.ConfigServiceV2Client()
# Setup Request
sink_name = client.sink_path('[PROJECT]', '[SINK]')
sink = {}
response = client.update_sink(sink_name, sink)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = logging_config_pb2.UpdateSinkRequest(
sink_name=sink_name, sink=sink)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def update_sink(
self,
sink_name,
sink,
unique_writer_identity=None,
update_mask=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Updates a sink. This method replaces the following fields in the
existing sink with values from the new sink: ``destination``, and
``filter``. The updated sink might also have a new ``writer_identity``;
see the ``unique_writer_identity`` field.
Example:
>>> from google.cloud import logging_v2
>>>
>>> client = logging_v2.ConfigServiceV2Client()
>>>
>>> sink_name = client.sink_path('[PROJECT]', '[SINK]')
>>>
>>> # TODO: Initialize `sink`:
>>> sink = {}
>>>
>>> response = client.update_sink(sink_name, sink)
Args:
sink_name (str): Required. The full resource name of the sink to update, including the
parent resource and the sink identifier:
::
"projects/[PROJECT_ID]/sinks/[SINK_ID]"
"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]"
"folders/[FOLDER_ID]/sinks/[SINK_ID]"
Example: ``"projects/my-project-id/sinks/my-sink-id"``.
sink (Union[dict, ~google.cloud.logging_v2.types.LogSink]): Required. The updated sink, whose name is the same identifier that
appears as part of ``sink_name``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.logging_v2.types.LogSink`
unique_writer_identity (bool): Optional. See
`sinks.create <https://cloud.google.com/logging/docs/api/reference/rest/v2/projects.sinks/create>`__
for a description of this field. When updating a sink, the effect of
this field on the value of ``writer_identity`` in the updated sink
depends on both the old and new values of this field:
- If the old and new values of this field are both false or both true,
then there is no change to the sink's ``writer_identity``.
- If the old value is false and the new value is true, then
``writer_identity`` is changed to a unique service account.
- It is an error if the old value is true and the new value is set to
false or defaulted to false.
update_mask (Union[dict, ~google.cloud.logging_v2.types.FieldMask]): Optional. Field mask that specifies the fields in ``sink`` that need an
update. A sink field will be overwritten if, and only if, it is in the
update mask. ``name`` and output only fields cannot be updated.
An empty updateMask is temporarily treated as using the following mask
for backwards compatibility purposes: destination,filter,includeChildren
At some point in the future, behavior will be removed and specifying an
empty updateMask will be an error.
For a detailed ``FieldMask`` definition, see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask
Example: ``updateMask=filter``.
If a dict is provided, it must be of the same form as the protobuf
message :class:`~google.cloud.logging_v2.types.FieldMask`
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.cloud.logging_v2.types.LogSink` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if "update_sink" not in self._inner_api_calls:
self._inner_api_calls[
"update_sink"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.update_sink,
default_retry=self._method_configs["UpdateSink"].retry,
default_timeout=self._method_configs["UpdateSink"].timeout,
client_info=self._client_info,
)
request = logging_config_pb2.UpdateSinkRequest(
sink_name=sink_name,
sink=sink,
unique_writer_identity=unique_writer_identity,
update_mask=update_mask,
)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("sink_name", sink_name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
return self._inner_api_calls["update_sink"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
