Package depresourceapi contains curated functions which iteract with the deployment resources API, exposing an API which its usage is preferred over the direct client calls.

Create performs a Create using the specified Request against the API.

Delete removes the specified deployment ID from the platform.

Get returns info about a deployment.

GetApm returns info about an apm resource belonging to a given deployment.

GetAppSearch returns info about an appsearch resource belonging to a given deployment.

GetElasticsearch returns info about an elasticsearch resource belonging to a given deployment.

GetElasticsearchID returns the deployment's elasticsearch resource ID.

GetEnterpriseSearch returns info about an Enterprise Search resource belonging to a given deployment.

GetKibana returns info about an kibana resource belonging to a given deployment.

GetResource is a high level function which either returns the top level deployment information when no params.Kind is specified, or it returns a specific deployment resource information by RefID.

List returns the platform deployments.

NewUpdateRequest generates a DeploymentUpdateRequest from a GetResponse.

OverrideCreateOrUpdateRequest sets a series of overrides to either the Create or Update deployment request.

PopulateRefID takes in a the necessary parameters to discover a RefID from a resource kind, and populates the value in the params.RefID field in the form of a *string.

RequestID creates a 64-character string when an empty s tring is provided, or returns the provided string.

Restore restores a deployment which has been previously shut down.

Resync forces indexer to immediately resynchronize the search index and cache for a given deployment.

ResyncAll asynchronously resynchronizes the search index for all deployments.

Search performs a search using the specified Request against the API.

Shutdown shuts down a deployment and all of its associated resources.

Update receives an update payload with an optional region override in case the region isn't specified in the update request payload.

CreateParams is consumed by Create.

DeleteParams is consumed by Delete.

GetParams is consumed by get resource functions.

GetResourceParams is consumed by GetResource.

ListParams is consumed by List.

PayloadOverrides represent the override settings to.

PopulateRefIDParams is consumed by PopulateRefID.

RestoreParams is consumed by Restore.

ResyncAllParams is consumed by ResyncAll.

ResyncParams is consumed by Resync.

SearchParams is consumed by Search.

ShutdownParams is consumed by Shutdown.

UpdateParams is consumed by Update.