close()

Close httplib2 connections.

create(parent, body=None, customRangeId=None, requestId=None, x__xgafv=None)

Creates a new CustomRange in a given project and location.

Args:
parent: string, Required. The parent resource name where the CustomRange will be created. (required)
body: object, The request body.
The object takes the form of:

{ # A CustomRange represents a user-defined IP address range.
"attributes": [ # Optional. The attributes of the CustomRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"description": "A String", # Optional. The description of the CustomRange.
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
"parentRange": "A String", # Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
"realm": "A String", # Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
"registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
}

customRangeId: string, Required. The ID to use for the CustomRange, which will become the final segment of the resource name.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, force=None, requestId=None, x__xgafv=None)

Deletes a single CustomRange.

Args:
name: string, Required. The resource name of the CustomRange to delete. (required)
force: boolean, Optional. If set to true, all associated resources will be deleted.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

findFreeIpRanges(name, cidrPrefixLength=None, rangeCount=None, requestId=None, x__xgafv=None)

Finds free IP ranges in a single CustomRange.

Args:
  name: string, Required. The resource name of the CustomRange to search within. (required)
  cidrPrefixLength: integer, Required. The prefix length of the free IP ranges to find.
  rangeCount: integer, Optional. The number of free IP ranges to find.
  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the CloudNumberRegistry.FindCustomRangeFreeIpRanges method.
  "freeIpCidrRanges": [ # Output only. The free IP CIDR ranges found.
    "A String",
  ],
}

get(name, x__xgafv=None)

Gets details of a single CustomRange.

Args:
  name: string, Required. The resource name of the CustomRange to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A CustomRange represents a user-defined IP address range.
  "attributes": [ # Optional. The attributes of the CustomRange.
    { # A key-value pair representing a custom attribute associated with a resource.
      "key": "A String", # Required. The key of the attribute.
      "value": "A String", # Required. The value of the attribute.
    },
  ],
  "description": "A String", # Optional. The description of the CustomRange.
  "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
  "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
  "labels": { # Optional. User-defined labels.
    "a_key": "A String",
  },
  "name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
  "parentRange": "A String", # Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
  "realm": "A String", # Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
  "registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists CustomRanges in a given project and location.

Args:
  parent: string, Required. The parent resource name, for example `projects/*/locations/*`. (required)
  filter: string, Optional. Filter expression to filter the results.
  orderBy: string, Optional. Hint for how to order the results.
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the CloudNumberRegistry.ListCustomRanges method.
  "customRanges": [ # The list of CustomRanges.
    { # A CustomRange represents a user-defined IP address range.
      "attributes": [ # Optional. The attributes of the CustomRange.
        { # A key-value pair representing a custom attribute associated with a resource.
          "key": "A String", # Required. The key of the attribute.
          "value": "A String", # Required. The value of the attribute.
        },
      ],
      "description": "A String", # Optional. The description of the CustomRange.
      "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
      "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
      "labels": { # Optional. User-defined labels.
        "a_key": "A String",
      },
      "name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
      "parentRange": "A String", # Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
      "realm": "A String", # Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
      "registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
    },
  ],
  "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single CustomRange.

Args:
name: string, Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. (required)
body: object, The request body.
The object takes the form of:

{ # A CustomRange represents a user-defined IP address range.
"attributes": [ # Optional. The attributes of the CustomRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"description": "A String", # Optional. The description of the CustomRange.
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
"parentRange": "A String", # Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
"realm": "A String", # Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
"registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
}

requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the CustomRange resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

showUtilization(name, x__xgafv=None)

Gets the details of a single CustomRange and its utilization.

Args:
  name: string, Required. The resource name of the CustomRange. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for the CloudNumberRegistry.ShowCustomRangeUtilization method.
  "customRange": { # A CustomRange represents a user-defined IP address range. # The CustomRange resource.
    "attributes": [ # Optional. The attributes of the CustomRange.
      { # A key-value pair representing a custom attribute associated with a resource.
        "key": "A String", # Required. The key of the attribute.
        "value": "A String", # Required. The value of the attribute.
      },
    ],
    "description": "A String", # Optional. The description of the CustomRange.
    "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
    "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
    "labels": { # Optional. User-defined labels.
      "a_key": "A String",
    },
    "name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
    "parentRange": "A String", # Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.
    "realm": "A String", # Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.
    "registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
  },
  "rangeUtilization": { # Utilization metrics for an IP Range, including consumed and produced address counts. # The utilization details of the CustomRange.
    "totalConsumed": "A String", # Output only. The total number of IP addresses consumed in the Range.
    "totalProduced": "A String", # Output only. The total number of IP addresses produced in the Range.
    "usage": 3.14, # Output only. The usage of the Range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL.
  },
}

Cloud Number Registry API . projects . locations . customRanges

Instance Methods

Method Details