Class TargetTcpProxy

  • All Implemented Interfaces:
    TargetTcpProxyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class TargetTcpProxy
    extends com.google.protobuf.GeneratedMessageV3
    implements TargetTcpProxyOrBuilder
     Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview.
     
    Protobuf type google.cloud.compute.v1.TargetTcpProxy
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TargetTcpProxy.Builder
      Represents a Target TCP Proxy resource.
      static class  TargetTcpProxy.ProxyHeader
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      String getCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      com.google.protobuf.ByteString getCreationTimestampBytes()
      [Output Only] Creation timestamp in RFC3339 text format.
      static TargetTcpProxy getDefaultInstance()  
      TargetTcpProxy getDefaultInstanceForType()  
      String getDescription()
      An optional description of this resource.
      com.google.protobuf.ByteString getDescriptionBytes()
      An optional description of this resource.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      long getId()
      [Output Only] The unique identifier for the resource.
      String getKind()
      [Output Only] Type of the resource.
      com.google.protobuf.ByteString getKindBytes()
      [Output Only] Type of the resource.
      String getName()
      Name of the resource.
      com.google.protobuf.ByteString getNameBytes()
      Name of the resource.
      com.google.protobuf.Parser<TargetTcpProxy> getParserForType()  
      boolean getProxyBind()
      This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
      String getProxyHeader()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      com.google.protobuf.ByteString getProxyHeaderBytes()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      String getRegion()
      [Output Only] URL of the region where the regional TCP proxy resides.
      com.google.protobuf.ByteString getRegionBytes()
      [Output Only] URL of the region where the regional TCP proxy resides.
      String getSelfLink()
      [Output Only] Server-defined URL for the resource.
      com.google.protobuf.ByteString getSelfLinkBytes()
      [Output Only] Server-defined URL for the resource.
      int getSerializedSize()  
      String getService()
      URL to the BackendService resource.
      com.google.protobuf.ByteString getServiceBytes()
      URL to the BackendService resource.
      boolean hasCreationTimestamp()
      [Output Only] Creation timestamp in RFC3339 text format.
      boolean hasDescription()
      An optional description of this resource.
      int hashCode()  
      boolean hasId()
      [Output Only] The unique identifier for the resource.
      boolean hasKind()
      [Output Only] Type of the resource.
      boolean hasName()
      Name of the resource.
      boolean hasProxyBind()
      This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED.
      boolean hasProxyHeader()
      Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1.
      boolean hasRegion()
      [Output Only] URL of the region where the regional TCP proxy resides.
      boolean hasSelfLink()
      [Output Only] Server-defined URL for the resource.
      boolean hasService()
      URL to the BackendService resource.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static TargetTcpProxy.Builder newBuilder()  
      static TargetTcpProxy.Builder newBuilder​(TargetTcpProxy prototype)  
      TargetTcpProxy.Builder newBuilderForType()  
      protected TargetTcpProxy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static TargetTcpProxy parseDelimitedFrom​(InputStream input)  
      static TargetTcpProxy parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TargetTcpProxy parseFrom​(byte[] data)  
      static TargetTcpProxy parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TargetTcpProxy parseFrom​(com.google.protobuf.ByteString data)  
      static TargetTcpProxy parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TargetTcpProxy parseFrom​(com.google.protobuf.CodedInputStream input)  
      static TargetTcpProxy parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TargetTcpProxy parseFrom​(InputStream input)  
      static TargetTcpProxy parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static TargetTcpProxy parseFrom​(ByteBuffer data)  
      static TargetTcpProxy parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<TargetTcpProxy> parser()  
      TargetTcpProxy.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasCreationTimestamp

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

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

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface TargetTcpProxyOrBuilder
        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 TargetTcpProxyOrBuilder
        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 TargetTcpProxyOrBuilder
        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 TargetTcpProxyOrBuilder
        Returns:
        The bytes for description.
      • hasId

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

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

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
         
        optional string kind = 3292052;
        Specified by:
        hasKind in interface TargetTcpProxyOrBuilder
        Returns:
        Whether the kind field is set.
      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
         
        optional string kind = 3292052;
        Specified by:
        getKind in interface TargetTcpProxyOrBuilder
        Returns:
        The kind.
      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.
         
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface TargetTcpProxyOrBuilder
        Returns:
        The bytes for kind.
      • 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 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;
        Specified by:
        hasName in interface TargetTcpProxyOrBuilder
        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 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;
        Specified by:
        getName in interface TargetTcpProxyOrBuilder
        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 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;
        Specified by:
        getNameBytes in interface TargetTcpProxyOrBuilder
        Returns:
        The bytes for name.
      • hasProxyBind

        public boolean hasProxyBind()
         This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.
         
        optional bool proxy_bind = 286025582;
        Specified by:
        hasProxyBind in interface TargetTcpProxyOrBuilder
        Returns:
        Whether the proxyBind field is set.
      • getProxyBind

        public boolean getProxyBind()
         This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false.
         
        optional bool proxy_bind = 286025582;
        Specified by:
        getProxyBind in interface TargetTcpProxyOrBuilder
        Returns:
        The proxyBind.
      • hasProxyHeader

        public boolean hasProxyHeader()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
         Check the ProxyHeader enum for the list of possible values.
         
        optional string proxy_header = 160374142;
        Specified by:
        hasProxyHeader in interface TargetTcpProxyOrBuilder
        Returns:
        Whether the proxyHeader field is set.
      • getProxyHeader

        public String getProxyHeader()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
         Check the ProxyHeader enum for the list of possible values.
         
        optional string proxy_header = 160374142;
        Specified by:
        getProxyHeader in interface TargetTcpProxyOrBuilder
        Returns:
        The proxyHeader.
      • getProxyHeaderBytes

        public com.google.protobuf.ByteString getProxyHeaderBytes()
         Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
         Check the ProxyHeader enum for the list of possible values.
         
        optional string proxy_header = 160374142;
        Specified by:
        getProxyHeaderBytes in interface TargetTcpProxyOrBuilder
        Returns:
        The bytes for proxyHeader.
      • hasRegion

        public boolean hasRegion()
         [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
         
        optional string region = 138946292;
        Specified by:
        hasRegion in interface TargetTcpProxyOrBuilder
        Returns:
        Whether the region field is set.
      • getRegion

        public String getRegion()
         [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
         
        optional string region = 138946292;
        Specified by:
        getRegion in interface TargetTcpProxyOrBuilder
        Returns:
        The region.
      • getRegionBytes

        public com.google.protobuf.ByteString getRegionBytes()
         [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy.
         
        optional string region = 138946292;
        Specified by:
        getRegionBytes in interface TargetTcpProxyOrBuilder
        Returns:
        The bytes for region.
      • hasSelfLink

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

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

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

        public boolean hasService()
         URL to the BackendService resource.
         
        optional string service = 373540533;
        Specified by:
        hasService in interface TargetTcpProxyOrBuilder
        Returns:
        Whether the service field is set.
      • getService

        public String getService()
         URL to the BackendService resource.
         
        optional string service = 373540533;
        Specified by:
        getService in interface TargetTcpProxyOrBuilder
        Returns:
        The service.
      • getServiceBytes

        public com.google.protobuf.ByteString getServiceBytes()
         URL to the BackendService resource.
         
        optional string service = 373540533;
        Specified by:
        getServiceBytes in interface TargetTcpProxyOrBuilder
        Returns:
        The bytes for service.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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 TargetTcpProxy parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

        protected TargetTcpProxy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static TargetTcpProxy getDefaultInstance()
      • parser

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

        public com.google.protobuf.Parser<TargetTcpProxy> 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.GeneratedMessageV3
      • getDefaultInstanceForType

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