Class v3.SnoozeServiceClient (5.2.0)

Version latest

• 5.2.0 (latest)
• 4.0.0
• 3.0.4
• 2.3.5

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. v3

Package

@google-cloud/monitoring

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of SnoozeServiceClient.

Parameters
Name	Description
opts	ClientOptions
gaxInstance	typeof gax | typeof fallback : loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SnoozeServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath.

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static get servicePath(): string;

The DNS address for this API service.

snoozeServiceStub

snoozeServiceStub?: Promise<{
        [name: string]: Function;
    }>;

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

createSnooze(request, options)

createSnooze(request?: protos.google.monitoring.v3.ICreateSnoozeRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.ISnooze,
        protos.google.monitoring.v3.ICreateSnoozeRequest | undefined,
        {} | undefined
    ]>;

Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval.

Parameters
Name	Description
request	ICreateSnoozeRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.ICreateSnoozeRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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]
   */
  // const parent = 'abc123'
  /**
   *  Required. The `Snooze` to create. Omit the `name` field, as it will be
   *  filled in by the API.
   */
  // const snooze = {}

  // Imports the Monitoring library
  const {SnoozeServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new SnoozeServiceClient();

  async function callCreateSnooze() {
    // Construct request
    const request = {
      parent,
      snooze,
    };

    // Run request
    const response = await monitoringClient.createSnooze(request);
    console.log(response);
  }

  callCreateSnooze();

createSnooze(request, options, callback)

createSnooze(request: protos.google.monitoring.v3.ICreateSnoozeRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.ICreateSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSnoozeRequest
options	CallOptions
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.ICreateSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createSnooze(request, callback)

createSnooze(request: protos.google.monitoring.v3.ICreateSnoozeRequest, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.ICreateSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateSnoozeRequest
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.ICreateSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

folderAlertPolicyConditionPath(folder, alertPolicy, condition)

folderAlertPolicyConditionPath(folder: string, alertPolicy: string, condition: string): string;

Return a fully-qualified folderAlertPolicyCondition resource name string.

Parameters
Name	Description
folder	string
alertPolicy	string
condition	string

Returns
Type	Description
string	{string} Resource name string.

folderAlertPolicyPath(folder, alertPolicy)

folderAlertPolicyPath(folder: string, alertPolicy: string): string;

Return a fully-qualified folderAlertPolicy resource name string.

Parameters
Name	Description
folder	string
alertPolicy	string

Returns
Type	Description
string	{string} Resource name string.

folderChannelDescriptorPath(folder, channelDescriptor)

folderChannelDescriptorPath(folder: string, channelDescriptor: string): string;

Return a fully-qualified folderChannelDescriptor resource name string.

Parameters
Name	Description
folder	string
channelDescriptor	string

Returns
Type	Description
string	{string} Resource name string.

folderGroupPath(folder, group)

folderGroupPath(folder: string, group: string): string;

Return a fully-qualified folderGroup resource name string.

Parameters
Name	Description
folder	string
group	string

Returns
Type	Description
string	{string} Resource name string.

folderNotificationChannelPath(folder, notificationChannel)

folderNotificationChannelPath(folder: string, notificationChannel: string): string;

Return a fully-qualified folderNotificationChannel resource name string.

Parameters
Name	Description
folder	string
notificationChannel	string

Returns
Type	Description
string	{string} Resource name string.

folderServicePath(folder, service)

folderServicePath(folder: string, service: string): string;

Return a fully-qualified folderService resource name string.

Parameters
Name	Description
folder	string
service	string

Returns
Type	Description
string	{string} Resource name string.

folderServiceServiceLevelObjectivePath(folder, service, serviceLevelObjective)

folderServiceServiceLevelObjectivePath(folder: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified folderServiceServiceLevelObjective resource name string.

Parameters
Name	Description
folder	string
service	string
serviceLevelObjective	string

Returns
Type	Description
string	{string} Resource name string.

folderUptimeCheckConfigPath(folder, uptimeCheckConfig)

folderUptimeCheckConfigPath(folder: string, uptimeCheckConfig: string): string;

Return a fully-qualified folderUptimeCheckConfig resource name string.

Parameters
Name	Description
folder	string
uptimeCheckConfig	string

Returns
Type	Description
string	{string} Resource name string.

getProjectId()

getProjectId(): Promise<string>;

Returns
Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter
Name	Description
callback	Callback<string, undefined, undefined>

Returns
Type	Description
void

getSnooze(request, options)

getSnooze(request?: protos.google.monitoring.v3.IGetSnoozeRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.ISnooze,
        protos.google.monitoring.v3.IGetSnoozeRequest | undefined,
        {} | undefined
    ]>;

Retrieves a Snooze by name.

Parameters
Name	Description
request	IGetSnoozeRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IGetSnoozeRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ID of the `Snooze` to retrieve. The format is:
   *      projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]
   */
  // const name = 'abc123'

  // Imports the Monitoring library
  const {SnoozeServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new SnoozeServiceClient();

  async function callGetSnooze() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await monitoringClient.getSnooze(request);
    console.log(response);
  }

  callGetSnooze();

getSnooze(request, options, callback)

getSnooze(request: protos.google.monitoring.v3.IGetSnoozeRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IGetSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSnoozeRequest
options	CallOptions
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IGetSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getSnooze(request, callback)

getSnooze(request: protos.google.monitoring.v3.IGetSnoozeRequest, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IGetSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetSnoozeRequest
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IGetSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

listSnoozes(request, options)

listSnoozes(request?: protos.google.monitoring.v3.IListSnoozesRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.ISnooze[],
        protos.google.monitoring.v3.IListSnoozesRequest | null,
        protos.google.monitoring.v3.IListSnoozesResponse
    ]>;

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

Parameters
Name	Description
request	IListSnoozesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.monitoring.v3.ISnooze[], protos.google.monitoring.v3.IListSnoozesRequest | null, protos.google.monitoring.v3.IListSnoozesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listSnoozesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSnoozes(request, options, callback)

listSnoozes(request: protos.google.monitoring.v3.IListSnoozesRequest, options: CallOptions, callback: PaginationCallback<protos.google.monitoring.v3.IListSnoozesRequest, protos.google.monitoring.v3.IListSnoozesResponse | null | undefined, protos.google.monitoring.v3.ISnooze>): void;

Parameters
Name	Description
request	IListSnoozesRequest
options	CallOptions
callback	PaginationCallback<protos.google.monitoring.v3.IListSnoozesRequest, protos.google.monitoring.v3.IListSnoozesResponse | null | undefined, protos.google.monitoring.v3.ISnooze>

Returns
Type	Description
void

listSnoozes(request, callback)

listSnoozes(request: protos.google.monitoring.v3.IListSnoozesRequest, callback: PaginationCallback<protos.google.monitoring.v3.IListSnoozesRequest, protos.google.monitoring.v3.IListSnoozesResponse | null | undefined, protos.google.monitoring.v3.ISnooze>): void;

Parameters
Name	Description
request	IListSnoozesRequest
callback	PaginationCallback<protos.google.monitoring.v3.IListSnoozesRequest, protos.google.monitoring.v3.IListSnoozesResponse | null | undefined, protos.google.monitoring.v3.ISnooze>

Returns
Type	Description
void

listSnoozesAsync(request, options)

listSnoozesAsync(request?: protos.google.monitoring.v3.IListSnoozesRequest, options?: CallOptions): AsyncIterable<protos.google.monitoring.v3.ISnooze>;

Equivalent to listSnoozes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListSnoozesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.monitoring.v3.ISnooze>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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]
   */
  // const parent = 'abc123'
  /**
   *  Optional. Optional filter to restrict results to the given criteria. The
   *  following fields are supported.
   *    * `interval.start_time`
   *    * `interval.end_time`
   *  For example:
   *      interval.start_time > "2022-03-11T00:00:00-08:00" AND
   *          interval.end_time < "2022-03-12t00:00:00-08:00"="" */="" const="" filter='abc123' *="" *="" optional.="" the="" maximum="" number="" of="" results="" to="" return="" for="" a="" single="" query.="" the="" *="" server="" may="" further="" constrain="" the="" maximum="" number="" of="" results="" returned="" in="" a="" *="" single="" page.="" the="" value="" should="" be="" in="" the="" range="" 1,="" 1000.="" if="" the="" value="" given="" *="" is="" outside="" this="" range,="" the="" server="" will="" decide="" the="" number="" of="" results="" to="" be="" *="" returned.="" */="" const="" pagesize="1234" *="" *="" optional.="" the="" `next_page_token`="" from="" a="" previous="" call="" to="" *="" `listsnoozesrequest`="" to="" get="" the="" next="" page="" of="" results.="" */="" const="" pagetoken='abc123' imports="" the="" monitoring="" library="" const="" {snoozeserviceclient}="require('@google-cloud/monitoring').v3;" instantiates="" a="" client="" const="" monitoringclient="new" snoozeserviceclient();="" async="" function="" calllistsnoozes()="" {="" construct="" request="" const="" request="{" parent,="" };="" run="" request="" const="" iterable="monitoringClient.listSnoozesAsync(request);" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllistsnoozes();="">

listSnoozesStream(request, options)

listSnoozesStream(request?: protos.google.monitoring.v3.IListSnoozesRequest, options?: CallOptions): Transform;

Equivalent to listSnoozes, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListSnoozesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Transform	{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listSnoozesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchAlertPolicyFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the alert_policy from FolderAlertPolicyCondition resource.

Parameter
Name	Description
folderAlertPolicyConditionName	string A fully-qualified path representing folder_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName)

matchAlertPolicyFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;

Parse the alert_policy from FolderAlertPolicy resource.

Parameter
Name	Description
folderAlertPolicyName	string A fully-qualified path representing folder_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchAlertPolicyFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the alert_policy from OrganizationAlertPolicyCondition resource.

Parameter
Name	Description
organizationAlertPolicyConditionName	string A fully-qualified path representing organization_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName)

matchAlertPolicyFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;

Parse the alert_policy from OrganizationAlertPolicy resource.

Parameter
Name	Description
organizationAlertPolicyName	string A fully-qualified path representing organization_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchAlertPolicyFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the alert_policy from ProjectAlertPolicyCondition resource.

Parameter
Name	Description
projectAlertPolicyConditionName	string A fully-qualified path representing project_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName)

matchAlertPolicyFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;

Parse the alert_policy from ProjectAlertPolicy resource.

Parameter
Name	Description
projectAlertPolicyName	string A fully-qualified path representing project_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the alert_policy.

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName)

matchChannelDescriptorFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;

Parse the channel_descriptor from FolderChannelDescriptor resource.

Parameter
Name	Description
folderChannelDescriptorName	string A fully-qualified path representing folder_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the channel_descriptor.

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)

matchChannelDescriptorFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;

Parse the channel_descriptor from OrganizationChannelDescriptor resource.

Parameter
Name	Description
organizationChannelDescriptorName	string A fully-qualified path representing organization_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the channel_descriptor.

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName)

matchChannelDescriptorFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;

Parse the channel_descriptor from ProjectChannelDescriptor resource.

Parameter
Name	Description
projectChannelDescriptorName	string A fully-qualified path representing project_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the channel_descriptor.

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchConditionFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the condition from FolderAlertPolicyCondition resource.

Parameter
Name	Description
folderAlertPolicyConditionName	string A fully-qualified path representing folder_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the condition.

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchConditionFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the condition from OrganizationAlertPolicyCondition resource.

Parameter
Name	Description
organizationAlertPolicyConditionName	string A fully-qualified path representing organization_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the condition.

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchConditionFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the condition from ProjectAlertPolicyCondition resource.

Parameter
Name	Description
projectAlertPolicyConditionName	string A fully-qualified path representing project_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the condition.

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName)

matchFolderFromFolderAlertPolicyConditionName(folderAlertPolicyConditionName: string): string | number;

Parse the folder from FolderAlertPolicyCondition resource.

Parameter
Name	Description
folderAlertPolicyConditionName	string A fully-qualified path representing folder_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName)

matchFolderFromFolderAlertPolicyName(folderAlertPolicyName: string): string | number;

Parse the folder from FolderAlertPolicy resource.

Parameter
Name	Description
folderAlertPolicyName	string A fully-qualified path representing folder_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName)

matchFolderFromFolderChannelDescriptorName(folderChannelDescriptorName: string): string | number;

Parse the folder from FolderChannelDescriptor resource.

Parameter
Name	Description
folderChannelDescriptorName	string A fully-qualified path representing folder_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderGroupName(folderGroupName)

matchFolderFromFolderGroupName(folderGroupName: string): string | number;

Parse the folder from FolderGroup resource.

Parameter
Name	Description
folderGroupName	string A fully-qualified path representing folder_group resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName)

matchFolderFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;

Parse the folder from FolderNotificationChannel resource.

Parameter
Name	Description
folderNotificationChannelName	string A fully-qualified path representing folder_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderServiceName(folderServiceName)

matchFolderFromFolderServiceName(folderServiceName: string): string | number;

Parse the folder from FolderService resource.

Parameter
Name	Description
folderServiceName	string A fully-qualified path representing folder_service resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchFolderFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the folder from FolderServiceServiceLevelObjective resource.

Parameter
Name	Description
folderServiceServiceLevelObjectiveName	string A fully-qualified path representing folder_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)

matchFolderFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;

Parse the folder from FolderUptimeCheckConfig resource.

Parameter
Name	Description
folderUptimeCheckConfigName	string A fully-qualified path representing folder_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the folder.

matchGroupFromFolderGroupName(folderGroupName)

matchGroupFromFolderGroupName(folderGroupName: string): string | number;

Parse the group from FolderGroup resource.

Parameter
Name	Description
folderGroupName	string A fully-qualified path representing folder_group resource.

Returns
Type	Description
string | number	{string} A string representing the group.

matchGroupFromOrganizationGroupName(organizationGroupName)

matchGroupFromOrganizationGroupName(organizationGroupName: string): string | number;

Parse the group from OrganizationGroup resource.

Parameter
Name	Description
organizationGroupName	string A fully-qualified path representing organization_group resource.

Returns
Type	Description
string | number	{string} A string representing the group.

matchGroupFromProjectGroupName(projectGroupName)

matchGroupFromProjectGroupName(projectGroupName: string): string | number;

Parse the group from ProjectGroup resource.

Parameter
Name	Description
projectGroupName	string A fully-qualified path representing project_group resource.

Returns
Type	Description
string | number	{string} A string representing the group.

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName)

matchNotificationChannelFromFolderNotificationChannelName(folderNotificationChannelName: string): string | number;

Parse the notification_channel from FolderNotificationChannel resource.

Parameter
Name	Description
folderNotificationChannelName	string A fully-qualified path representing folder_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the notification_channel.

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName)

matchNotificationChannelFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;

Parse the notification_channel from OrganizationNotificationChannel resource.

Parameter
Name	Description
organizationNotificationChannelName	string A fully-qualified path representing organization_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the notification_channel.

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName)

matchNotificationChannelFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;

Parse the notification_channel from ProjectNotificationChannel resource.

Parameter
Name	Description
projectNotificationChannelName	string A fully-qualified path representing project_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the notification_channel.

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName)

matchOrganizationFromOrganizationAlertPolicyConditionName(organizationAlertPolicyConditionName: string): string | number;

Parse the organization from OrganizationAlertPolicyCondition resource.

Parameter
Name	Description
organizationAlertPolicyConditionName	string A fully-qualified path representing organization_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName)

matchOrganizationFromOrganizationAlertPolicyName(organizationAlertPolicyName: string): string | number;

Parse the organization from OrganizationAlertPolicy resource.

Parameter
Name	Description
organizationAlertPolicyName	string A fully-qualified path representing organization_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName)

matchOrganizationFromOrganizationChannelDescriptorName(organizationChannelDescriptorName: string): string | number;

Parse the organization from OrganizationChannelDescriptor resource.

Parameter
Name	Description
organizationChannelDescriptorName	string A fully-qualified path representing organization_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationGroupName(organizationGroupName)

matchOrganizationFromOrganizationGroupName(organizationGroupName: string): string | number;

Parse the organization from OrganizationGroup resource.

Parameter
Name	Description
organizationGroupName	string A fully-qualified path representing organization_group resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName)

matchOrganizationFromOrganizationNotificationChannelName(organizationNotificationChannelName: string): string | number;

Parse the organization from OrganizationNotificationChannel resource.

Parameter
Name	Description
organizationNotificationChannelName	string A fully-qualified path representing organization_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationServiceName(organizationServiceName)

matchOrganizationFromOrganizationServiceName(organizationServiceName: string): string | number;

Parse the organization from OrganizationService resource.

Parameter
Name	Description
organizationServiceName	string A fully-qualified path representing organization_service resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchOrganizationFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the organization from OrganizationServiceServiceLevelObjective resource.

Parameter
Name	Description
organizationServiceServiceLevelObjectiveName	string A fully-qualified path representing organization_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)

matchOrganizationFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;

Parse the organization from OrganizationUptimeCheckConfig resource.

Parameter
Name	Description
organizationUptimeCheckConfigName	string A fully-qualified path representing organization_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName)

matchProjectFromProjectAlertPolicyConditionName(projectAlertPolicyConditionName: string): string | number;

Parse the project from ProjectAlertPolicyCondition resource.

Parameter
Name	Description
projectAlertPolicyConditionName	string A fully-qualified path representing project_alert_policy_condition resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName)

matchProjectFromProjectAlertPolicyName(projectAlertPolicyName: string): string | number;

Parse the project from ProjectAlertPolicy resource.

Parameter
Name	Description
projectAlertPolicyName	string A fully-qualified path representing project_alert_policy resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName)

matchProjectFromProjectChannelDescriptorName(projectChannelDescriptorName: string): string | number;

Parse the project from ProjectChannelDescriptor resource.

Parameter
Name	Description
projectChannelDescriptorName	string A fully-qualified path representing project_channel_descriptor resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectGroupName(projectGroupName)

matchProjectFromProjectGroupName(projectGroupName: string): string | number;

Parse the project from ProjectGroup resource.

Parameter
Name	Description
projectGroupName	string A fully-qualified path representing project_group resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name	Description
projectName	string A fully-qualified path representing Project resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName)

matchProjectFromProjectNotificationChannelName(projectNotificationChannelName: string): string | number;

Parse the project from ProjectNotificationChannel resource.

Parameter
Name	Description
projectNotificationChannelName	string A fully-qualified path representing project_notification_channel resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectServiceName(projectServiceName)

matchProjectFromProjectServiceName(projectServiceName: string): string | number;

Parse the project from ProjectService resource.

Parameter
Name	Description
projectServiceName	string A fully-qualified path representing project_service resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchProjectFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the project from ProjectServiceServiceLevelObjective resource.

Parameter
Name	Description
projectServiceServiceLevelObjectiveName	string A fully-qualified path representing project_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)

matchProjectFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;

Parse the project from ProjectUptimeCheckConfig resource.

Parameter
Name	Description
projectUptimeCheckConfigName	string A fully-qualified path representing project_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchProjectFromSnoozeName(snoozeName)

matchProjectFromSnoozeName(snoozeName: string): string | number;

Parse the project from Snooze resource.

Parameter
Name	Description
snoozeName	string A fully-qualified path representing Snooze resource.

Returns
Type	Description
string | number	{string} A string representing the project.

matchServiceFromFolderServiceName(folderServiceName)

matchServiceFromFolderServiceName(folderServiceName: string): string | number;

Parse the service from FolderService resource.

Parameter
Name	Description
folderServiceName	string A fully-qualified path representing folder_service resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchServiceFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the service from FolderServiceServiceLevelObjective resource.

Parameter
Name	Description
folderServiceServiceLevelObjectiveName	string A fully-qualified path representing folder_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceFromOrganizationServiceName(organizationServiceName)

matchServiceFromOrganizationServiceName(organizationServiceName: string): string | number;

Parse the service from OrganizationService resource.

Parameter
Name	Description
organizationServiceName	string A fully-qualified path representing organization_service resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchServiceFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the service from OrganizationServiceServiceLevelObjective resource.

Parameter
Name	Description
organizationServiceServiceLevelObjectiveName	string A fully-qualified path representing organization_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceFromProjectServiceName(projectServiceName)

matchServiceFromProjectServiceName(projectServiceName: string): string | number;

Parse the service from ProjectService resource.

Parameter
Name	Description
projectServiceName	string A fully-qualified path representing project_service resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchServiceFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the service from ProjectServiceServiceLevelObjective resource.

