Reference documentation and code samples for the Compute V1 Client class CompositeHealthCheck.
Represents a composite health check.
A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered.
Generated from protobuf message google.cloud.compute.v1.CompositeHealthCheck
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ creation_timestamp
string
Output only. [Output Only] Creation timestamp inRFC3339 text format.
↳ description
string
An optional description of this resource. Provide this property when you create the resource.
↳ fingerprint
string
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
↳ health_destination
string
URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
↳ health_sources
string[]
URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
↳ id
int|string
Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.
↳ kind
string
Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
↳ 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 withRFC1035. 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. [Output Only] URL of the region where the composite health check 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. [Output Only] Server-defined URL for the resource.
↳ self_link_with_id
string
Output only. [Output Only] Server-defined URL with id for the resource.
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
string
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
var
string
$this
getDescription
An optional description of this resource. Provide this property when you create the resource.
string
hasDescription
clearDescription
setDescription
An optional description of this resource. Provide this property when you create the resource.
var
string
$this
getFingerprint
Fingerprint of this resource. A hash of the contents stored in this object.
This field is used in optimistic locking. This field will be ignored when inserting a CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
string
hasFingerprint
clearFingerprint
setFingerprint
Fingerprint of this resource. A hash of the contents stored in this object.
This field is used in optimistic locking. This field will be ignored when inserting a CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck.
var
string
$this
getHealthDestination
URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
string
hasHealthDestination
clearHealthDestination
setHealthDestination
URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.
var
string
$this
getHealthSources
URLs to the HealthSource resources whose results are AND'ed.
I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
setHealthSources
URLs to the HealthSource resources whose results are AND'ed.
I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated.
var
string[]
$this
getId
Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.
int|string
hasId
clearId
setId
Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.
var
int|string
$this
getKind
Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
string
hasKind
clearKind
setKind
Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.
var
string
$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 withRFC1035.
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.
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 withRFC1035.
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.
var
string
$this
getRegion
Output only. [Output Only] URL of the region where the composite health check 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.
string
hasRegion
clearRegion
setRegion
Output only. [Output Only] URL of the region where the composite health check 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.
var
string
$this
getSelfLink
Output only. [Output Only] Server-defined URL for the resource.
string
hasSelfLink
clearSelfLink
setSelfLink
Output only. [Output Only] Server-defined URL for the resource.
var
string
$this
getSelfLinkWithId
Output only. [Output Only] Server-defined URL with id for the resource.
string
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
Output only. [Output Only] Server-defined URL with id for the resource.
var
string
$this
