Package com.google.cloud.compute.v1

Class TargetInstance

  • All Implemented Interfaces:
    TargetInstanceOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class TargetInstance
extends com.google.protobuf.GeneratedMessageV3
implements TargetInstanceOrBuilder
     Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances.
    Protobuf type google.cloud.compute.v1.TargetInstance
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  TargetInstance.Builder
      Represents a Target Instance resource.
      static class  TargetInstance.NatPolicy
      Must have a value of NO_NAT.

      • 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 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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        Returns:
        The id.

      • hasInstance

        public boolean hasInstance()
         A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance
        optional string instance = 18257045;
        Specified by:
        hasInstance in interface TargetInstanceOrBuilder
        Returns:
        Whether the instance field is set.

      • getInstance

        public String getInstance()
         A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance
        optional string instance = 18257045;
        Specified by:
        getInstance in interface TargetInstanceOrBuilder
        Returns:
        The instance.

      • getInstanceBytes

        public com.google.protobuf.ByteString getInstanceBytes()
         A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance
        optional string instance = 18257045;
        Specified by:
        getInstanceBytes in interface TargetInstanceOrBuilder
        Returns:
        The bytes for instance.

      • hasKind

        public boolean hasKind()
         [Output Only] The type of the resource. Always compute#targetInstance for target instances.
        optional string kind = 3292052;
        Specified by:
        hasKind in interface TargetInstanceOrBuilder
        Returns:
        Whether the kind field is set.

      • getKind

        public String getKind()
         [Output Only] The type of the resource. Always compute#targetInstance for target instances.
        optional string kind = 3292052;
        Specified by:
        getKind in interface TargetInstanceOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] The type of the resource. Always compute#targetInstance for target instances.
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        Returns:
        The bytes for name.

      • hasNatPolicy

        public boolean hasNatPolicy()
         Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.
 Check the NatPolicy enum for the list of possible values.
        optional string nat_policy = 509780496;
        Specified by:
        hasNatPolicy in interface TargetInstanceOrBuilder
        Returns:
        Whether the natPolicy field is set.

      • getNatPolicy

        public String getNatPolicy()
         Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.
 Check the NatPolicy enum for the list of possible values.
        optional string nat_policy = 509780496;
        Specified by:
        getNatPolicy in interface TargetInstanceOrBuilder
        Returns:
        The natPolicy.

      • getNatPolicyBytes

        public com.google.protobuf.ByteString getNatPolicyBytes()
         Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance.
 Check the NatPolicy enum for the list of possible values.
        optional string nat_policy = 509780496;
        Specified by:
        getNatPolicyBytes in interface TargetInstanceOrBuilder
        Returns:
        The bytes for natPolicy.

      • hasNetwork

        public boolean hasNetwork()
         The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
        optional string network = 232872494;
        Specified by:
        hasNetwork in interface TargetInstanceOrBuilder
        Returns:
        Whether the network field is set.

      • getNetwork

        public String getNetwork()
         The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
        optional string network = 232872494;
        Specified by:
        getNetwork in interface TargetInstanceOrBuilder
        Returns:
        The network.

      • getNetworkBytes

        public com.google.protobuf.ByteString getNetworkBytes()
         The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to.
        optional string network = 232872494;
        Specified by:
        getNetworkBytes in interface TargetInstanceOrBuilder
        Returns:
        The bytes for network.

      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        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 TargetInstanceOrBuilder
        Returns:
        The bytes for selfLink.

      • hasZone

        public boolean hasZone()
         [Output Only] URL of the zone where the target instance resides. 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 zone = 3744684;
        Specified by:
        hasZone in interface TargetInstanceOrBuilder
        Returns:
        Whether the zone field is set.

      • getZone

        public String getZone()
         [Output Only] URL of the zone where the target instance resides. 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 zone = 3744684;
        Specified by:
        getZone in interface TargetInstanceOrBuilder
        Returns:
        The zone.

      • getZoneBytes

        public com.google.protobuf.ByteString getZoneBytes()
         [Output Only] URL of the zone where the target instance resides. 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 zone = 3744684;
        Specified by:
        getZoneBytes in interface TargetInstanceOrBuilder
        Returns:
        The bytes for zone.

      • 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 TargetInstance parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static TargetInstance getDefaultInstance()

      • parser

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

      • getParserForType

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