Class ServiceLbPolicy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networkservices.v1.ServiceLbPolicy
- All Implemented Interfaces:
ServiceLbPolicyOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class ServiceLbPolicy
extends com.google.protobuf.GeneratedMessage
implements ServiceLbPolicyOrBuilder
ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.Protobuf type
google.cloud.networkservices.v1.ServiceLbPolicy- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classOption to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing.static interfacestatic final classServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.static final classOption to specify health based failover behavior.static interfacestatic final classConfiguration to provide isolation support for the associated Backend Service.static interfacestatic enumThe granularity of this isolation restriction.static enumThe mode of this isolation restriction, defining whether clients in a given region are allowed to reach out to another region.static enumThe global load balancing algorithm to be used.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Optional.booleanOptional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static ServiceLbPolicyOptional.com.google.protobuf.ByteStringOptional.static final com.google.protobuf.Descriptors.DescriptorOptional.Optional.Optional.Optional.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.Optional.intOptional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.com.google.protobuf.Parser<ServiceLbPolicy>intcom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOptional.booleanOutput only.booleanOptional.inthashCode()booleanOptional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic ServiceLbPolicy.Builderstatic ServiceLbPolicy.BuildernewBuilder(ServiceLbPolicy prototype) protected ServiceLbPolicy.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ServiceLbPolicyparseDelimitedFrom(InputStream input) static ServiceLbPolicyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServiceLbPolicyparseFrom(byte[] data) static ServiceLbPolicyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServiceLbPolicyparseFrom(com.google.protobuf.ByteString data) static ServiceLbPolicyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServiceLbPolicyparseFrom(com.google.protobuf.CodedInputStream input) static ServiceLbPolicyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServiceLbPolicyparseFrom(InputStream input) static ServiceLbPolicyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ServiceLbPolicyparseFrom(ByteBuffer data) static ServiceLbPolicyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ServiceLbPolicy>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
LOAD_BALANCING_ALGORITHM_FIELD_NUMBER
public static final int LOAD_BALANCING_ALGORITHM_FIELD_NUMBER- See Also:
-
AUTO_CAPACITY_DRAIN_FIELD_NUMBER
public static final int AUTO_CAPACITY_DRAIN_FIELD_NUMBER- See Also:
-
FAILOVER_CONFIG_FIELD_NUMBER
public static final int FAILOVER_CONFIG_FIELD_NUMBER- See Also:
-
ISOLATION_CONFIG_FIELD_NUMBER
public static final int ISOLATION_CONFIG_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getName
Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNamein interfaceServiceLbPolicyOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNameBytesin interfaceServiceLbPolicyOrBuilder- Returns:
- The bytes for name.
-
hasCreateTime
public boolean hasCreateTime()Output only. The timestamp when this resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceServiceLbPolicyOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The timestamp when this resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceServiceLbPolicyOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when this resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceServiceLbPolicyOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. The timestamp when this resource was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceServiceLbPolicyOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. The timestamp when this resource was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceServiceLbPolicyOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when this resource was last updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceServiceLbPolicyOrBuilder
-
getLabelsCount
public int getLabelsCount()Description copied from interface:ServiceLbPolicyOrBuilderOptional. Set of label tags associated with the ServiceLbPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsCountin interfaceServiceLbPolicyOrBuilder
-
containsLabels
Optional. Set of label tags associated with the ServiceLbPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
containsLabelsin interfaceServiceLbPolicyOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceServiceLbPolicyOrBuilder
-
getLabelsMap
Optional. Set of label tags associated with the ServiceLbPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsMapin interfaceServiceLbPolicyOrBuilder
-
getLabelsOrDefault
Optional. Set of label tags associated with the ServiceLbPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsOrDefaultin interfaceServiceLbPolicyOrBuilder
-
getLabelsOrThrow
Optional. Set of label tags associated with the ServiceLbPolicy resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLabelsOrThrowin interfaceServiceLbPolicyOrBuilder
-
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDescriptionin interfaceServiceLbPolicyOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDescriptionBytesin interfaceServiceLbPolicyOrBuilder- Returns:
- The bytes for description.
-
getLoadBalancingAlgorithmValue
public int getLoadBalancingAlgorithmValue()Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
.google.cloud.networkservices.v1.ServiceLbPolicy.LoadBalancingAlgorithm load_balancing_algorithm = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLoadBalancingAlgorithmValuein interfaceServiceLbPolicyOrBuilder- Returns:
- The enum numeric value on the wire for loadBalancingAlgorithm.
-
getLoadBalancingAlgorithm
Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
.google.cloud.networkservices.v1.ServiceLbPolicy.LoadBalancingAlgorithm load_balancing_algorithm = 6 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getLoadBalancingAlgorithmin interfaceServiceLbPolicyOrBuilder- Returns:
- The loadBalancingAlgorithm.
-
hasAutoCapacityDrain
public boolean hasAutoCapacityDrain()Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasAutoCapacityDrainin interfaceServiceLbPolicyOrBuilder- Returns:
- Whether the autoCapacityDrain field is set.
-
getAutoCapacityDrain
Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAutoCapacityDrainin interfaceServiceLbPolicyOrBuilder- Returns:
- The autoCapacityDrain.
-
getAutoCapacityDrainOrBuilder
Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.AutoCapacityDrain auto_capacity_drain = 8 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getAutoCapacityDrainOrBuilderin interfaceServiceLbPolicyOrBuilder
-
hasFailoverConfig
public boolean hasFailoverConfig()Optional. Configuration related to health based failover.
.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasFailoverConfigin interfaceServiceLbPolicyOrBuilder- Returns:
- Whether the failoverConfig field is set.
-
getFailoverConfig
Optional. Configuration related to health based failover.
.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getFailoverConfigin interfaceServiceLbPolicyOrBuilder- Returns:
- The failoverConfig.
-
getFailoverConfigOrBuilder
Optional. Configuration related to health based failover.
.google.cloud.networkservices.v1.ServiceLbPolicy.FailoverConfig failover_config = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getFailoverConfigOrBuilderin interfaceServiceLbPolicyOrBuilder
-
hasIsolationConfig
public boolean hasIsolationConfig()Optional. Configuration to provide isolation support for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.IsolationConfig isolation_config = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasIsolationConfigin interfaceServiceLbPolicyOrBuilder- Returns:
- Whether the isolationConfig field is set.
-
getIsolationConfig
Optional. Configuration to provide isolation support for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.IsolationConfig isolation_config = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getIsolationConfigin interfaceServiceLbPolicyOrBuilder- Returns:
- The isolationConfig.
-
getIsolationConfigOrBuilder
Optional. Configuration to provide isolation support for the associated Backend Service.
.google.cloud.networkservices.v1.ServiceLbPolicy.IsolationConfig isolation_config = 11 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getIsolationConfigOrBuilderin interfaceServiceLbPolicyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ServiceLbPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServiceLbPolicy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServiceLbPolicy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServiceLbPolicy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServiceLbPolicy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ServiceLbPolicy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ServiceLbPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ServiceLbPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ServiceLbPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ServiceLbPolicy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ServiceLbPolicy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-