Reference documentation and code samples for the Compute V1 Client class NotificationEndpointGrpcSettings.
Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.
Generated from protobuf message google.cloud.compute.v1.NotificationEndpointGrpcSettings
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ authority |
string
Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 |
↳ endpoint |
string
Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. |
↳ payload_name |
string
Optional. If specified, this field is used to populate the "name" field in gRPC requests. |
↳ resend_interval |
Google\Cloud\Compute\V1\Duration
Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints. |
↳ retry_duration_sec |
int
How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. |
getAuthority
Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3
| Returns | |
|---|---|
| Type | Description |
string | |
hasAuthority
clearAuthority
setAuthority
Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpoint
Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.
| Returns | |
|---|---|
| Type | Description |
string | |
hasEndpoint
clearEndpoint
setEndpoint
Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPayloadName
Optional. If specified, this field is used to populate the "name" field in gRPC requests.
| Returns | |
|---|---|
| Type | Description |
string | |
hasPayloadName
clearPayloadName
setPayloadName
Optional. If specified, this field is used to populate the "name" field in gRPC requests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResendInterval
Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\Duration|null | |
hasResendInterval
clearResendInterval
setResendInterval
Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. Can only be set for regional notification endpoints.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRetryDurationSec
How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.
| Returns | |
|---|---|
| Type | Description |
int | |
hasRetryDurationSec
clearRetryDurationSec
setRetryDurationSec
How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |