As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

SnoozeService¶

class google.cloud.monitoring_v3.services.snooze_service.SnoozeServiceAsyncClient(*, 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]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶

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.

Instantiates the snooze service async client.

Parameters

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 to use. 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 api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static alert_policy_path(project: str, alert_policy: str) → str¶: Returns a fully-qualified alert_policy string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

async create_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.CreateSnoozeRequest, dict]] = None, *, parent: Optional[str] = None, snooze: Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

async def sample_create_snooze():
    # Create a client
    client = monitoring_v3.SnoozeServiceAsyncClient()

    # 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 = await client.create_snooze(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.monitoring_v3.types.CreateSnoozeRequest, dict]]) – The request object. The message definition for creating a Snooze. Users must provide the body of the Snooze to be created but must omit the Snooze field, name.
parent (str) –
Required. The project in which a Snooze should be created. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
```
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
snooze (google.cloud.monitoring_v3.types.Snooze) –
Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

This corresponds to the snooze field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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.

Return type

google.cloud.monitoring_v3.types.Snooze

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceAsyncClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.GetSnoozeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

async def sample_get_snooze():
    # Create a client
    client = monitoring_v3.SnoozeServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.GetSnoozeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_snooze(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.monitoring_v3.types.GetSnoozeRequest, dict]]) – The request object. The message definition for retrieving a Snooze. Users must specify the field, name, which identifies the Snooze.
name (str) –
Required. The ID of the Snooze to retrieve. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
```
This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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.

Return type

google.cloud.monitoring_v3.types.Snooze

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

async list_snoozes(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.ListSnoozesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesAsyncPager[source]¶

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

# 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

async def sample_list_snoozes():
    # Create a client
    client = monitoring_v3.SnoozeServiceAsyncClient()

    # Initialize request argument(s)
    request = monitoring_v3.ListSnoozesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_snoozes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

request (Optional[Union[google.cloud.monitoring_v3.types.ListSnoozesRequest, dict]]) – The request object. The message definition for listing Snoozes associated with the given parent, satisfying the optional filter.
parent (str) –
Required. The project whose Snoozes should be listed. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
```
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

The results of a successful ListSnoozes call, containing the matching: Snoozes.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesAsyncPager

static parse_alert_policy_path(path: str) → Dict[str, str]¶: Parses a alert_policy path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_snooze_path(path: str) → Dict[str, str]¶: Parses a snooze path into its component segments.

static snooze_path(project: str, snooze: str) → str¶: Returns a fully-qualified snooze string.

property transport: google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: SnoozeServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

async update_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.UpdateSnoozeRequest, dict]] = None, *, snooze: Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

async def sample_update_snooze():
    # Create a client
    client = monitoring_v3.SnoozeServiceAsyncClient()

    # 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 = await client.update_snooze(request=request)

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.monitoring_v3.types.UpdateSnoozeRequest, dict]]) –
The request object. The message definition for updating a Snooze. The field, snooze.name identifies the Snooze to be updated. The remainder of snooze gives the content the Snooze in question will be assigned.

What fields can be updated depends on the start time and end time of the Snooze.
- end time is in the past: These Snoozes are considered read-only and cannot be updated.
- start time is in the past and end time is in the future: display_name and interval.end_time can be updated.
- start time is in the future: display_name, interval.start_time and interval.end_time can be updated.
snooze (google.cloud.monitoring_v3.types.Snooze) –
Required. The Snooze to update. Must have the name field present.

This corresponds to the snooze field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The fields to update.

For each field listed in update_mask:
- If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
- If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.
Fields not listed retain their existing value.

The following are the field names that are accepted in update_mask:
- display_name
- interval.start_time
- interval.end_time
That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry (google.api_core.retry_async.AsyncRetry) – 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

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.

Return type

google.cloud.monitoring_v3.types.Snooze

class google.cloud.monitoring_v3.services.snooze_service.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>)[source]¶

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.

Instantiates the snooze service client.

Parameters

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 api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static alert_policy_path(project: str, alert_policy: str) → str[source]¶: Returns a fully-qualified alert_policy string.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.CreateSnoozeRequest, dict]] = None, *, parent: Optional[str] = None, snooze: Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

request (Union[google.cloud.monitoring_v3.types.CreateSnoozeRequest, dict]) – The request object. The message definition for creating a Snooze. Users must provide the body of the Snooze to be created but must omit the Snooze field, name.
parent (str) –
Required. The project in which a Snooze should be created. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
```
This corresponds to the parent field on the request instance; if request is provided, this should not be set.
snooze (google.cloud.monitoring_v3.types.Snooze) –
Required. The Snooze to create. Omit the name field, as it will be filled in by the API.

This corresponds to the snooze 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.

Returns

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.

Return type

google.cloud.monitoring_v3.types.Snooze

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

Creates an instance of this client using the provided credentials: info.

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)¶

