def delete_log(
self,
request: logging.DeleteLogRequest = None,
*,
log_name: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes all the log entries in a log. The log
reappears if it receives new entries. Log entries
written shortly before the delete operation might not be
deleted. Entries received after the delete operation
with a timestamp before the operation will be deleted.
Args:
request (google.cloud.logging_v2.types.DeleteLogRequest):
The request object. The parameters to DeleteLog.
log_name (str):
Required. The resource name of the log to delete:
::
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
``[LOG_ID]`` must be URL-encoded. For example,
``"projects/my-project-id/logs/syslog"``,
``"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"``.
For more information about log names, see
[LogEntry][google.logging.v2.LogEntry].
This corresponds to the ``log_name`` 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.
"""
# 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([log_name])
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 logging.DeleteLogRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, logging.DeleteLogRequest):
request = logging.DeleteLogRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if log_name is not None:
request.log_name = log_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.delete_log]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("log_name", request.log_name), )), )
# Send the request.
rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
async def delete_log(
self,
request: Union[logging.DeleteLogRequest, dict] = None,
*,
log_name: str = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Deletes all the log entries in a log. The log
reappears if it receives new entries. Log entries
written shortly before the delete operation might not be
deleted. Entries received after the delete operation
with a timestamp before the operation will be deleted.
.. code-block:: python
from google.cloud import logging_v2
def sample_delete_log():
# Create a client
client = logging_v2.LoggingServiceV2Client()
# Initialize request argument(s)
request = logging_v2.DeleteLogRequest(
log_name="log_name_value",
)
# Make the request
client.delete_log(request=request)
Args:
request (Union[google.cloud.logging_v2.types.DeleteLogRequest, dict]):
The request object. The parameters to DeleteLog.
log_name (:class:`str`):
Required. The resource name of the log to delete:
::
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
``[LOG_ID]`` must be URL-encoded. For example,
``"projects/my-project-id/logs/syslog"``,
``"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity"``.
For more information about log names, see
[LogEntry][google.logging.v2.LogEntry].
This corresponds to the ``log_name`` 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.
"""
# 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([log_name])
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 = logging.DeleteLogRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if log_name is not None:
request.log_name = log_name
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.delete_log,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
core_exceptions.DeadlineExceeded,
core_exceptions.InternalServerError,
core_exceptions.ServiceUnavailable,
),
deadline=60.0,
),
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(
(("log_name", request.log_name), )), )
# Send the request.
await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
