Struct Address 

#[non_exhaustive]
pub struct Address {

    pub address: Option<String>,
    pub address_type: Option<AddressType>,
    pub creation_timestamp: Option<String>,
    pub description: Option<String>,
    pub id: Option<u64>,
    pub ip_collection: Option<String>,
    pub ip_version: Option<IpVersion>,
    pub ipv_6_endpoint_type: Option<Ipv6EndpointType>,
    pub kind: Option<String>,
    pub label_fingerprint: Option<Bytes>,
    pub labels: HashMap<String, String>,
    pub name: Option<String>,
    pub network: Option<String>,
    pub network_tier: Option<NetworkTier>,
    pub prefix_length: Option<i32>,
    pub purpose: Option<Purpose>,
    pub region: Option<String>,
    pub self_link: Option<String>,
    pub status: Option<Status>,
    pub subnetwork: Option<String>,
    pub users: Vec<String>,
    /* private fields */
}

Available on crate features addresses or global-addresses only.

Represents an IP Address resource.

Google Compute Engine has two IP Address resources:

• Global (external and internal)
• Regional (external and internal)

For more information, see Reserving a static external IP address.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: Option<String>

The static IP address represented by this resource.

address_type: Option<AddressType>

The type of address to reserve, either INTERNAL orEXTERNAL. If unspecified, defaults to EXTERNAL.

creation_timestamp: Option<String>

Output only. [Output Only] Creation timestamp inRFC3339 text format.

description: Option<String>

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

id: Option<u64>

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

ip_collection: Option<String>

Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations.

Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP.

Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name

Partial URL, as in

      - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name
      - regions/region/publicDelegatedPrefixes/pdp-name

ip_version: Option<IpVersion>

The IP version that will be used by this address. Valid options areIPV4 or IPV6.

ipv_6_endpoint_type: Option<Ipv6EndpointType>

The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation.

kind: Option<String>

Output only. [Output Only] Type of the resource. Always compute#address for addresses.

label_fingerprint: Option<Bytes>

A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an Address.

labels: HashMap<String, String>

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

name: Option<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

network: Option<String>

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with theVPC_PEERING purpose.

network_tier: Option<NetworkTier>

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM orSTANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier.

If this field is not specified, it is assumed to be PREMIUM.

prefix_length: Option<i32>

The prefix length if the resource represents an IP range.

purpose: Option<Purpose>

The purpose of this resource, which can be one of the following values:

 - GCE_ENDPOINT for addresses that are used by VM
 instances, alias IP ranges, load balancers, and similar resources.
 - DNS_RESOLVER for a DNS resolver address in a subnetwork
   for a Cloud DNS  inbound
   forwarder IP addresses (regional internal IP address in a subnet of
   a VPC network)
 - VPC_PEERING for global internal IP addresses used for

      private services access allocated ranges.
 - NAT_AUTO for the regional external IP addresses used by
      Cloud NAT when allocating addresses using

      automatic NAT IP address allocation.
 - IPSEC_INTERCONNECT for addresses created from a private
 IP range that are reserved for a VLAN attachment in an
 *HA VPN over Cloud Interconnect* configuration. These addresses
 are regional resources.
 - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned
 to multiple internal forwarding rules.
 - `PRIVATE_SERVICE_CONNECT` for a private network address that is
 used to configure Private Service Connect. Only global internal addresses
 can use this purpose.

region: Option<String>

Output only. [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. This field is not applicable to global addresses.

self_link: Option<String>

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

status: Option<Status>

Output only. [Output Only] The status of the address, which can be one ofRESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.

subnetwork: Option<String>

The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork’s IP range. This field can only be used with INTERNAL type with aGCE_ENDPOINT or DNS_RESOLVER purpose.

users: Vec<String>

[Output Only] The URLs of the resources that are using this address.

Implementations

impl Address

pub fn new() -> Self

pub fn set_address<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of address.

Example

let x = Address::new().set_address("example");

pub fn set_or_clear_address<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of address.

Example

let x = Address::new().set_or_clear_address(Some("example"));
let x = Address::new().set_or_clear_address(None::<String>);

pub fn set_address_type<T>(self, v: T) -> Self

where T: Into<AddressType>,

Sets the value of address_type.

Example

use google_cloud_compute_v1::model::address::AddressType;
let x0 = Address::new().set_address_type(AddressType::Internal);
let x1 = Address::new().set_address_type(AddressType::UnspecifiedType);

pub fn set_or_clear_address_type<T>(self, v: Option<T>) -> Self

where T: Into<AddressType>,

Sets or clears the value of address_type.

Example

use google_cloud_compute_v1::model::address::AddressType;
let x0 = Address::new().set_or_clear_address_type(Some(AddressType::Internal));
let x1 = Address::new().set_or_clear_address_type(Some(AddressType::UnspecifiedType));
let x_none = Address::new().set_or_clear_address_type(None::<AddressType>);

pub fn set_creation_timestamp<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of creation_timestamp.

Example

let x = Address::new().set_creation_timestamp("example");

pub fn set_or_clear_creation_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of creation_timestamp.

Example

let x = Address::new().set_or_clear_creation_timestamp(Some("example"));
let x = Address::new().set_or_clear_creation_timestamp(None::<String>);

pub fn set_description<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of description.

Example

let x = Address::new().set_description("example");

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of description.

Example

let x = Address::new().set_or_clear_description(Some("example"));
let x = Address::new().set_or_clear_description(None::<String>);

pub fn set_id<T>(self, v: T) -> Self

where T: Into<u64>,

Sets the value of id.

Example

let x = Address::new().set_id(42_u32);

pub fn set_or_clear_id<T>(self, v: Option<T>) -> Self

where T: Into<u64>,

Sets or clears the value of id.

Example

let x = Address::new().set_or_clear_id(Some(42_u32));
let x = Address::new().set_or_clear_id(None::<u32>);

pub fn set_ip_collection<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of ip_collection.

Example

let x = Address::new().set_ip_collection("example");

pub fn set_or_clear_ip_collection<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of ip_collection.

Example

let x = Address::new().set_or_clear_ip_collection(Some("example"));
let x = Address::new().set_or_clear_ip_collection(None::<String>);

pub fn set_ip_version<T>(self, v: T) -> Self

where T: Into<IpVersion>,

Sets the value of ip_version.

Example

use google_cloud_compute_v1::model::address::IpVersion;
let x0 = Address::new().set_ip_version(IpVersion::Ipv6);
let x1 = Address::new().set_ip_version(IpVersion::UnspecifiedVersion);

pub fn set_or_clear_ip_version<T>(self, v: Option<T>) -> Self

where T: Into<IpVersion>,

Sets or clears the value of ip_version.

Example

use google_cloud_compute_v1::model::address::IpVersion;
let x0 = Address::new().set_or_clear_ip_version(Some(IpVersion::Ipv6));
let x1 = Address::new().set_or_clear_ip_version(Some(IpVersion::UnspecifiedVersion));
let x_none = Address::new().set_or_clear_ip_version(None::<IpVersion>);

pub fn set_ipv_6_endpoint_type<T>(self, v: T) -> Self

where T: Into<Ipv6EndpointType>,

Sets the value of ipv_6_endpoint_type.

Example

use google_cloud_compute_v1::model::address::Ipv6EndpointType;
let x0 = Address::new().set_ipv_6_endpoint_type(Ipv6EndpointType::Vm);

pub fn set_or_clear_ipv_6_endpoint_type<T>(self, v: Option<T>) -> Self

where T: Into<Ipv6EndpointType>,

Sets or clears the value of ipv_6_endpoint_type.

Example

use google_cloud_compute_v1::model::address::Ipv6EndpointType;
let x0 = Address::new().set_or_clear_ipv_6_endpoint_type(Some(Ipv6EndpointType::Vm));
let x_none = Address::new().set_or_clear_ipv_6_endpoint_type(None::<Ipv6EndpointType>);

pub fn set_kind<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of kind.

Example

let x = Address::new().set_kind("example");

pub fn set_or_clear_kind<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of kind.

Example

let x = Address::new().set_or_clear_kind(Some("example"));
let x = Address::new().set_or_clear_kind(None::<String>);

pub fn set_label_fingerprint<T>(self, v: T) -> Self

where T: Into<Bytes>,

Sets the value of label_fingerprint.

Example

let x = Address::new().set_label_fingerprint(bytes::Bytes::from_static(b"example"));

pub fn set_or_clear_label_fingerprint<T>(self, v: Option<T>) -> Self

where T: Into<Bytes>,

Sets or clears the value of label_fingerprint.

Example

let x = Address::new().set_or_clear_label_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = Address::new().set_or_clear_label_fingerprint(None::<bytes::Bytes>);

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = Address::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_name<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of name.

Example

let x = Address::new().set_name("example");

pub fn set_or_clear_name<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of name.

Example

let x = Address::new().set_or_clear_name(Some("example"));
let x = Address::new().set_or_clear_name(None::<String>);

pub fn set_network<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of network.

Example

let x = Address::new().set_network("example");

pub fn set_or_clear_network<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of network.

Example

let x = Address::new().set_or_clear_network(Some("example"));
let x = Address::new().set_or_clear_network(None::<String>);

pub fn set_network_tier<T>(self, v: T) -> Self

where T: Into<NetworkTier>,

Sets the value of network_tier.

Example

use google_cloud_compute_v1::model::address::NetworkTier;
let x0 = Address::new().set_network_tier(NetworkTier::Premium);
let x1 = Address::new().set_network_tier(NetworkTier::Standard);
let x2 = Address::new().set_network_tier(NetworkTier::StandardOverridesFixedStandard);

pub fn set_or_clear_network_tier<T>(self, v: Option<T>) -> Self

where T: Into<NetworkTier>,

Sets or clears the value of network_tier.

Example

use google_cloud_compute_v1::model::address::NetworkTier;
let x0 = Address::new().set_or_clear_network_tier(Some(NetworkTier::Premium));
let x1 = Address::new().set_or_clear_network_tier(Some(NetworkTier::Standard));
let x2 = Address::new().set_or_clear_network_tier(Some(NetworkTier::StandardOverridesFixedStandard));
let x_none = Address::new().set_or_clear_network_tier(None::<NetworkTier>);

pub fn set_prefix_length<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of prefix_length.

Example

let x = Address::new().set_prefix_length(42);

pub fn set_or_clear_prefix_length<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of prefix_length.

Example

let x = Address::new().set_or_clear_prefix_length(Some(42));
let x = Address::new().set_or_clear_prefix_length(None::<i32>);

pub fn set_purpose<T>(self, v: T) -> Self

where T: Into<Purpose>,

Sets the value of purpose.

Example

use google_cloud_compute_v1::model::address::Purpose;
let x0 = Address::new().set_purpose(Purpose::GceEndpoint);
let x1 = Address::new().set_purpose(Purpose::IpsecInterconnect);
let x2 = Address::new().set_purpose(Purpose::NatAuto);

pub fn set_or_clear_purpose<T>(self, v: Option<T>) -> Self

where T: Into<Purpose>,

Sets or clears the value of purpose.

Example

use google_cloud_compute_v1::model::address::Purpose;
let x0 = Address::new().set_or_clear_purpose(Some(Purpose::GceEndpoint));
let x1 = Address::new().set_or_clear_purpose(Some(Purpose::IpsecInterconnect));
let x2 = Address::new().set_or_clear_purpose(Some(Purpose::NatAuto));
let x_none = Address::new().set_or_clear_purpose(None::<Purpose>);

pub fn set_region<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of region.

Example

let x = Address::new().set_region("example");

pub fn set_or_clear_region<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of region.

Example

let x = Address::new().set_or_clear_region(Some("example"));
let x = Address::new().set_or_clear_region(None::<String>);

pub fn set_self_link<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of self_link.

Example

let x = Address::new().set_self_link("example");

pub fn set_or_clear_self_link<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of self_link.

Example

let x = Address::new().set_or_clear_self_link(Some("example"));
let x = Address::new().set_or_clear_self_link(None::<String>);

pub fn set_status<T>(self, v: T) -> Self

where T: Into<Status>,

Sets the value of status.

Example

use google_cloud_compute_v1::model::address::Status;
let x0 = Address::new().set_status(Status::Reserved);
let x1 = Address::new().set_status(Status::Reserving);

pub fn set_or_clear_status<T>(self, v: Option<T>) -> Self

where T: Into<Status>,

Sets or clears the value of status.

Example

use google_cloud_compute_v1::model::address::Status;
let x0 = Address::new().set_or_clear_status(Some(Status::Reserved));
let x1 = Address::new().set_or_clear_status(Some(Status::Reserving));
let x_none = Address::new().set_or_clear_status(None::<Status>);

pub fn set_subnetwork<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of subnetwork.

Example

let x = Address::new().set_subnetwork("example");

pub fn set_or_clear_subnetwork<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of subnetwork.

Example

let x = Address::new().set_or_clear_subnetwork(Some("example"));
let x = Address::new().set_or_clear_subnetwork(None::<String>);

pub fn set_users<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of users.

Example

let x = Address::new().set_users(["a", "b", "c"]);

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Default for Address

fn default() -> Address

Returns the “default value” for a type.

impl Message for Address

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Address

fn eq(&self, other: &Address) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Address