* $monitoringService = new Google\Service\Monitoring(...); * $notificationChannels = $monitoringService->projects_notificationChannels; * */ class ProjectsNotificationChannels extends \Google\Service\Resource { /** * Creates a new notification channel, representing a single notification * endpoint such as an email address, SMS number, or PagerDuty service.Design * your application to single-thread API calls that modify the state of * notification channels in a single project. This includes calls to * CreateNotificationChannel, DeleteNotificationChannel and * UpdateNotificationChannel. (notificationChannels.create) * * @param string $name Required. The project * (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute * the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the * container into which the channel will be written, this does not name the * newly created channel. The resulting channel's name will have a normalized * version of this field as a prefix, but will add * /notificationChannels/[CHANNEL_ID] to identify the channel. * @param NotificationChannel $postBody * @param array $optParams Optional parameters. * @return NotificationChannel * @throws \Google\Service\Exception */ public function create($name, NotificationChannel $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('create', [$params], NotificationChannel::class); } /** * Deletes a notification channel.Design your application to single-thread API * calls that modify the state of notification channels in a single project. * This includes calls to CreateNotificationChannel, DeleteNotificationChannel * and UpdateNotificationChannel. (notificationChannels.delete) * * @param string $name Required. The channel for which to execute the request. * The format is: * projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] * @param array $optParams Optional parameters. * * @opt_param bool force If true, the notification channel will be deleted * regardless of its use in alert policies (the policies will be updated to * remove the channel). If false, this operation will fail if the notification * channel is referenced by existing alerting policies. * @return MonitoringEmpty * @throws \Google\Service\Exception */ public function delete($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('delete', [$params], MonitoringEmpty::class); } /** * Gets a single notification channel. The channel includes the relevant * configuration details with which the channel was created. However, the * response may truncate or omit passwords, API keys, or other private key * matter and thus the response may not be 100% identical to the information * that was supplied in the call to the create method. * (notificationChannels.get) * * @param string $name Required. The channel for which to execute the request. * The format is: * projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] * @param array $optParams Optional parameters. * @return NotificationChannel * @throws \Google\Service\Exception */ public function get($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('get', [$params], NotificationChannel::class); } /** * Requests a verification code for an already verified channel that can then be * used in a call to VerifyNotificationChannel() on a different channel with an * equivalent identity in the same or in a different project. This makes it * possible to copy a channel between projects without requiring manual * reverification of the channel. If the channel is not in the verified state, * this method will fail (in other words, this may only be used if the * SendNotificationChannelVerificationCode and VerifyNotificationChannel paths * have already been used to put the given channel into the verified * state).There is no guarantee that the verification codes returned by this * method will be of a similar structure or form as the ones that are delivered * to the channel via SendNotificationChannelVerificationCode; while * VerifyNotificationChannel() will recognize both the codes delivered via * SendNotificationChannelVerificationCode() and returned from * GetNotificationChannelVerificationCode(), it is typically the case that the * verification codes delivered via SendNotificationChannelVerificationCode() * will be shorter and also have a shorter expiration (e.g. codes such as * "G-123456") whereas GetVerificationCode() will typically return a much * longer, websafe base 64 encoded string that has a longer expiration time. * (notificationChannels.getVerificationCode) * * @param string $name Required. The notification channel for which a * verification code is to be generated and retrieved. This must name a channel * that is already verified; if the specified channel is not verified, the * request will fail. * @param GetNotificationChannelVerificationCodeRequest $postBody * @param array $optParams Optional parameters. * @return GetNotificationChannelVerificationCodeResponse * @throws \Google\Service\Exception */ public function getVerificationCode($name, GetNotificationChannelVerificationCodeRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('getVerificationCode', [$params], GetNotificationChannelVerificationCodeResponse::class); } /** * Lists the notification channels that have been created for the project. To * list the types of notification channels that are supported, use the * ListNotificationChannelDescriptors method. * (notificationChannels.listProjectsNotificationChannels) * * @param string $name Required. The project * (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute * the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the * container in which to look for the notification channels; it does not name a * specific channel. To query a specific channel by REST resource name, use the * GetNotificationChannel operation. * @param array $optParams Optional parameters. * * @opt_param string filter Optional. If provided, this field specifies the * criteria that must be met by notification channels to be included in the * response.For more details, see sorting and filtering * (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). * @opt_param string orderBy Optional. A comma-separated list of fields by which * to sort the result. Supports the same set of fields as in filter. Entries can * be prefixed with a minus sign to sort in descending rather than ascending * order.For more details, see sorting and filtering * (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). * @opt_param int pageSize Optional. The maximum number of results to return in * a single response. If not set to a positive number, a reasonable value will * be chosen by the service. * @opt_param string pageToken Optional. If non-empty, page_token must contain a * value returned as the next_page_token in a previous response to request the * next set of results. * @return ListNotificationChannelsResponse * @throws \Google\Service\Exception */ public function listProjectsNotificationChannels($name, $optParams = []) { $params = ['name' => $name]; $params = array_merge($params, $optParams); return $this->call('list', [$params], ListNotificationChannelsResponse::class); } /** * Updates a notification channel. Fields not specified in the field mask remain * unchanged.Design your application to single-thread API calls that modify the * state of notification channels in a single project. This includes calls to * CreateNotificationChannel, DeleteNotificationChannel and * UpdateNotificationChannel. (notificationChannels.patch) * * @param string $name Identifier. The full REST resource name for this channel. * The format is: * projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The * [CHANNEL_ID] is automatically assigned by the server on creation. * @param NotificationChannel $postBody * @param array $optParams Optional parameters. * * @opt_param string updateMask Optional. The fields to update. * @return NotificationChannel * @throws \Google\Service\Exception */ public function patch($name, NotificationChannel $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('patch', [$params], NotificationChannel::class); } /** * Causes a verification code to be delivered to the channel. The code can then * be supplied in VerifyNotificationChannel to verify the channel. * (notificationChannels.sendVerificationCode) * * @param string $name Required. The notification channel to which to send a * verification code. * @param SendNotificationChannelVerificationCodeRequest $postBody * @param array $optParams Optional parameters. * @return MonitoringEmpty * @throws \Google\Service\Exception */ public function sendVerificationCode($name, SendNotificationChannelVerificationCodeRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('sendVerificationCode', [$params], MonitoringEmpty::class); } /** * Verifies a NotificationChannel by proving receipt of the code delivered to * the channel as a result of calling SendNotificationChannelVerificationCode. * (notificationChannels.verify) * * @param string $name Required. The notification channel to verify. * @param VerifyNotificationChannelRequest $postBody * @param array $optParams Optional parameters. * @return NotificationChannel * @throws \Google\Service\Exception */ public function verify($name, VerifyNotificationChannelRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('verify', [$params], NotificationChannel::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsNotificationChannels::class, 'Google_Service_Monitoring_Resource_ProjectsNotificationChannels');