REST Resource: projects.locations.customRanges

Resource: CustomRange

Message describing CustomRange object

JSON representation 
{
  "name": string,
  "realm": string,
  "parentRange": string,
  "registryBook": string,
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "description": string,
  "labels": {
    string: string,
    ...
  },

  // Union field ip_cidr_range can be only one of the following:
  "ipv4CidrRange": string,
  "ipv6CidrRange": string
  // End of list of possible types for union field ip_cidr_range.
}
Fields
name

string

Required. Identifier. name of resource
realm

string

Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project}/locations/{location}/realms/{realm}
parentRange

string

Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project}/locations/{location}/customRanges/{customRange}
registryBook

string

Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified.
attributes[]

object (Attribute)

Optional. The attributes of the CustomRange.
description

string

Optional. Description of the CustomRange.
labels

map (key: string, value: string)

Optional. Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field ip_cidr_range. The IP CIDR range of the CustomRange. ip_cidr_range can be only one of the following:
ipv4CidrRange

string

Optional. The IPv4 CIDR range of the CustomRange.
ipv6CidrRange

string

Optional. The IPv6 CIDR range of the CustomRange.

Methods

create

 Creates a new CustomRange in a given project and location.

delete

 Deletes a single CustomRange.

findFreeIpRanges

 Finds free IP ranges in a single CustomRange.

get

 Gets details of a single CustomRange.

list

 Lists CustomRanges in a given project and location.

patch

 Updates the parameters of a single CustomRange.

showUtilization

 Gets the details of a single CustomRange and its utilization.