SnoozeServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport, typing.Callable[[...], google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The SnoozeService API is used to temporarily prevent an alert policy from generating alerts. A Snooze is a description of the criteria under which one or more alert policies should not fire alerts for the specified duration.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
SnoozeServiceTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
SnoozeServiceClient
SnoozeServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport, typing.Callable[[...], google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the snooze service client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Optional[Union[str,SnoozeServiceTransport,Callable[..., SnoozeServiceTransport]]]
The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the SnoozeServiceTransport constructor. If set to None, a transport is chosen automatically. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
alert_policy_path
alert_policy_path(project: str, alert_policy: str) -> str
Returns a fully-qualified alert_policy string.
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_snooze
create_snooze(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.snooze_service.CreateSnoozeRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
snooze: typing.Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.snooze.Snooze
Creates a Snooze
that will prevent alerts, which match the
provided criteria, from being opened. The Snooze
applies for
a specific time interval.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3
def sample_create_snooze():
# Create a client
client = monitoring_v3.SnoozeServiceClient()
# Initialize request argument(s)
snooze = monitoring_v3.Snooze()
snooze.name = "name_value"
snooze.display_name = "display_name_value"
request = monitoring_v3.CreateSnoozeRequest(
parent="parent_value",
snooze=snooze,
)
# Make the request
response = client.create_snooze(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.CreateSnoozeRequest, dict]
The request object. The message definition for creating a |
parent |
str
Required. The |
snooze |
google.cloud.monitoring_v3.types.Snooze
Required. The |
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 | |
---|---|
Type | Description |
google.cloud.monitoring_v3.types.Snooze |
A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SnoozeServiceClient |
The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
SnoozeServiceClient |
The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
SnoozeServiceClient |
The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_snooze
get_snooze(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.snooze_service.GetSnoozeRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.snooze.Snooze
Retrieves a Snooze
by name
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3
def sample_get_snooze():
# Create a client
client = monitoring_v3.SnoozeServiceClient()
# Initialize request argument(s)
request = monitoring_v3.GetSnoozeRequest(
name="name_value",
)
# Make the request
response = client.get_snooze(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.GetSnoozeRequest, dict]
The request object. The message definition for retrieving a |
name |
str
Required. The ID of the |
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 | |
---|---|
Type | Description |
google.cloud.monitoring_v3.types.Snooze |
A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time. |
list_snoozes
list_snoozes(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.snooze_service.ListSnoozesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesPager
Lists the Snooze
\ s associated with a project. Can
optionally pass in filter
, which specifies predicates to
match Snooze
\ s.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3
def sample_list_snoozes():
# Create a client
client = monitoring_v3.SnoozeServiceClient()
# Initialize request argument(s)
request = monitoring_v3.ListSnoozesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_snoozes(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.ListSnoozesRequest, dict]
The request object. The message definition for listing |
parent |
str
Required. The |
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 | |
---|---|
Type | Description |
google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesPager |
The results of a successful ListSnoozes call, containing the matching Snoozes. Iterating over this object will yield results and resolve additional pages automatically. |
parse_alert_policy_path
parse_alert_policy_path(path: str) -> typing.Dict[str, str]
Parses a alert_policy path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_snooze_path
parse_snooze_path(path: str) -> typing.Dict[str, str]
Parses a snooze path into its component segments.
snooze_path
snooze_path(project: str, snooze: str) -> str
Returns a fully-qualified snooze string.
update_snooze
update_snooze(
request: typing.Optional[
typing.Union[
google.cloud.monitoring_v3.types.snooze_service.UpdateSnoozeRequest, dict
]
] = None,
*,
snooze: typing.Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.monitoring_v3.types.snooze.Snooze
Updates a Snooze
, identified by its name
, with the
parameters in the given Snooze
object.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import monitoring_v3
def sample_update_snooze():
# Create a client
client = monitoring_v3.SnoozeServiceClient()
# Initialize request argument(s)
snooze = monitoring_v3.Snooze()
snooze.name = "name_value"
snooze.display_name = "display_name_value"
request = monitoring_v3.UpdateSnoozeRequest(
snooze=snooze,
)
# Make the request
response = client.update_snooze(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.monitoring_v3.types.UpdateSnoozeRequest, dict]
The request object. The message definition for updating a |
snooze |
google.cloud.monitoring_v3.types.Snooze
Required. The |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. The fields to update. For each field listed in |
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 | |
---|---|
Type | Description |
google.cloud.monitoring_v3.types.Snooze |
A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time. |