REST Resource: organizations.boundaries

Resource: Boundary

A Boundary is a collection of projects defined by a filtering criteria on an organization or a folder.

JSON representation
{
  "name": string,
  "displayName": string,
  "managementProject": string,
  "resourceFilter": {
    object (ResourceFilter)
  },
  "state": enum (State),
  "etag": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The unique resource name of the Boundary. Format: - organizations/{organizationId}/boundaries/{boundaryId} - folders/{folder_id}/boundaries/{boundaryId} Example: folders/123456789/boundaries/my-boundary

displayName

string

Optional. Human-readable display name of the Boundary. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Production Boundary

managementProject

string

Output only. The Management Project of the CapabilityConfig this Boundary is associated with. Will be empty if the Boundary is not associated with any CapabilityConfig. Format: projects/{projectNumber} Example: projects/123456789012

resourceFilter

object (ResourceFilter)

Optional. The filter defining the criteria for descendant projects to be included in the Boundary. Descendant projects are dynamically included in the Boundary based on this filter.

state

enum (State)

Output only. The lifecycle state of the Boundary.

etag

string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

createTime

string (Timestamp format)

Output only. The creation time of the Boundary.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The most recent time this Boundary was modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Methods

create

Creates a Boundary under a parent Folder or Organization.

delete

Deletes the Boundary identified by the specified name (for example, folders/123456789/boundaries/my-boundary).

get

Retrieves the Boundary identified by the specified name (for example, folders/123456789/boundaries/my-boundary).

list

Lists Boundaries that are direct children of the specified organization or folder resource.

patch

Updates the display_name and resource_filter.tag_filter.tag_value of the Boundary identified by the specified name (for example, folders/123456789/boundaries/my-boundary).