Help us shape the future of Go! Take the 2026 Go Developer Survey

grid

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package grid provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCreateGridTopologyRequest

func NewCreateGridTopologyRequest(server string, body CreateGridTopologyJSONRequestBody) (*http.Request, error)

NewCreateGridTopologyRequest calls the generic CreateGridTopology builder with application/json body

func NewCreateGridTopologyRequestWithBody

func NewCreateGridTopologyRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewCreateGridTopologyRequestWithBody constructs an http.Request for the CreateGridTopology method, with any body, and a specified content type

func NewDeleteGridTopologyRequest

func NewDeleteGridTopologyRequest(server string, key string) (*http.Request, error)

NewDeleteGridTopologyRequest constructs an http.Request for the DeleteGridTopology method

func NewGetGridTopologyRequest

func NewGetGridTopologyRequest(server string, key string) (*http.Request, error)

NewGetGridTopologyRequest constructs an http.Request for the GetGridTopology method

func NewGetMonitoringEntityDetailRequest

func NewGetMonitoringEntityDetailRequest(server string, key string, entityType string, entityId string) (*http.Request, error)

NewGetMonitoringEntityDetailRequest constructs an http.Request for the GetMonitoringEntityDetail method

func NewGetMonitoringEntityListRequest

func NewGetMonitoringEntityListRequest(server string, key string, params *GetMonitoringEntityListParams) (*http.Request, error)

NewGetMonitoringEntityListRequest constructs an http.Request for the GetMonitoringEntityList method

func NewGetMonitoringSummaryRequest

func NewGetMonitoringSummaryRequest(server string, key string, params *GetMonitoringSummaryParams) (*http.Request, error)

NewGetMonitoringSummaryRequest constructs an http.Request for the GetMonitoringSummary method

func NewListGridTopologiesRequest

func NewListGridTopologiesRequest(server string) (*http.Request, error)

NewListGridTopologiesRequest constructs an http.Request for the ListGridTopologies method

func NewListJPDsRequest

func NewListJPDsRequest(server string, params *ListJPDsParams) (*http.Request, error)

NewListJPDsRequest constructs an http.Request for the ListJPDs method

func NewUpdateGridTopologyRequest

func NewUpdateGridTopologyRequest(server string, key string, body UpdateGridTopologyJSONRequestBody) (*http.Request, error)

NewUpdateGridTopologyRequest calls the generic UpdateGridTopology builder with application/json body

func NewUpdateGridTopologyRequestWithBody

func NewUpdateGridTopologyRequestWithBody(server string, key string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateGridTopologyRequestWithBody constructs an http.Request for the UpdateGridTopology method, with any body, and a specified content type

Types

type AllEntityTypesSummaryResponse

type AllEntityTypesSummaryResponse struct {
	// EntityTypes Required within this object. One entry per monitored entity type: users, groups, permissions, tokens, projects, environments, roles, projectGroups, projectUsers and projectResources. Users, groups, permissions and tokens are replicated through Access federation; the other types report zero counts.
	EntityTypes []EntityTypeSummary `json:"entity_types"`

	// Timestamp Required within this object. Server-owned. RFC 3339 time the counts were computed.
	Timestamp time.Time `json:"timestamp"`
}

AllEntityTypesSummaryResponse Sync counts per entity type across the topology.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CreateGridTopology

func (c *Client) CreateGridTopology(ctx context.Context, body CreateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateGridTopology Create a topology

Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.

Takes a body of the `application/json` content type.

Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).

func (*Client) CreateGridTopologyWithBody

func (c *Client) CreateGridTopologyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

CreateGridTopologyWithBody Create a topology

Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.

Takes any type of body and a specified content type.

Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).

func (*Client) DeleteGridTopology

func (c *Client) DeleteGridTopology(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*http.Response, error)

DeleteGridTopology Delete a topology

Removes a topology and the Access federation it configured between its sites. Identities already replicated stay on each site. Administrators only.

Corresponds with DELETE /api/v1/topology/{key} (the `DeleteGridTopology` operationId).

func (*Client) GetGridTopology

