Stay organized with collections Save and categorize content based on your preferences.
Client(
*,
project=None,
credentials=None,
_http=None,
_use_grpc=None,
client_info=None,
client_options=None
)
Client to bundle configuration needed for API requests.
Properties logging_api metrics_api sinks_api Methods ClientClient(
*,
project=None,
credentials=None,
_http=None,
_use_grpc=None,
client_info=None,
client_options=None
)
Parameters Name Description project
Optional[str]
the project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials
Optional[google.auth.credentials.Credentials]
Thehe OAuth2 Credentials to use for this client. If not passed (and if no _http
object is passed), falls back to the default inferred from the environment.
_http
Optional[requests.Session]
HTTP object to make requests. Can be any object that defines request()
with the same interface as requests.Session.request
. If not passed, an _http
object is created that is bound to the credentials
for the current object. This parameter should be considered private, and could change in the future.
_use_grpc
Optional[bool]
Explicitly specifies whether to use the gRPC transport or HTTP. If unset, falls back to the GOOGLE_CLOUD_DISABLE_GRPC
environment variable This parameter should be considered private, and could change in the future.
client_info
Optional[Union[google.api_core.client_info.ClientInfo, google.api_core.gapic_v1.client_info.ClientInfo]]
The client info used to send a user-agent string along with API requests. If None
, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.
client_options
Optional[Union[dict, google.api_core.client_options.ClientOptions]]
Client options used to set user options on the client. API Endpoint should be set through client_options.
closeCloses the Client and all handlers associated with this Client.
flush_handlersFlushes all Python log handlers associated with this Client.
get_default_handlerget_default_handler(**kw)
Return the default logging handler based on the local environment.
Parameter Name Descriptionkw
dict
keyword args passed to handler constructor
Returns Type Descriptionlogging.Handler
The default log handler based on the environment list_entries
list_entries(
*,
resource_names=None,
filter_=None,
order_by=None,
max_results=None,
page_size=None,
page_token=None
)
Return a generator of log entry resources.
Parameters Name Descriptionresource_names
Sequence[str]
Names of one or more parent resources from which to retrieve log entries: :: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" If not passed, defaults to the project bound to the API's client.
filter_
str
a filter expression. See https://cloud.google.com/logging/docs/view/advanced_filters
order_by
str
or :data:logging_v2.DESCENDING
.
max_results
Optional[int]
Optional. The maximum number of entries to return. Non-positive values are treated as 0. If None, uses API defaults.
page_size
int
number of entries to fetch in each API call. Although requests are paged internally, logs are returned by the generator one at a time. If not passed, defaults to a value set by the API.
page_token
str
opaque marker for the starting "page" of entries. If not passed, the API will return the first page of entries.
list_metricslist_metrics(*, max_results=None, page_size=None, page_token=None)
Parameters Name Description max_results
Optional[int]
Optional. The maximum number of entries to return. Non-positive values are treated as 0. If None, uses API defaults.
page_size
int
number of entries to fetch in each API call. Although requests are paged internally, logs are returned by the generator one at a time. If not passed, defaults to a value set by the API.
page_token
str
opaque marker for the starting "page" of entries. If not passed, the API will return the first page of entries.
list_sinkslist_sinks(*, parent=None, max_results=None, page_size=None, page_token=None)
Parameters Name Description parent
Optional[str]
The parent resource whose sinks are to be listed: :: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]". If not passed, defaults to the project bound to the API's client.
max_results
Optional[int]
Optional. The maximum number of entries to return. Non-positive values are treated as 0. If None, uses API defaults.
page_size
int
number of entries to fetch in each API call. Although requests are paged internally, logs are returned by the generator one at a time. If not passed, defaults to a value set by the API.
page_token
str
opaque marker for the starting "page" of entries. If not passed, the API will return the first page of entries.
loggerlogger(name, *, labels=None, resource=None)
Creates a logger bound to the current client.
Parameters Name Descriptionname
str
The name of the logger to be constructed.
resource
Optional[logging_v2.Resource
]
a monitored resource object representing the resource the code was run on. If not given, will be inferred from the environment.
labels
Optional[dict]
Mapping of default labels for entries written via this logger.
Returns Type Descriptionlogging_v2.logger.Logger
Logger created with the current client. metric
metric(name, *, filter_=None, description="")
Creates a metric bound to the current client.
Parameters Name Descriptionname
str
The name of the metric to be constructed.
filter_
Optional[str]
The advanced logs filter expression defining the entries tracked by the metric. If not passed, the instance should already exist, to be refreshed via Metric.reload
.
description
Optional[str]
The description of the metric to be constructed. If not passed, the instance should already exist, to be refreshed via Metric.reload
.
logging_v2.metric.Metric
Metric created with the current client. setup_logging
setup_logging(
*, log_level=20, excluded_loggers=("google.api_core.bidi", "werkzeug"), **kw
)
Attach default Cloud Logging handler to the root logger.
This method uses the default log handler, obtained by get_default_handler
, and attaches it to the root Python logger, so that a call such as logging.warn
, as well as all child loggers, will report to Cloud Logging.
log_level
Optional[int]
The logging level threshold of the attached logger, as set by the logging.Logger.setLevel
method. Defaults to :const:logging.INFO
.
excluded_loggers
Optional[Tuple[str]]
The loggers to not attach the handler to. This will always include the loggers in the path of the logging client itself.
Returns Type Descriptiondict
keyword args passed to handler constructor sink
sink(name, *, filter_=None, destination=None)
Creates a sink bound to the current client.
Parameters Name Descriptionname
str
the name of the sink to be constructed.
filter_
Optional[str]
the advanced logs filter expression defining the entries exported by the sink. If not passed, the instance should already exist, to be refreshed via Sink.reload
.
destination
str
destination URI for the entries exported by the sink. If not passed, the instance should already exist, to be refreshed via Sink.reload
.
logging_v2.sink.Sink
Sink created with the current client.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4