apiservice

Documentation

Index

• type AuthenticationPolicyProperties
• type BatchRequest
• type BatchRequestItem
• type BatchResponse
• type BatchResponseItem
• type TaskListResult
• type TaskProperties

Types

type AuthenticationPolicyProperties

type AuthenticationPolicyProperties struct {

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

	Schema string `json:"_schema,omitempty"`

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

	// Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.
	ApiFailedAuthLockoutPeriod int64 `json:"api_failed_auth_lockout_period,omitempty"`

	// In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.
	ApiFailedAuthResetPeriod int64 `json:"api_failed_auth_reset_period,omitempty"`

	// Only applies to NSX Manager nodes. Ignored on other node types.
	ApiMaxAuthFailures int64 `json:"api_max_auth_failures,omitempty"`

	// Once a lockout occurs, the account remains locked out of the CLI for this time period.
	CliFailedAuthLockoutPeriod int64 `json:"cli_failed_auth_lockout_period,omitempty"`

	// Number of authentication failures that trigger CLI lockout
	CliMaxAuthFailures int64 `json:"cli_max_auth_failures,omitempty"`

	// Minimum number of characters required in account passwords
	MinimumPasswordLength int64 `json:"minimum_password_length,omitempty"`
}

type BatchRequest

type BatchRequest struct {

	// Flag to decide if we will continue processing subsequent requests in case of current error for atomic = false.
	ContinueOnError bool `json:"continue_on_error,omitempty"`

	Requests []BatchRequestItem `json:"requests,omitempty"`
}

type BatchRequestItem

type BatchRequestItem struct {
	Body *interface{} `json:"body,omitempty"`

	// http method type
	Method string `json:"method"`

	// relative uri (path and args), of the call including resource id (if this is a POST/DELETE), exclude hostname and port and prefix, exploded form of parameters
	Uri string `json:"uri"`
}

type BatchResponse

type BatchResponse struct {

	// Indicates if any of the APIs failed
	HasErrors bool `json:"has_errors,omitempty"`

	// Bulk list results
	Results []BatchResponseItem `json:"results"`

	// Optional flag indicating that all items were rolled back even if succeeded initially
	RolledBack bool `json:"rolled_back,omitempty"`
}

type BatchResponseItem

type BatchResponseItem struct {

	// object returned by api
	Body *interface{} `json:"body,omitempty"`

	// http status code
	Code int64 `json:"code"`

	// The headers returned by the API call
	Headers *interface{} `json:"headers,omitempty"`
}

type TaskListResult

type TaskListResult struct {

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

	Schema string `json:"_schema,omitempty"`

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

	// Opaque cursor to be used for getting next page of records (supplied by current result page)
	Cursor string `json:"cursor,omitempty"`

	// Count of results found (across all pages), set only on first page
	ResultCount int64 `json:"result_count,omitempty"`

	SortAscending bool `json:"sort_ascending,omitempty"`

	// Field by which records are sorted
	SortBy string `json:"sort_by,omitempty"`

	// Task property results
	Results []TaskProperties `json:"results"`
}

type TaskProperties

type TaskProperties struct {

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

	Schema string `json:"_schema,omitempty"`

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

	// True if response for asynchronous request is available
	AsyncResponseAvailable bool `json:"async_response_available,omitempty"`

	// True if this task can be canceled
	Cancelable bool `json:"cancelable,omitempty"`

	// Description of the task
	Description string `json:"description,omitempty"`

	// The end time of the task in epoch milliseconds
	EndTime int64 `json:"end_time,omitempty"`

	// Identifier for this task
	Id string `json:"id,omitempty"`

	// A message describing the disposition of the task
	Message string `json:"message,omitempty"`

	// Task progress if known, from 0 to 100
	Progress int64 `json:"progress,omitempty"`

	// HTTP request method
	RequestMethod string `json:"request_method,omitempty"`

	// URI of the method invocation that spawned this task
	RequestUri string `json:"request_uri,omitempty"`

	// The start time of the task in epoch milliseconds
	StartTime int64 `json:"start_time,omitempty"`

	// Current status of the task
	Status string `json:"status,omitempty"`

	// Name of the user who created this task
	User string `json:"user,omitempty"`
}