Parameter
Name	Description
projectServiceServiceLevelObjectiveName	string A fully-qualified path representing project_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service.

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromFolderServiceServiceLevelObjectiveName(folderServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from FolderServiceServiceLevelObjective resource.

Parameter
Name	Description
folderServiceServiceLevelObjectiveName	string A fully-qualified path representing folder_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service_level_objective.

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromOrganizationServiceServiceLevelObjectiveName(organizationServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from OrganizationServiceServiceLevelObjective resource.

Parameter
Name	Description
organizationServiceServiceLevelObjectiveName	string A fully-qualified path representing organization_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service_level_objective.

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName)

matchServiceLevelObjectiveFromProjectServiceServiceLevelObjectiveName(projectServiceServiceLevelObjectiveName: string): string | number;

Parse the service_level_objective from ProjectServiceServiceLevelObjective resource.

Parameter
Name	Description
projectServiceServiceLevelObjectiveName	string A fully-qualified path representing project_service_service_level_objective resource.

Returns
Type	Description
string | number	{string} A string representing the service_level_objective.

matchSnoozeFromSnoozeName(snoozeName)

matchSnoozeFromSnoozeName(snoozeName: string): string | number;

Parse the snooze from Snooze resource.

Parameter
Name	Description
snoozeName	string A fully-qualified path representing Snooze resource.

Returns
Type	Description
string | number	{string} A string representing the snooze.

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName)

matchUptimeCheckConfigFromFolderUptimeCheckConfigName(folderUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from FolderUptimeCheckConfig resource.

Parameter
Name	Description
folderUptimeCheckConfigName	string A fully-qualified path representing folder_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the uptime_check_config.

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName)

matchUptimeCheckConfigFromOrganizationUptimeCheckConfigName(organizationUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from OrganizationUptimeCheckConfig resource.

Parameter
Name	Description
organizationUptimeCheckConfigName	string A fully-qualified path representing organization_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the uptime_check_config.

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName)

matchUptimeCheckConfigFromProjectUptimeCheckConfigName(projectUptimeCheckConfigName: string): string | number;

Parse the uptime_check_config from ProjectUptimeCheckConfig resource.

Parameter
Name	Description
projectUptimeCheckConfigName	string A fully-qualified path representing project_uptime_check_config resource.

Returns
Type	Description
string | number	{string} A string representing the uptime_check_config.

organizationAlertPolicyConditionPath(organization, alertPolicy, condition)

organizationAlertPolicyConditionPath(organization: string, alertPolicy: string, condition: string): string;

Return a fully-qualified organizationAlertPolicyCondition resource name string.

Parameters
Name	Description
organization	string
alertPolicy	string
condition	string

Returns
Type	Description
string	{string} Resource name string.

organizationAlertPolicyPath(organization, alertPolicy)

organizationAlertPolicyPath(organization: string, alertPolicy: string): string;

Return a fully-qualified organizationAlertPolicy resource name string.

Parameters
Name	Description
organization	string
alertPolicy	string

Returns
Type	Description
string	{string} Resource name string.

organizationChannelDescriptorPath(organization, channelDescriptor)

organizationChannelDescriptorPath(organization: string, channelDescriptor: string): string;

Return a fully-qualified organizationChannelDescriptor resource name string.

Parameters
Name	Description
organization	string
channelDescriptor	string

Returns
Type	Description
string	{string} Resource name string.

organizationGroupPath(organization, group)

organizationGroupPath(organization: string, group: string): string;

Return a fully-qualified organizationGroup resource name string.

Parameters
Name	Description
organization	string
group	string

Returns
Type	Description
string	{string} Resource name string.

organizationNotificationChannelPath(organization, notificationChannel)

organizationNotificationChannelPath(organization: string, notificationChannel: string): string;

Return a fully-qualified organizationNotificationChannel resource name string.

Parameters
Name	Description
organization	string
notificationChannel	string

Returns
Type	Description
string	{string} Resource name string.

organizationServicePath(organization, service)

organizationServicePath(organization: string, service: string): string;

Return a fully-qualified organizationService resource name string.

Parameters
Name	Description
organization	string
service	string

Returns
Type	Description
string	{string} Resource name string.

organizationServiceServiceLevelObjectivePath(organization, service, serviceLevelObjective)

