Struct google_compute1::api::Subnetwork

pub struct Subnetwork {

    pub creation_timestamp: Option<String>,
    pub description: Option<String>,
    pub enable_flow_logs: Option<bool>,
    pub fingerprint: Option<String>,
    pub gateway_address: Option<String>,
    pub id: Option<String>,
    pub ip_cidr_range: Option<String>,
    pub ipv6_cidr_range: Option<String>,
    pub kind: Option<String>,
    pub log_config: Option<SubnetworkLogConfig>,
    pub name: Option<String>,
    pub network: Option<String>,
    pub private_ip_google_access: Option<bool>,
    pub private_ipv6_google_access: Option<String>,
    pub purpose: Option<String>,
    pub region: Option<String>,
    pub role: Option<String>,
    pub secondary_ip_ranges: Option<Vec<SubnetworkSecondaryRange>>,
    pub self_link: Option<String>,
    pub state: Option<String>,
}

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 {$api_version}.subnetworks ==)

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• aggregated list subnetworks (none)
• delete subnetworks (none)
• expand ip cidr range subnetworks (none)
• get subnetworks (response)
• get iam policy subnetworks (none)
• insert subnetworks (request)
• list subnetworks (none)
• list usable subnetworks (none)
• patch subnetworks (request)
• set iam policy subnetworks (none)
• set private ip google access subnetworks (none)
• test iam permissions subnetworks (none)

Fields

creation_timestamp: Option<String>

[Output Only] Creation timestamp in RFC3339 text format.

description: Option<String>

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

enable_flow_logs: Option<bool>

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. This field isn’t supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.

fingerprint: Option<String>

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.

gateway_address: Option<String>

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

id: Option<String>

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

ip_cidr_range: Option<String>

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.

ipv6_cidr_range: Option<String>

[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.

kind: Option<String>

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

log_config: Option<SubnetworkLogConfig>

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

name: Option<String>

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.

network: Option<String>

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.

private_ip_google_access: Option<bool>

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.

private_ipv6_google_access: Option<String>

The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority.

This field can be both set at resource creation time and updated using patch.

purpose: Option<String>

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. The enableFlowLogs field isn’t supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.

region: Option<String>

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

role: Option<String>

The role of subnetwork. Currently, 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.

secondary_ip_ranges: Option<Vec<SubnetworkSecondaryRange>>

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.

self_link: Option<String>

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

state: Option<String>

[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 CREATING: Subnetwork is provisioning DELETING: Subnetwork is being deleted UPDATING: Subnetwork is being updated

Trait Implementations

impl Clone for Subnetwork

fn clone(&self) -> Subnetwork

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Subnetwork

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Subnetwork

fn default() -> Subnetwork

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Subnetwork

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Subnetwork

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl RequestValue for Subnetwork

impl Resource for Subnetwork

impl ResponseResult for Subnetwork