public final class TargetInstance extends 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
Static Fields
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
INSTANCE_FIELD_NUMBER
public static final int INSTANCE_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
NAT_POLICY_FIELD_NUMBER
public static final int NAT_POLICY_FIELD_NUMBER
Field Value
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
Field Value
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
Field Value
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TargetInstance getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TargetInstance.Builder newBuilder()
Returns
newBuilder(TargetInstance prototype)
public static TargetInstance.Builder newBuilder(TargetInstance prototype)
Parameter
Returns
public static TargetInstance parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TargetInstance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TargetInstance parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TargetInstance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TargetInstance parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TargetInstance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TargetInstance parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TargetInstance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TargetInstance parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TargetInstance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TargetInstance parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TargetInstance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TargetInstance> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns
Type | Description |
String | The creationTimestamp.
|
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns
Type | Description |
ByteString | The bytes for creationTimestamp.
|
getDefaultInstanceForType()
public TargetInstance getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type | Description |
ByteString | The bytes for description.
|
getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns
Type | Description |
long | The id.
|
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;
Returns
Type | Description |
String | The instance.
|
getInstanceBytes()
public 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;
Returns
getKind()
[Output Only] The type of the resource. Always compute#targetInstance for target instances.
optional string kind = 3292052;
Returns
Type | Description |
String | The kind.
|
getKindBytes()
public ByteString getKindBytes()
[Output Only] The type of the resource. Always compute#targetInstance for target instances.
optional string kind = 3292052;
Returns
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?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns
Type | Description |
String | The name.
|
getNameBytes()
public 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?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns
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;
Returns
Type | Description |
String | The natPolicy.
|
getNatPolicyBytes()
public 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;
Returns
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;
Returns
Type | Description |
String | The network.
|
getNetworkBytes()
public 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;
Returns
getParserForType()
public Parser<TargetInstance> getParserForType()
Returns
Overrides
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns
Type | Description |
String | The selfLink.
|
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
Returns
Type | Description |
String | The zone.
|
getZoneBytes()
public 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;
Returns
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
Returns
Type | Description |
boolean | Whether the creationTimestamp field is set.
|
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
Returns
Type | Description |
boolean | Whether the description field is set.
|
hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
Returns
Type | Description |
boolean | Whether the id field is set.
|
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;
Returns
Type | Description |
boolean | Whether the instance field is set.
|
hasKind()
[Output Only] The type of the resource. Always compute#targetInstance for target instances.
optional string kind = 3292052;
Returns
Type | Description |
boolean | Whether the kind field is set.
|
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?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
Returns
Type | Description |
boolean | Whether the name field is set.
|
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;
Returns
Type | Description |
boolean | Whether the natPolicy field is set.
|
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;
Returns
Type | Description |
boolean | Whether the network field is set.
|
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
Returns
Type | Description |
boolean | Whether the selfLink field is set.
|
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;
Returns
Type | Description |
boolean | Whether the zone field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TargetInstance.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TargetInstance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TargetInstance.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions