Subnetwork (Compute Engine API v1-rev20190825-1.28.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.Subnetwork

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Subnetwork
extends GenericJson
```
Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Subnetwork()

Constructors
Constructor and Description
`Subnetwork()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subnetwork`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`Subnetwork`	`encodeFingerprint(byte[] fingerprint)` Fingerprint of this resource.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`Boolean`	`getEnableFlowLogs()` Whether to enable flow logging for this subnetwork.
`String`	`getFingerprint()` Fingerprint of this resource.
`String`	`getGatewayAddress()` [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getIpCidrRange()` The range of internal addresses that are owned by this subnetwork.
`String`	`getKind()` [Output Only] Type of the resource.
`SubnetworkLogConfig`	`getLogConfig()` This field denotes the VPC flow logging options for this subnetwork.
`String`	`getName()` The name of the resource, provided by the client when initially creating the resource.
`String`	`getNetwork()` The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork.
`Boolean`	`getPrivateIpGoogleAccess()` Whether the VMs in this subnet can access Google services without assigned external IP addresses.
`String`	`getPurpose()` The purpose of the resource.
`String`	`getRegion()` URL of the region where the Subnetwork resides.
`String`	`getRole()` The role of subnetwork.
`List<SubnetworkSecondaryRange>`	`getSecondaryIpRanges()` An array of configurations for secondary IP ranges for VM instances contained in this subnetwork.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getState()` [Output Only] The state of the subnetwork, which can be one of READY or DRAINING.
`Subnetwork`	`set(String fieldName, Object value)`
`Subnetwork`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Subnetwork`	`setDescription(String description)` An optional description of this resource.
`Subnetwork`	`setEnableFlowLogs(Boolean enableFlowLogs)` Whether to enable flow logging for this subnetwork.
`Subnetwork`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`Subnetwork`	`setGatewayAddress(String gatewayAddress)` [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
`Subnetwork`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`Subnetwork`	`setIpCidrRange(String ipCidrRange)` The range of internal addresses that are owned by this subnetwork.
`Subnetwork`	`setKind(String kind)` [Output Only] Type of the resource.
`Subnetwork`	`setLogConfig(SubnetworkLogConfig logConfig)` This field denotes the VPC flow logging options for this subnetwork.
`Subnetwork`	`setName(String name)` The name of the resource, provided by the client when initially creating the resource.
`Subnetwork`	`setNetwork(String network)` The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork.
`Subnetwork`	`setPrivateIpGoogleAccess(Boolean privateIpGoogleAccess)` Whether the VMs in this subnet can access Google services without assigned external IP addresses.
`Subnetwork`	`setPurpose(String purpose)` The purpose of the resource.
`Subnetwork`	`setRegion(String region)` URL of the region where the Subnetwork resides.
`Subnetwork`	`setRole(String role)` The role of subnetwork.
`Subnetwork`	`setSecondaryIpRanges(List<SubnetworkSecondaryRange> secondaryIpRanges)` An array of configurations for secondary IP ranges for VM instances contained in this subnetwork.
`Subnetwork`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`Subnetwork`	`setState(String state)` [Output Only] The state of the subnetwork, which can be one of READY or DRAINING.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Subnetwork
```
public Subnetwork()
```
- Method Detail
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Subnetwork setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Subnetwork setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.
    
    Parameters:
    
    description - description or null for none
  - getEnableFlowLogs
```
public Boolean getEnableFlowLogs()
```
    Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.
    
    Returns:
    
    value or null for none
  - setEnableFlowLogs
```
public Subnetwork setEnableFlowLogs(Boolean enableFlowLogs)
```
    Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.
    
    Parameters:
    
    enableFlowLogs - enableFlowLogs or null for none
  - getFingerprint
```
public String getFingerprint()
```
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public Subnetwork setFingerprint(String fingerprint)
```
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public Subnetwork encodeFingerprint(byte[] fingerprint)
```
    Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getGatewayAddress
```
public String getGatewayAddress()
```
    [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
    
    Returns:
    
    value or null for none
  - setGatewayAddress
```
public Subnetwork setGatewayAddress(String gatewayAddress)
```
    [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.
    
    Parameters:
    
    gatewayAddress - gatewayAddress or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Subnetwork setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getIpCidrRange
```
public String getIpCidrRange()
```
    The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.
    
    Returns:
    
    value or null for none
  - setIpCidrRange
```
public Subnetwork setIpCidrRange(String ipCidrRange)
```
    The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.
    
    Parameters:
    
    ipCidrRange - ipCidrRange or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
    
    Returns:
    
    value or null for none
  - setKind
```
public Subnetwork setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.
    
    Parameters:
    
    kind - kind or null for none
  - getLogConfig
```
public SubnetworkLogConfig getLogConfig()
```
    This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver.
    
    Returns:
    
    value or null for none
  - setLogConfig
```
public Subnetwork setLogConfig(SubnetworkLogConfig logConfig)
```
    This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver.
    
    Parameters:
    
    logConfig - logConfig or null for none
  - getName
```
public String getName()
```
    The name of the resource, provided by the client when initially creating the resource. 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.
    
    Returns:
    
    value or null for none
  - setName
```
public Subnetwork setName(String name)
```
    The name of the resource, provided by the client when initially creating the resource. 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.
    
    Parameters:
    
    name - name or null for none
  - getNetwork
```
public String getNetwork()
```
    The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.
    
    Returns:
    
    value or null for none
  - setNetwork
```
public Subnetwork setNetwork(String network)
```
    The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.
    
    Parameters:
    
    network - network or null for none
  - getPrivateIpGoogleAccess
```
public Boolean getPrivateIpGoogleAccess()
```
    Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.
    
    Returns:
    
    value or null for none
  - setPrivateIpGoogleAccess
```
public Subnetwork setPrivateIpGoogleAccess(Boolean privateIpGoogleAccess)
```
    Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.
    
    Parameters:
    
    privateIpGoogleAccess - privateIpGoogleAccess or null for none
  - getPurpose
```
public String getPurpose()
```
    The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918.
    
    Returns:
    
    value or null for none
  - setPurpose
```
public Subnetwork setPurpose(String purpose)
```
    The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918.
    
    Parameters:
    
    purpose - purpose or null for none
  - getRegion
```
public String getRegion()
```
    URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
    
    Returns:
    
    value or null for none
  - setRegion
```
public Subnetwork setRegion(String region)
```
    URL of the region where the Subnetwork resides. This field can be set only at resource creation time.
    
    Parameters:
    
    region - region or null for none
  - getRole
```
public String getRole()
```
    The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.
    
    Returns:
    
    value or null for none
  - setRole
```
public Subnetwork setRole(String role)
```
    The role of subnetwork. Currenly, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.
    
    Parameters:
    
    role - role or null for none
  - getSecondaryIpRanges
```
public List<SubnetworkSecondaryRange> getSecondaryIpRanges()
```
    An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.
    
    Returns:
    
    value or null for none
  - setSecondaryIpRanges
```
public Subnetwork setSecondaryIpRanges(List<SubnetworkSecondaryRange> secondaryIpRanges)
```
    An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.
    
    Parameters:
    
    secondaryIpRanges - secondaryIpRanges or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public Subnetwork setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getState
```
public String getState()
```
    [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY.
    
    Returns:
    
    value or null for none
  - setState
```
public Subnetwork setState(String state)
```
    [Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY.
    
    Parameters:
    
    state - state or null for none
  - set
```
public Subnetwork set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Subnetwork clone()
```
    Overrides:
    
    clone in class GenericJson

Class Subnetwork

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Subnetwork

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getEnableFlowLogs

setEnableFlowLogs

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getGatewayAddress

setGatewayAddress

getId

setId

getIpCidrRange

setIpCidrRange

getKind

setKind

getLogConfig

setLogConfig

getName

setName

getNetwork

setNetwork

getPrivateIpGoogleAccess

setPrivateIpGoogleAccess

getPurpose

setPurpose

getRegion

setRegion

getRole

setRole

getSecondaryIpRanges

setSecondaryIpRanges

getSelfLink

setSelfLink

getState

setState

set

clone