GoogleApi.NetworkConnectivity.V1.Model.InternalRange (google_api_network_connectivity v0.12.0)

View Source

The internal range resource for IPAM operations within a VPC network. Used to represent a private address range along with behavioral characteristics of that range (its usage and peering behavior). Networking resources can link to this range if they are created as belonging to it.

Attributes

  • createTime (type: DateTime.t, default: nil) - Time when the internal range was created.
  • description (type: String.t, default: nil) - A description of this resource.
  • excludeCidrRanges (type: list(String.t), default: nil) - Optional. ExcludeCidrRanges flag. Specifies a set of CIDR blocks that allows exclusion of particular CIDR ranges from the auto-allocation process, without having to reserve these blocks
  • immutable (type: boolean(), default: nil) - Optional. Immutable ranges cannot have their fields modified, except for labels and description.
  • ipCidrRange (type: String.t, default: nil) - The IP range that this internal range defines. NOTE: IPv6 ranges are limited to usage=EXTERNAL_TO_VPC and peering=FOR_SELF. NOTE: For IPv6 Ranges this field is compulsory, i.e. the address range must be specified explicitly.
  • labels (type: map(), default: nil) - User-defined labels.
  • migration (type: GoogleApi.NetworkConnectivity.V1.Model.Migration.t, default: nil) - Optional. Must be present if usage is set to FOR_MIGRATION.
  • name (type: String.t, default: nil) - Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names
  • network (type: String.t, default: nil) - The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. For example: https://www.googleapis.com/compute/v1/projects/{project}/locations/global/networks/{network} projects/{project}/locations/global/networks/{network} {network}
  • overlaps (type: list(String.t), default: nil) - Optional. Types of resources that are allowed to overlap with the current internal range.
  • peering (type: String.t, default: nil) - The type of peering set for this internal range.
  • prefixLength (type: integer(), default: nil) - An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.
  • targetCidrRange (type: list(String.t), default: nil) - Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC.
  • updateTime (type: DateTime.t, default: nil) - Time when the internal range was updated.
  • usage (type: String.t, default: nil) - The type of usage set for this InternalRange.
  • users (type: list(String.t), default: nil) - Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.NetworkConnectivity.V1.Model.InternalRange{
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  excludeCidrRanges: [String.t()] | nil,
  immutable: boolean() | nil,
  ipCidrRange: String.t() | nil,
  labels: map() | nil,
  migration: GoogleApi.NetworkConnectivity.V1.Model.Migration.t() | nil,
  name: String.t() | nil,
  network: String.t() | nil,
  overlaps: [String.t()] | nil,
  peering: String.t() | nil,
  prefixLength: integer() | nil,
  targetCidrRange: [String.t()] | nil,
  updateTime: DateTime.t() | nil,
  usage: String.t() | nil,
  users: [String.t()] | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.