- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class HealthCheckService.Builder extends GeneratedMessageV3.Builder<HealthCheckService.Builder> implements HealthCheckServiceOrBuilderRepresents a Health-Check as a Service resource.
Protobuf type google.cloud.compute.v1.HealthCheckService
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HealthCheckService.BuilderImplements
HealthCheckServiceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllHealthChecks(Iterable<String> values)
public HealthCheckService.Builder addAllHealthChecks(Iterable<String> values)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The healthChecks to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addAllNetworkEndpointGroups(Iterable<String> values)
public HealthCheckService.Builder addAllNetworkEndpointGroups(Iterable<String> values)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The networkEndpointGroups to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addAllNotificationEndpoints(Iterable<String> values)
public HealthCheckService.Builder addAllNotificationEndpoints(Iterable<String> values)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The notificationEndpoints to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addHealthChecks(String value)
public HealthCheckService.Builder addHealthChecks(String value)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe healthChecks to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addHealthChecksBytes(ByteString value)
public HealthCheckService.Builder addHealthChecksBytes(ByteString value)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the healthChecks to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addNetworkEndpointGroups(String value)
public HealthCheckService.Builder addNetworkEndpointGroups(String value)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe networkEndpointGroups to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addNetworkEndpointGroupsBytes(ByteString value)
public HealthCheckService.Builder addNetworkEndpointGroupsBytes(ByteString value)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the networkEndpointGroups to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addNotificationEndpoints(String value)
public HealthCheckService.Builder addNotificationEndpoints(String value)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe notificationEndpoints to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addNotificationEndpointsBytes(ByteString value)
public HealthCheckService.Builder addNotificationEndpointsBytes(ByteString value)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the notificationEndpoints to add. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public HealthCheckService.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
build()
public HealthCheckService build()| Returns | |
|---|---|
| Type | Description |
HealthCheckService |
|
buildPartial()
public HealthCheckService buildPartial()| Returns | |
|---|---|
| Type | Description |
HealthCheckService |
|
clear()
public HealthCheckService.Builder clear()| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
clearCreationTimestamp()
public HealthCheckService.Builder clearCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearDescription()
public HealthCheckService.Builder clearDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public HealthCheckService.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
clearFingerprint()
public HealthCheckService.Builder clearFingerprint()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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearHealthChecks()
public HealthCheckService.Builder clearHealthChecks()A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearHealthStatusAggregationPolicy()
public HealthCheckService.Builder clearHealthStatusAggregationPolicy()Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearId()
public HealthCheckService.Builder clearId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearKind()
public HealthCheckService.Builder clearKind()[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearName()
public HealthCheckService.Builder clearName() Name of the resource. 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? 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.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearNetworkEndpointGroups()
public HealthCheckService.Builder clearNetworkEndpointGroups()A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearNotificationEndpoints()
public HealthCheckService.Builder clearNotificationEndpoints()A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public HealthCheckService.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
clearRegion()
public HealthCheckService.Builder clearRegion()[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clearSelfLink()
public HealthCheckService.Builder clearSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
clone()
public HealthCheckService.Builder clone()| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String |
The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for creationTimestamp. |
getDefaultInstanceForType()
public HealthCheckService getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
HealthCheckService |
|
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFingerprint()
public String 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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
String |
The fingerprint. |
getFingerprintBytes()
public ByteString getFingerprintBytes()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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for fingerprint. |
getHealthChecks(int index)
public String getHealthChecks(int index)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The healthChecks at the given index. |
getHealthChecksBytes(int index)
public ByteString getHealthChecksBytes(int index)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the healthChecks at the given index. |
getHealthChecksCount()
public int getHealthChecksCount()A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Returns | |
|---|---|
| Type | Description |
int |
The count of healthChecks. |
getHealthChecksList()
public ProtocolStringList getHealthChecksList()A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the healthChecks. |
getHealthStatusAggregationPolicy()
public String getHealthStatusAggregationPolicy()Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Returns | |
|---|---|
| Type | Description |
String |
The healthStatusAggregationPolicy. |
getHealthStatusAggregationPolicyBytes()
public ByteString getHealthStatusAggregationPolicyBytes()Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for healthStatusAggregationPolicy. |
getId()
public long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
long |
The id. |
getKind()
public String getKind()[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String |
The kind. |
getKindBytes()
public ByteString getKindBytes()[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kind. |
getName()
public String getName() Name of the resource. 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? 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.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Name of the resource. 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? 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.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getNetworkEndpointGroups(int index)
public String getNetworkEndpointGroups(int index)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The networkEndpointGroups at the given index. |
getNetworkEndpointGroupsBytes(int index)
public ByteString getNetworkEndpointGroupsBytes(int index)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the networkEndpointGroups at the given index. |
getNetworkEndpointGroupsCount()
public int getNetworkEndpointGroupsCount()A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Returns | |
|---|---|
| Type | Description |
int |
The count of networkEndpointGroups. |
getNetworkEndpointGroupsList()
public ProtocolStringList getNetworkEndpointGroupsList()A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the networkEndpointGroups. |
getNotificationEndpoints(int index)
public String getNotificationEndpoints(int index)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The notificationEndpoints at the given index. |
getNotificationEndpointsBytes(int index)
public ByteString getNotificationEndpointsBytes(int index)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the notificationEndpoints at the given index. |
getNotificationEndpointsCount()
public int getNotificationEndpointsCount()A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Returns | |
|---|---|
| Type | Description |
int |
The count of notificationEndpoints. |
getNotificationEndpointsList()
public ProtocolStringList getNotificationEndpointsList()A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the notificationEndpoints. |
getRegion()
public String getRegion()[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
String |
The region. |
getRegionBytes()
public ByteString getRegionBytes()[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for region. |
getSelfLink()
public String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for selfLink. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the description field is set. |
hasFingerprint()
public boolean hasFingerprint()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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fingerprint field is set. |
hasHealthStatusAggregationPolicy()
public boolean hasHealthStatusAggregationPolicy()Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the healthStatusAggregationPolicy field is set. |
hasId()
public boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the id field is set. |
hasKind()
public boolean hasKind()[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the kind field is set. |
hasName()
public boolean hasName() Name of the resource. 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? 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.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the name field is set. |
hasRegion()
public boolean hasRegion()[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the selfLink field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(HealthCheckService other)
public HealthCheckService.Builder mergeFrom(HealthCheckService other)| Parameter | |
|---|---|
| Name | Description |
other |
HealthCheckService |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public HealthCheckService.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public HealthCheckService.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final HealthCheckService.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
setCreationTimestamp(String value)
public HealthCheckService.Builder setCreationTimestamp(String value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe creationTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setCreationTimestampBytes(ByteString value)
public HealthCheckService.Builder setCreationTimestampBytes(ByteString value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for creationTimestamp to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setDescription(String value)
public HealthCheckService.Builder setDescription(String value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public HealthCheckService.Builder setDescriptionBytes(ByteString value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public HealthCheckService.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
setFingerprint(String value)
public HealthCheckService.Builder setFingerprint(String value)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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe fingerprint to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setFingerprintBytes(ByteString value)
public HealthCheckService.Builder setFingerprintBytes(ByteString value)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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.
optional string fingerprint = 234678500;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for fingerprint to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setHealthChecks(int index, String value)
public HealthCheckService.Builder setHealthChecks(int index, String value)A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups.
repeated string health_checks = 448370606;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe healthChecks to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setHealthStatusAggregationPolicy(String value)
public HealthCheckService.Builder setHealthStatusAggregationPolicy(String value)Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe healthStatusAggregationPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setHealthStatusAggregationPolicyBytes(ByteString value)
public HealthCheckService.Builder setHealthStatusAggregationPolicyBytes(ByteString value)Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for healthStatusAggregationPolicy to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setId(long value)
public HealthCheckService.Builder setId(long value)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe id to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setKind(String value)
public HealthCheckService.Builder setKind(String value)[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kind to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setKindBytes(ByteString value)
public HealthCheckService.Builder setKindBytes(ByteString value)[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kind to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setName(String value)
public HealthCheckService.Builder setName(String value) Name of the resource. 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? 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.
optional string name = 3373707;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public HealthCheckService.Builder setNameBytes(ByteString value) Name of the resource. 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? 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.
optional string name = 3373707;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setNetworkEndpointGroups(int index, String value)
public HealthCheckService.Builder setNetworkEndpointGroups(int index, String value)A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.
repeated string network_endpoint_groups = 29346733;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe networkEndpointGroups to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setNotificationEndpoints(int index, String value)
public HealthCheckService.Builder setNotificationEndpoints(int index, String value)A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global.
repeated string notification_endpoints = 406728490;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe notificationEndpoints to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setRegion(String value)
public HealthCheckService.Builder setRegion(String value)[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe region to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setRegionBytes(ByteString value)
public HealthCheckService.Builder setRegionBytes(ByteString value)[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for region to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public HealthCheckService.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|
setSelfLink(String value)
public HealthCheckService.Builder setSelfLink(String value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setSelfLinkBytes(ByteString value)
public HealthCheckService.Builder setSelfLinkBytes(ByteString value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final HealthCheckService.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
HealthCheckService.Builder |
|