Package com.google.cloud.compute.v1

Interface HealthCheckServiceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HealthCheckService, HealthCheckService.Builder
@Generated public interface HealthCheckServiceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCreationTimestamp

      boolean hasCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      String getCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
 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 regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
 regional HealthCheckService, theHealthCheck must be regional and in the same
 region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
 global HealthChecks must specify sourceRegions,
 and HealthChecks that specify sourceRegions can
 only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
      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 regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
 regional HealthCheckService, theHealthCheck must be regional and in the same
 region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
 global HealthChecks must specify sourceRegions,
 and HealthChecks that specify sourceRegions can
 only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
      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 regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
 regional HealthCheckService, theHealthCheck must be regional and in the same
 region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
 global HealthChecks must specify sourceRegions,
 and HealthChecks that specify sourceRegions can
 only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
      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 regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For
 regional HealthCheckService, theHealthCheck must be regional and in the same
 region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the
 global HealthChecks must specify sourceRegions,
 and HealthChecks that specify sourceRegions can
 only be used with global INTERNET_IP_PORTNetworkEndpointGroups.
      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 reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.

 .
 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 reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.

 .
 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 reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.

 .
 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. [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. [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. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output only] Type of the resource. Alwayscompute#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 regionalHealthCheckService, NEGs must be in
 zones in the region of the HealthCheckService. For globalHealthCheckServices, 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 regionalHealthCheckService, NEGs must be in
 zones in the region of the HealthCheckService. For globalHealthCheckServices, 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 regionalHealthCheckService, NEGs must be in
 zones in the region of the HealthCheckService. For globalHealthCheckServices, 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 regionalHealthCheckService, NEGs must be in
 zones in the region of the HealthCheckService. For globalHealthCheckServices, 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 regionalHealthCheckService,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 regionalHealthCheckService,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 regionalHealthCheckService,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 regionalHealthCheckService,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. [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. [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. [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. [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. [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The selfLink.

    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The bytes for selfLink.