Package com.google.cloud.compute.v1

Class HealthAggregationPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.compute.v1.HealthAggregationPolicy
All Implemented Interfaces:
HealthAggregationPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class HealthAggregationPolicy extends com.google.protobuf.GeneratedMessage implements HealthAggregationPolicyOrBuilder
 Represents a health aggregation policy.

 A health aggregation policy resource defines a policy to aggregate health.

 For more information, see
 Health checks overview.
Protobuf type google.cloud.compute.v1.HealthAggregationPolicy
See Also:

  • Field Details

    • CREATION_TIMESTAMP_FIELD_NUMBER

      public static final int CREATION_TIMESTAMP_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • FINGERPRINT_FIELD_NUMBER

      public static final int FINGERPRINT_FIELD_NUMBER
      See Also:

    • HEALTHY_PERCENT_THRESHOLD_FIELD_NUMBER

      public static final int HEALTHY_PERCENT_THRESHOLD_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • KIND_FIELD_NUMBER

      public static final int KIND_FIELD_NUMBER
      See Also:

    • MIN_HEALTHY_THRESHOLD_FIELD_NUMBER

      public static final int MIN_HEALTHY_THRESHOLD_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • POLICY_TYPE_FIELD_NUMBER

      public static final int POLICY_TYPE_FIELD_NUMBER
      See Also:

    • REGION_FIELD_NUMBER

      public static final int REGION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasCreationTimestamp

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

    • getCreationTimestamp

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

    • getCreationTimestampBytes

      public com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Specified by:
      getCreationTimestampBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for creationTimestamp.

    • hasDescription

      public boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      hasDescription in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescription in interface HealthAggregationPolicyOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Specified by:
      getDescriptionBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for description.

    • 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 HealthAggregationPolicy. An up-to-date fingerprint
 must be provided in order to patch the HealthAggregationPolicy; Otherwise,
 the request will fail with error 412 conditionNotMet. To see
 the latest fingerprint, make a get() request to retrieve the
 HealthAggregationPolicy.
      optional string fingerprint = 234678500;
      Specified by:
      hasFingerprint in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the fingerprint field is set.

    • 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 HealthAggregationPolicy. An up-to-date fingerprint
 must be provided in order to patch the HealthAggregationPolicy; Otherwise,
 the request will fail with error 412 conditionNotMet. To see
 the latest fingerprint, make a get() request to retrieve the
 HealthAggregationPolicy.
      optional string fingerprint = 234678500;
      Specified by:
      getFingerprint in interface HealthAggregationPolicyOrBuilder
      Returns:
      The fingerprint.

    • getFingerprintBytes

      public 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 HealthAggregationPolicy. An up-to-date fingerprint
 must be provided in order to patch the HealthAggregationPolicy; Otherwise,
 the request will fail with error 412 conditionNotMet. To see
 the latest fingerprint, make a get() request to retrieve the
 HealthAggregationPolicy.
      optional string fingerprint = 234678500;
      Specified by:
      getFingerprintBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for fingerprint.

    • hasHealthyPercentThreshold

      public boolean hasHealthyPercentThreshold()
       Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a
 percentage) of healthy endpoints required in order to consider the
 aggregated health result HEALTHY. Defaults to 60. Must be in
 range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
 and will be set to the default if unspecified. Note that both this
 threshold and minHealthyThreshold must be satisfied in order
 for HEALTHY to be the aggregated result. "Endpoints" refers to network
 endpoints within a Network Endpoint Group or instances within an Instance
 Group.
      optional uint32 healthy_percent_threshold = 72242895;
      Specified by:
      hasHealthyPercentThreshold in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the healthyPercentThreshold field is set.

    • getHealthyPercentThreshold

      public int getHealthyPercentThreshold()
       Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a
 percentage) of healthy endpoints required in order to consider the
 aggregated health result HEALTHY. Defaults to 60. Must be in
 range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
 and will be set to the default if unspecified. Note that both this
 threshold and minHealthyThreshold must be satisfied in order
 for HEALTHY to be the aggregated result. "Endpoints" refers to network
 endpoints within a Network Endpoint Group or instances within an Instance
 Group.
      optional uint32 healthy_percent_threshold = 72242895;
      Specified by:
      getHealthyPercentThreshold in interface HealthAggregationPolicyOrBuilder
      Returns:
      The healthyPercentThreshold.

    • hasId

      public boolean hasId()
       Output only. [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Specified by:
      hasId in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
       Output only. [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Specified by:
      getId in interface HealthAggregationPolicyOrBuilder
      Returns:
      The id.

    • hasKind

      public boolean hasKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation
 policies.
      optional string kind = 3292052;
      Specified by:
      hasKind in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the kind field is set.

    • getKind

      public String getKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation
 policies.
      optional string kind = 3292052;
      Specified by:
      getKind in interface HealthAggregationPolicyOrBuilder
      Returns:
      The kind.

    • getKindBytes

      public com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation
 policies.
      optional string kind = 3292052;
      Specified by:
      getKindBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for kind.

    • hasMinHealthyThreshold

      public boolean hasMinHealthyThreshold()
       Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of
 healthy endpoints required in order to consider the aggregated health
 result HEALTHY. Defaults to 1. Must be positive. Not
 applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
 and will be set to the default if unspecified. Note that both this
 threshold and healthyPercentThreshold must be satisfied in
 order for HEALTHY to be the aggregated result. "Endpoints" refers to
 network endpoints within a Network Endpoint Group or instances within an
 Instance Group.
      optional uint32 min_healthy_threshold = 132310940;
      Specified by:
      hasMinHealthyThreshold in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the minHealthyThreshold field is set.

    • getMinHealthyThreshold

      public int getMinHealthyThreshold()
       Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of
 healthy endpoints required in order to consider the aggregated health
 result HEALTHY. Defaults to 1. Must be positive. Not
 applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,
 and will be set to the default if unspecified. Note that both this
 threshold and healthyPercentThreshold must be satisfied in
 order for HEALTHY to be the aggregated result. "Endpoints" refers to
 network endpoints within a Network Endpoint Group or instances within an
 Instance Group.
      optional uint32 min_healthy_threshold = 132310940;
      Specified by:
      getMinHealthyThreshold in interface HealthAggregationPolicyOrBuilder
      Returns:
      The minHealthyThreshold.

    • hasName

      public boolean hasName()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Specified by:
      hasName in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Specified by:
      getName in interface HealthAggregationPolicyOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the resource. Provided by the client when the resource is created.
 The name must be 1-63 characters long, and comply withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must
 be a dash, lowercase letter, or digit, except the last character, which
 cannot be a dash.
      optional string name = 3373707;
      Specified by:
      getNameBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for name.

    • hasPolicyType

      public boolean hasPolicyType()
       Specifies the type of the healthAggregationPolicy. The only allowed value
 for global resources is DNS_PUBLIC_IP_POLICY. The only allowed
 value for regional resources is BACKEND_SERVICE_POLICY. Must
 be specified when the healthAggregationPolicy is created, and cannot be
 mutated.
 Check the PolicyType enum for the list of possible values.
      optional string policy_type = 18158119;
      Specified by:
      hasPolicyType in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the policyType field is set.

    • getPolicyType

      public String getPolicyType()
       Specifies the type of the healthAggregationPolicy. The only allowed value
 for global resources is DNS_PUBLIC_IP_POLICY. The only allowed
 value for regional resources is BACKEND_SERVICE_POLICY. Must
 be specified when the healthAggregationPolicy is created, and cannot be
 mutated.
 Check the PolicyType enum for the list of possible values.
      optional string policy_type = 18158119;
      Specified by:
      getPolicyType in interface HealthAggregationPolicyOrBuilder
      Returns:
      The policyType.

    • getPolicyTypeBytes

      public com.google.protobuf.ByteString getPolicyTypeBytes()
       Specifies the type of the healthAggregationPolicy. The only allowed value
 for global resources is DNS_PUBLIC_IP_POLICY. The only allowed
 value for regional resources is BACKEND_SERVICE_POLICY. Must
 be specified when the healthAggregationPolicy is created, and cannot be
 mutated.
 Check the PolicyType enum for the list of possible values.
      optional string policy_type = 18158119;
      Specified by:
      getPolicyTypeBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for policyType.

    • hasRegion

      public boolean hasRegion()
       Output only. [Output Only] URL of the region where the health aggregation policy
 resides. This field applies only to the regional resource. You must specify
 this field as part of the HTTP request URL. It is not settable as a field
 in the request body.
      optional string region = 138946292;
      Specified by:
      hasRegion in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the region field is set.

    • getRegion

      public String getRegion()
       Output only. [Output Only] URL of the region where the health aggregation policy
 resides. This field applies only to the regional resource. You must specify
 this field as part of the HTTP request URL. It is not settable as a field
 in the request body.
      optional string region = 138946292;
      Specified by:
      getRegion in interface HealthAggregationPolicyOrBuilder
      Returns:
      The region.

    • getRegionBytes

      public com.google.protobuf.ByteString getRegionBytes()
       Output only. [Output Only] URL of the region where the health aggregation policy
 resides. This field applies only to the regional resource. You must specify
 this field as part of the HTTP request URL. It is not settable as a field
 in the request body.
      optional string region = 138946292;
      Specified by:
      getRegionBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for region.

    • hasSelfLink

      public boolean hasSelfLink()
       Output only. [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Specified by:
      hasSelfLink in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      public String getSelfLink()
       Output only. [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Specified by:
      getSelfLink in interface HealthAggregationPolicyOrBuilder
      Returns:
      The selfLink.

    • getSelfLinkBytes

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

    • hasSelfLinkWithId

      public boolean hasSelfLinkWithId()
       Output only. [Output Only] Server-defined URL with id for the resource.
      optional string self_link_with_id = 44520962;
      Specified by:
      hasSelfLinkWithId in interface HealthAggregationPolicyOrBuilder
      Returns:
      Whether the selfLinkWithId field is set.

    • getSelfLinkWithId

      public String getSelfLinkWithId()
       Output only. [Output Only] Server-defined URL with id for the resource.
      optional string self_link_with_id = 44520962;
      Specified by:
      getSelfLinkWithId in interface HealthAggregationPolicyOrBuilder
      Returns:
      The selfLinkWithId.

    • getSelfLinkWithIdBytes

      public com.google.protobuf.ByteString getSelfLinkWithIdBytes()
       Output only. [Output Only] Server-defined URL with id for the resource.
      optional string self_link_with_id = 44520962;
      Specified by:
      getSelfLinkWithIdBytes in interface HealthAggregationPolicyOrBuilder
      Returns:
      The bytes for selfLinkWithId.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static HealthAggregationPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthAggregationPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static HealthAggregationPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static HealthAggregationPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public HealthAggregationPolicy.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static HealthAggregationPolicy.Builder newBuilder()

    • newBuilder

      public static HealthAggregationPolicy.Builder newBuilder(HealthAggregationPolicy prototype)

    • toBuilder

      public HealthAggregationPolicy.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected HealthAggregationPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static HealthAggregationPolicy getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<HealthAggregationPolicy> parser()

    • getParserForType

      public com.google.protobuf.Parser<HealthAggregationPolicy> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public HealthAggregationPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder