common

Documentation

Index

• type EmbeddedResource
• type KeyValue
• type KeyValuePair
• type ManagedResource
• type NetworkError
• type OwnerResourceLink
• type Resource
• type ResourceLink
• type ResourceReference
• type SelfResourceLink
• type Tag

Types

type EmbeddedResource

type EmbeddedResource struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	Owner *OwnerResourceLink `json:"_owner,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Identifier of the resource
	Id string `json:"id,omitempty"`

	// The type of this resource.
	ResourceType string `json:"resource_type,omitempty"`
}

type KeyValue

type KeyValue struct {

	// key name
	Key string `json:"key"`

	// key value
	Value string `json:"value"`
}

type KeyValuePair

type KeyValuePair struct {

	// Key
	Key string `json:"key"`

	// Value
	Value string `json:"value"`
}

type ManagedResource

type ManagedResource struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *SelfResourceLink `json:"_self,omitempty"`

	// The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
	Revision int64 `json:"_revision"`

	// Timestamp of resource creation
	CreateTime int64 `json:"_create_time,omitempty"`

	// ID of the user who created this resource
	CreateUser string `json:"_create_user,omitempty"`

	// Timestamp of last modification
	LastModifiedTime int64 `json:"_last_modified_time,omitempty"`

	// ID of the user who last modified this resource
	LastModifiedUser string `json:"_last_modified_user,omitempty"`

	// Indicates system owned resource
	SystemOwned bool `json:"_system_owned,omitempty"`

	// Description of this resource
	Description string `json:"description,omitempty"`

	// Defaults to ID if not set
	DisplayName string `json:"display_name,omitempty"`

	// Unique identifier of this resource
	Id string `json:"id,omitempty"`

	// The type of this resource.
	ResourceType string `json:"resource_type,omitempty"`

	// Opaque identifiers meaningful to the API user
	Tags []Tag `json:"tags,omitempty"`
}

type NetworkError

type NetworkError struct {
	// Error code of network related error.
	ErrorCode string `json:"error_code,omitempty"`
	// Detailed message of network related error.
	ErrorMessage string `json:"error_message,omitempty"`
	// Additional error information in json format.
	Spec string `json:"spec,omitempty"`
}

Network error related to container objects.

type OwnerResourceLink

type OwnerResourceLink struct {

	// Optional action
	Action string `json:"action,omitempty"`

	Href string `json:"href,omitempty"`

	Rel string `json:"rel,omitempty"`
}

type Resource

type Resource struct {

	// The server will populate this field when returing the resource. Ignored on PUT and POST.
	Links []ResourceLink `json:"_links,omitempty"`

	Schema string `json:"_schema,omitempty"`

	Self *SelfResourceLink `json:"_self,omitempty"`
}

type ResourceLink

type ResourceLink struct {

	// Optional action
	Action string `json:"action,omitempty"`

	Href string `json:"href,omitempty"`

	// Custom relation type (follows RFC 5988 where appropriate definitions exist)
	Rel string `json:"rel,omitempty"`
}

type ResourceReference

type ResourceReference struct {

	// Will be set to false if the referenced NSX resource has been deleted.
	IsValid bool `json:"is_valid,omitempty"`

	// Display name of the NSX resource.
	TargetDisplayName string `json:"target_display_name,omitempty"`

	// Identifier of the NSX resource.
	TargetId string `json:"target_id,omitempty"`

	// Type of the NSX resource.
	TargetType string `json:"target_type,omitempty"`
}

A weak reference to an NSX resource.

type SelfResourceLink

type SelfResourceLink struct {

	// Optional action
	Action string `json:"action,omitempty"`

	Href string `json:"href,omitempty"`

	Rel string `json:"rel,omitempty"`
}

type Tag

type Tag struct {

	// Tag searches may optionally be restricted by scope
	Scope string `json:"scope,omitempty"`

	// Identifier meaningful to user
	Tag string `json:"tag,omitempty"`
}