Compute Engine v1 API - Class Subnetwork (3.2.0)

public sealed class Subnetwork : IMessage<Subnetwork>, IEquatable<Subnetwork>, IDeepCloneable<Subnetwork>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Subnetwork.

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.

Inheritance

object > Subnetwork

Implements

IMessage Subnetwork, IEquatable Subnetwork, IDeepCloneable Subnetwork, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Subnetwork()

public Subnetwork()

Subnetwork(Subnetwork)

public Subnetwork(Subnetwork other)

Parameter
Name	Description
`other`	`Subnetwork`

Properties

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.

Property Value
Type	Description
`string`

EnableFlowLogs

public bool EnableFlowLogs { get; set; }

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 determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY.

Property Value
Type	Description
`bool`

ExternalIpv6Prefix

public string ExternalIpv6Prefix { get; set; }

The external IPv6 address range that is owned by this subnetwork.

Property Value
Type	Description
`string`

Fingerprint

public string Fingerprint { get; set; }

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.

Property Value
Type	Description
`string`

GatewayAddress

public string GatewayAddress { get; set; }

[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.

Property Value
Type	Description
`string`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasEnableFlowLogs

public bool HasEnableFlowLogs { get; }

Gets whether the "enable_flow_logs" field is set

Property Value
Type	Description
`bool`

HasExternalIpv6Prefix

public bool HasExternalIpv6Prefix { get; }

Gets whether the "external_ipv6_prefix" field is set

Property Value
Type	Description
`bool`

HasFingerprint

public bool HasFingerprint { get; }

Gets whether the "fingerprint" field is set

Property Value
Type	Description
`bool`

HasGatewayAddress

public bool HasGatewayAddress { get; }

Gets whether the "gateway_address" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasInternalIpv6Prefix

public bool HasInternalIpv6Prefix { get; }

Gets whether the "internal_ipv6_prefix" field is set

Property Value
Type	Description
`bool`

HasIpCidrRange

public bool HasIpCidrRange { get; }

Gets whether the "ip_cidr_range" field is set

Property Value
Type	Description
`bool`

HasIpv6AccessType

public bool HasIpv6AccessType { get; }

Gets whether the "ipv6_access_type" field is set

Property Value
Type	Description
`bool`

HasIpv6CidrRange

public bool HasIpv6CidrRange { get; }

Gets whether the "ipv6_cidr_range" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasNetwork

public bool HasNetwork { get; }

Gets whether the "network" field is set

Property Value
Type	Description
`bool`

HasPrivateIpGoogleAccess

public bool HasPrivateIpGoogleAccess { get; }

Gets whether the "private_ip_google_access" field is set

Property Value
Type	Description
`bool`

HasPrivateIpv6GoogleAccess

public bool HasPrivateIpv6GoogleAccess { get; }

Gets whether the "private_ipv6_google_access" field is set

Property Value
Type	Description
`bool`

HasPurpose

public bool HasPurpose { get; }

Gets whether the "purpose" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasReservedInternalRange

public bool HasReservedInternalRange { get; }

Gets whether the "reserved_internal_range" field is set

Property Value
Type	Description
`bool`

HasRole

public bool HasRole { get; }

Gets whether the "role" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HasStackType

public bool HasStackType { get; }

Gets whether the "stack_type" field is set

Property Value
Type	Description
`bool`

HasState

public bool HasState { get; }

Gets whether the "state" field is set

Property Value
Type	Description
`bool`

Id

public ulong Id { get; set; }

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

Property Value
Type	Description
`ulong`

InternalIpv6Prefix

public string InternalIpv6Prefix { get; set; }

The internal IPv6 address range that is owned by this subnetwork.

Property Value
Type	Description
`string`

IpCidrRange

public string IpCidrRange { get; set; }

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 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange.

Property Value
Type	Description
`string`

Ipv6AccessType

public string Ipv6AccessType { get; set; }

The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. Check the Ipv6AccessType enum for the list of possible values.

Property Value
Type	Description
`string`

Ipv6CidrRange

public string Ipv6CidrRange { get; set; }

[Output Only] This field is for internal use.

Property Value
Type	Description
`string`

Kind

public string Kind { get; set; }

[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.

Property Value
Type	Description
`string`

LogConfig

public SubnetworkLogConfig LogConfig { get; set; }

This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Cloud Logging.

Property Value
Type	Description
`SubnetworkLogConfig`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`string`

Network

public string Network { get; set; }

The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time.

Property Value
Type	Description
`string`

PrivateIpGoogleAccess

public bool PrivateIpGoogleAccess { get; set; }

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.

Property Value
Type	Description
`bool`

PrivateIpv6GoogleAccess

public string PrivateIpv6GoogleAccess { get; set; }

This field is for internal use. This field can be both set at resource creation time and updated using patch. Check the PrivateIpv6GoogleAccess enum for the list of possible values.

Property Value
Type	Description
`string`

Purpose

public string Purpose { get; set; }

The purpose of the resource. This field can be either PRIVATE, GLOBAL_MANAGED_PROXY, REGIONAL_MANAGED_PROXY, PEER_MIGRATION or PRIVATE_SERVICE_CONNECT. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. Subnets with purpose set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY are user-created subnetworks that are reserved for Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to PEER_MIGRATION is used for subnet migration from one peered VPC to another. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. Check the Purpose enum for the list of possible values.

Property Value
Type	Description
`string`

Region

public string Region { get; set; }

URL of the region where the Subnetwork resides. This field can be set only at resource creation time.

Property Value
Type	Description
`string`

ReservedInternalRange

public string ReservedInternalRange { get; set; }

The URL of the reserved internal range.

Property Value
Type	Description
`string`

Role

public string Role { get; set; }

The role of subnetwork. Currently, this field is only used when purpose is set to GLOBAL_MANAGED_PROXY or REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. 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. Check the Role enum for the list of possible values.

Property Value
Type	Description
`string`

SecondaryIpRanges

public RepeatedField<SubnetworkSecondaryRange> SecondaryIpRanges { get; }

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.

Property Value
Type	Description
`RepeatedFieldSubnetworkSecondaryRange`

SelfLink

public string SelfLink { get; set; }

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

Property Value
Type	Description
`string`

StackType

public string StackType { get; set; }

The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. Check the StackType enum for the list of possible values.

Property Value
Type	Description
`string`

State

public string State { get; set; }

[Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: 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 Check the State enum for the list of possible values.

Property Value
Type	Description
`string`