client

package
v0.0.4 Latest Latest
Warning

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

Go to latest
Published: Feb 12, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

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

Index

Constants

View Source
const (
	OauthTokenScopes = "oauthToken.Scopes"
)

Variables

This section is empty.

Functions

func NewDeleteCustomerManagedKeyIdRequest

func NewDeleteCustomerManagedKeyIdRequest(server string, customerManagedKeyId CustomerManagedKeyId) (*http.Request, error)

NewDeleteCustomerManagedKeyIdRequest generates requests for DeleteCustomerManagedKeyId

func NewDeleteInstanceIdRequest

func NewDeleteInstanceIdRequest(server string, instanceId InstanceId) (*http.Request, error)

NewDeleteInstanceIdRequest generates requests for DeleteInstanceId

func NewDeleteSessionRequest

func NewDeleteSessionRequest(server string, sessionId SessionId) (*http.Request, error)

NewDeleteSessionRequest generates requests for DeleteSession

func NewGetCustomerManagedKeyIdRequest

func NewGetCustomerManagedKeyIdRequest(server string, customerManagedKeyId CustomerManagedKeyId) (*http.Request, error)

NewGetCustomerManagedKeyIdRequest generates requests for GetCustomerManagedKeyId

func NewGetCustomerManagedKeysRequest

func NewGetCustomerManagedKeysRequest(server string, params *GetCustomerManagedKeysParams) (*http.Request, error)

NewGetCustomerManagedKeysRequest generates requests for GetCustomerManagedKeys

func NewGetInstanceIdRequest

func NewGetInstanceIdRequest(server string, instanceId InstanceId) (*http.Request, error)

NewGetInstanceIdRequest generates requests for GetInstanceId

func NewGetInstancesRequest

func NewGetInstancesRequest(server string, params *GetInstancesParams) (*http.Request, error)

NewGetInstancesRequest generates requests for GetInstances

func NewGetProjectIdRequest

func NewGetProjectIdRequest(server string, tenantId TenantId) (*http.Request, error)

NewGetProjectIdRequest generates requests for GetProjectId

func NewGetProjectMetricsIntegrationDetailsRequest

func NewGetProjectMetricsIntegrationDetailsRequest(server string, tenantId TenantId) (*http.Request, error)

NewGetProjectMetricsIntegrationDetailsRequest generates requests for GetProjectMetricsIntegrationDetails

func NewGetProjectsRequest

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

NewGetProjectsRequest generates requests for GetProjects

func NewGetSessionRequest

func NewGetSessionRequest(server string, sessionId SessionId) (*http.Request, error)

NewGetSessionRequest generates requests for GetSession

func NewGetSessionsRequest

func NewGetSessionsRequest(server string, params *GetSessionsParams) (*http.Request, error)

NewGetSessionsRequest generates requests for GetSessions

func NewGetSnapshotSnapshotidRequest

func NewGetSnapshotSnapshotidRequest(server string, instanceId InstanceId, snapshotId string) (*http.Request, error)

NewGetSnapshotSnapshotidRequest generates requests for GetSnapshotSnapshotid

func NewGetSnapshotsRequest

func NewGetSnapshotsRequest(server string, instanceId InstanceId, params *GetSnapshotsParams) (*http.Request, error)

NewGetSnapshotsRequest generates requests for GetSnapshots

func NewPatchInstanceIdRequest

func NewPatchInstanceIdRequest(server string, instanceId InstanceId, body PatchInstanceIdJSONRequestBody) (*http.Request, error)

NewPatchInstanceIdRequest calls the generic PatchInstanceId builder with application/json body

func NewPatchInstanceIdRequestWithBody

func NewPatchInstanceIdRequestWithBody(server string, instanceId InstanceId, contentType string, body io.Reader) (*http.Request, error)

NewPatchInstanceIdRequestWithBody generates requests for PatchInstanceId with any type of body

func NewPostCustomerManagedKeysRequest

func NewPostCustomerManagedKeysRequest(server string, body PostCustomerManagedKeysJSONRequestBody) (*http.Request, error)

NewPostCustomerManagedKeysRequest calls the generic PostCustomerManagedKeys builder with application/json body

func NewPostCustomerManagedKeysRequestWithBody

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

NewPostCustomerManagedKeysRequestWithBody generates requests for PostCustomerManagedKeys with any type of body

func NewPostInstancesRequest

func NewPostInstancesRequest(server string, body PostInstancesJSONRequestBody) (*http.Request, error)

NewPostInstancesRequest calls the generic PostInstances builder with application/json body

func NewPostInstancesRequestWithBody

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

NewPostInstancesRequestWithBody generates requests for PostInstances with any type of body

func NewPostInstancesSizingRequest

func NewPostInstancesSizingRequest(server string, body PostInstancesSizingJSONRequestBody) (*http.Request, error)

NewPostInstancesSizingRequest calls the generic PostInstancesSizing builder with application/json body

func NewPostInstancesSizingRequestWithBody

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

NewPostInstancesSizingRequestWithBody generates requests for PostInstancesSizing with any type of body

func NewPostOverwriteInstanceRequest

func NewPostOverwriteInstanceRequest(server string, instanceId InstanceId, body PostOverwriteInstanceJSONRequestBody) (*http.Request, error)

NewPostOverwriteInstanceRequest calls the generic PostOverwriteInstance builder with application/json body

func NewPostOverwriteInstanceRequestWithBody

func NewPostOverwriteInstanceRequestWithBody(server string, instanceId InstanceId, contentType string, body io.Reader) (*http.Request, error)

NewPostOverwriteInstanceRequestWithBody generates requests for PostOverwriteInstance with any type of body

func NewPostPauseInstanceRequest

func NewPostPauseInstanceRequest(server string, instanceId string, body PostPauseInstanceJSONRequestBody) (*http.Request, error)

NewPostPauseInstanceRequest calls the generic PostPauseInstance builder with application/json body

func NewPostPauseInstanceRequestWithBody

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

NewPostPauseInstanceRequestWithBody generates requests for PostPauseInstance with any type of body

func NewPostRestoreSnapshotRequest

func NewPostRestoreSnapshotRequest(server string, instanceId InstanceId, snapshotId string, body PostRestoreSnapshotJSONRequestBody) (*http.Request, error)

NewPostRestoreSnapshotRequest calls the generic PostRestoreSnapshot builder with application/json body

func NewPostRestoreSnapshotRequestWithBody

func NewPostRestoreSnapshotRequestWithBody(server string, instanceId InstanceId, snapshotId string, contentType string, body io.Reader) (*http.Request, error)

NewPostRestoreSnapshotRequestWithBody generates requests for PostRestoreSnapshot with any type of body

func NewPostResumeInstanceRequest

func NewPostResumeInstanceRequest(server string, instanceId string, body PostResumeInstanceJSONRequestBody) (*http.Request, error)

NewPostResumeInstanceRequest calls the generic PostResumeInstance builder with application/json body

func NewPostResumeInstanceRequestWithBody

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

NewPostResumeInstanceRequestWithBody generates requests for PostResumeInstance with any type of body

func NewPostSessionRequest

func NewPostSessionRequest(server string, body PostSessionJSONRequestBody) (*http.Request, error)

NewPostSessionRequest calls the generic PostSession builder with application/json body

func NewPostSessionRequestWithBody

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

NewPostSessionRequestWithBody generates requests for PostSession with any type of body

func NewPostSessionsSizingRequest

func NewPostSessionsSizingRequest(server string, body PostSessionsSizingJSONRequestBody) (*http.Request, error)

NewPostSessionsSizingRequest calls the generic PostSessionsSizing builder with application/json body

func NewPostSessionsSizingRequestWithBody

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

NewPostSessionsSizingRequestWithBody generates requests for PostSessionsSizing with any type of body

func NewPostSnapshotsRequest

func NewPostSnapshotsRequest(server string, instanceId InstanceId, body PostSnapshotsJSONRequestBody) (*http.Request, error)

NewPostSnapshotsRequest calls the generic PostSnapshots builder with application/json body

func NewPostSnapshotsRequestWithBody

func NewPostSnapshotsRequestWithBody(server string, instanceId InstanceId, contentType string, body io.Reader) (*http.Request, error)

NewPostSnapshotsRequestWithBody generates requests for PostSnapshots with any type of body

func NewPostUpgradeInstanceRequest

func NewPostUpgradeInstanceRequest(server string, instanceId string, body PostUpgradeInstanceJSONRequestBody) (*http.Request, error)

NewPostUpgradeInstanceRequest calls the generic PostUpgradeInstance builder with application/json body

func NewPostUpgradeInstanceRequestWithBody

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

NewPostUpgradeInstanceRequestWithBody generates requests for PostUpgradeInstance with any type of body

Types

type BadGateway

type BadGateway struct {
	// contains filtered or unexported fields
}

BadGateway defines model for BadGateway.

func (BadGateway) AsError

func (t BadGateway) AsError() (Error, error)

AsError returns the union data inside the BadGateway as a Error

func (BadGateway) AsMiddlewareError

func (t BadGateway) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the BadGateway as a MiddlewareError

func (*BadGateway) FromError

func (t *BadGateway) FromError(v Error) error

FromError overwrites any union data inside the BadGateway as the provided Error

func (*BadGateway) FromMiddlewareError

func (t *BadGateway) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the BadGateway as the provided MiddlewareError

func (BadGateway) MarshalJSON

func (t BadGateway) MarshalJSON() ([]byte, error)

func (*BadGateway) MergeError

func (t *BadGateway) MergeError(v Error) error

MergeError performs a merge with any union data inside the BadGateway, using the provided Error

func (*BadGateway) MergeMiddlewareError

func (t *BadGateway) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the BadGateway, using the provided MiddlewareError

func (*BadGateway) UnmarshalJSON

func (t *BadGateway) UnmarshalJSON(b []byte) error

type BadRequest

type BadRequest = Error

BadRequest Used for describing one or more errors returned by an endpoint.

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) DeleteCustomerManagedKeyId

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

func (*Client) DeleteInstanceId

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

func (*Client) DeleteSession

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

func (*Client) GetCustomerManagedKeyId

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

func (*Client) GetCustomerManagedKeys

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

func (*Client) GetInstanceId

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

func (*Client) GetInstances

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

func (*Client) GetProjectId

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

func (*Client) GetProjectMetricsIntegrationDetails

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

func (*Client) GetProjects

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

func (*Client) GetSession

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

func (*Client) GetSessions

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

func (*Client) GetSnapshotSnapshotid

func (c *Client) GetSnapshotSnapshotid(ctx context.Context, instanceId InstanceId, snapshotId string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetSnapshots

func (c *Client) GetSnapshots(ctx context.Context, instanceId InstanceId, params *GetSnapshotsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchInstanceId

func (c *Client) PatchInstanceId(ctx context.Context, instanceId InstanceId, body PatchInstanceIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchInstanceIdWithBody

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

func (*Client) PostCustomerManagedKeys

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

func (*Client) PostCustomerManagedKeysWithBody

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

func (*Client) PostInstances

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

func (*Client) PostInstancesSizing

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

func (*Client) PostInstancesSizingWithBody

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

func (*Client) PostInstancesWithBody

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

func (*Client) PostOverwriteInstance

func (c *Client) PostOverwriteInstance(ctx context.Context, instanceId InstanceId, body PostOverwriteInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostOverwriteInstanceWithBody

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

func (*Client) PostPauseInstance

func (c *Client) PostPauseInstance(ctx context.Context, instanceId string, body PostPauseInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostPauseInstanceWithBody

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

func (*Client) PostRestoreSnapshot

func (c *Client) PostRestoreSnapshot(ctx context.Context, instanceId InstanceId, snapshotId string, body PostRestoreSnapshotJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostRestoreSnapshotWithBody

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

func (*Client) PostResumeInstance

func (c *Client) PostResumeInstance(ctx context.Context, instanceId string, body PostResumeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostResumeInstanceWithBody

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

func (*Client) PostSession

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

func (*Client) PostSessionWithBody

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

func (*Client) PostSessionsSizing

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

func (*Client) PostSessionsSizingWithBody

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

func (*Client) PostSnapshots

func (c *Client) PostSnapshots(ctx context.Context, instanceId InstanceId, body PostSnapshotsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostSnapshotsWithBody

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

func (*Client) PostUpgradeInstance

func (c *Client) PostUpgradeInstance(ctx context.Context, instanceId string, body PostUpgradeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostUpgradeInstanceWithBody

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

type ClientInterface

type ClientInterface interface {
	// GetCustomerManagedKeys request
	GetCustomerManagedKeys(ctx context.Context, params *GetCustomerManagedKeysParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostCustomerManagedKeysWithBody request with any body
	PostCustomerManagedKeysWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostCustomerManagedKeys(ctx context.Context, body PostCustomerManagedKeysJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteCustomerManagedKeyId request
	DeleteCustomerManagedKeyId(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCustomerManagedKeyId request
	GetCustomerManagedKeyId(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSessions request
	GetSessions(ctx context.Context, params *GetSessionsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostSessionWithBody request with any body
	PostSessionWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostSession(ctx context.Context, body PostSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostSessionsSizingWithBody request with any body
	PostSessionsSizingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostSessionsSizing(ctx context.Context, body PostSessionsSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteSession request
	DeleteSession(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSession request
	GetSession(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstances request
	GetInstances(ctx context.Context, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostInstancesWithBody request with any body
	PostInstancesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostInstances(ctx context.Context, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostInstancesSizingWithBody request with any body
	PostInstancesSizingWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostInstancesSizing(ctx context.Context, body PostInstancesSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteInstanceId request
	DeleteInstanceId(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetInstanceId request
	GetInstanceId(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchInstanceIdWithBody request with any body
	PatchInstanceIdWithBody(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PatchInstanceId(ctx context.Context, instanceId InstanceId, body PatchInstanceIdJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostOverwriteInstanceWithBody request with any body
	PostOverwriteInstanceWithBody(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostOverwriteInstance(ctx context.Context, instanceId InstanceId, body PostOverwriteInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostPauseInstanceWithBody request with any body
	PostPauseInstanceWithBody(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostPauseInstance(ctx context.Context, instanceId string, body PostPauseInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostResumeInstanceWithBody request with any body
	PostResumeInstanceWithBody(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostResumeInstance(ctx context.Context, instanceId string, body PostResumeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSnapshots request
	GetSnapshots(ctx context.Context, instanceId InstanceId, params *GetSnapshotsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostSnapshotsWithBody request with any body
	PostSnapshotsWithBody(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostSnapshots(ctx context.Context, instanceId InstanceId, body PostSnapshotsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSnapshotSnapshotid request
	GetSnapshotSnapshotid(ctx context.Context, instanceId InstanceId, snapshotId string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostRestoreSnapshotWithBody request with any body
	PostRestoreSnapshotWithBody(ctx context.Context, instanceId InstanceId, snapshotId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostRestoreSnapshot(ctx context.Context, instanceId InstanceId, snapshotId string, body PostRestoreSnapshotJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostUpgradeInstanceWithBody request with any body
	PostUpgradeInstanceWithBody(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostUpgradeInstance(ctx context.Context, instanceId string, body PostUpgradeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProjects request
	GetProjects(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProjectId request
	GetProjectId(ctx context.Context, tenantId TenantId, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetProjectMetricsIntegrationDetails request
	GetProjectMetricsIntegrationDetails(ctx context.Context, tenantId TenantId, 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) DeleteCustomerManagedKeyIdWithResponse

func (c *ClientWithResponses) DeleteCustomerManagedKeyIdWithResponse(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*DeleteCustomerManagedKeyIdResponse, error)

DeleteCustomerManagedKeyIdWithResponse request returning *DeleteCustomerManagedKeyIdResponse

func (*ClientWithResponses) DeleteInstanceIdWithResponse

func (c *ClientWithResponses) DeleteInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*DeleteInstanceIdResponse, error)

DeleteInstanceIdWithResponse request returning *DeleteInstanceIdResponse

func (*ClientWithResponses) DeleteSessionWithResponse

func (c *ClientWithResponses) DeleteSessionWithResponse(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*DeleteSessionResponse, error)

DeleteSessionWithResponse request returning *DeleteSessionResponse

func (*ClientWithResponses) GetCustomerManagedKeyIdWithResponse

func (c *ClientWithResponses) GetCustomerManagedKeyIdWithResponse(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*GetCustomerManagedKeyIdResponse, error)

GetCustomerManagedKeyIdWithResponse request returning *GetCustomerManagedKeyIdResponse

func (*ClientWithResponses) GetCustomerManagedKeysWithResponse

func (c *ClientWithResponses) GetCustomerManagedKeysWithResponse(ctx context.Context, params *GetCustomerManagedKeysParams, reqEditors ...RequestEditorFn) (*GetCustomerManagedKeysResponse, error)

GetCustomerManagedKeysWithResponse request returning *GetCustomerManagedKeysResponse

func (*ClientWithResponses) GetInstanceIdWithResponse

func (c *ClientWithResponses) GetInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*GetInstanceIdResponse, error)

GetInstanceIdWithResponse request returning *GetInstanceIdResponse

func (*ClientWithResponses) GetInstancesWithResponse

func (c *ClientWithResponses) GetInstancesWithResponse(ctx context.Context, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

GetInstancesWithResponse request returning *GetInstancesResponse

func (*ClientWithResponses) GetProjectIdWithResponse

func (c *ClientWithResponses) GetProjectIdWithResponse(ctx context.Context, tenantId TenantId, reqEditors ...RequestEditorFn) (*GetProjectIdResponse, error)

GetProjectIdWithResponse request returning *GetProjectIdResponse

func (*ClientWithResponses) GetProjectMetricsIntegrationDetailsWithResponse

func (c *ClientWithResponses) GetProjectMetricsIntegrationDetailsWithResponse(ctx context.Context, tenantId TenantId, reqEditors ...RequestEditorFn) (*GetProjectMetricsIntegrationDetailsResponse, error)

GetProjectMetricsIntegrationDetailsWithResponse request returning *GetProjectMetricsIntegrationDetailsResponse

func (*ClientWithResponses) GetProjectsWithResponse

func (c *ClientWithResponses) GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

GetProjectsWithResponse request returning *GetProjectsResponse

func (*ClientWithResponses) GetSessionWithResponse

func (c *ClientWithResponses) GetSessionWithResponse(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

GetSessionWithResponse request returning *GetSessionResponse

func (*ClientWithResponses) GetSessionsWithResponse

func (c *ClientWithResponses) GetSessionsWithResponse(ctx context.Context, params *GetSessionsParams, reqEditors ...RequestEditorFn) (*GetSessionsResponse, error)

GetSessionsWithResponse request returning *GetSessionsResponse

func (*ClientWithResponses) GetSnapshotSnapshotidWithResponse

func (c *ClientWithResponses) GetSnapshotSnapshotidWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, reqEditors ...RequestEditorFn) (*GetSnapshotSnapshotidResponse, error)

GetSnapshotSnapshotidWithResponse request returning *GetSnapshotSnapshotidResponse

func (*ClientWithResponses) GetSnapshotsWithResponse

func (c *ClientWithResponses) GetSnapshotsWithResponse(ctx context.Context, instanceId InstanceId, params *GetSnapshotsParams, reqEditors ...RequestEditorFn) (*GetSnapshotsResponse, error)

GetSnapshotsWithResponse request returning *GetSnapshotsResponse

func (*ClientWithResponses) PatchInstanceIdWithBodyWithResponse

func (c *ClientWithResponses) PatchInstanceIdWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchInstanceIdResponse, error)

PatchInstanceIdWithBodyWithResponse request with arbitrary body returning *PatchInstanceIdResponse

func (*ClientWithResponses) PatchInstanceIdWithResponse

func (c *ClientWithResponses) PatchInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, body PatchInstanceIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchInstanceIdResponse, error)

func (*ClientWithResponses) PostCustomerManagedKeysWithBodyWithResponse

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

PostCustomerManagedKeysWithBodyWithResponse request with arbitrary body returning *PostCustomerManagedKeysResponse

func (*ClientWithResponses) PostCustomerManagedKeysWithResponse

func (c *ClientWithResponses) PostCustomerManagedKeysWithResponse(ctx context.Context, body PostCustomerManagedKeysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCustomerManagedKeysResponse, error)

func (*ClientWithResponses) PostInstancesSizingWithBodyWithResponse

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

PostInstancesSizingWithBodyWithResponse request with arbitrary body returning *PostInstancesSizingResponse

func (*ClientWithResponses) PostInstancesSizingWithResponse

func (c *ClientWithResponses) PostInstancesSizingWithResponse(ctx context.Context, body PostInstancesSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesSizingResponse, error)

func (*ClientWithResponses) PostInstancesWithBodyWithResponse

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

PostInstancesWithBodyWithResponse request with arbitrary body returning *PostInstancesResponse

func (*ClientWithResponses) PostInstancesWithResponse

func (c *ClientWithResponses) PostInstancesWithResponse(ctx context.Context, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

func (*ClientWithResponses) PostOverwriteInstanceWithBodyWithResponse

func (c *ClientWithResponses) PostOverwriteInstanceWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOverwriteInstanceResponse, error)

PostOverwriteInstanceWithBodyWithResponse request with arbitrary body returning *PostOverwriteInstanceResponse

func (*ClientWithResponses) PostOverwriteInstanceWithResponse

func (c *ClientWithResponses) PostOverwriteInstanceWithResponse(ctx context.Context, instanceId InstanceId, body PostOverwriteInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostOverwriteInstanceResponse, error)

func (*ClientWithResponses) PostPauseInstanceWithBodyWithResponse

func (c *ClientWithResponses) PostPauseInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPauseInstanceResponse, error)

PostPauseInstanceWithBodyWithResponse request with arbitrary body returning *PostPauseInstanceResponse

func (*ClientWithResponses) PostPauseInstanceWithResponse

func (c *ClientWithResponses) PostPauseInstanceWithResponse(ctx context.Context, instanceId string, body PostPauseInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPauseInstanceResponse, error)

func (*ClientWithResponses) PostRestoreSnapshotWithBodyWithResponse

func (c *ClientWithResponses) PostRestoreSnapshotWithBodyWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRestoreSnapshotResponse, error)

PostRestoreSnapshotWithBodyWithResponse request with arbitrary body returning *PostRestoreSnapshotResponse

func (*ClientWithResponses) PostRestoreSnapshotWithResponse

func (c *ClientWithResponses) PostRestoreSnapshotWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, body PostRestoreSnapshotJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRestoreSnapshotResponse, error)

func (*ClientWithResponses) PostResumeInstanceWithBodyWithResponse

func (c *ClientWithResponses) PostResumeInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostResumeInstanceResponse, error)

PostResumeInstanceWithBodyWithResponse request with arbitrary body returning *PostResumeInstanceResponse

func (*ClientWithResponses) PostResumeInstanceWithResponse

func (c *ClientWithResponses) PostResumeInstanceWithResponse(ctx context.Context, instanceId string, body PostResumeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostResumeInstanceResponse, error)

func (*ClientWithResponses) PostSessionWithBodyWithResponse

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

PostSessionWithBodyWithResponse request with arbitrary body returning *PostSessionResponse

func (*ClientWithResponses) PostSessionWithResponse

func (c *ClientWithResponses) PostSessionWithResponse(ctx context.Context, body PostSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSessionResponse, error)

func (*ClientWithResponses) PostSessionsSizingWithBodyWithResponse

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

PostSessionsSizingWithBodyWithResponse request with arbitrary body returning *PostSessionsSizingResponse

func (*ClientWithResponses) PostSessionsSizingWithResponse

func (c *ClientWithResponses) PostSessionsSizingWithResponse(ctx context.Context, body PostSessionsSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSessionsSizingResponse, error)

func (*ClientWithResponses) PostSnapshotsWithBodyWithResponse

func (c *ClientWithResponses) PostSnapshotsWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSnapshotsResponse, error)

PostSnapshotsWithBodyWithResponse request with arbitrary body returning *PostSnapshotsResponse

func (*ClientWithResponses) PostSnapshotsWithResponse

func (c *ClientWithResponses) PostSnapshotsWithResponse(ctx context.Context, instanceId InstanceId, body PostSnapshotsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSnapshotsResponse, error)

func (*ClientWithResponses) PostUpgradeInstanceWithBodyWithResponse

func (c *ClientWithResponses) PostUpgradeInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostUpgradeInstanceResponse, error)

PostUpgradeInstanceWithBodyWithResponse request with arbitrary body returning *PostUpgradeInstanceResponse

func (*ClientWithResponses) PostUpgradeInstanceWithResponse

func (c *ClientWithResponses) PostUpgradeInstanceWithResponse(ctx context.Context, instanceId string, body PostUpgradeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostUpgradeInstanceResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetCustomerManagedKeysWithResponse request
	GetCustomerManagedKeysWithResponse(ctx context.Context, params *GetCustomerManagedKeysParams, reqEditors ...RequestEditorFn) (*GetCustomerManagedKeysResponse, error)

	// PostCustomerManagedKeysWithBodyWithResponse request with any body
	PostCustomerManagedKeysWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostCustomerManagedKeysResponse, error)

	PostCustomerManagedKeysWithResponse(ctx context.Context, body PostCustomerManagedKeysJSONRequestBody, reqEditors ...RequestEditorFn) (*PostCustomerManagedKeysResponse, error)

	// DeleteCustomerManagedKeyIdWithResponse request
	DeleteCustomerManagedKeyIdWithResponse(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*DeleteCustomerManagedKeyIdResponse, error)

	// GetCustomerManagedKeyIdWithResponse request
	GetCustomerManagedKeyIdWithResponse(ctx context.Context, customerManagedKeyId CustomerManagedKeyId, reqEditors ...RequestEditorFn) (*GetCustomerManagedKeyIdResponse, error)

	// GetSessionsWithResponse request
	GetSessionsWithResponse(ctx context.Context, params *GetSessionsParams, reqEditors ...RequestEditorFn) (*GetSessionsResponse, error)

	// PostSessionWithBodyWithResponse request with any body
	PostSessionWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSessionResponse, error)

	PostSessionWithResponse(ctx context.Context, body PostSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSessionResponse, error)

	// PostSessionsSizingWithBodyWithResponse request with any body
	PostSessionsSizingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSessionsSizingResponse, error)

	PostSessionsSizingWithResponse(ctx context.Context, body PostSessionsSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSessionsSizingResponse, error)

	// DeleteSessionWithResponse request
	DeleteSessionWithResponse(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*DeleteSessionResponse, error)

	// GetSessionWithResponse request
	GetSessionWithResponse(ctx context.Context, sessionId SessionId, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

	// GetInstancesWithResponse request
	GetInstancesWithResponse(ctx context.Context, params *GetInstancesParams, reqEditors ...RequestEditorFn) (*GetInstancesResponse, error)

	// PostInstancesWithBodyWithResponse request with any body
	PostInstancesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

	PostInstancesWithResponse(ctx context.Context, body PostInstancesJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesResponse, error)

	// PostInstancesSizingWithBodyWithResponse request with any body
	PostInstancesSizingWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostInstancesSizingResponse, error)

	PostInstancesSizingWithResponse(ctx context.Context, body PostInstancesSizingJSONRequestBody, reqEditors ...RequestEditorFn) (*PostInstancesSizingResponse, error)

	// DeleteInstanceIdWithResponse request
	DeleteInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*DeleteInstanceIdResponse, error)

	// GetInstanceIdWithResponse request
	GetInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, reqEditors ...RequestEditorFn) (*GetInstanceIdResponse, error)

	// PatchInstanceIdWithBodyWithResponse request with any body
	PatchInstanceIdWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchInstanceIdResponse, error)

	PatchInstanceIdWithResponse(ctx context.Context, instanceId InstanceId, body PatchInstanceIdJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchInstanceIdResponse, error)

	// PostOverwriteInstanceWithBodyWithResponse request with any body
	PostOverwriteInstanceWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostOverwriteInstanceResponse, error)

	PostOverwriteInstanceWithResponse(ctx context.Context, instanceId InstanceId, body PostOverwriteInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostOverwriteInstanceResponse, error)

	// PostPauseInstanceWithBodyWithResponse request with any body
	PostPauseInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostPauseInstanceResponse, error)

	PostPauseInstanceWithResponse(ctx context.Context, instanceId string, body PostPauseInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostPauseInstanceResponse, error)

	// PostResumeInstanceWithBodyWithResponse request with any body
	PostResumeInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostResumeInstanceResponse, error)

	PostResumeInstanceWithResponse(ctx context.Context, instanceId string, body PostResumeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostResumeInstanceResponse, error)

	// GetSnapshotsWithResponse request
	GetSnapshotsWithResponse(ctx context.Context, instanceId InstanceId, params *GetSnapshotsParams, reqEditors ...RequestEditorFn) (*GetSnapshotsResponse, error)

	// PostSnapshotsWithBodyWithResponse request with any body
	PostSnapshotsWithBodyWithResponse(ctx context.Context, instanceId InstanceId, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSnapshotsResponse, error)

	PostSnapshotsWithResponse(ctx context.Context, instanceId InstanceId, body PostSnapshotsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSnapshotsResponse, error)

	// GetSnapshotSnapshotidWithResponse request
	GetSnapshotSnapshotidWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, reqEditors ...RequestEditorFn) (*GetSnapshotSnapshotidResponse, error)

	// PostRestoreSnapshotWithBodyWithResponse request with any body
	PostRestoreSnapshotWithBodyWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostRestoreSnapshotResponse, error)

	PostRestoreSnapshotWithResponse(ctx context.Context, instanceId InstanceId, snapshotId string, body PostRestoreSnapshotJSONRequestBody, reqEditors ...RequestEditorFn) (*PostRestoreSnapshotResponse, error)

	// PostUpgradeInstanceWithBodyWithResponse request with any body
	PostUpgradeInstanceWithBodyWithResponse(ctx context.Context, instanceId string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostUpgradeInstanceResponse, error)

	PostUpgradeInstanceWithResponse(ctx context.Context, instanceId string, body PostUpgradeInstanceJSONRequestBody, reqEditors ...RequestEditorFn) (*PostUpgradeInstanceResponse, error)

	// GetProjectsWithResponse request
	GetProjectsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetProjectsResponse, error)

	// GetProjectIdWithResponse request
	GetProjectIdWithResponse(ctx context.Context, tenantId TenantId, reqEditors ...RequestEditorFn) (*GetProjectIdResponse, error)

	// GetProjectMetricsIntegrationDetailsWithResponse request
	GetProjectMetricsIntegrationDetailsWithResponse(ctx context.Context, tenantId TenantId, reqEditors ...RequestEditorFn) (*GetProjectMetricsIntegrationDetailsResponse, error)
}

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

type CloudProvider

type CloudProvider string

CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.

const (
	CloudProviderAws   CloudProvider = "aws"
	CloudProviderAzure CloudProvider = "azure"
	CloudProviderGcp   CloudProvider = "gcp"
)

Defines values for CloudProvider.

type Conflict

type Conflict = Error

Conflict Used for describing one or more errors returned by an endpoint.

type CustomerManagedKey

type CustomerManagedKey struct {
	Data struct {
		// CloudProvider The cloud provider of the key
		CloudProvider CustomerManagedKeyDataCloudProvider `json:"cloud_provider"`

		// Created Timestamp when the key was created
		Created string `json:"created"`

		// Id The id of the key
		Id string `json:"id"`

		// InstanceType The type of instances this key was configured for. Either 'enterprise-db' or 'enterprise-ds'.
		InstanceType CustomerManagedKeyDataInstanceType `json:"instance_type"`

		// KeyId The ID of the key in your Cloud Provider. Equal to Key ARN for AWS.
		KeyId string `json:"key_id"`

		// Name The name of the key
		Name string `json:"name"`

		// Region The region where this key was configured for. The key will be only be available for encrypting instances in this region.
		Region string `json:"region"`

		// Status The status of the key
		Status string `json:"status"`

		// TenantId The project to which the key belongs to
		TenantId string `json:"tenant_id"`
	} `json:"data"`
}

CustomerManagedKey Describes a Customer Managed Key

type CustomerManagedKeyDataCloudProvider

type CustomerManagedKeyDataCloudProvider string

CustomerManagedKeyDataCloudProvider The cloud provider of the key

const (
	CustomerManagedKeyDataCloudProviderAws   CustomerManagedKeyDataCloudProvider = "aws"
	CustomerManagedKeyDataCloudProviderAzure CustomerManagedKeyDataCloudProvider = "azure"
	CustomerManagedKeyDataCloudProviderGcp   CustomerManagedKeyDataCloudProvider = "gcp"
)

Defines values for CustomerManagedKeyDataCloudProvider.

type CustomerManagedKeyDataInstanceType

type CustomerManagedKeyDataInstanceType string

CustomerManagedKeyDataInstanceType The type of instances this key was configured for. Either 'enterprise-db' or 'enterprise-ds'.

const (
	CustomerManagedKeyDataInstanceTypeEnterpriseDb CustomerManagedKeyDataInstanceType = "enterprise-db"
	CustomerManagedKeyDataInstanceTypeEnterpriseDs CustomerManagedKeyDataInstanceType = "enterprise-ds"
)

Defines values for CustomerManagedKeyDataInstanceType.

type CustomerManagedKeyId

type CustomerManagedKeyId = string

CustomerManagedKeyId defines model for customerManagedKeyId.

type CustomerManagedKeyNotFound

type CustomerManagedKeyNotFound = Error

CustomerManagedKeyNotFound Used for describing one or more errors returned by an endpoint.

type DeleteCustomerManagedKeyIdResponse

type DeleteCustomerManagedKeyIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *Error
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *CustomerManagedKeyNotFound
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseDeleteCustomerManagedKeyIdResponse

func ParseDeleteCustomerManagedKeyIdResponse(rsp *http.Response) (*DeleteCustomerManagedKeyIdResponse, error)

ParseDeleteCustomerManagedKeyIdResponse parses an HTTP response from a DeleteCustomerManagedKeyIdWithResponse call

func (DeleteCustomerManagedKeyIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteCustomerManagedKeyIdResponse) StatusCode

func (r DeleteCustomerManagedKeyIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteInstanceIdResponse

type DeleteInstanceIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseDeleteInstanceIdResponse

func ParseDeleteInstanceIdResponse(rsp *http.Response) (*DeleteInstanceIdResponse, error)

ParseDeleteInstanceIdResponse parses an HTTP response from a DeleteInstanceIdWithResponse call

func (DeleteInstanceIdResponse) Status

func (r DeleteInstanceIdResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteInstanceIdResponse) StatusCode

func (r DeleteInstanceIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteSessionResponse

type DeleteSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		Data *struct {
			Id *string `json:"id,omitempty"`
		} `json:"data,omitempty"`

		// Errors Used for describing one or more errors returned by an endpoint.
		Errors *Error `json:"errors,omitempty"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *SessionNotFound
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseDeleteSessionResponse

func ParseDeleteSessionResponse(rsp *http.Response) (*DeleteSessionResponse, error)

ParseDeleteSessionResponse parses an HTTP response from a DeleteSessionWithResponse call

func (DeleteSessionResponse) Status

func (r DeleteSessionResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteSessionResponse) StatusCode

func (r DeleteSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	Errors []struct {
		// Field The name of the property in the request body that this error refers to, if applicable.
		Field *string `json:"field,omitempty"`

		// Message Detailed explanation of an error that has been encountered. Aimed at developers debugging issues, not recommended to be passed onto the end user.
		Message string `json:"message"`

		// Reason The category of the error.
		Reason string `json:"reason"`
	} `json:"errors"`
}

Error Used for describing one or more errors returned by an endpoint.

type Forbidden

type Forbidden struct {
	// contains filtered or unexported fields
}

Forbidden defines model for Forbidden.

func (Forbidden) AsError

func (t Forbidden) AsError() (Error, error)

AsError returns the union data inside the Forbidden as a Error

func (Forbidden) AsMiddlewareError

func (t Forbidden) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the Forbidden as a MiddlewareError

func (*Forbidden) FromError

func (t *Forbidden) FromError(v Error) error

FromError overwrites any union data inside the Forbidden as the provided Error

func (*Forbidden) FromMiddlewareError

func (t *Forbidden) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the Forbidden as the provided MiddlewareError

func (Forbidden) MarshalJSON

func (t Forbidden) MarshalJSON() ([]byte, error)

func (*Forbidden) MergeError

func (t *Forbidden) MergeError(v Error) error

MergeError performs a merge with any union data inside the Forbidden, using the provided Error

func (*Forbidden) MergeMiddlewareError

func (t *Forbidden) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the Forbidden, using the provided MiddlewareError

func (*Forbidden) UnmarshalJSON

func (t *Forbidden) UnmarshalJSON(b []byte) error

type GatewayTimeout

type GatewayTimeout struct {
	// contains filtered or unexported fields
}

GatewayTimeout defines model for GatewayTimeout.

func (GatewayTimeout) AsError

func (t GatewayTimeout) AsError() (Error, error)

AsError returns the union data inside the GatewayTimeout as a Error

func (GatewayTimeout) AsMiddlewareError

func (t GatewayTimeout) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the GatewayTimeout as a MiddlewareError

func (*GatewayTimeout) FromError

func (t *GatewayTimeout) FromError(v Error) error

FromError overwrites any union data inside the GatewayTimeout as the provided Error

func (*GatewayTimeout) FromMiddlewareError

func (t *GatewayTimeout) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the GatewayTimeout as the provided MiddlewareError

func (GatewayTimeout) MarshalJSON

func (t GatewayTimeout) MarshalJSON() ([]byte, error)

func (*GatewayTimeout) MergeError

func (t *GatewayTimeout) MergeError(v Error) error

MergeError performs a merge with any union data inside the GatewayTimeout, using the provided Error

func (*GatewayTimeout) MergeMiddlewareError

func (t *GatewayTimeout) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the GatewayTimeout, using the provided MiddlewareError

func (*GatewayTimeout) UnmarshalJSON

func (t *GatewayTimeout) UnmarshalJSON(b []byte) error

type GdsSessionDetails

type GdsSessionDetails struct {
	Data *struct {
		// CloudProvider The cloud provider of the session
		CloudProvider *string `json:"cloud_provider,omitempty"`

		// CreatedAt The timestamp when the session was created
		CreatedAt *string `json:"created_at,omitempty"`

		// DatabaseUuid The UUID of the Neo4j database from which the session was created from. Empty if not attached to any instance.
		DatabaseUuid *string `json:"database_uuid,omitempty"`

		// ExpiryDate The timestamp when the session will expire
		ExpiryDate *string `json:"expiry_date,omitempty"`

		// Host The host where the session is running
		Host string `json:"host"`

		// Id The unique identifier for this session
		Id string `json:"id"`

		// InstanceId The id for the instance the session is associated with. Empty if not attached to any instance.
		InstanceId *string `json:"instance_id,omitempty"`

		// Memory The size of the session main memory in GB
		Memory string `json:"memory"`

		// Name The name of the session
		Name string `json:"name"`

		// Region The region where the session is hosted
		Region *string `json:"region,omitempty"`

		// Status The status of the session
		Status GdsSessionDetailsDataStatus `json:"status"`

		// TenantId The project to which the instance belongs to
		TenantId string `json:"tenant_id"`

		// Ttl The time to live of an inactive session before it expires.
		Ttl *int `json:"ttl,omitempty"`

		// UserId The user who created the session
		UserId string `json:"user_id"`
	} `json:"data,omitempty"`
}

GdsSessionDetails Describes a GDS Session

type GdsSessionDetailsDataStatus

type GdsSessionDetailsDataStatus string

GdsSessionDetailsDataStatus The status of the session

const (
	GdsSessionDetailsDataStatusCreating GdsSessionDetailsDataStatus = "Creating"
	GdsSessionDetailsDataStatusExpired  GdsSessionDetailsDataStatus = "Expired"
	GdsSessionDetailsDataStatusFailed   GdsSessionDetailsDataStatus = "Failed"
	GdsSessionDetailsDataStatusReady    GdsSessionDetailsDataStatus = "Ready"
)

Defines values for GdsSessionDetailsDataStatus.

type GetCustomerManagedKeyIdResponse

type GetCustomerManagedKeyIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *CustomerManagedKey
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *CustomerManagedKeyNotFound
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseGetCustomerManagedKeyIdResponse

func ParseGetCustomerManagedKeyIdResponse(rsp *http.Response) (*GetCustomerManagedKeyIdResponse, error)

ParseGetCustomerManagedKeyIdResponse parses an HTTP response from a GetCustomerManagedKeyIdWithResponse call

func (GetCustomerManagedKeyIdResponse) Status

Status returns HTTPResponse.Status

func (GetCustomerManagedKeyIdResponse) StatusCode

func (r GetCustomerManagedKeyIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetCustomerManagedKeysParams

type GetCustomerManagedKeysParams struct {
	// TenantId An optional project ID to filter customer managed keys in a project
	TenantId *TenantIdForCmkOptional `form:"tenantId,omitempty" json:"tenantId,omitempty"`
}

GetCustomerManagedKeysParams defines parameters for GetCustomerManagedKeys.

type GetCustomerManagedKeysResponse

type GetCustomerManagedKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []struct {
			// Id The UUID of the key
			Id string `json:"id"`

			// Name The name of the key
			Name string `json:"name"`

			// TenantId The id of the project which the key belongs to
			TenantId string `json:"tenant_id"`
		} `json:"data"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetCustomerManagedKeysResponse

func ParseGetCustomerManagedKeysResponse(rsp *http.Response) (*GetCustomerManagedKeysResponse, error)

ParseGetCustomerManagedKeysResponse parses an HTTP response from a GetCustomerManagedKeysWithResponse call

func (GetCustomerManagedKeysResponse) Status

Status returns HTTPResponse.Status

func (GetCustomerManagedKeysResponse) StatusCode

func (r GetCustomerManagedKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstanceIdResponse

type GetInstanceIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseGetInstanceIdResponse

func ParseGetInstanceIdResponse(rsp *http.Response) (*GetInstanceIdResponse, error)

ParseGetInstanceIdResponse parses an HTTP response from a GetInstanceIdWithResponse call

func (GetInstanceIdResponse) Status

func (r GetInstanceIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstanceIdResponse) StatusCode

func (r GetInstanceIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetInstancesParams

type GetInstancesParams struct {
	// TenantId An optional project ID to filter instances in a project
	TenantId *TenantIdOptional `form:"tenantId,omitempty" json:"tenantId,omitempty"`
}

GetInstancesParams defines parameters for GetInstances.

type GetInstancesResponse

type GetInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []InstanceSummary `json:"data"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetInstancesResponse

func ParseGetInstancesResponse(rsp *http.Response) (*GetInstancesResponse, error)

ParseGetInstancesResponse parses an HTTP response from a GetInstancesWithResponse call

func (GetInstancesResponse) Status

func (r GetInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (GetInstancesResponse) StatusCode

func (r GetInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProjectIdResponse

type GetProjectIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Project
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *ProjectNotFound
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseGetProjectIdResponse

func ParseGetProjectIdResponse(rsp *http.Response) (*GetProjectIdResponse, error)

ParseGetProjectIdResponse parses an HTTP response from a GetProjectIdWithResponse call

func (GetProjectIdResponse) Status

func (r GetProjectIdResponse) Status() string

Status returns HTTPResponse.Status

func (GetProjectIdResponse) StatusCode

func (r GetProjectIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetProjectMetricsIntegrationDetailsResponse

type GetProjectMetricsIntegrationDetailsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *MetricsIntegrationDetails
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *ProjectNotFound
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParseGetProjectMetricsIntegrationDetailsResponse

func ParseGetProjectMetricsIntegrationDetailsResponse(rsp *http.Response) (*GetProjectMetricsIntegrationDetailsResponse, error)

ParseGetProjectMetricsIntegrationDetailsResponse parses an HTTP response from a GetProjectMetricsIntegrationDetailsWithResponse call

func (GetProjectMetricsIntegrationDetailsResponse) Status

Status returns HTTPResponse.Status

func (GetProjectMetricsIntegrationDetailsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetProjectsResponse

type GetProjectsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []ProjectSummary `json:"data"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetProjectsResponse

func ParseGetProjectsResponse(rsp *http.Response) (*GetProjectsResponse, error)

ParseGetProjectsResponse parses an HTTP response from a GetProjectsWithResponse call

func (GetProjectsResponse) Status

func (r GetProjectsResponse) Status() string

Status returns HTTPResponse.Status

func (GetProjectsResponse) StatusCode

func (r GetProjectsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionResponse

type GetSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data map[string]interface{} `json:"data"`

		// Errors Used for describing one or more errors returned by an endpoint.
		Errors *Error `json:"errors,omitempty"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *SessionNotFound
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetSessionResponse

func ParseGetSessionResponse(rsp *http.Response) (*GetSessionResponse, error)

ParseGetSessionResponse parses an HTTP response from a GetSessionWithResponse call

func (GetSessionResponse) Status

func (r GetSessionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSessionResponse) StatusCode

func (r GetSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionsParams

type GetSessionsParams struct {
	// InstanceId Instance ID
	InstanceId *InstanceIdQuery `form:"instanceId,omitempty" json:"instanceId,omitempty"`

	// TenantId An optional project ID to filter GDS Sessions
	TenantId *TenantIdForSessionsOptional `form:"tenantId,omitempty" json:"tenantId,omitempty"`

	// OrganizationId An optional organization ID to filter GDS Sessions
	OrganizationId *OrganizationIdOptional `form:"organizationId,omitempty" json:"organizationId,omitempty"`
}

GetSessionsParams defines parameters for GetSessions.

type GetSessionsResponse

type GetSessionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data []GdsSessionDetails `json:"data"`
	}
	JSON400 *BadRequest
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *InstanceNotFound
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetSessionsResponse

func ParseGetSessionsResponse(rsp *http.Response) (*GetSessionsResponse, error)

ParseGetSessionsResponse parses an HTTP response from a GetSessionsWithResponse call

func (GetSessionsResponse) Status

func (r GetSessionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSessionsResponse) StatusCode

func (r GetSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSnapshotSnapshotid200DataProfile

type GetSnapshotSnapshotid200DataProfile string

type GetSnapshotSnapshotid200DataStatus

type GetSnapshotSnapshotid200DataStatus string

type GetSnapshotSnapshotidResponse

type GetSnapshotSnapshotidResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data struct {
			InstanceId *string                              `json:"instance_id,omitempty"`
			Profile    *GetSnapshotSnapshotid200DataProfile `json:"profile,omitempty"`
			SnapshotId *string                              `json:"snapshot_id,omitempty"`
			Status     *GetSnapshotSnapshotid200DataStatus  `json:"status,omitempty"`
			Timestamp  *string                              `json:"timestamp,omitempty"`
		} `json:"data"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *SnapshotNotFound
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetSnapshotSnapshotidResponse

func ParseGetSnapshotSnapshotidResponse(rsp *http.Response) (*GetSnapshotSnapshotidResponse, error)

ParseGetSnapshotSnapshotidResponse parses an HTTP response from a GetSnapshotSnapshotidWithResponse call

func (GetSnapshotSnapshotidResponse) Status

Status returns HTTPResponse.Status

func (GetSnapshotSnapshotidResponse) StatusCode

func (r GetSnapshotSnapshotidResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSnapshots200DataProfile

type GetSnapshots200DataProfile string

type GetSnapshots200DataStatus

type GetSnapshots200DataStatus string

type GetSnapshotsParams

type GetSnapshotsParams struct {
	// Date An optional date parameter to list snapshots for a given day, defaults to today.
	Date *openapi_types.Date `form:"date,omitempty" json:"date,omitempty"`
}

GetSnapshotsParams defines parameters for GetSnapshots.

type GetSnapshotsResponse

type GetSnapshotsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *[]struct {
			InstanceId *string                     `json:"instance_id,omitempty"`
			Profile    *GetSnapshots200DataProfile `json:"profile,omitempty"`
			SnapshotId *string                     `json:"snapshot_id,omitempty"`
			Status     *GetSnapshots200DataStatus  `json:"status,omitempty"`
			Timestamp  *string                     `json:"timestamp,omitempty"`
		} `json:"data,omitempty"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *InstanceNotFound
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParseGetSnapshotsResponse

func ParseGetSnapshotsResponse(rsp *http.Response) (*GetSnapshotsResponse, error)

ParseGetSnapshotsResponse parses an HTTP response from a GetSnapshotsWithResponse call

func (GetSnapshotsResponse) Status

func (r GetSnapshotsResponse) Status() string

Status returns HTTPResponse.Status

func (GetSnapshotsResponse) StatusCode

func (r GetSnapshotsResponse) 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 Instance

type Instance struct {
	Data struct {
		// CdcEnrichmentMode The CDC mode of the instance. **This field is returned ONLY for VDC or BC instances**
		CdcEnrichmentMode *InstanceDataCdcEnrichmentMode `json:"cdc_enrichment_mode,omitempty"`

		// CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
		CloudProvider CloudProvider `json:"cloud_provider"`

		// ConnectionUrl URL for connecting to the Neo4j instance
		ConnectionUrl string `json:"connection_url"`

		// CreatedAt The timestamp when the instance was created
		CreatedAt string `json:"created_at"`

		// CustomerManagedKeyId ID of the Customer Managed Key if one was used for creating the instance
		CustomerManagedKeyId *string `json:"customer_managed_key_id,omitempty"`

		// GraphAnalyticsPlugin The graph analytics plugin configuration of the instance.
		GraphAnalyticsPlugin *bool `json:"graph_analytics_plugin,omitempty"`

		// GraphNodes The number of nodes in an Instance. **This field is returned ONLY for free instances**
		GraphNodes *string `json:"graph_nodes,omitempty"`

		// GraphRelationships The number of relationships in an Instance. **This field is returned ONLY for free instances**
		GraphRelationships *string `json:"graph_relationships,omitempty"`

		// Id The id of the instance
		Id string `json:"id"`

		// Memory The size of the instance memory in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project.
		Memory InstanceMemory `json:"memory"`

		// MetricsIntegrationUrl Metrics integration endpoint URL for the Neo4j instance
		MetricsIntegrationUrl *string `json:"metrics_integration_url,omitempty"`

		// Name The name of the instance
		Name string `json:"name"`

		// Region The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
		Region InstanceRegion `json:"region"`

		// SecondariesCount The number of secondaries in an Instance. **This field is returned ONLY for VDC instances**
		SecondariesCount *float32 `json:"secondaries_count,omitempty"`

		// Status The status of the instance
		Status InstanceDataStatus `json:"status"`

		// Storage The size of the instance storage in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project. This field is NOT returned for Aura DB Free instances.
		Storage InstanceStorage `json:"storage"`

		// TenantId The project to which the instance belongs to
		TenantId string `json:"tenant_id"`

		// Type The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
		Type InstanceType `json:"type"`

		// VectorOptimized The vector optimization configuration of the instance.
		VectorOptimized *bool `json:"vector_optimized,omitempty"`
	} `json:"data"`
}

Instance Describes an Aura instance.

type InstanceDataCdcEnrichmentMode

type InstanceDataCdcEnrichmentMode string

InstanceDataCdcEnrichmentMode The CDC mode of the instance. **This field is returned ONLY for VDC or BC instances**

Defines values for InstanceDataCdcEnrichmentMode.

type InstanceDataStatus

type InstanceDataStatus string

InstanceDataStatus The status of the instance

const (
	InstanceDataStatusCreating      InstanceDataStatus = "creating"
	InstanceDataStatusDestroying    InstanceDataStatus = "destroying"
	InstanceDataStatusLoading       InstanceDataStatus = "loading"
	InstanceDataStatusLoadingFailed InstanceDataStatus = "loading failed"
	InstanceDataStatusOverwriting   InstanceDataStatus = "overwriting"
	InstanceDataStatusPaused        InstanceDataStatus = "paused"
	InstanceDataStatusPausing       InstanceDataStatus = "pausing"
	InstanceDataStatusRestoring     InstanceDataStatus = "restoring"
	InstanceDataStatusResuming      InstanceDataStatus = "resuming"
	InstanceDataStatusRunning       InstanceDataStatus = "running"
	InstanceDataStatusSuspended     InstanceDataStatus = "suspended"
	InstanceDataStatusSuspending    InstanceDataStatus = "suspending"
	InstanceDataStatusUpdating      InstanceDataStatus = "updating"
)

Defines values for InstanceDataStatus.

type InstanceId

type InstanceId = string

InstanceId defines model for instanceId.

type InstanceIdQuery

type InstanceIdQuery = string

InstanceIdQuery defines model for instanceIdQuery.

type InstanceMemory

type InstanceMemory = string

InstanceMemory The size of the instance memory in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project.

type InstanceNotFound

type InstanceNotFound = Error

InstanceNotFound Used for describing one or more errors returned by an endpoint.

type InstanceRegion

type InstanceRegion = string

InstanceRegion The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.

type InstanceStorage

type InstanceStorage = string

InstanceStorage The size of the instance storage in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project. This field is NOT returned for Aura DB Free instances.

type InstanceSummary

type InstanceSummary struct {
	// CloudProvider The cloud provider of the instance
	CloudProvider InstanceSummaryCloudProvider `json:"cloud_provider"`

	// CreatedAt The timestamp when the instance was created
	CreatedAt string `json:"created_at"`

	// Id The id of the instance
	Id string `json:"id"`

	// Name The name of the instance
	Name string `json:"name"`

	// TenantId The project to which the instance belongs to
	TenantId string `json:"tenant_id"`
}

InstanceSummary Summary of an Aura instance details, as returned in the get instances endpoint.

type InstanceSummaryCloudProvider

type InstanceSummaryCloudProvider string

InstanceSummaryCloudProvider The cloud provider of the instance

Defines values for InstanceSummaryCloudProvider.

type InstanceType

type InstanceType string

InstanceType The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.

const (
	InstanceTypeBusinessCritical InstanceType = "business-critical"
	InstanceTypeEnterpriseDb     InstanceType = "enterprise-db"
	InstanceTypeEnterpriseDs     InstanceType = "enterprise-ds"
	InstanceTypeFreeDb           InstanceType = "free-db"
	InstanceTypeProfessionalDb   InstanceType = "professional-db"
	InstanceTypeProfessionalDs   InstanceType = "professional-ds"
)

Defines values for InstanceType.

type InstanceVersion

type InstanceVersion = string

InstanceVersion The Neo4j version of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid versions for your project.

type InternalServerError

type InternalServerError struct {
	// contains filtered or unexported fields
}

InternalServerError defines model for InternalServerError.

func (InternalServerError) AsError

func (t InternalServerError) AsError() (Error, error)

AsError returns the union data inside the InternalServerError as a Error

func (InternalServerError) AsMiddlewareError

func (t InternalServerError) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the InternalServerError as a MiddlewareError

func (*InternalServerError) FromError

func (t *InternalServerError) FromError(v Error) error

FromError overwrites any union data inside the InternalServerError as the provided Error

func (*InternalServerError) FromMiddlewareError

func (t *InternalServerError) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the InternalServerError as the provided MiddlewareError

func (InternalServerError) MarshalJSON

func (t InternalServerError) MarshalJSON() ([]byte, error)

func (*InternalServerError) MergeError

func (t *InternalServerError) MergeError(v Error) error

MergeError performs a merge with any union data inside the InternalServerError, using the provided Error

func (*InternalServerError) MergeMiddlewareError

func (t *InternalServerError) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the InternalServerError, using the provided MiddlewareError

func (*InternalServerError) UnmarshalJSON

func (t *InternalServerError) UnmarshalJSON(b []byte) error

type MetricsIntegrationDetails

type MetricsIntegrationDetails struct {
	Data struct {
		// Endpoint Metrics integration endpoint URL.
		Endpoint string `json:"endpoint"`
	} `json:"data"`
}

MetricsIntegrationDetails Details about project metrics integration.

type MiddlewareError

type MiddlewareError struct {
	// Error Error message describing the problem
	Error *string `json:"error,omitempty"`
}

MiddlewareError Sometimes our API middleware may return an error in this format.

The error message is an explanation of the error that has been encountered. Aimed at developers debugging issues, not recommended to be passed onto the end user.

type OrganizationIdOptional

type OrganizationIdOptional = string

OrganizationIdOptional defines model for organizationIdOptional.

type PatchInstanceIdJSONBody

type PatchInstanceIdJSONBody struct {
	// GraphAnalyticsPlugin Add or remove the instance graph analytics plugin.
	GraphAnalyticsPlugin *bool `json:"graph_analytics_plugin,omitempty"`

	// Memory The size of the instance memory in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project.
	Memory *InstanceMemory `json:"memory,omitempty"`

	// Name Edit the instance name in the Aura Console.
	//
	// The name may include any UTF-8 characters with no trailing or leading whitespace.
	Name *string `json:"name,omitempty"`

	// Storage The size of the instance storage in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project. This field is NOT returned for Aura DB Free instances.
	Storage *InstanceStorage `json:"storage,omitempty"`

	// VectorOptimized Add or remove the instance vector optimization.
	VectorOptimized *bool `json:"vector_optimized,omitempty"`
}

PatchInstanceIdJSONBody defines parameters for PatchInstanceId.

type PatchInstanceIdJSONRequestBody

type PatchInstanceIdJSONRequestBody PatchInstanceIdJSONBody

PatchInstanceIdJSONRequestBody defines body for PatchInstanceId for application/json ContentType.

type PatchInstanceIdResponse

type PatchInstanceIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Instance
	JSON202      *map[string]interface{}
	JSON400      *BadRequest
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON415      *UnsupportedMediaType
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePatchInstanceIdResponse

func ParsePatchInstanceIdResponse(rsp *http.Response) (*PatchInstanceIdResponse, error)

ParsePatchInstanceIdResponse parses an HTTP response from a PatchInstanceIdWithResponse call

func (PatchInstanceIdResponse) Status

func (r PatchInstanceIdResponse) Status() string

Status returns HTTPResponse.Status

func (PatchInstanceIdResponse) StatusCode

func (r PatchInstanceIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostCustomerManagedKeysJSONBody

type PostCustomerManagedKeysJSONBody struct {
	// CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
	CloudProvider CloudProvider `json:"cloud_provider"`

	// InstanceType The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
	InstanceType InstanceType `json:"instance_type"`
	KeyId        string       `json:"key_id"`

	// Name The name of the key (any UTF-8 characters with no trailing or leading whitespace).
	Name string `json:"name"`

	// Region The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
	Region InstanceRegion `json:"region"`

	// TenantId Project ID
	TenantId string `json:"tenant_id"`
}

PostCustomerManagedKeysJSONBody defines parameters for PostCustomerManagedKeys.

type PostCustomerManagedKeysJSONRequestBody

type PostCustomerManagedKeysJSONRequestBody PostCustomerManagedKeysJSONBody

PostCustomerManagedKeysJSONRequestBody defines body for PostCustomerManagedKeys for application/json ContentType.

type PostCustomerManagedKeysResponse

type PostCustomerManagedKeysResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *CustomerManagedKey
	JSON400      *Error
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON415      *UnsupportedMediaType
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostCustomerManagedKeysResponse

func ParsePostCustomerManagedKeysResponse(rsp *http.Response) (*PostCustomerManagedKeysResponse, error)

ParsePostCustomerManagedKeysResponse parses an HTTP response from a PostCustomerManagedKeysWithResponse call

func (PostCustomerManagedKeysResponse) Status

Status returns HTTPResponse.Status

func (PostCustomerManagedKeysResponse) StatusCode

func (r PostCustomerManagedKeysResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostInstancesJSONBody

type PostInstancesJSONBody struct {
	// CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
	CloudProvider CloudProvider `json:"cloud_provider"`

	// CustomerManagedKeyId An optional customer managed key to be used for instance creation.
	CustomerManagedKeyId *string `json:"customer_managed_key_id,omitempty"`

	// GraphAnalyticsPlugin An optional graph analytics plugin configuration to be set during instance creation.
	GraphAnalyticsPlugin *bool `json:"graph_analytics_plugin,omitempty"`

	// Memory The size of the instance memory in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project.
	Memory InstanceMemory `json:"memory"`

	// Name The name of the instance (any UTF-8 characters with no trailing or leading whitespace).
	Name string `json:"name"`

	// Region The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
	Region InstanceRegion `json:"region"`

	// SourceInstanceId The ID of the source instance when cloning.
	SourceInstanceId *string `json:"source_instance_id,omitempty"`

	// SourceSnapshotId An optional snapshot ID to create an instance from a specific snapshot. `source_instance_id` must also be provided. Note that the snapshot must be exportable in order to create a new instance with it.
	SourceSnapshotId *string `json:"source_snapshot_id,omitempty"`

	// TenantId Project ID
	TenantId string `json:"tenant_id"`

	// Type The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
	Type InstanceType `json:"type"`

	// VectorOptimized An optional vector optimization configuration to be set during instance creation.
	VectorOptimized *bool `json:"vector_optimized,omitempty"`

	// Version The Neo4j version of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid versions for your project.
	Version InstanceVersion `json:"version"`
}

PostInstancesJSONBody defines parameters for PostInstances.

type PostInstancesJSONRequestBody

type PostInstancesJSONRequestBody PostInstancesJSONBody

PostInstancesJSONRequestBody defines body for PostInstances for application/json ContentType.

type PostInstancesResponse

type PostInstancesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		Data *struct {
			// CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
			CloudProvider CloudProvider `json:"cloud_provider"`

			// ConnectionUrl The URL to connect to the Neo4j instance with.
			ConnectionUrl string `json:"connection_url"`

			// CreatedAt The timestamp when the instance was created.
			CreatedAt string `json:"created_at"`

			// GraphAnalyticsPlugin The graph analytics plugin configuration when the instance was created.
			GraphAnalyticsPlugin *bool `json:"graph_analytics_plugin,omitempty"`

			// Id The instance ID.
			Id string `json:"id"`

			// Name Name of the instance
			Name string `json:"name"`

			// Password The initial password for authenticating with this instance.
			Password string `json:"password"`

			// Region The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
			Region InstanceRegion `json:"region"`

			// TenantId The ID for the project.
			TenantId string `json:"tenant_id"`

			// Type The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
			Type InstanceType `json:"type"`

			// Username The initial username for authenticating with this instance.
			Username string `json:"username"`

			// VectorOptimized The vector optimization configuration when the instance was created.
			VectorOptimized *bool `json:"vector_optimized,omitempty"`
		} `json:"data,omitempty"`
	}
	JSON400 *Error
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON405 *Error
	JSON415 *UnsupportedMediaType
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParsePostInstancesResponse

func ParsePostInstancesResponse(rsp *http.Response) (*PostInstancesResponse, error)

ParsePostInstancesResponse parses an HTTP response from a PostInstancesWithResponse call

func (PostInstancesResponse) Status

func (r PostInstancesResponse) Status() string

Status returns HTTPResponse.Status

func (PostInstancesResponse) StatusCode

func (r PostInstancesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostInstancesSizingJSONBody

type PostInstancesSizingJSONBody struct {
	// AlgorithmCategories The algorithm categories to be used in the instance.
	AlgorithmCategories *[]string `json:"algorithm_categories,omitempty"`

	// InstanceType The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
	InstanceType *InstanceType `json:"instance_type,omitempty"`

	// NodeCount The number of nodes to be stored in the instance.
	NodeCount int `json:"node_count"`

	// RelationshipCount The number of relationships to be stored in the instance.
	RelationshipCount int `json:"relationship_count"`
}

PostInstancesSizingJSONBody defines parameters for PostInstancesSizing.

type PostInstancesSizingJSONRequestBody

type PostInstancesSizingJSONRequestBody PostInstancesSizingJSONBody

PostInstancesSizingJSONRequestBody defines body for PostInstancesSizing for application/json ContentType.

type PostInstancesSizingResponse

type PostInstancesSizingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *struct {
			// DidExceedMaximum Indicates if the instance size exceeds the maximum allowed.
			DidExceedMaximum bool `json:"did_exceed_maximum"`

			// MinRequiredMemory The minimum required memory for the instance.
			MinRequiredMemory string `json:"min_required_memory"`

			// RecommendedSize The recommended instance size.
			RecommendedSize string `json:"recommended_size"`
		} `json:"data,omitempty"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON415 *UnsupportedMediaType
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParsePostInstancesSizingResponse

func ParsePostInstancesSizingResponse(rsp *http.Response) (*PostInstancesSizingResponse, error)

ParsePostInstancesSizingResponse parses an HTTP response from a PostInstancesSizingWithResponse call

func (PostInstancesSizingResponse) Status

Status returns HTTPResponse.Status

func (PostInstancesSizingResponse) StatusCode

func (r PostInstancesSizingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostOverwriteInstanceJSONBody

type PostOverwriteInstanceJSONBody struct {
	SourceInstanceId string  `json:"source_instance_id"`
	SourceSnapshotId *string `json:"source_snapshot_id,omitempty"`
}

PostOverwriteInstanceJSONBody defines parameters for PostOverwriteInstance.

type PostOverwriteInstanceJSONRequestBody

type PostOverwriteInstanceJSONRequestBody PostOverwriteInstanceJSONBody

PostOverwriteInstanceJSONRequestBody defines body for PostOverwriteInstance for application/json ContentType.

type PostOverwriteInstanceResponse

type PostOverwriteInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostOverwriteInstanceResponse

func ParsePostOverwriteInstanceResponse(rsp *http.Response) (*PostOverwriteInstanceResponse, error)

ParsePostOverwriteInstanceResponse parses an HTTP response from a PostOverwriteInstanceWithResponse call

func (PostOverwriteInstanceResponse) Status

Status returns HTTPResponse.Status

func (PostOverwriteInstanceResponse) StatusCode

func (r PostOverwriteInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostPauseInstanceJSONBody

type PostPauseInstanceJSONBody = map[string]interface{}

PostPauseInstanceJSONBody defines parameters for PostPauseInstance.

type PostPauseInstanceJSONRequestBody

type PostPauseInstanceJSONRequestBody = PostPauseInstanceJSONBody

PostPauseInstanceJSONRequestBody defines body for PostPauseInstance for application/json ContentType.

type PostPauseInstanceResponse

type PostPauseInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Instance
	JSON400      *BadRequest
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostPauseInstanceResponse

func ParsePostPauseInstanceResponse(rsp *http.Response) (*PostPauseInstanceResponse, error)

ParsePostPauseInstanceResponse parses an HTTP response from a PostPauseInstanceWithResponse call

func (PostPauseInstanceResponse) Status

func (r PostPauseInstanceResponse) Status() string

Status returns HTTPResponse.Status

func (PostPauseInstanceResponse) StatusCode

func (r PostPauseInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostRestoreSnapshotJSONBody

type PostRestoreSnapshotJSONBody = map[string]interface{}

PostRestoreSnapshotJSONBody defines parameters for PostRestoreSnapshot.

type PostRestoreSnapshotJSONRequestBody

type PostRestoreSnapshotJSONRequestBody = PostRestoreSnapshotJSONBody

PostRestoreSnapshotJSONRequestBody defines body for PostRestoreSnapshot for application/json ContentType.

type PostRestoreSnapshotResponse

type PostRestoreSnapshotResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *SnapshotNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostRestoreSnapshotResponse

func ParsePostRestoreSnapshotResponse(rsp *http.Response) (*PostRestoreSnapshotResponse, error)

ParsePostRestoreSnapshotResponse parses an HTTP response from a PostRestoreSnapshotWithResponse call

func (PostRestoreSnapshotResponse) Status

Status returns HTTPResponse.Status

func (PostRestoreSnapshotResponse) StatusCode

func (r PostRestoreSnapshotResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostResumeInstanceJSONBody

type PostResumeInstanceJSONBody = map[string]interface{}

PostResumeInstanceJSONBody defines parameters for PostResumeInstance.

type PostResumeInstanceJSONRequestBody

type PostResumeInstanceJSONRequestBody = PostResumeInstanceJSONBody

PostResumeInstanceJSONRequestBody defines body for PostResumeInstance for application/json ContentType.

type PostResumeInstanceResponse

type PostResumeInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostResumeInstanceResponse

func ParsePostResumeInstanceResponse(rsp *http.Response) (*PostResumeInstanceResponse, error)

ParsePostResumeInstanceResponse parses an HTTP response from a PostResumeInstanceWithResponse call

func (PostResumeInstanceResponse) Status

Status returns HTTPResponse.Status

func (PostResumeInstanceResponse) StatusCode

func (r PostResumeInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostSessionJSONBody

type PostSessionJSONBody struct {
	// CloudProvider The cloud provider hosting the session. Please refer to your Aura project configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
	CloudProvider interface{} `json:"cloud_provider,omitempty"`

	// DatabaseUuid The UUID of the Neo4j database from which the session was created from.
	DatabaseUuid *string `json:"database_uuid,omitempty"`

	// InstanceId The ID of the instance the session will be attached to. Enables projecting data from the instance and write-back of results.
	InstanceId *string `json:"instance_id,omitempty"`

	// Memory The memory of the session in 'GB'
	Memory *string `json:"memory,omitempty"`

	// Name The name of the session.
	Name *string `json:"name,omitempty"`

	// Region The region where the session is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
	Region *string `json:"region,omitempty"`

	// TenantId The ID of the Tenant/Project to which the session belongs.
	TenantId *string `json:"tenant_id,omitempty"`

	// Ttl The time to live of the session. If not specified, defaults to 1 hour.
	Ttl *string `json:"ttl,omitempty"`
}

PostSessionJSONBody defines parameters for PostSession.

type PostSessionJSONRequestBody

type PostSessionJSONRequestBody PostSessionJSONBody

PostSessionJSONRequestBody defines body for PostSession for application/json ContentType.

type PostSessionResponse

type PostSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data map[string]interface{} `json:"data"`

		// Errors Used for describing one or more errors returned by an endpoint.
		Errors *Error `json:"errors,omitempty"`
	}
	JSON202 *struct {
		Data map[string]interface{} `json:"data"`

		// Errors Used for describing one or more errors returned by an endpoint.
		Errors *Error `json:"errors,omitempty"`
	}
	JSON400 *BadRequest
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON409 *SessionConflict
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParsePostSessionResponse

func ParsePostSessionResponse(rsp *http.Response) (*PostSessionResponse, error)

ParsePostSessionResponse parses an HTTP response from a PostSessionWithResponse call

func (PostSessionResponse) Status

func (r PostSessionResponse) Status() string

Status returns HTTPResponse.Status

func (PostSessionResponse) StatusCode

func (r PostSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostSessionsSizingJSONBody

type PostSessionsSizingJSONBody struct {
	// AlgorithmCategories The algorithm categories to be used in the instance.
	AlgorithmCategories *[]string `json:"algorithm_categories,omitempty"`

	// NodeCount The number of nodes to be stored in the instance.
	NodeCount int `json:"node_count"`

	// NodeLabelCount The number of labels per node.
	NodeLabelCount *int `json:"node_label_count,omitempty"`

	// NodePropertyCount The number of properties per node.
	NodePropertyCount *int `json:"node_property_count,omitempty"`

	// RelationshipCount The number of relationships to be stored in the instance.
	RelationshipCount int `json:"relationship_count"`

	// RelationshipPropertyCount The number of properties per relationship.
	RelationshipPropertyCount *int `json:"relationship_property_count,omitempty"`
}

PostSessionsSizingJSONBody defines parameters for PostSessionsSizing.

type PostSessionsSizingJSONRequestBody

type PostSessionsSizingJSONRequestBody PostSessionsSizingJSONBody

PostSessionsSizingJSONRequestBody defines body for PostSessionsSizing for application/json ContentType.

type PostSessionsSizingResponse

type PostSessionsSizingResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Data *struct {
			// EstimatedMemory The estimated memory for the session.
			EstimatedMemory string `json:"estimated_memory"`

			// RecommendedSize The recommended session size.
			RecommendedSize string `json:"recommended_size"`
		} `json:"data,omitempty"`
	}
	JSON400 *BadRequest
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON415 *UnsupportedMediaType
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParsePostSessionsSizingResponse

func ParsePostSessionsSizingResponse(rsp *http.Response) (*PostSessionsSizingResponse, error)

ParsePostSessionsSizingResponse parses an HTTP response from a PostSessionsSizingWithResponse call

func (PostSessionsSizingResponse) Status

Status returns HTTPResponse.Status

func (PostSessionsSizingResponse) StatusCode

func (r PostSessionsSizingResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostSnapshotsJSONBody

type PostSnapshotsJSONBody = map[string]interface{}

PostSnapshotsJSONBody defines parameters for PostSnapshots.

type PostSnapshotsJSONRequestBody

type PostSnapshotsJSONRequestBody = PostSnapshotsJSONBody

PostSnapshotsJSONRequestBody defines body for PostSnapshots for application/json ContentType.

type PostSnapshotsResponse

type PostSnapshotsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON202      *struct {
		Data *struct {
			// SnapshotId The ID of the created snapshot
			SnapshotId string `json:"snapshot_id"`
		} `json:"data,omitempty"`
	}
	JSON401 *Unauthorized
	JSON403 *Forbidden
	JSON404 *InstanceNotFound
	JSON409 *Conflict
	JSON429 *TooManyRequests
	JSON500 *InternalServerError
	JSON502 *BadGateway
	JSON503 *ServiceUnavailable
	JSON504 *GatewayTimeout
}

func ParsePostSnapshotsResponse

func ParsePostSnapshotsResponse(rsp *http.Response) (*PostSnapshotsResponse, error)

ParsePostSnapshotsResponse parses an HTTP response from a PostSnapshotsWithResponse call

func (PostSnapshotsResponse) Status

func (r PostSnapshotsResponse) Status() string

Status returns HTTPResponse.Status

func (PostSnapshotsResponse) StatusCode

func (r PostSnapshotsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostUpgradeInstanceJSONBody

type PostUpgradeInstanceJSONBody struct {
	Memory  *string `json:"memory,omitempty"`
	Storage *string `json:"storage,omitempty"`
}

PostUpgradeInstanceJSONBody defines parameters for PostUpgradeInstance.

type PostUpgradeInstanceJSONRequestBody

type PostUpgradeInstanceJSONRequestBody PostUpgradeInstanceJSONBody

PostUpgradeInstanceJSONRequestBody defines body for PostUpgradeInstance for application/json ContentType.

type PostUpgradeInstanceResponse

type PostUpgradeInstanceResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Instance
	JSON401      *Unauthorized
	JSON403      *Forbidden
	JSON404      *InstanceNotFound
	JSON409      *Conflict
	JSON429      *TooManyRequests
	JSON500      *InternalServerError
	JSON502      *BadGateway
	JSON503      *ServiceUnavailable
	JSON504      *GatewayTimeout
}

func ParsePostUpgradeInstanceResponse

func ParsePostUpgradeInstanceResponse(rsp *http.Response) (*PostUpgradeInstanceResponse, error)

ParsePostUpgradeInstanceResponse parses an HTTP response from a PostUpgradeInstanceWithResponse call

func (PostUpgradeInstanceResponse) Status

Status returns HTTPResponse.Status

func (PostUpgradeInstanceResponse) StatusCode

func (r PostUpgradeInstanceResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Project

type Project struct {
	Data struct {
		// Id The id of the project
		Id string `json:"id"`

		// InstanceConfigurations A list of instance configurations that are supported by the project
		InstanceConfigurations []struct {
			// CloudProvider The cloud provider hosting the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid cloud_providers for your project.
			CloudProvider CloudProvider `json:"cloud_provider"`

			// Memory The size of the instance memory in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project.
			Memory InstanceMemory `json:"memory"`

			// Region The region where the instance is hosted. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid regions for your project.
			Region InstanceRegion `json:"region"`

			// RegionName A human-friendly name for the region
			RegionName string `json:"region_name"`

			// Storage The size of the instance storage in GB. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid sizes for your project. This field is NOT returned for Aura DB Free instances.
			Storage InstanceStorage `json:"storage"`

			// Type The type of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid types for your project. The `enterprise-db` type is used to represent Virtual Dedicated Cloud.
			Type InstanceType `json:"type"`

			// Version The Neo4j version of the instance. Please refer to your Aura project instance configurations, returned by the GET /tenants/{tenantId} endpoint, for a list of valid versions for your project.
			Version InstanceVersion `json:"version"`
		} `json:"instance_configurations"`

		// Name The name of the project
		Name string `json:"name"`
	} `json:"data"`
}

Project Describes an Aura project.

type ProjectNotFound

type ProjectNotFound = Error

ProjectNotFound Used for describing one or more errors returned by an endpoint.

type ProjectSummary

type ProjectSummary struct {
	// Id The id of the project
	Id string `json:"id"`

	// Name The name of the project
	Name string `json:"name"`
}

ProjectSummary Summary of an Aura project details, as returned in the get projects endpoint.

type RequestEditorFn

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

RequestEditorFn is the function signature for the RequestEditor callback function

type ServiceUnavailable

type ServiceUnavailable struct {
	// contains filtered or unexported fields
}

ServiceUnavailable defines model for ServiceUnavailable.

func (ServiceUnavailable) AsError

func (t ServiceUnavailable) AsError() (Error, error)

AsError returns the union data inside the ServiceUnavailable as a Error

func (ServiceUnavailable) AsMiddlewareError

func (t ServiceUnavailable) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the ServiceUnavailable as a MiddlewareError

func (*ServiceUnavailable) FromError

func (t *ServiceUnavailable) FromError(v Error) error

FromError overwrites any union data inside the ServiceUnavailable as the provided Error

func (*ServiceUnavailable) FromMiddlewareError

func (t *ServiceUnavailable) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the ServiceUnavailable as the provided MiddlewareError

func (ServiceUnavailable) MarshalJSON

func (t ServiceUnavailable) MarshalJSON() ([]byte, error)

func (*ServiceUnavailable) MergeError

func (t *ServiceUnavailable) MergeError(v Error) error

MergeError performs a merge with any union data inside the ServiceUnavailable, using the provided Error

func (*ServiceUnavailable) MergeMiddlewareError

func (t *ServiceUnavailable) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the ServiceUnavailable, using the provided MiddlewareError

func (*ServiceUnavailable) UnmarshalJSON

func (t *ServiceUnavailable) UnmarshalJSON(b []byte) error

type SessionConflict

type SessionConflict = Error

SessionConflict Used for describing one or more errors returned by an endpoint.

type SessionId

type SessionId = string

SessionId defines model for sessionId.

type SessionNotFound

type SessionNotFound = Error

SessionNotFound Used for describing one or more errors returned by an endpoint.

type SnapshotNotFound

type SnapshotNotFound = Error

SnapshotNotFound Used for describing one or more errors returned by an endpoint.

type TenantId

type TenantId = string

TenantId defines model for tenantId.

type TenantIdForCmkOptional

type TenantIdForCmkOptional = string

TenantIdForCmkOptional defines model for tenantIdForCmkOptional.

type TenantIdForSessionsOptional

type TenantIdForSessionsOptional = string

TenantIdForSessionsOptional defines model for tenantIdForSessionsOptional.

type TenantIdOptional

type TenantIdOptional = string

TenantIdOptional defines model for tenantIdOptional.

type TooManyRequests

type TooManyRequests struct {
	// contains filtered or unexported fields
}

TooManyRequests defines model for TooManyRequests.

func (TooManyRequests) AsError

func (t TooManyRequests) AsError() (Error, error)

AsError returns the union data inside the TooManyRequests as a Error

func (TooManyRequests) AsMiddlewareError

func (t TooManyRequests) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the TooManyRequests as a MiddlewareError

func (*TooManyRequests) FromError

func (t *TooManyRequests) FromError(v Error) error

FromError overwrites any union data inside the TooManyRequests as the provided Error

func (*TooManyRequests) FromMiddlewareError

func (t *TooManyRequests) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the TooManyRequests as the provided MiddlewareError

func (TooManyRequests) MarshalJSON

func (t TooManyRequests) MarshalJSON() ([]byte, error)

func (*TooManyRequests) MergeError

func (t *TooManyRequests) MergeError(v Error) error

MergeError performs a merge with any union data inside the TooManyRequests, using the provided Error

func (*TooManyRequests) MergeMiddlewareError

func (t *TooManyRequests) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the TooManyRequests, using the provided MiddlewareError

func (*TooManyRequests) UnmarshalJSON

func (t *TooManyRequests) UnmarshalJSON(b []byte) error

type Unauthorized

type Unauthorized struct {
	// contains filtered or unexported fields
}

Unauthorized defines model for Unauthorized.

func (Unauthorized) AsError

func (t Unauthorized) AsError() (Error, error)

AsError returns the union data inside the Unauthorized as a Error

func (Unauthorized) AsMiddlewareError

func (t Unauthorized) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the Unauthorized as a MiddlewareError

func (*Unauthorized) FromError

func (t *Unauthorized) FromError(v Error) error

FromError overwrites any union data inside the Unauthorized as the provided Error

func (*Unauthorized) FromMiddlewareError

func (t *Unauthorized) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the Unauthorized as the provided MiddlewareError

func (Unauthorized) MarshalJSON

func (t Unauthorized) MarshalJSON() ([]byte, error)

func (*Unauthorized) MergeError

func (t *Unauthorized) MergeError(v Error) error

MergeError performs a merge with any union data inside the Unauthorized, using the provided Error

func (*Unauthorized) MergeMiddlewareError

func (t *Unauthorized) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the Unauthorized, using the provided MiddlewareError

func (*Unauthorized) UnmarshalJSON

func (t *Unauthorized) UnmarshalJSON(b []byte) error

type UnsupportedMediaType

type UnsupportedMediaType struct {
	// contains filtered or unexported fields
}

UnsupportedMediaType defines model for UnsupportedMediaType.

func (UnsupportedMediaType) AsError

func (t UnsupportedMediaType) AsError() (Error, error)

AsError returns the union data inside the UnsupportedMediaType as a Error

func (UnsupportedMediaType) AsMiddlewareError

func (t UnsupportedMediaType) AsMiddlewareError() (MiddlewareError, error)

AsMiddlewareError returns the union data inside the UnsupportedMediaType as a MiddlewareError

func (*UnsupportedMediaType) FromError

func (t *UnsupportedMediaType) FromError(v Error) error

FromError overwrites any union data inside the UnsupportedMediaType as the provided Error

func (*UnsupportedMediaType) FromMiddlewareError

func (t *UnsupportedMediaType) FromMiddlewareError(v MiddlewareError) error

FromMiddlewareError overwrites any union data inside the UnsupportedMediaType as the provided MiddlewareError

func (UnsupportedMediaType) MarshalJSON

func (t UnsupportedMediaType) MarshalJSON() ([]byte, error)

func (*UnsupportedMediaType) MergeError

func (t *UnsupportedMediaType) MergeError(v Error) error

MergeError performs a merge with any union data inside the UnsupportedMediaType, using the provided Error

func (*UnsupportedMediaType) MergeMiddlewareError

func (t *UnsupportedMediaType) MergeMiddlewareError(v MiddlewareError) error

MergeMiddlewareError performs a merge with any union data inside the UnsupportedMediaType, using the provided MiddlewareError

func (*UnsupportedMediaType) UnmarshalJSON

func (t *UnsupportedMediaType) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

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