Creates an instance of this client using the provided credentials: file.

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

SnoozeServiceClient

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.GetSnoozeRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

request (Union[google.cloud.monitoring_v3.types.GetSnoozeRequest, dict]) – The request object. The message definition for retrieving a Snooze. Users must specify the field, name, which identifies the Snooze.
name (str) –
Required. The ID of the Snooze to retrieve. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
```
This corresponds to the 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.

Returns

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.

Return type

google.cloud.monitoring_v3.types.Snooze

list_snoozes(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.ListSnoozesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesPager[source]¶

Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes.

# 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

request (Union[google.cloud.monitoring_v3.types.ListSnoozesRequest, dict]) – The request object. The message definition for listing Snoozes associated with the given parent, satisfying the optional filter.
parent (str) –
Required. The project whose Snoozes should be listed. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
```
This corresponds to the parent 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.

Returns

The results of a successful ListSnoozes call, containing the matching: Snoozes.

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesPager

static parse_alert_policy_path(path: str) → Dict[str, str][source]¶: Parses a alert_policy path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_snooze_path(path: str) → Dict[str, str][source]¶: Parses a snooze path into its component segments.

static snooze_path(project: str, snooze: str) → str[source]¶: Returns a fully-qualified snooze string.

property transport: google.cloud.monitoring_v3.services.snooze_service.transports.base.SnoozeServiceTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

SnoozeServiceTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_snooze(request: Optional[Union[google.cloud.monitoring_v3.types.snooze_service.UpdateSnoozeRequest, dict]] = None, *, snooze: Optional[google.cloud.monitoring_v3.types.snooze.Snooze] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.monitoring_v3.types.snooze.Snooze[source]¶

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

request (Union[google.cloud.monitoring_v3.types.UpdateSnoozeRequest, dict]) –
The request object. The message definition for updating a Snooze. The field, snooze.name identifies the Snooze to be updated. The remainder of snooze gives the content the Snooze in question will be assigned.

What fields can be updated depends on the start time and end time of the Snooze.
- end time is in the past: These Snoozes are considered read-only and cannot be updated.
- start time is in the past and end time is in the future: display_name and interval.end_time can be updated.
- start time is in the future: display_name, interval.start_time and interval.end_time can be updated.
snooze (google.cloud.monitoring_v3.types.Snooze) –
Required. The Snooze to update. Must have the name field present.

This corresponds to the snooze field on the request instance; if request is provided, this should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask) –
Required. The fields to update.

For each field listed in update_mask:
- If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
- If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.
Fields not listed retain their existing value.

The following are the field names that are accepted in update_mask:
- display_name
- interval.start_time
- interval.end_time
That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

This corresponds to the update_mask 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.

Returns

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.

Return type

google.cloud.monitoring_v3.types.Snooze

class google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesAsyncPager(method: Callable[[...], Awaitable[google.cloud.monitoring_v3.types.snooze_service.ListSnoozesResponse]], request: google.cloud.monitoring_v3.types.snooze_service.ListSnoozesRequest, response: google.cloud.monitoring_v3.types.snooze_service.ListSnoozesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_snoozes requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListSnoozesResponse object, and provides an __aiter__ method to iterate through its snoozes field.

If there are more pages, the __aiter__ method will make additional ListSnoozes requests and continue to iterate through the snoozes field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListSnoozesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.monitoring_v3.types.ListSnoozesRequest) – The initial request object.
response (google.cloud.monitoring_v3.types.ListSnoozesResponse) – The initial response object.
retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.monitoring_v3.services.snooze_service.pagers.ListSnoozesPager(method: Callable[[...], google.cloud.monitoring_v3.types.snooze_service.ListSnoozesResponse], request: google.cloud.monitoring_v3.types.snooze_service.ListSnoozesRequest, response: google.cloud.monitoring_v3.types.snooze_service.ListSnoozesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_snoozes requests.

This class thinly wraps an initial google.cloud.monitoring_v3.types.ListSnoozesResponse object, and provides an __iter__ method to iterate through its snoozes field.

If there are more pages, the __iter__ method will make additional ListSnoozes requests and continue to iterate through the snoozes field on the corresponding responses.

All the usual google.cloud.monitoring_v3.types.ListSnoozesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.monitoring_v3.types.ListSnoozesRequest) – The initial request object.
response (google.cloud.monitoring_v3.types.ListSnoozesResponse) – The initial response object.
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.

SnoozeService¶

google-cloud-monitoring

Navigation

Related Topics