ProjectsNotificationChannelsResourceApi class

Constructors

ProjectsNotificationChannelsResourceApi(ApiRequester client)

Properties

hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

create(NotificationChannel request, String name, { String $fields }) → Future<NotificationChannel>
Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service. [...]
delete(String name, { bool force, String $fields }) → Future<Empty>
Deletes a notification channel. [...]
get(String name, { String $fields }) → Future<NotificationChannel>
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. [...]
getVerificationCode(GetNotificationChannelVerificationCodeRequest request, String name, { String $fields }) → Future<GetNotificationChannelVerificationCodeResponse>
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. [...]
list(String name, { String filter String orderBy String pageToken int pageSize, String $fields }) → Future<ListNotificationChannelsResponse>
Lists the notification channels that have been created for the project. [...]
patch(NotificationChannel request, String name, { String updateMask String $fields }) → Future<NotificationChannel>
Updates a notification channel. Fields not specified in the field mask remain unchanged. [...]
sendVerificationCode(SendNotificationChannelVerificationCodeRequest request, String name, { String $fields }) → Future<Empty>
Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. [...]
verify(VerifyNotificationChannelRequest request, String name, { String $fields }) → Future<NotificationChannel>
Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator.
inherited