com.google.cloud.compute.v1

Interface HealthCheckServiceOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

HealthCheckService, HealthCheckService.Builder

public interface HealthCheckServiceOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
com.google.protobuf.ByteString	getCreationTimestampBytes() [Output Only] Creation timestamp in RFC3339 text format.
String	getDescription() An optional description of this resource.
com.google.protobuf.ByteString	getDescriptionBytes() An optional description of this resource.
String	getFingerprint() Fingerprint of this resource.
com.google.protobuf.ByteString	getFingerprintBytes() Fingerprint of this resource.
String	getHealthChecks(int index) A list of URLs to the HealthCheck resources.
com.google.protobuf.ByteString	getHealthChecksBytes(int index) A list of URLs to the HealthCheck resources.
int	getHealthChecksCount() A list of URLs to the HealthCheck resources.
List<String>	getHealthChecksList() A list of URLs to the HealthCheck resources.
String	getHealthStatusAggregationPolicy() Optional.
com.google.protobuf.ByteString	getHealthStatusAggregationPolicyBytes() Optional.
long	getId() [Output Only] The unique identifier for the resource.
String	getKind() [Output only] Type of the resource.
com.google.protobuf.ByteString	getKindBytes() [Output only] Type of the resource.
String	getName() Name of the resource.
com.google.protobuf.ByteString	getNameBytes() Name of the resource.
String	getNetworkEndpointGroups(int index) A list of URLs to the NetworkEndpointGroup resources.
com.google.protobuf.ByteString	getNetworkEndpointGroupsBytes(int index) A list of URLs to the NetworkEndpointGroup resources.
int	getNetworkEndpointGroupsCount() A list of URLs to the NetworkEndpointGroup resources.
List<String>	getNetworkEndpointGroupsList() A list of URLs to the NetworkEndpointGroup resources.
String	getNotificationEndpoints(int index) A list of URLs to the NotificationEndpoint resources.
com.google.protobuf.ByteString	getNotificationEndpointsBytes(int index) A list of URLs to the NotificationEndpoint resources.
int	getNotificationEndpointsCount() A list of URLs to the NotificationEndpoint resources.
List<String>	getNotificationEndpointsList() A list of URLs to the NotificationEndpoint resources.
String	getRegion() [Output Only] URL of the region where the health check service resides.
com.google.protobuf.ByteString	getRegionBytes() [Output Only] URL of the region where the health check service resides.
String	getSelfLink() [Output Only] Server-defined URL for the resource.
com.google.protobuf.ByteString	getSelfLinkBytes() [Output Only] Server-defined URL for the resource.
boolean	hasCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
boolean	hasDescription() An optional description of this resource.
boolean	hasFingerprint() Fingerprint of this resource.
boolean	hasHealthStatusAggregationPolicy() Optional.
boolean	hasId() [Output Only] The unique identifier for the resource.
boolean	hasKind() [Output only] Type of the resource.
boolean	hasName() Name of the resource.
boolean	hasRegion() [Output Only] URL of the region where the health check service resides.
boolean	hasSelfLink() [Output Only] Server-defined URL for the resource.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCreationTimestamp

boolean hasCreationTimestamp()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

Whether the creationTimestamp field is set.

getCreationTimestamp

String getCreationTimestamp()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

The creationTimestamp.

getCreationTimestampBytes

com.google.protobuf.ByteString getCreationTimestampBytes()

 [Output Only] Creation timestamp in RFC3339 text format.
 

optional string creation_timestamp = 30525366;

Returns:

The bytes for creationTimestamp.

hasDescription

boolean hasDescription()

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

optional string description = 422937596;

Returns:

Whether the description field is set.

getDescription

String getDescription()

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

optional string description = 422937596;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns:

The bytes for description.

hasFingerprint

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:

Whether the fingerprint field is set.

getFingerprint

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:

The fingerprint.

getFingerprintBytes

com.google.protobuf.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:

The bytes for fingerprint.

getHealthChecksList

List<String> 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:

A list containing the healthChecks.

getHealthChecksCount

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:

The count of healthChecks.

getHealthChecks

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;

Parameters:

index - The index of the element to return.

Returns:

The healthChecks at the given index.

getHealthChecksBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the healthChecks at the given index.

hasHealthStatusAggregationPolicy

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:

Whether the healthStatusAggregationPolicy field is set.

getHealthStatusAggregationPolicy

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:

The healthStatusAggregationPolicy.

getHealthStatusAggregationPolicyBytes

com.google.protobuf.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:

The bytes for healthStatusAggregationPolicy.

hasId

boolean hasId()

 [Output Only] The unique identifier for the resource. This identifier is defined by the server.
 

optional uint64 id = 3355;

Returns:

Whether the id field is set.

getId

long getId()

 [Output Only] The unique identifier for the resource. This identifier is defined by the server.
 

optional uint64 id = 3355;

Returns:

The id.

hasKind

boolean hasKind()

 [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
 

optional string kind = 3292052;

Returns:

Whether the kind field is set.

getKind

String getKind()

 [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
 

optional string kind = 3292052;

Returns:

The kind.

getKindBytes

com.google.protobuf.ByteString getKindBytes()

 [Output only] Type of the resource. Always compute#healthCheckServicefor health check services.
 

optional string kind = 3292052;

Returns:

The bytes for kind.

hasName

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]([-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.
 

optional string name = 3373707;

Returns:

Whether the name field is set.

getName

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]([-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.
 

optional string name = 3373707;

Returns:

The name.

getNameBytes

com.google.protobuf.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]([-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.
 

optional string name = 3373707;

Returns:

The bytes for name.

getNetworkEndpointGroupsList

List<String> 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:

A list containing the networkEndpointGroups.

getNetworkEndpointGroupsCount

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:

The count of networkEndpointGroups.

getNetworkEndpointGroups

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;

Parameters:

index - The index of the element to return.

Returns:

The networkEndpointGroups at the given index.

getNetworkEndpointGroupsBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the networkEndpointGroups at the given index.

getNotificationEndpointsList

List<String> 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:

A list containing the notificationEndpoints.

getNotificationEndpointsCount

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:

The count of notificationEndpoints.

getNotificationEndpoints

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;

Parameters:

index - The index of the element to return.

Returns:

The notificationEndpoints at the given index.

getNotificationEndpointsBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the notificationEndpoints at the given index.

hasRegion

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:

Whether the region field is set.

getRegion

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:

The region.

getRegionBytes

com.google.protobuf.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:

The bytes for region.

hasSelfLink

boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns:

Whether the selfLink field is set.

getSelfLink

String getSelfLink()

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

optional string self_link = 456214797;

Returns:

The selfLink.

getSelfLinkBytes

com.google.protobuf.ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns:

The bytes for selfLink.