Class LbTrafficExtension

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networkservices.v1.LbTrafficExtension
All Implemented Interfaces:
LbTrafficExtensionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class LbTrafficExtension extends com.google.protobuf.GeneratedMessage implements LbTrafficExtensionOrBuilder
 `LbTrafficExtension` is a resource that lets the extension service modify the
 headers and payloads of both requests and responses without impacting the
 choice of backend services or any other security policies associated with the
 backend service.
 
Protobuf type google.cloud.networkservices.v1.LbTrafficExtension
See Also:
  • 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:
    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:
    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:
    • FORWARDING_RULES_FIELD_NUMBER

      public static final int FORWARDING_RULES_FIELD_NUMBER
      See Also:
    • EXTENSION_CHAINS_FIELD_NUMBER

      public static final int EXTENSION_CHAINS_FIELD_NUMBER
      See Also:
    • LOAD_BALANCING_SCHEME_FIELD_NUMBER

      public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
      See Also:
    • METADATA_FIELD_NUMBER

      public static final int METADATA_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:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

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

      public String getName()
       Required. Identifier. Name of the `LbTrafficExtension` resource in the
       following format:
       `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface LbTrafficExtensionOrBuilder
      Returns:
      The name.
    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. Identifier. Name of the `LbTrafficExtension` resource in the
       following format:
       `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
       
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface LbTrafficExtensionOrBuilder
      Returns:
      The bytes for name.
    • hasCreateTime

      public boolean hasCreateTime()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface LbTrafficExtensionOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface LbTrafficExtensionOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when the resource was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface LbTrafficExtensionOrBuilder
    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface LbTrafficExtensionOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface LbTrafficExtensionOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when the resource was updated.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface LbTrafficExtensionOrBuilder
    • getDescription

      public String getDescription()
       Optional. A human-readable description of the resource.
       
      string description = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface LbTrafficExtensionOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human-readable description of the resource.
       
      string description = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface LbTrafficExtensionOrBuilder
      Returns:
      The bytes for description.
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: LbTrafficExtensionOrBuilder
       Optional. Set of labels associated with the `LbTrafficExtension` resource.
      
       The format must comply with [the requirements for
       labels](https://cloud.google.com/compute/docs/labeling-resources#requirements)
       for Google Cloud resources.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface LbTrafficExtensionOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       Optional. Set of labels associated with the `LbTrafficExtension` resource.
      
       The format must comply with [the requirements for
       labels](https://cloud.google.com/compute/docs/labeling-resources#requirements)
       for Google Cloud resources.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface LbTrafficExtensionOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface LbTrafficExtensionOrBuilder
    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. Set of labels associated with the `LbTrafficExtension` resource.
      
       The format must comply with [the requirements for
       labels](https://cloud.google.com/compute/docs/labeling-resources#requirements)
       for Google Cloud resources.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface LbTrafficExtensionOrBuilder
    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. Set of labels associated with the `LbTrafficExtension` resource.
      
       The format must comply with [the requirements for
       labels](https://cloud.google.com/compute/docs/labeling-resources#requirements)
       for Google Cloud resources.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface LbTrafficExtensionOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. Set of labels associated with the `LbTrafficExtension` resource.
      
       The format must comply with [the requirements for
       labels](https://cloud.google.com/compute/docs/labeling-resources#requirements)
       for Google Cloud resources.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface LbTrafficExtensionOrBuilder
    • getForwardingRulesList

      public com.google.protobuf.ProtocolStringList getForwardingRulesList()
       Optional. A list of references to the forwarding rules to which this
       service extension is attached. At least one forwarding rule is required.
       Only one `LbTrafficExtension` resource can be associated with a forwarding
       rule.
       
      repeated string forwarding_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getForwardingRulesList in interface LbTrafficExtensionOrBuilder
      Returns:
      A list containing the forwardingRules.
    • getForwardingRulesCount

      public int getForwardingRulesCount()
       Optional. A list of references to the forwarding rules to which this
       service extension is attached. At least one forwarding rule is required.
       Only one `LbTrafficExtension` resource can be associated with a forwarding
       rule.
       
      repeated string forwarding_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getForwardingRulesCount in interface LbTrafficExtensionOrBuilder
      Returns:
      The count of forwardingRules.
    • getForwardingRules

      public String getForwardingRules(int index)
       Optional. A list of references to the forwarding rules to which this
       service extension is attached. At least one forwarding rule is required.
       Only one `LbTrafficExtension` resource can be associated with a forwarding
       rule.
       
      repeated string forwarding_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getForwardingRules in interface LbTrafficExtensionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The forwardingRules at the given index.
    • getForwardingRulesBytes

      public com.google.protobuf.ByteString getForwardingRulesBytes(int index)
       Optional. A list of references to the forwarding rules to which this
       service extension is attached. At least one forwarding rule is required.
       Only one `LbTrafficExtension` resource can be associated with a forwarding
       rule.
       
      repeated string forwarding_rules = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getForwardingRulesBytes in interface LbTrafficExtensionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the forwardingRules at the given index.
    • getExtensionChainsList

      public List<ExtensionChain> getExtensionChainsList()
       Required. A set of ordered extension chains that contain the match
       conditions and extensions to execute. Match conditions for each extension
       chain are evaluated in sequence for a given request. The first extension
       chain that has a condition that matches the request is executed.
       Any subsequent extension chains do not execute.
       Limited to 5 extension chains per resource.
       
      repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getExtensionChainsList in interface LbTrafficExtensionOrBuilder
    • getExtensionChainsOrBuilderList

      public List<? extends ExtensionChainOrBuilder> getExtensionChainsOrBuilderList()
       Required. A set of ordered extension chains that contain the match
       conditions and extensions to execute. Match conditions for each extension
       chain are evaluated in sequence for a given request. The first extension
       chain that has a condition that matches the request is executed.
       Any subsequent extension chains do not execute.
       Limited to 5 extension chains per resource.
       
      repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getExtensionChainsOrBuilderList in interface LbTrafficExtensionOrBuilder
    • getExtensionChainsCount

      public int getExtensionChainsCount()
       Required. A set of ordered extension chains that contain the match
       conditions and extensions to execute. Match conditions for each extension
       chain are evaluated in sequence for a given request. The first extension
       chain that has a condition that matches the request is executed.
       Any subsequent extension chains do not execute.
       Limited to 5 extension chains per resource.
       
      repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getExtensionChainsCount in interface LbTrafficExtensionOrBuilder
    • getExtensionChains

      public ExtensionChain getExtensionChains(int index)
       Required. A set of ordered extension chains that contain the match
       conditions and extensions to execute. Match conditions for each extension
       chain are evaluated in sequence for a given request. The first extension
       chain that has a condition that matches the request is executed.
       Any subsequent extension chains do not execute.
       Limited to 5 extension chains per resource.
       
      repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getExtensionChains in interface LbTrafficExtensionOrBuilder
    • getExtensionChainsOrBuilder

      public ExtensionChainOrBuilder getExtensionChainsOrBuilder(int index)
       Required. A set of ordered extension chains that contain the match
       conditions and extensions to execute. Match conditions for each extension
       chain are evaluated in sequence for a given request. The first extension
       chain that has a condition that matches the request is executed.
       Any subsequent extension chains do not execute.
       Limited to 5 extension chains per resource.
       
      repeated .google.cloud.networkservices.v1.ExtensionChain extension_chains = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getExtensionChainsOrBuilder in interface LbTrafficExtensionOrBuilder
    • getLoadBalancingSchemeValue

      public int getLoadBalancingSchemeValue()
       Required. All backend services and forwarding rules referenced by this
       extension must share the same load balancing scheme. Supported values:
       `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to
       [Backend services
       overview](https://cloud.google.com/load-balancing/docs/backend-service).
       
      .google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoadBalancingSchemeValue in interface LbTrafficExtensionOrBuilder
      Returns:
      The enum numeric value on the wire for loadBalancingScheme.
    • getLoadBalancingScheme

      public LoadBalancingScheme getLoadBalancingScheme()
       Required. All backend services and forwarding rules referenced by this
       extension must share the same load balancing scheme. Supported values:
       `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to
       [Backend services
       overview](https://cloud.google.com/load-balancing/docs/backend-service).
       
      .google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoadBalancingScheme in interface LbTrafficExtensionOrBuilder
      Returns:
      The loadBalancingScheme.
    • hasMetadata

      public boolean hasMetadata()
       Optional. The metadata provided here is included as part of the
       `metadata_context` (of type `google.protobuf.Struct`) in the
       `ProcessingRequest` message sent to the extension server.
      
       The metadata applies to all extensions in all extensions chains in this
       resource.
      
       The metadata is available under the key
       `com.google.lb_traffic_extension.<resource_name>`.
      
       The following variables are supported in the metadata:
      
       `{forwarding_rule_id}` - substituted with the forwarding rule's fully
       qualified resource name.
      
       This field must not be set if at least one of the extension chains
       contains plugin extensions. Setting it results in a validation error.
      
       You can set metadata at either the resource level or the extension level.
       The extension level metadata is recommended because you can pass a
       different set of metadata through each extension to the backend.
       
      .google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasMetadata in interface LbTrafficExtensionOrBuilder
      Returns:
      Whether the metadata field is set.
    • getMetadata

      public com.google.protobuf.Struct getMetadata()
       Optional. The metadata provided here is included as part of the
       `metadata_context` (of type `google.protobuf.Struct`) in the
       `ProcessingRequest` message sent to the extension server.
      
       The metadata applies to all extensions in all extensions chains in this
       resource.
      
       The metadata is available under the key
       `com.google.lb_traffic_extension.<resource_name>`.
      
       The following variables are supported in the metadata:
      
       `{forwarding_rule_id}` - substituted with the forwarding rule's fully
       qualified resource name.
      
       This field must not be set if at least one of the extension chains
       contains plugin extensions. Setting it results in a validation error.
      
       You can set metadata at either the resource level or the extension level.
       The extension level metadata is recommended because you can pass a
       different set of metadata through each extension to the backend.
       
      .google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadata in interface LbTrafficExtensionOrBuilder
      Returns:
      The metadata.
    • getMetadataOrBuilder

      public com.google.protobuf.StructOrBuilder getMetadataOrBuilder()
       Optional. The metadata provided here is included as part of the
       `metadata_context` (of type `google.protobuf.Struct`) in the
       `ProcessingRequest` message sent to the extension server.
      
       The metadata applies to all extensions in all extensions chains in this
       resource.
      
       The metadata is available under the key
       `com.google.lb_traffic_extension.<resource_name>`.
      
       The following variables are supported in the metadata:
      
       `{forwarding_rule_id}` - substituted with the forwarding rule's fully
       qualified resource name.
      
       This field must not be set if at least one of the extension chains
       contains plugin extensions. Setting it results in a validation error.
      
       You can set metadata at either the resource level or the extension level.
       The extension level metadata is recommended because you can pass a
       different set of metadata through each extension to the backend.
       
      .google.protobuf.Struct metadata = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMetadataOrBuilder in interface LbTrafficExtensionOrBuilder
    • 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 LbTrafficExtension parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static LbTrafficExtension parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static LbTrafficExtension parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static LbTrafficExtension.Builder newBuilder()
    • newBuilder

      public static LbTrafficExtension.Builder newBuilder(LbTrafficExtension prototype)
    • toBuilder

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

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

      public static LbTrafficExtension getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<LbTrafficExtension> parser()
    • getParserForType

      public com.google.protobuf.Parser<LbTrafficExtension> 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 LbTrafficExtension getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder