Class Client (1.15.1)

Client(
    project=None,
    credentials=None,
    _http=None,
    _use_grpc=None,
    client_info=None,
    client_options=None,
)

Client to bundle configuration needed for API requests.

Parameters

Name	Description
project	`str` the project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials	`google.auth.credentials.Credentials` (Optional) The 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	`requests.Session` (Optional) 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	`bool` (Optional) 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	`google.api_core.client_info.ClientInfo` or `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	`google.api_core.client_options.ClientOptions` or `dict` (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

Inheritance

builtins.object > google.cloud.client._ClientFactoryMixin > google.cloud.client.Client > builtins.object > google.cloud.client._ClientProjectMixin > google.cloud.client.ClientWithProject > Client

Properties

logging_api

Helper for logging-related API calls.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.logs

metrics_api

Helper for log metric-related API calls.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics

sinks_api

Helper for log sink-related API calls.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks

Methods

get_default_handler

get_default_handler(**kw)

Return the default logging handler based on the local environment.

Parameter

Name	Description
kw	`dict` keyword args passed to handler constructor

Returns

Type	Description
`logging.Handler`	The default log handler based on the environment

list_entries

list_entries(
    projects=None, filter_=None, order_by=None, page_size=None, page_token=None
)

Return a page of log entries.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/list

Parameters

Name	Description
projects	`list of strings` project IDs to include. If not passed, defaults to the project bound to the client.
filter_	`str` a filter expression. See https://cloud.google.com/logging/docs/view/advanced_filters
order_by	`str` One of :data:`<xref uid="google.cloud.logging.ASCENDING">ASCENDING</xref>` or :data:`<xref uid="google.cloud.logging.DESCENDING">DESCENDING</xref>`.
page_size	`int` Optional. The maximum number of entries in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
page_token	`str` Optional. If present, return the next batch of entries, using the value, which must correspond to the `nextPageToken` value returned in the previous response. Deprecated: use the `pages` property of the returned iterator instead of manually passing the token.

Returns

Type	Description
`google.api_core.page_iterator.Iterator`	Iterator of _BaseEntry accessible to the current client.

list_metrics

list_metrics(page_size=None, page_token=None)

List metrics for the project associated with this client.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics/list

Parameters

Name	Description
page_size	`int` Optional. The maximum number of metrics in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
page_token	`str` Optional. If present, return the next batch of metrics, using the value, which must correspond to the `nextPageToken` value returned in the previous response. Deprecated: use the `pages` property of the returned iterator instead of manually passing the token.

Returns

Type	Description
`google.api_core.page_iterator.Iterator`	Iterator of Metric accessible to the current client.

list_sinks

list_sinks(page_size=None, page_token=None)

List sinks for the project associated with this client.

See https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.sinks/list

Parameters

Name	Description
page_size	`int` Optional. The maximum number of sinks in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API.
page_token	`str` Optional. If present, return the next batch of sinks, using the value, which must correspond to the `nextPageToken` value returned in the previous response. Deprecated: use the `pages` property of the returned iterator instead of manually passing the token.

Returns

Type	Description
`google.api_core.page_iterator.Iterator`	Iterator of Sink accessible to the current client.

logger

logger(name)

Creates a logger bound to the current client.

Parameter

Name	Description
name	`str` the name of the logger to be constructed.

Returns

Type	Description
Logger	Logger created with the current client.

metric

metric(name, filter_=None, description="")

Creates a metric bound to the current client.

Parameters

Name	Description
name	`str` the name of the metric to be constructed.
filter_	`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	`str` the description of the metric to be constructed. If not passed, the instance should already exist, to be refreshed via `Metric.reload`.

Returns

Type	Description
Metric	Metric created with the current client.

setup_logging

setup_logging(
    log_level=20,
    excluded_loggers=("google.cloud", "google.auth", "google_auth_httplib2"),
    **kw
)

Attach default Stackdriver 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 Stackdriver logging.

Parameters

Name	Description
kw	`dict` keyword args passed to handler constructor
log_level	`int` (Optional) Python logging log level. Defaults to :const:`logging.INFO`.
excluded_loggers	`tuple` (Optional) The loggers to not attach the handler to. This will always include the loggers in the path of the logging client itself.

sink

sink(name, filter_=None, destination=None)

Creates a sink bound to the current client.

Parameters

Name	Description
name	`str` the name of the sink to be constructed.
filter_	`str` (optional) 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`.

Returns

Type	Description
Sink	Sink created with the current client.