Class TargetInstance.Builder (1.65.0) 

public static final class TargetInstance.Builder extends GeneratedMessageV3.Builder<TargetInstance.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TargetInstance.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetInstance.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetInstance.Builder
Overrides

build()

public TargetInstance build()
Returns
Type Description
TargetInstance

buildPartial()

public TargetInstance buildPartial()
Returns
Type Description
TargetInstance

clear()

public TargetInstance.Builder clear()
Returns
Type Description
TargetInstance.Builder
Overrides

clearCreationTimestamp()

public TargetInstance.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearDescription()

public TargetInstance.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TargetInstance.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TargetInstance.Builder
Overrides

clearId()

public TargetInstance.Builder clearId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearInstance()

public TargetInstance.Builder clearInstance()

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
TargetInstance.Builder

This builder for chaining.

clearKind()

public TargetInstance.Builder clearKind()

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

optional string kind = 3292052;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearName()

public TargetInstance.Builder clearName()

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
TargetInstance.Builder

This builder for chaining.

clearNatPolicy()

public TargetInstance.Builder clearNatPolicy()

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
TargetInstance.Builder

This builder for chaining.

clearNetwork()

public TargetInstance.Builder clearNetwork()

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
TargetInstance.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetInstance.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TargetInstance.Builder
Overrides

clearSecurityPolicy()

public TargetInstance.Builder clearSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearSelfLink()

public TargetInstance.Builder clearSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
TargetInstance.Builder

This builder for chaining.

clearZone()

public TargetInstance.Builder clearZone()

[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
TargetInstance.Builder

This builder for chaining.

clone()

public TargetInstance.Builder clone()
Returns
Type Description
TargetInstance.Builder
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
Type Description
TargetInstance

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getId()

public long 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
Type Description
ByteString

The bytes for instance.

getKind()

public String 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
Type Description
ByteString

The bytes for kind.

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? 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
Type Description
ByteString

The bytes for name.

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
Type Description
ByteString

The bytes for natPolicy.

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
Type Description
ByteString

The bytes for network.

getSecurityPolicy()

public String getSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Returns
Type Description
String

The securityPolicy.

getSecurityPolicyBytes()

public ByteString getSecurityPolicyBytes()

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Returns
Type Description
ByteString

The bytes for securityPolicy.

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
Type Description
ByteString

The bytes for selfLink.

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;

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
Type Description
ByteString

The bytes for zone.

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()

public boolean 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()

public boolean 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()

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? 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.

hasSecurityPolicy()

public boolean hasSecurityPolicy()

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Returns
Type Description
boolean

Whether the securityPolicy 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()

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;

Returns
Type Description
boolean

Whether the zone field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TargetInstance other)

public TargetInstance.Builder mergeFrom(TargetInstance other)
Parameter
Name Description
other TargetInstance
Returns
Type Description
TargetInstance.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetInstance.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetInstance.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TargetInstance.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TargetInstance.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetInstance.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetInstance.Builder
Overrides

setCreationTimestamp(String value)

public TargetInstance.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public TargetInstance.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setDescription(String value)

public TargetInstance.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public TargetInstance.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TargetInstance.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TargetInstance.Builder
Overrides

setId(long value)

public TargetInstance.Builder setId(long value)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setInstance(String value)

public TargetInstance.Builder setInstance(String value)

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;

Parameter
Name Description
value String

The instance to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setInstanceBytes(ByteString value)

public TargetInstance.Builder setInstanceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for instance to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setKind(String value)

public TargetInstance.Builder setKind(String value)

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setKindBytes(ByteString value)

public TargetInstance.Builder setKindBytes(ByteString value)

[Output Only] The type of the resource. Always compute#targetInstance for target instances.

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setName(String value)

public TargetInstance.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setNameBytes(ByteString value)

public TargetInstance.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setNatPolicy(String value)

public TargetInstance.Builder setNatPolicy(String value)

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;

Parameter
Name Description
value String

The natPolicy to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setNatPolicyBytes(ByteString value)

public TargetInstance.Builder setNatPolicyBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for natPolicy to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setNetwork(String value)

public TargetInstance.Builder setNetwork(String value)

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;

Parameter
Name Description
value String

The network to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public TargetInstance.Builder setNetworkBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TargetInstance.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TargetInstance.Builder
Overrides

setSecurityPolicy(String value)

public TargetInstance.Builder setSecurityPolicy(String value)

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Parameter
Name Description
value String

The securityPolicy to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setSecurityPolicyBytes(ByteString value)

public TargetInstance.Builder setSecurityPolicyBytes(ByteString value)

[Output Only] The resource URL for the security policy associated with this target instance.

optional string security_policy = 171082513;

Parameter
Name Description
value ByteString

The bytes for securityPolicy to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setSelfLink(String value)

public TargetInstance.Builder setSelfLink(String value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public TargetInstance.Builder setSelfLinkBytes(ByteString value)

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetInstance.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TargetInstance.Builder
Overrides

setZone(String value)

public TargetInstance.Builder setZone(String value)

[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;

Parameter
Name Description
value String

The zone to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public TargetInstance.Builder setZoneBytes(ByteString value)

[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;

Parameter
Name Description
value ByteString

The bytes for zone to set.
Returns
Type Description
TargetInstance.Builder

This builder for chaining.