Class SnoozeServiceClient (2.15.1)

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]] = 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

transport

Returns the transport used by the client instance.

Returns
Type	Description
`SnoozeServiceTransport`	The transport 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]] = 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`	`Union[str, SnoozeServiceTransport]` The transport to use. 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. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.
`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.

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.Union[
        google.api_core.retry.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 `Snooze`. Users must provide the body of the `Snooze` to be created but must omit the `Snooze` field, `name`.
`parent`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ 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
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,
)

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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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.Union[
        google.api_core.retry.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 `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
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.Union[
        google.api_core.retry.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 `Snooze`\ s associated with the given `parent`, satisfying the optional `filter`.
`parent`	`str` Required. The `project https://cloud.google.com/monitoring/api/v3#project_name`__ whose `Snooze`\ s 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
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.Union[
        google.api_core.retry.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`. 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 `Snooze`\ s 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
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.