Package com.google.cloud.compute.v1
Interface HealthAggregationPolicyOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HealthAggregationPolicy,HealthAggregationPolicy.Builder
@Generated
public interface HealthAggregationPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionOutput only.com.google.protobuf.ByteStringOutput only.An optional description of this resource.com.google.protobuf.ByteStringAn optional description of this resource.Fingerprint of this resource.com.google.protobuf.ByteStringFingerprint of this resource.intCan only be set if the policyType field isBACKEND_SERVICE_POLICY.longgetId()Output only.getKind()Output only.com.google.protobuf.ByteStringOutput only.intCan only be set if the policyType field isBACKEND_SERVICE_POLICY.getName()Name of the resource.com.google.protobuf.ByteStringName of the resource.Specifies the type of the healthAggregationPolicy.com.google.protobuf.ByteStringSpecifies the type of the healthAggregationPolicy.Output only.com.google.protobuf.ByteStringOutput only.Output only.com.google.protobuf.ByteStringOutput only.Output only.com.google.protobuf.ByteStringOutput only.booleanOutput only.booleanAn optional description of this resource.booleanFingerprint of this resource.booleanCan only be set if the policyType field isBACKEND_SERVICE_POLICY.booleanhasId()Output only.booleanhasKind()Output only.booleanCan only be set if the policyType field isBACKEND_SERVICE_POLICY.booleanhasName()Name of the resource.booleanSpecifies the type of the healthAggregationPolicy.booleanOutput only.booleanOutput only.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
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 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;- 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 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;- 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 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;- Returns:
- The bytes for fingerprint.
-
hasHealthyPercentThreshold
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;- Returns:
- Whether the healthyPercentThreshold field is set.
-
getHealthyPercentThreshold
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;- Returns:
- The healthyPercentThreshold.
-
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#healthAggregationPolicy for health aggregation policies.
optional string kind = 3292052;- Returns:
- Whether the kind field is set.
-
getKind
String getKind()Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies.
optional string kind = 3292052;- Returns:
- The kind.
-
getKindBytes
com.google.protobuf.ByteString getKindBytes()Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies.
optional string kind = 3292052;- Returns:
- The bytes for kind.
-
hasMinHealthyThreshold
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;- Returns:
- Whether the minHealthyThreshold field is set.
-
getMinHealthyThreshold
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;- Returns:
- The minHealthyThreshold.
-
hasName
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;- Returns:
- Whether the name field is set.
-
getName
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;- Returns:
- The name.
-
getNameBytes
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;- Returns:
- The bytes for name.
-
hasPolicyType
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;- Returns:
- Whether the policyType field is set.
-
getPolicyType
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;- Returns:
- The policyType.
-
getPolicyTypeBytes
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;- Returns:
- The bytes for policyType.
-
hasRegion
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;- Returns:
- Whether the region field is set.
-
getRegion
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;- Returns:
- The region.
-
getRegionBytes
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;- 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.
-
hasSelfLinkWithId
boolean hasSelfLinkWithId()Output only. [Output Only] Server-defined URL with id for the resource.
optional string self_link_with_id = 44520962;- Returns:
- Whether the selfLinkWithId field is set.
-
getSelfLinkWithId
String getSelfLinkWithId()Output only. [Output Only] Server-defined URL with id for the resource.
optional string self_link_with_id = 44520962;- Returns:
- The selfLinkWithId.
-
getSelfLinkWithIdBytes
com.google.protobuf.ByteString getSelfLinkWithIdBytes()Output only. [Output Only] Server-defined URL with id for the resource.
optional string self_link_with_id = 44520962;- Returns:
- The bytes for selfLinkWithId.
-