func (c *Client) GetGridTopology(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetGridTopology Get a topology

Returns one topology with the current state of each site. Administrators only.

Corresponds with GET /api/v1/topology/{key} (the `GetGridTopology` operationId).

func (*Client) GetMonitoringEntityDetail

func (c *Client) GetMonitoringEntityDetail(ctx context.Context, key string, entityType string, entityId string, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMonitoringEntityDetail Get one entity's sync state

Returns the delivery state of one entity to every target in the topology, including the last error for failed targets. Administrators only.

Corresponds with GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id} (the `GetMonitoringEntityDetail` operationId).

func (*Client) GetMonitoringEntityList

func (c *Client) GetMonitoringEntityList(ctx context.Context, key string, params *GetMonitoringEntityListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMonitoringEntityList List monitored entities

Lists entities of one type with their delivery state to each target in the topology, newest change first, one page at a time. Administrators only.

Corresponds with GET /api/v1/topology/{key}/monitoring/entities (the `GetMonitoringEntityList` operationId).

func (*Client) GetMonitoringSummary

func (c *Client) GetMonitoringSummary(ctx context.Context, key string, params *GetMonitoringSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetMonitoringSummary Summarise entity sync

Returns failure, in-progress and success counts per entity type across every target in the topology, optionally limited to a modification window. Administrators only.

Corresponds with GET /api/v1/topology/{key}/monitoring/entities/summary (the `GetMonitoringSummary` operationId).

func (*Client) ListGridTopologies

func (c *Client) ListGridTopologies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

ListGridTopologies List topologies

Returns every topology defined on this instance. Administrators only.

Corresponds with GET /api/v1/topology (the `ListGridTopologies` operationId).

func (*Client) ListJPDs

func (c *Client) ListJPDs(ctx context.Context, params *ListJPDsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListJPDs List known instances

Lists the instances this instance knows: itself and every paired peer. Filters accept * wildcards. Administrators only.

Corresponds with GET /api/v1/jpds (the `ListJPDs` operationId).

func (*Client) UpdateGridTopology

func (c *Client) UpdateGridTopology(ctx context.Context, key string, body UpdateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateGridTopology Update a topology

Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.

Takes a body of the `application/json` content type.

Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).

func (*Client) UpdateGridTopologyWithBody

func (c *Client) UpdateGridTopologyWithBody(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

UpdateGridTopologyWithBody Update a topology

Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.

Takes any type of body and a specified content type.

Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).

type ClientInterface

type ClientInterface interface {

	// ListJPDs List known instances
	//
	// Lists the instances this instance knows: itself and every paired peer. Filters accept * wildcards. Administrators only.
	//
	// Corresponds with GET /api/v1/jpds (the `ListJPDs` operationId).
	ListJPDs(ctx context.Context, params *ListJPDsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListGridTopologies List topologies
	//
	// Returns every topology defined on this instance. Administrators only.
	//
	// Corresponds with GET /api/v1/topology (the `ListGridTopologies` operationId).
	ListGridTopologies(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateGridTopologyWithBody Create a topology
	//
	// Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).
	CreateGridTopologyWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateGridTopology Create a topology
	//
	// Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).
	CreateGridTopology(ctx context.Context, body CreateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteGridTopology Delete a topology
	//
	// Removes a topology and the Access federation it configured between its sites. Identities already replicated stay on each site. Administrators only.
	//
	// Corresponds with DELETE /api/v1/topology/{key} (the `DeleteGridTopology` operationId).
	DeleteGridTopology(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetGridTopology Get a topology
	//
	// Returns one topology with the current state of each site. Administrators only.
	//
	// Corresponds with GET /api/v1/topology/{key} (the `GetGridTopology` operationId).
	GetGridTopology(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateGridTopologyWithBody Update a topology
	//
	// Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).
	UpdateGridTopologyWithBody(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateGridTopology Update a topology
	//
	// Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).
	UpdateGridTopology(ctx context.Context, key string, body UpdateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMonitoringEntityList List monitored entities
	//
	// Lists entities of one type with their delivery state to each target in the topology, newest change first, one page at a time. Administrators only.
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities (the `GetMonitoringEntityList` operationId).
	GetMonitoringEntityList(ctx context.Context, key string, params *GetMonitoringEntityListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMonitoringSummary Summarise entity sync
	//
	// Returns failure, in-progress and success counts per entity type across every target in the topology, optionally limited to a modification window. Administrators only.
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities/summary (the `GetMonitoringSummary` operationId).
	GetMonitoringSummary(ctx context.Context, key string, params *GetMonitoringSummaryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetMonitoringEntityDetail Get one entity's sync state
	//
	// Returns the delivery state of one entity to every target in the topology, including the last error for failed targets. Administrators only.
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id} (the `GetMonitoringEntityDetail` operationId).
	GetMonitoringEntityDetail(ctx context.Context, key string, entityType string, entityId string, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CreateGridTopologyWithBodyWithResponse

func (c *ClientWithResponses) CreateGridTopologyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateGridTopologyResponse, error)

CreateGridTopologyWithBodyWithResponse Create a topology

Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).

func (*ClientWithResponses) CreateGridTopologyWithResponse

func (c *ClientWithResponses) CreateGridTopologyWithResponse(ctx context.Context, body CreateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateGridTopologyResponse, error)

CreateGridTopologyWithResponse Create a topology

Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).

func (*ClientWithResponses) DeleteGridTopologyWithResponse

func (c *ClientWithResponses) DeleteGridTopologyWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*DeleteGridTopologyResponse, error)

DeleteGridTopologyWithResponse Delete a topology

Removes a topology and the Access federation it configured between its sites. Identities already replicated stay on each site. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with DELETE /api/v1/topology/{key} (the `DeleteGridTopology` operationId).

func (*ClientWithResponses) GetGridTopologyWithResponse

func (c *ClientWithResponses) GetGridTopologyWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*GetGridTopologyResponse, error)

GetGridTopologyWithResponse Get a topology

Returns one topology with the current state of each site. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/topology/{key} (the `GetGridTopology` operationId).

func (*ClientWithResponses) GetMonitoringEntityDetailWithResponse

func (c *ClientWithResponses) GetMonitoringEntityDetailWithResponse(ctx context.Context, key string, entityType string, entityId string, reqEditors ...RequestEditorFn) (*GetMonitoringEntityDetailResponse, error)

GetMonitoringEntityDetailWithResponse Get one entity's sync state

Returns the delivery state of one entity to every target in the topology, including the last error for failed targets. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id} (the `GetMonitoringEntityDetail` operationId).

func (*ClientWithResponses) GetMonitoringEntityListWithResponse

func (c *ClientWithResponses) GetMonitoringEntityListWithResponse(ctx context.Context, key string, params *GetMonitoringEntityListParams, reqEditors ...RequestEditorFn) (*GetMonitoringEntityListResponse, error)

GetMonitoringEntityListWithResponse List monitored entities

Lists entities of one type with their delivery state to each target in the topology, newest change first, one page at a time. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/topology/{key}/monitoring/entities (the `GetMonitoringEntityList` operationId).

func (*ClientWithResponses) GetMonitoringSummaryWithResponse

func (c *ClientWithResponses) GetMonitoringSummaryWithResponse(ctx context.Context, key string, params *GetMonitoringSummaryParams, reqEditors ...RequestEditorFn) (*GetMonitoringSummaryResponse, error)

GetMonitoringSummaryWithResponse Summarise entity sync

Returns failure, in-progress and success counts per entity type across every target in the topology, optionally limited to a modification window. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/topology/{key}/monitoring/entities/summary (the `GetMonitoringSummary` operationId).

func (*ClientWithResponses) ListGridTopologiesWithResponse

func (c *ClientWithResponses) ListGridTopologiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListGridTopologiesResponse, error)

ListGridTopologiesWithResponse List topologies

Returns every topology defined on this instance. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/topology (the `ListGridTopologies` operationId).

func (*ClientWithResponses) ListJPDsWithResponse

func (c *ClientWithResponses) ListJPDsWithResponse(ctx context.Context, params *ListJPDsParams, reqEditors ...RequestEditorFn) (*ListJPDsResponse, error)

ListJPDsWithResponse List known instances

Lists the instances this instance knows: itself and every paired peer. Filters accept * wildcards. Administrators only.

Returns a wrapper object for the known response body format(s).

Corresponds with GET /api/v1/jpds (the `ListJPDs` operationId).

func (*ClientWithResponses) UpdateGridTopologyWithBodyWithResponse

func (c *ClientWithResponses) UpdateGridTopologyWithBodyWithResponse(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateGridTopologyResponse, error)

UpdateGridTopologyWithBodyWithResponse Update a topology

Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).

func (*ClientWithResponses) UpdateGridTopologyWithResponse

func (c *ClientWithResponses) UpdateGridTopologyWithResponse(ctx context.Context, key string, body UpdateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateGridTopologyResponse, error)

UpdateGridTopologyWithResponse Update a topology

Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListJPDsWithResponse List known instances
	//
	// Lists the instances this instance knows: itself and every paired peer. Filters accept * wildcards. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/jpds (the `ListJPDs` operationId).
	ListJPDsWithResponse(ctx context.Context, params *ListJPDsParams, reqEditors ...RequestEditorFn) (*ListJPDsResponse, error)

	// ListGridTopologiesWithResponse List topologies
	//
	// Returns every topology defined on this instance. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/topology (the `ListGridTopologies` operationId).
	ListGridTopologiesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*ListGridTopologiesResponse, error)

	// CreateGridTopologyWithBodyWithResponse Create a topology
	//
	// Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).
	CreateGridTopologyWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateGridTopologyResponse, error)

	// CreateGridTopologyWithResponse Create a topology
	//
	// Stores a topology and configures Access federation between every pair of its sites, so identity changes made on any site reach the others. The key is derived from name by lowercasing it and replacing each run of characters other than letters and digits with a hyphen; the call answers 409 if that key exists. The topology is stored even when configuring a site fails afterwards; check each site's status in the response. Administrators only.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /api/v1/topology (the `CreateGridTopology` operationId).
	CreateGridTopologyWithResponse(ctx context.Context, body CreateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateGridTopologyResponse, error)

	// DeleteGridTopologyWithResponse Delete a topology
	//
	// Removes a topology and the Access federation it configured between its sites. Identities already replicated stay on each site. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with DELETE /api/v1/topology/{key} (the `DeleteGridTopology` operationId).
	DeleteGridTopologyWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*DeleteGridTopologyResponse, error)

	// GetGridTopologyWithResponse Get a topology
	//
	// Returns one topology with the current state of each site. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/topology/{key} (the `GetGridTopology` operationId).
	GetGridTopologyWithResponse(ctx context.Context, key string, reqEditors ...RequestEditorFn) (*GetGridTopologyResponse, error)

	// UpdateGridTopologyWithBodyWithResponse Update a topology
	//
	// Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).
	UpdateGridTopologyWithBodyWithResponse(ctx context.Context, key string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateGridTopologyResponse, error)

	// UpdateGridTopologyWithResponse Update a topology
	//
	// Changes the name, description or site list. A new site list is applied as a whole: added sites are federated with the others and removed sites are disconnected. As with creation, a site whose federation fails after the store is reported Disconnected rather than failing the call. Administrators only.
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with PATCH /api/v1/topology/{key} (the `UpdateGridTopology` operationId).
	UpdateGridTopologyWithResponse(ctx context.Context, key string, body UpdateGridTopologyJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateGridTopologyResponse, error)

	// GetMonitoringEntityListWithResponse List monitored entities
	//
	// Lists entities of one type with their delivery state to each target in the topology, newest change first, one page at a time. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities (the `GetMonitoringEntityList` operationId).
	GetMonitoringEntityListWithResponse(ctx context.Context, key string, params *GetMonitoringEntityListParams, reqEditors ...RequestEditorFn) (*GetMonitoringEntityListResponse, error)

	// GetMonitoringSummaryWithResponse Summarise entity sync
	//
	// Returns failure, in-progress and success counts per entity type across every target in the topology, optionally limited to a modification window. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities/summary (the `GetMonitoringSummary` operationId).
	GetMonitoringSummaryWithResponse(ctx context.Context, key string, params *GetMonitoringSummaryParams, reqEditors ...RequestEditorFn) (*GetMonitoringSummaryResponse, error)

	// GetMonitoringEntityDetailWithResponse Get one entity's sync state
	//
	// Returns the delivery state of one entity to every target in the topology, including the last error for failed targets. Administrators only.
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /api/v1/topology/{key}/monitoring/entities/{entity_type}/{entity_id} (the `GetMonitoringEntityDetail` operationId).
	GetMonitoringEntityDetailWithResponse(ctx context.Context, key string, entityType string, entityId string, reqEditors ...RequestEditorFn) (*GetMonitoringEntityDetailResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CreateGridTopologyJSONRequestBody

type CreateGridTopologyJSONRequestBody = CreateTopologyRequest

CreateGridTopologyJSONRequestBody defines body for CreateGridTopology for application/json ContentType.

type CreateGridTopologyResponse

type CreateGridTopologyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON201 the response for an HTTP 201 `application/json` response
	JSON201 *TopologyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *TopologyValidationError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseCreateGridTopologyResponse

func ParseCreateGridTopologyResponse(rsp *http.Response) (*CreateGridTopologyResponse, error)

ParseCreateGridTopologyResponse parses an HTTP response from a CreateGridTopologyWithResponse call

func (CreateGridTopologyResponse) ContentType

func (r CreateGridTopologyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CreateGridTopologyResponse) GetBody

func (r CreateGridTopologyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CreateGridTopologyResponse) GetJSON201

GetJSON201 returns the response for an HTTP 201 `application/json` response

func (CreateGridTopologyResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CreateGridTopologyResponse) GetJSON401

func (r CreateGridTopologyResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CreateGridTopologyResponse) GetJSON403

func (r CreateGridTopologyResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (CreateGridTopologyResponse) GetJSON409

func (r CreateGridTopologyResponse) GetJSON409() *ErrorResponse

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (CreateGridTopologyResponse) GetJSON500

func (r CreateGridTopologyResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CreateGridTopologyResponse) Status

Status returns HTTPResponse.Status

func (CreateGridTopologyResponse) StatusCode

func (r CreateGridTopologyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CreateTopologyRequest

type CreateTopologyRequest struct {
	// Description Optional within this object. Free text.
	Description *string `json:"description,omitempty"`

	// Name Required within this object. Display name. The topology key is derived from it and must be unique.
	Name string `json:"name"`

	// Sites Required within this object. The instances in the topology; at least two, each named once.
	Sites []SiteRequest `json:"sites"`
}

CreateTopologyRequest A new topology: a named set of instances that federate identity with each other.

type DeleteGridTopologyResponse

type DeleteGridTopologyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON409 the response for an HTTP 409 `application/json` response
	JSON409 *TopologyResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseDeleteGridTopologyResponse

func ParseDeleteGridTopologyResponse(rsp *http.Response) (*DeleteGridTopologyResponse, error)

ParseDeleteGridTopologyResponse parses an HTTP response from a DeleteGridTopologyWithResponse call

func (DeleteGridTopologyResponse) ContentType

func (r DeleteGridTopologyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (DeleteGridTopologyResponse) GetBody

func (r DeleteGridTopologyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (DeleteGridTopologyResponse) GetJSON401

func (r DeleteGridTopologyResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (DeleteGridTopologyResponse) GetJSON403

func (r DeleteGridTopologyResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (DeleteGridTopologyResponse) GetJSON404

func (r DeleteGridTopologyResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (DeleteGridTopologyResponse) GetJSON409

GetJSON409 returns the response for an HTTP 409 `application/json` response

func (DeleteGridTopologyResponse) GetJSON500

func (r DeleteGridTopologyResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (DeleteGridTopologyResponse) Status

Status returns HTTPResponse.Status

func (DeleteGridTopologyResponse) StatusCode

func (r DeleteGridTopologyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type EntityDetailResponse

type EntityDetailResponse struct {
	// EntityId Required within this object. The entity's business id.
	EntityId string `json:"entity_id"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`

	// Targets Required within this object. Delivery state per target.
	Targets []TargetSyncStatus `json:"targets"`
}

EntityDetailResponse Delivery state of one entity to every target, including failure reasons.

type EntityListItem

type EntityListItem struct {
	// EntityId Required within this object. The entity's business id, such as a username.
	EntityId string `json:"entity_id"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`

	// Targets Optional within this object. Delivery state per target.
	Targets *[]TargetSyncStatus `json:"targets,omitempty"`
}

EntityListItem One entity and its per-target states.

type EntityListResponse

type EntityListResponse struct {
	// Entities Required within this object. Entities on this page.
	Entities []EntityListItem `json:"entities"`

	// NextPageToken Required within this object. Opaque token for the next page; empty on the last page.
	NextPageToken string `json:"next_page_token"`

	// TotalCount Required within this object. Entities matching the filters across all pages.
	TotalCount int64 `json:"total_count"`
}

EntityListResponse A page of monitored entities.

type EntityTypeSummary

type EntityTypeSummary struct {
	// Counts Required within this object. Counts across every target in the topology.
	Counts StatusCounts `json:"counts"`

	// EntityType Required within this object. The entity type public key.
	EntityType string `json:"entity_type"`
}

EntityTypeSummary Counts for one monitored entity type.

type ErrorResponse

type ErrorResponse struct {
	// Code Required within this object. A symbolic code such as NOT_FOUND.
	Code string `json:"code"`

	// Details Optional within this object. Field-level details, one string each.
	Details *[]string `json:"details,omitempty"`

	// Message Required within this object. Human readable explanation.
	Message string `json:"message"`
}

ErrorResponse The flat error envelope used by /grid; details lists the offending fields when there are any.

type GetGridTopologyResponse

type GetGridTopologyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TopologyResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseGetGridTopologyResponse

func ParseGetGridTopologyResponse(rsp *http.Response) (*GetGridTopologyResponse, error)

ParseGetGridTopologyResponse parses an HTTP response from a GetGridTopologyWithResponse call

func (GetGridTopologyResponse) ContentType

func (r GetGridTopologyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetGridTopologyResponse) GetBody

func (r GetGridTopologyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetGridTopologyResponse) GetJSON200

func (r GetGridTopologyResponse) GetJSON200() *TopologyResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetGridTopologyResponse) GetJSON401

func (r GetGridTopologyResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetGridTopologyResponse) GetJSON403

func (r GetGridTopologyResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetGridTopologyResponse) GetJSON404

func (r GetGridTopologyResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetGridTopologyResponse) GetJSON500

func (r GetGridTopologyResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetGridTopologyResponse) Status

func (r GetGridTopologyResponse) Status() string

Status returns HTTPResponse.Status

func (GetGridTopologyResponse) StatusCode

func (r GetGridTopologyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMonitoringEntityDetailResponse

type GetMonitoringEntityDetailResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EntityDetailResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseGetMonitoringEntityDetailResponse

func ParseGetMonitoringEntityDetailResponse(rsp *http.Response) (*GetMonitoringEntityDetailResponse, error)

ParseGetMonitoringEntityDetailResponse parses an HTTP response from a GetMonitoringEntityDetailWithResponse call

func (GetMonitoringEntityDetailResponse) ContentType

func (r GetMonitoringEntityDetailResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMonitoringEntityDetailResponse) GetBody

GetBody returns the raw response body bytes

func (GetMonitoringEntityDetailResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMonitoringEntityDetailResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMonitoringEntityDetailResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMonitoringEntityDetailResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetMonitoringEntityDetailResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMonitoringEntityDetailResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMonitoringEntityDetailResponse) Status

Status returns HTTPResponse.Status

func (GetMonitoringEntityDetailResponse) StatusCode

func (r GetMonitoringEntityDetailResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMonitoringEntityListParams

type GetMonitoringEntityListParams struct {
	// EntityType Required query parameter. Entity type public key: users, groups, permissions, tokens, projects, environments, roles, projectGroups, projectUsers and projectResources. Users, groups, permissions and tokens are replicated through Access federation; the other types report zero counts.
	EntityType string `form:"entity_type" json:"entity_type"`

	// Status Optional query parameter. Return only entities with at least one target in this state; omitted means any state.
	Status *GetMonitoringEntityListParamsStatus `form:"status,omitempty" json:"status,omitempty"`

	// PageToken Optional query parameter. The next_page_token from the previous page; omitted for the first page.
	PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
}

GetMonitoringEntityListParams defines parameters for GetMonitoringEntityList.

type GetMonitoringEntityListParamsStatus

type GetMonitoringEntityListParamsStatus string

GetMonitoringEntityListParamsStatus defines parameters for GetMonitoringEntityList.

const (
	GetMonitoringEntityListParamsStatusFailure    GetMonitoringEntityListParamsStatus = "failure"
	GetMonitoringEntityListParamsStatusInProgress GetMonitoringEntityListParamsStatus = "in_progress"
	GetMonitoringEntityListParamsStatusSuccess    GetMonitoringEntityListParamsStatus = "success"
)

Defines values for GetMonitoringEntityListParamsStatus.

func (GetMonitoringEntityListParamsStatus) Valid

Valid indicates whether the value is a known member of the GetMonitoringEntityListParamsStatus enum.

type GetMonitoringEntityListResponse

type GetMonitoringEntityListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *EntityListResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseGetMonitoringEntityListResponse

func ParseGetMonitoringEntityListResponse(rsp *http.Response) (*GetMonitoringEntityListResponse, error)

ParseGetMonitoringEntityListResponse parses an HTTP response from a GetMonitoringEntityListWithResponse call

func (GetMonitoringEntityListResponse) ContentType

func (r GetMonitoringEntityListResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMonitoringEntityListResponse) GetBody

func (r GetMonitoringEntityListResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMonitoringEntityListResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMonitoringEntityListResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMonitoringEntityListResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMonitoringEntityListResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetMonitoringEntityListResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMonitoringEntityListResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMonitoringEntityListResponse) Status

Status returns HTTPResponse.Status

func (GetMonitoringEntityListResponse) StatusCode

func (r GetMonitoringEntityListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetMonitoringSummaryParams

type GetMonitoringSummaryParams struct {
	// ModifiedAfter Optional query parameter. RFC 3339 time; only entities modified after it are counted.
	ModifiedAfter *time.Time `form:"modified_after,omitempty" json:"modified_after,omitempty"`

	// ModifiedBefore Optional query parameter. RFC 3339 time; only entities modified before it are counted. Must be later than modified_after when both are given.
	ModifiedBefore *time.Time `form:"modified_before,omitempty" json:"modified_before,omitempty"`

	// ShowSystemEntities Optional query parameter. When true, also count the project-scoped types projectUsers, projectGroups and projectResources. Defaults to false.
	ShowSystemEntities *bool `form:"show_system_entities,omitempty" json:"show_system_entities,omitempty"`
}

GetMonitoringSummaryParams defines parameters for GetMonitoringSummary.

type GetMonitoringSummaryResponse

type GetMonitoringSummaryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AllEntityTypesSummaryResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseGetMonitoringSummaryResponse

func ParseGetMonitoringSummaryResponse(rsp *http.Response) (*GetMonitoringSummaryResponse, error)

ParseGetMonitoringSummaryResponse parses an HTTP response from a GetMonitoringSummaryWithResponse call

func (GetMonitoringSummaryResponse) ContentType

func (r GetMonitoringSummaryResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetMonitoringSummaryResponse) GetBody

func (r GetMonitoringSummaryResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetMonitoringSummaryResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetMonitoringSummaryResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetMonitoringSummaryResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetMonitoringSummaryResponse) GetJSON403

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (GetMonitoringSummaryResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetMonitoringSummaryResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetMonitoringSummaryResponse) Status

Status returns HTTPResponse.Status

func (GetMonitoringSummaryResponse) StatusCode

func (r GetMonitoringSummaryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type JPDLocation

type JPDLocation struct {
	// CityName Optional within this object. City name; empty when not configured.
	CityName *string `json:"city_name,omitempty"`

	// CountryCode Optional within this object. ISO 3166-1 alpha-2 country code; empty when not configured.
	CountryCode *string `json:"country_code,omitempty"`
}

JPDLocation Where an instance runs, as configured on that instance.

type JPDResponse

type JPDResponse struct {
	// BaseUrl Optional within this object. The public base URL the instance reports for itself; may differ from url behind a proxy.
	BaseUrl *string `json:"base_url,omitempty"`

	// Id Optional within this object. Server-owned. The instance's service id.
	Id *string `json:"id,omitempty"`

	// Licenses Optional within this object. Licence entries; always one entry.
	Licenses *[]License `json:"licenses,omitempty"`

	// Local Optional within this object. True for the instance answering the request.
	Local *bool `json:"local,omitempty"`

	// Location Optional within this object. Configured location of the instance.
	Location *JPDLocation `json:"location,omitempty"`

	// Name Optional within this object. Display name of the instance.
	Name *string `json:"name,omitempty"`

	// Status Optional within this object. Last observed reachability.
	Status *JPDStatus `json:"status,omitempty"`

	// Url Optional within this object. URL this instance uses to reach it.
	Url *string `json:"url,omitempty"`
}

JPDResponse One instance known to this instance: itself or a paired peer.

type JPDStatus

type JPDStatus struct {
	// Code Optional within this object. ONLINE: reachable and trusted. OFFLINE: not reachable. PARTIAL: reachable but reporting an unhealthy service. UNAUTHORIZED: reachable but the pairing keys are no longer accepted.
	Code *JPDStatusCode `json:"code,omitempty"`

	// Message Optional within this object. Explanation for any code other than ONLINE; empty otherwise.
	Message *string `json:"message,omitempty"`
}

JPDStatus Reachability of an instance as last observed over the peer protocol.

type JPDStatusCode

type JPDStatusCode string

JPDStatusCode Optional within this object. ONLINE: reachable and trusted. OFFLINE: not reachable. PARTIAL: reachable but reporting an unhealthy service. UNAUTHORIZED: reachable but the pairing keys are no longer accepted.

const (
	JPDStatusCodeOFFLINE      JPDStatusCode = "OFFLINE"
	JPDStatusCodeONLINE       JPDStatusCode = "ONLINE"
	JPDStatusCodePARTIAL      JPDStatusCode = "PARTIAL"
	JPDStatusCodeUNAUTHORIZED JPDStatusCode = "UNAUTHORIZED"
)

Defines values for JPDStatusCode.

func (JPDStatusCode) Valid

func (e JPDStatusCode) Valid() bool

Valid indicates whether the value is a known member of the JPDStatusCode enum.

type License

type License struct {
	// Type Optional within this object. Licence type; always `artifactweave`.
	Type *string `json:"type,omitempty"`
}

License A licence entry reported for an instance.

type ListGridTopologiesResponse

type ListGridTopologiesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TopologiesListResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseListGridTopologiesResponse

func ParseListGridTopologiesResponse(rsp *http.Response) (*ListGridTopologiesResponse, error)

ParseListGridTopologiesResponse parses an HTTP response from a ListGridTopologiesWithResponse call

func (ListGridTopologiesResponse) ContentType

func (r ListGridTopologiesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListGridTopologiesResponse) GetBody

func (r ListGridTopologiesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListGridTopologiesResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListGridTopologiesResponse) GetJSON401

func (r ListGridTopologiesResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListGridTopologiesResponse) GetJSON403

func (r ListGridTopologiesResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListGridTopologiesResponse) GetJSON500

func (r ListGridTopologiesResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListGridTopologiesResponse) Status

Status returns HTTPResponse.Status

func (ListGridTopologiesResponse) StatusCode

func (r ListGridTopologiesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListJPDsParams

type ListJPDsParams struct {
	// Name Optional query parameter. Filter on instance name; * matches any run of characters.
	Name *string `form:"name,omitempty" json:"name,omitempty"`

	// Tag Optional query parameter. Filter on instance tag. Instances carry no tags, so only * (or omitting the filter) matches anything.
	Tag *string `form:"tag,omitempty" json:"tag,omitempty"`

	// Url Optional query parameter. Filter on instance URL; * matches any run of characters.
	Url *string `form:"url,omitempty" json:"url,omitempty"`

	// Status Optional query parameter. Filter on status code.
	Status *ListJPDsParamsStatus `form:"status,omitempty" json:"status,omitempty"`
}

ListJPDsParams defines parameters for ListJPDs.

type ListJPDsParamsStatus

type ListJPDsParamsStatus string

ListJPDsParamsStatus defines parameters for ListJPDs.

const (
	ListJPDsParamsStatusOFFLINE      ListJPDsParamsStatus = "OFFLINE"
	ListJPDsParamsStatusONLINE       ListJPDsParamsStatus = "ONLINE"
	ListJPDsParamsStatusPARTIAL      ListJPDsParamsStatus = "PARTIAL"
	ListJPDsParamsStatusUNAUTHORIZED ListJPDsParamsStatus = "UNAUTHORIZED"
)

Defines values for ListJPDsParamsStatus.

func (ListJPDsParamsStatus) Valid

func (e ListJPDsParamsStatus) Valid() bool

Valid indicates whether the value is a known member of the ListJPDsParamsStatus enum.

type ListJPDsResponse

type ListJPDsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *[]JPDResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorResponse
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseListJPDsResponse

func ParseListJPDsResponse(rsp *http.Response) (*ListJPDsResponse, error)

ParseListJPDsResponse parses an HTTP response from a ListJPDsWithResponse call

func (ListJPDsResponse) ContentType

func (r ListJPDsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListJPDsResponse) GetBody

func (r ListJPDsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListJPDsResponse) GetJSON200

func (r ListJPDsResponse) GetJSON200() *[]JPDResponse

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListJPDsResponse) GetJSON400

func (r ListJPDsResponse) GetJSON400() *ErrorResponse

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListJPDsResponse) GetJSON401

func (r ListJPDsResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListJPDsResponse) GetJSON403

func (r ListJPDsResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (ListJPDsResponse) GetJSON500

func (r ListJPDsResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListJPDsResponse) Status

func (r ListJPDsResponse) Status() string

Status returns HTTPResponse.Status

func (ListJPDsResponse) StatusCode

func (r ListJPDsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SiteRequest

type SiteRequest struct {
	// SiteName Required within this object. Name of a known instance (this one or a paired peer, as listed by GET /grid/api/v1/jpds). Unknown names answer 400 with a detail entry.
	SiteName string `json:"site_name"`
}

SiteRequest A site to include in a topology.

type StatusCounts

type StatusCounts struct {
	// Failure Required within this object. Entity and target pairs whose last delivery failed.
	Failure int64 `json:"failure"`

	// InProgress Required within this object. Pairs with a delivery queued or under way.
	InProgress int64 `json:"in_progress"`

	// Success Required within this object. Pairs whose last delivery was acknowledged.
	Success int64 `json:"success"`
}

StatusCounts Sync outcome counts for one entity type.

type TargetSyncStatus

type TargetSyncStatus struct {
	// Modified Optional within this object. RFC 3339 time the status last changed.
	Modified *time.Time `json:"modified,omitempty"`

	// SourceJpdId Required within this object. Service id of the sending instance.
	SourceJpdId string `json:"source_jpd_id"`

	// SourceSiteName Optional within this object. Name of the sending site.
	SourceSiteName *string `json:"source_site_name,omitempty"`

	// Status Required within this object. pending: queued, not yet sent. sent: delivered, not yet acknowledged. in_progress: being retried. success: acknowledged. failure: retries exhausted; see status_description.
	Status TargetSyncStatusStatus `json:"status"`

	// StatusDescription Optional within this object. The last error for failure; empty otherwise.
	StatusDescription *string `json:"status_description,omitempty"`

	// TargetJpdId Required within this object. Service id of the receiving instance.
	TargetJpdId string `json:"target_jpd_id"`

	// TargetSiteName Optional within this object. Name of the receiving site.
	TargetSiteName *string `json:"target_site_name,omitempty"`
}

TargetSyncStatus Delivery state of one entity from one site to another, taken from the peer outbox acknowledgements.

type TargetSyncStatusStatus

type TargetSyncStatusStatus string

TargetSyncStatusStatus Required within this object. pending: queued, not yet sent. sent: delivered, not yet acknowledged. in_progress: being retried. success: acknowledged. failure: retries exhausted; see status_description.

const (
	TargetSyncStatusStatusFailure    TargetSyncStatusStatus = "failure"
	TargetSyncStatusStatusInProgress TargetSyncStatusStatus = "in_progress"
	TargetSyncStatusStatusPending    TargetSyncStatusStatus = "pending"
	TargetSyncStatusStatusSent       TargetSyncStatusStatus = "sent"
	TargetSyncStatusStatusSuccess    TargetSyncStatusStatus = "success"
)

Defines values for TargetSyncStatusStatus.

func (TargetSyncStatusStatus) Valid

func (e TargetSyncStatusStatus) Valid() bool

Valid indicates whether the value is a known member of the TargetSyncStatusStatus enum.

type TopologiesListResponse

type TopologiesListResponse struct {
	// Topologies Required within this object. The topologies ordered by key.
	Topologies []TopologyResponse `json:"topologies"`

	// Total Required within this object. Number of topologies returned.
	Total int `json:"total"`
}

TopologiesListResponse Every topology on this instance.

type TopologyResponse

type TopologyResponse struct {
	// Created Optional within this object. Server-owned. RFC 3339 creation time.
	Created *time.Time `json:"created,omitempty"`

	// Description Optional within this object. Free text; empty when none.
	Description *string `json:"description,omitempty"`

	// Key Required within this object. Server-owned. Identifier derived from the name at creation and used in /topology/{key}.
	Key string `json:"key"`

	// Modified Optional within this object. Server-owned. RFC 3339 time of the last change.
	Modified *time.Time `json:"modified,omitempty"`

	// Name Required within this object. Display name.
	Name string `json:"name"`

	// Sites Required within this object. The sites and their state.
	Sites []TopologySiteResponse `json:"sites"`
}

TopologyResponse A stored topology.

type TopologySiteResponse

type TopologySiteResponse struct {
	// IsCurrent Optional within this object. True for the instance answering the request.
	IsCurrent *bool `json:"is_current,omitempty"`

	// Location Optional within this object. Configured location of the site.
	Location *JPDLocation `json:"location,omitempty"`

	// SiteName Optional within this object. The instance name.
	SiteName *string `json:"site_name,omitempty"`

	// Status Optional within this object. Connected when Access federation between this site and the others in the topology is configured and reachable; Disconnected otherwise, with the reason in status_description. A store that succeeds can still leave a site Disconnected.
	Status *TopologySiteResponseStatus `json:"status,omitempty"`

	// StatusDescription Optional within this object. Why a site is Disconnected; empty when Connected.
	StatusDescription *string `json:"status_description,omitempty"`
}

TopologySiteResponse One site of a stored topology and its federation state.

type TopologySiteResponseStatus

type TopologySiteResponseStatus string

TopologySiteResponseStatus Optional within this object. Connected when Access federation between this site and the others in the topology is configured and reachable; Disconnected otherwise, with the reason in status_description. A store that succeeds can still leave a site Disconnected.

const (
	Connected    TopologySiteResponseStatus = "Connected"
	Disconnected TopologySiteResponseStatus = "Disconnected"
)

Defines values for TopologySiteResponseStatus.

func (TopologySiteResponseStatus) Valid

func (e TopologySiteResponseStatus) Valid() bool

Valid indicates whether the value is a known member of the TopologySiteResponseStatus enum.

type TopologyValidationError

type TopologyValidationError struct {
	// Code Required within this object. A symbolic code such as VALIDATION_FAILED.
	Code string `json:"code"`

	// Details Optional within this object. One entry per failing site pair.
	Details *[]ValidationDetail `json:"details,omitempty"`

	// Message Required within this object. Human readable summary.
	Message string `json:"message"`
}

TopologyValidationError The /grid error envelope with per-site validation details; nothing was stored.

type UpdateGridTopologyJSONRequestBody

type UpdateGridTopologyJSONRequestBody = UpdateTopologyRequest

UpdateGridTopologyJSONRequestBody defines body for UpdateGridTopology for application/json ContentType.

type UpdateGridTopologyResponse

type UpdateGridTopologyResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *TopologyResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *TopologyValidationError
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorResponse
	// JSON403 the response for an HTTP 403 `application/json` response
	JSON403 *ErrorResponse
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorResponse
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorResponse
}

func ParseUpdateGridTopologyResponse

func ParseUpdateGridTopologyResponse(rsp *http.Response) (*UpdateGridTopologyResponse, error)

ParseUpdateGridTopologyResponse parses an HTTP response from a UpdateGridTopologyWithResponse call

func (UpdateGridTopologyResponse) ContentType

func (r UpdateGridTopologyResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (UpdateGridTopologyResponse) GetBody

func (r UpdateGridTopologyResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (UpdateGridTopologyResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (UpdateGridTopologyResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (UpdateGridTopologyResponse) GetJSON401

func (r UpdateGridTopologyResponse) GetJSON401() *ErrorResponse

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (UpdateGridTopologyResponse) GetJSON403

func (r UpdateGridTopologyResponse) GetJSON403() *ErrorResponse

GetJSON403 returns the response for an HTTP 403 `application/json` response

func (UpdateGridTopologyResponse) GetJSON404

func (r UpdateGridTopologyResponse) GetJSON404() *ErrorResponse

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (UpdateGridTopologyResponse) GetJSON500

func (r UpdateGridTopologyResponse) GetJSON500() *ErrorResponse

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (UpdateGridTopologyResponse) Status

Status returns HTTPResponse.Status

func (UpdateGridTopologyResponse) StatusCode

func (r UpdateGridTopologyResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type UpdateTopologyRequest

type UpdateTopologyRequest struct {
	// Description Optional within this object. New description.
	Description *string `json:"description,omitempty"`

	// Name Optional within this object. New display name.
	Name *string `json:"name,omitempty"`

	// Sites Optional within this object. Replaces the full site list; sites left out are disconnected from the topology.
	Sites *[]SiteRequest `json:"sites,omitempty"`
}

UpdateTopologyRequest Partial update of a topology; omitted fields keep their values. The key never changes, even when name does.

type ValidationDetail

type ValidationDetail struct {
	// Description Optional within this object. Human readable explanation.
	Description *string `json:"description,omitempty"`

	// SourceSite Optional within this object. The site the check ran from.
	SourceSite *string `json:"source_site,omitempty"`

	// Status Optional within this object. Short status of the failed check, such as unreachable or untrusted.
	Status *string `json:"status,omitempty"`

	// TargetSite Optional within this object. The site that failed.
	TargetSite *string `json:"target_site,omitempty"`
}

ValidationDetail Why one pair of sites failed validation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL