- 1.62.0 (latest)
- 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 final class HealthCheckService extends GeneratedMessageV3 implements HealthCheckServiceOrBuilder
Represents a Health-Check as a Service resource.
Protobuf type google.cloud.compute.v1.HealthCheckService
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > HealthCheckServiceImplements
HealthCheckServiceOrBuilderStatic Fields
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Type | Description |
int |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Type | Description |
int |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
Type | Description |
int |
HEALTH_CHECKS_FIELD_NUMBER
public static final int HEALTH_CHECKS_FIELD_NUMBER
Type | Description |
int |
HEALTH_STATUS_AGGREGATION_POLICY_FIELD_NUMBER
public static final int HEALTH_STATUS_AGGREGATION_POLICY_FIELD_NUMBER
Type | Description |
int |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Type | Description |
int |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Type | Description |
int |
NETWORK_ENDPOINT_GROUPS_FIELD_NUMBER
public static final int NETWORK_ENDPOINT_GROUPS_FIELD_NUMBER
Type | Description |
int |
NOTIFICATION_ENDPOINTS_FIELD_NUMBER
public static final int NOTIFICATION_ENDPOINTS_FIELD_NUMBER
Type | Description |
int |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
Type | Description |
int |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Type | Description |
int |
Static Methods
getDefaultInstance()
public static HealthCheckService getDefaultInstance()
Type | Description |
HealthCheckService |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
newBuilder()
public static HealthCheckService.Builder newBuilder()
Type | Description |
HealthCheckService.Builder |
newBuilder(HealthCheckService prototype)
public static HealthCheckService.Builder newBuilder(HealthCheckService prototype)
Name | Description |
prototype | HealthCheckService |
Type | Description |
HealthCheckService.Builder |
parseDelimitedFrom(InputStream input)
public static HealthCheckService parseDelimitedFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseFrom(byte[] data)
public static HealthCheckService parseFrom(byte[] data)
Name | Description |
data | byte[] |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static HealthCheckService parseFrom(ByteString data)
Name | Description |
data | ByteString |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static HealthCheckService parseFrom(CodedInputStream input)
Name | Description |
input | CodedInputStream |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseFrom(InputStream input)
public static HealthCheckService parseFrom(InputStream input)
Name | Description |
input | InputStream |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static HealthCheckService parseFrom(ByteBuffer data)
Name | Description |
data | ByteBuffer |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HealthCheckService parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
HealthCheckService |
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<HealthCheckService> parser()
Type | Description |
Parser<HealthCheckService> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Name | Description |
obj | Object |
Type | Description |
boolean |
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public HealthCheckService getDefaultInstanceForType()
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;
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;
Type | Description |
ByteString | The bytes for description. |
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;
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;
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. 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 NEGs.
repeated string health_checks = 448370606;
Name | Description |
index | int The index of the element to return. |
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. 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 NEGs.
repeated string health_checks = 448370606;
Name | Description |
index | int The index of the value to return. |
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. 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 NEGs.
repeated string health_checks = 448370606;
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. 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 NEGs.
repeated string health_checks = 448370606;
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. . Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
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. . Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
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;
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;
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;
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;
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;
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.
repeated string network_endpoint_groups = 29346733;
Name | Description |
index | int The index of the element to return. |
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.
repeated string network_endpoint_groups = 29346733;
Name | Description |
index | int The index of the value to return. |
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.
repeated string network_endpoint_groups = 29346733;
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.
repeated string network_endpoint_groups = 29346733;
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;
Name | Description |
index | int The index of the element to return. |
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;
Name | Description |
index | int The index of the value to return. |
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;
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;
Type | Description |
ProtocolStringList | A list containing the notificationEndpoints. |
getParserForType()
public Parser<HealthCheckService> getParserForType()
Type | Description |
Parser<HealthCheckService> |
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;
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;
Type | Description |
ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Type | Description |
UnknownFieldSet |
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
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;
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;
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. . Check the HealthStatusAggregationPolicy enum for the list of possible values.
optional string health_status_aggregation_policy = 253163129;
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;
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;
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;
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;
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;
Type | Description |
boolean | Whether the selfLink field is set. |
hashCode()
public int hashCode()
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
newBuilderForType()
public HealthCheckService.Builder newBuilderForType()
Type | Description |
HealthCheckService.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HealthCheckService.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Name | Description |
parent | BuilderParent |
Type | Description |
HealthCheckService.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Name | Description |
unused | UnusedPrivateParameter |
Type | Description |
Object |
toBuilder()
public HealthCheckService.Builder toBuilder()
Type | Description |
HealthCheckService.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Name | Description |
output | CodedOutputStream |
Type | Description |
IOException |