organizationServiceServiceLevelObjectivePath(organization: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified organizationServiceServiceLevelObjective resource name string.

Parameters
Name	Description
organization	string
service	string
serviceLevelObjective	string

Returns
Type	Description
string	{string} Resource name string.

organizationUptimeCheckConfigPath(organization, uptimeCheckConfig)

organizationUptimeCheckConfigPath(organization: string, uptimeCheckConfig: string): string;

Return a fully-qualified organizationUptimeCheckConfig resource name string.

Parameters
Name	Description
organization	string
uptimeCheckConfig	string

Returns
Type	Description
string	{string} Resource name string.

projectAlertPolicyConditionPath(project, alertPolicy, condition)

projectAlertPolicyConditionPath(project: string, alertPolicy: string, condition: string): string;

Return a fully-qualified projectAlertPolicyCondition resource name string.

Parameters
Name	Description
project	string
alertPolicy	string
condition	string

Returns
Type	Description
string	{string} Resource name string.

projectAlertPolicyPath(project, alertPolicy)

projectAlertPolicyPath(project: string, alertPolicy: string): string;

Return a fully-qualified projectAlertPolicy resource name string.

Parameters
Name	Description
project	string
alertPolicy	string

Returns
Type	Description
string	{string} Resource name string.

projectChannelDescriptorPath(project, channelDescriptor)

projectChannelDescriptorPath(project: string, channelDescriptor: string): string;

Return a fully-qualified projectChannelDescriptor resource name string.

Parameters
Name	Description
project	string
channelDescriptor	string

Returns
Type	Description
string	{string} Resource name string.

projectGroupPath(project, group)

projectGroupPath(project: string, group: string): string;

Return a fully-qualified projectGroup resource name string.

Parameters
Name	Description
project	string
group	string

Returns
Type	Description
string	{string} Resource name string.

projectNotificationChannelPath(project, notificationChannel)

projectNotificationChannelPath(project: string, notificationChannel: string): string;

Return a fully-qualified projectNotificationChannel resource name string.

Parameters
Name	Description
project	string
notificationChannel	string

Returns
Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name	Description
project	string

Returns
Type	Description
string	{string} Resource name string.

projectServicePath(project, service)

projectServicePath(project: string, service: string): string;

Return a fully-qualified projectService resource name string.

Parameters
Name	Description
project	string
service	string

Returns
Type	Description
string	{string} Resource name string.

projectServiceServiceLevelObjectivePath(project, service, serviceLevelObjective)

projectServiceServiceLevelObjectivePath(project: string, service: string, serviceLevelObjective: string): string;

Return a fully-qualified projectServiceServiceLevelObjective resource name string.

Parameters
Name	Description
project	string
service	string
serviceLevelObjective	string

Returns
Type	Description
string	{string} Resource name string.

projectUptimeCheckConfigPath(project, uptimeCheckConfig)

projectUptimeCheckConfigPath(project: string, uptimeCheckConfig: string): string;

Return a fully-qualified projectUptimeCheckConfig resource name string.

Parameters
Name	Description
project	string
uptimeCheckConfig	string

Returns
Type	Description
string	{string} Resource name string.

snoozePath(project, snooze)

snoozePath(project: string, snooze: string): string;

Return a fully-qualified snooze resource name string.

Parameters
Name	Description
project	string
snooze	string

Returns
Type	Description
string	{string} Resource name string.

updateSnooze(request, options)

updateSnooze(request?: protos.google.monitoring.v3.IUpdateSnoozeRequest, options?: CallOptions): Promise<[
        protos.google.monitoring.v3.ISnooze,
        protos.google.monitoring.v3.IUpdateSnoozeRequest | undefined,
        {} | undefined
    ]>;

Updates a Snooze, identified by its name, with the parameters in the given Snooze object.

Parameters
Name	Description
request	IUpdateSnoozeRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IUpdateSnoozeRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The `Snooze` to update. Must have the name field present.
   */
  // const snooze = {}
  /**
   *  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.
   */
  // const updateMask = {}

  // Imports the Monitoring library
  const {SnoozeServiceClient} = require('@google-cloud/monitoring').v3;

  // Instantiates a client
  const monitoringClient = new SnoozeServiceClient();

  async function callUpdateSnooze() {
    // Construct request
    const request = {
      snooze,
      updateMask,
    };

    // Run request
    const response = await monitoringClient.updateSnooze(request);
    console.log(response);
  }

  callUpdateSnooze();

updateSnooze(request, options, callback)

updateSnooze(request: protos.google.monitoring.v3.IUpdateSnoozeRequest, options: CallOptions, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IUpdateSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSnoozeRequest
options	CallOptions
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IUpdateSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateSnooze(request, callback)

updateSnooze(request: protos.google.monitoring.v3.IUpdateSnoozeRequest, callback: Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IUpdateSnoozeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateSnoozeRequest
callback	Callback<protos.google.monitoring.v3.ISnooze, protos.google.monitoring.v3.IUpdateSnoozeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void