ProposedSegmentationObject

ProposedSegmentationObject
Proposed Segmentation Object

Represents a logical segmentation entity. Each segmentation object contains a list of proposed groups.

This base schema is extended by type-specific schemas:

  • ProposedSegmentationApplicationObject: Applications with app_type and tier_count
  • ProposedSegmentationApplicationTierObject: Application tiers with parent_id reference
  • ProposedSegmentationEnvironmentObject: Environments
  • ProposedSegmentationOtherObject: General-purpose groups (regions, zones)
  • ProposedSegmentationInfrastructureServiceObject: Infrastructure service groups

Notes:

  • Use the segmentation_object_type discriminator to resolve the concrete subtype before deserializing.
  • publish_action is the ONLY writable field on PUT; all other fields are read-only and will be ignored.
  • Publishing a segmentation object publishes all of its proposed_groups; individual group publication is not supported through this schema.
  • publish_status reflects the overall object status; each site's group has its own independent publish_status_info.
AllOf
This class requires all of the following:
JSON Example 
{
    "_create_user": "admin",
    "_create_time": 1782155258592,
    "_last_modified_user": "admin",
    "_last_modified_time": 1782155258592,
    "_revision": 0,
    "_resource_type": "string",
    "_system_owned": false,
    "id": "-6286331157426286654",
    "display_name": "USA_Portland_Shared",
    "description": "string",
    "site_ids": [],
    "publish_action": "NONE",
    "segmentation_object_type": "ENVIRONMENT",
    "hierarchy_tags": [
        {
            "scope": "region",
            "tag": "USA"
        },
        {
            "scope": "zone",
            "tag": "Portland"
        },
        {
            "scope": "environment",
            "tag": "Shared"
        }
    ],
    "proposed_groups": [
        {
            "_create_user": "admin",
            "_create_time": 1782155258592,
            "_last_modified_user": "admin",
            "_last_modified_time": 1782155258592,
            "_revision": 0,
            "id": "674239690117385218",
            "display_name": "USA_Portland_Shared",
            "site_ids": [
                "123a456b-123c-456d-89ab-cdef12345678"
            ],
            "group_path": "/infra/domains/default/groups/c348192d-d1f0-37eb-9262-e9feac4a0547",
            "object_count_per_type": [
                {
                    "type": "VIRTUAL_MACHINE",
                    "count": 1
                }
            ],
            "group_action": "CREATE",
            "publish_status_info": {
                "publish_status": "READY_TO_PUBLISH"
            },
            "current_effective_vm_count": 0,
            "projected_effective_vm_count": 1
        }
    ],
    "publish_status": "READY_TO_PUBLISH",
    "parent_id": "-5834291957839695920"
}
Used By
Parameter To
Returned By