Compute V1 Client - Class NotificationEndpoint (1.20.0)

Reference documentation and code samples for the Compute V1 Client class NotificationEndpoint.

Represents a notification endpoint. A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. For more information, see Health checks overview.

Generated from protobuf message google.cloud.compute.v1.NotificationEndpoint

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this property when you create the resource.
↳ grpc_settings Google\Cloud\Compute\V1\NotificationEndpointGrpcSettings

Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.
↳ id int|string

[Output Only] A unique identifier for this resource type. The server generates this identifier.
↳ kind string

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.
↳ name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ region string

[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
↳ self_link string

[Output Only] Server-defined URL for the resource.

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getGrpcSettings

Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

Returns
Type Description
Google\Cloud\Compute\V1\NotificationEndpointGrpcSettings|null

hasGrpcSettings

clearGrpcSettings

setGrpcSettings

Settings of the gRPC notification endpoint including the endpoint URL and the retry duration.

Parameter
Name Description
var Google\Cloud\Compute\V1\NotificationEndpointGrpcSettings
Returns
Type Description
$this

getId

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints.

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getRegion

[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type Description
string

hasRegion

clearRegion

setRegion

[Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this