client

func (*AdminClient) ClearBuildpackCache ¶

func (c *AdminClient) ClearBuildpackCache(ctx context.Context) (string, error)

ClearBuildpackCache will delete all the existing buildpack caches in the blobstore. Success returns a JobID.

The buildpack cache is used during staging by buildpacks as a way to cache certain resources, e.g. downloaded Ruby gems. An admin who wants to decrease the size of their blobstore could use this endpoint to delete unnecessary blobs.

func (*AppClient) Create ¶

func (c *AppClient) Create(ctx context.Context, r *resource.AppCreate) (*resource.App, error)

Create a new app

func (*AppClient) Delete ¶

func (c *AppClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified app asynchronously and return a jobGUID.

func (*AppClient) First ¶

func (c *AppClient) First(ctx context.Context, opts *AppListOptions) (*resource.App, error)

First returns the first app matching the options or an error when less than 1 match

func (*AppClient) Get ¶

func (c *AppClient) Get(ctx context.Context, guid string) (*resource.App, error)

Get the specified app

func (*AppClient) GetEnvironment ¶

func (c *AppClient) GetEnvironment(ctx context.Context, guid string) (*resource.AppEnvironment, error)

GetEnvironment retrieves the environment variables that will be provided to an app at runtime. It will include environment variables for Environment Variable Groups and Service Bindings.

func (*AppClient) GetEnvironmentVariables ¶

func (c *AppClient) GetEnvironmentVariables(ctx context.Context, guid string) (map[string]*string, error)

GetEnvironmentVariables retrieves the environment variables that are associated with the given app

func (*AppClient) GetIncludeSpace ¶

func (c *AppClient) GetIncludeSpace(ctx context.Context, guid string) (*resource.App, *resource.Space, error)

GetIncludeSpace allows callers to fetch an app and include the parent space

func (*AppClient) GetIncludeSpaceAndOrganization ¶

func (c *AppClient) GetIncludeSpaceAndOrganization(ctx context.Context, guid string) (*resource.App, *resource.Space, *resource.Organization, error)

GetIncludeSpaceAndOrganization allows callers to fetch an app and include the parent space and organizations

func (*AppClient) List ¶

func (c *AppClient) List(ctx context.Context, opts *AppListOptions) ([]*resource.App, *Pager, error)

List pages all the apps the user has access to

func (*AppClient) ListAll ¶

func (c *AppClient) ListAll(ctx context.Context, opts *AppListOptions) ([]*resource.App, error)

ListAll retrieves all apps the user has access to

func (*AppClient) ListIncludeSpaces ¶

func (c *AppClient) ListIncludeSpaces(ctx context.Context, opts *AppListOptions) ([]*resource.App, []*resource.Space, *Pager, error)

ListIncludeSpaces page all apps the user has access to and include the associated spaces

func (*AppClient) ListIncludeSpacesAll ¶

func (c *AppClient) ListIncludeSpacesAll(ctx context.Context, opts *AppListOptions) ([]*resource.App, []*resource.Space, error)

ListIncludeSpacesAll retrieves all apps the user has access to and include the associated spaces

func (*AppClient) ListIncludeSpacesAndOrganizations ¶

func (c *AppClient) ListIncludeSpacesAndOrganizations(ctx context.Context, opts *AppListOptions) ([]*resource.App, []*resource.Space, []*resource.Organization, *Pager, error)

ListIncludeSpacesAndOrganizations page all apps the user has access to and include the associated spaces and organizations

func (*AppClient) ListIncludeSpacesAndOrganizationsAll ¶

func (c *AppClient) ListIncludeSpacesAndOrganizationsAll(ctx context.Context, opts *AppListOptions) ([]*resource.App, []*resource.Space, []*resource.Organization, error)

ListIncludeSpacesAndOrganizationsAll retrieves all apps the user has access to and include the associated spaces and organizations

func (*AppClient) Permissions ¶

func (c *AppClient) Permissions(ctx context.Context, guid string) (*resource.AppPermissions, error)

Permissions gets the current user’s permissions for the given app. If a user can see an app, then they can see its basic data. Only admin, read-only admins, and space developers can read sensitive data.

func (*AppClient) Restart ¶

func (c *AppClient) Restart(ctx context.Context, guid string) (*resource.App, error)

Restart will synchronously stop and start an application. Unlike the start and stop actions, this endpoint will error if the app is not successfully stopped in the runtime. For restarting applications without downtime, see the Deployments resource.

func (*AppClient) SSHEnabled ¶

func (c *AppClient) SSHEnabled(ctx context.Context, guid string) (*resource.AppSSHEnabled, error)

SSHEnabled returns if an application’s runtime environment will accept ssh connections. If ssh is disabled, the reason field will describe whether it is disabled globally, at the space level, or at the app level.

func (*AppClient) SetEnvironmentVariables ¶

func (c *AppClient) SetEnvironmentVariables(ctx context.Context, guid string, envRequest map[string]*string) (map[string]*string, error)

SetEnvironmentVariables updates the environment variables associated with the given app. The variables given in the request will be merged with the existing app environment variables. Any requested variables with a value of null will be removed from the app.

Environment variable names may not start with VCAP_ PORT is not a valid environment variable.

func (*AppClient) Single ¶

func (c *AppClient) Single(ctx context.Context, opts *AppListOptions) (*resource.App, error)

Single returns a single app matching the options or an error if not exactly 1 match

func (*AppClient) Start ¶

func (c *AppClient) Start(ctx context.Context, guid string) (*resource.App, error)

Start the app if not already started

func (*AppClient) Stop ¶

func (c *AppClient) Stop(ctx context.Context, guid string) (*resource.App, error)

Stop the app if not already stopped

func (*AppClient) Update ¶

func (c *AppClient) Update(ctx context.Context, guid string, r *resource.AppUpdate) (*resource.App, error)

Update the specified attributes of the app

func (*AppFeatureClient) Get ¶

func (c *AppFeatureClient) Get(ctx context.Context, appGUID, featureName string) (*resource.AppFeature, error)

Get retrieves the named app feature

func (*AppFeatureClient) GetRevisions ¶

func (c *AppFeatureClient) GetRevisions(ctx context.Context, appGUID string) (*resource.AppFeature, error)

GetRevisions retrieves the revisions app feature

func (*AppFeatureClient) GetSSH ¶

func (c *AppFeatureClient) GetSSH(ctx context.Context, appGUID string) (*resource.AppFeature, error)

GetSSH retrieves the SSH app feature

func (*AppFeatureClient) List ¶

func (c *AppFeatureClient) List(ctx context.Context, appGUID string) ([]*resource.AppFeature, *Pager, error)

List pages all app features

func (*AppFeatureClient) Update ¶

func (c *AppFeatureClient) Update(ctx context.Context, appGUID, featureName string, enabled bool) (*resource.AppFeature, error)

Update the enabled attribute of the named app feature

func (*AppFeatureClient) UpdateRevisions ¶

func (c *AppFeatureClient) UpdateRevisions(ctx context.Context, appGUID string, enabled bool) (*resource.AppFeature, error)

UpdateRevisions updated the enabled attribute of the revisions app feature

func (*AppFeatureClient) UpdateSSH ¶

func (c *AppFeatureClient) UpdateSSH(ctx context.Context, appGUID string, enabled bool) (*resource.AppFeature, error)

UpdateSSH updated the enabled attribute of the SSH app feature

func (AppListOptions) ToQueryString ¶

func (o AppListOptions) ToQueryString() (url.Values, error)

func (*AppUsageClient) Get ¶

func (c *AppUsageClient) Get(ctx context.Context, guid string) (*resource.AppUsage, error)

Get retrieves the specified app event

func (*AppUsageClient) List ¶

func (c *AppUsageClient) List(ctx context.Context, opts *AppUsageListOptions) ([]*resource.AppUsage, *Pager, error)

List pages all app usage events

func (*AppUsageClient) ListAll ¶

func (c *AppUsageClient) ListAll(ctx context.Context, opts *AppUsageListOptions) ([]*resource.AppUsage, error)

ListAll retrieves all app usage events

func (*AppUsageClient) Purge ¶

func (c *AppUsageClient) Purge(ctx context.Context) error

Purge destroys all existing events. Populates new usage events, one for each started app. All populated events will have a created_at value of current time.

There is the potential race condition if apps are currently being started, stopped, or scaled. The seeded usage events will have the same guid as the app.

func (AppUsageListOptions) ToQueryString ¶

func (o AppUsageListOptions) ToQueryString() (url.Values, error)

func (*AuditEventClient) First ¶

func (c *AuditEventClient) First(ctx context.Context, opts *AuditEventListOptions) (*resource.AuditEvent, error)

First returns the first audit event matching the options or an error when less than 1 match

func (*AuditEventClient) Get ¶

func (c *AuditEventClient) Get(ctx context.Context, guid string) (*resource.AuditEvent, error)

Get retrieves the specified audit event

func (*AuditEventClient) List ¶

func (c *AuditEventClient) List(ctx context.Context, opts *AuditEventListOptions) ([]*resource.AuditEvent, *Pager, error)

List pages all audit events the user has access to

func (*AuditEventClient) ListAll ¶

func (c *AuditEventClient) ListAll(ctx context.Context, opts *AuditEventListOptions) ([]*resource.AuditEvent, error)

ListAll retrieves all audit events the user has access to

func (*AuditEventClient) Single ¶

func (c *AuditEventClient) Single(ctx context.Context, opts *AuditEventListOptions) (*resource.AuditEvent, error)

Single returns a single audit event matching the options or an error if not exactly 1 match

func (AuditEventListOptions) ToQueryString ¶

func (o AuditEventListOptions) ToQueryString() (url.Values, error)

func (BuildAppListOptions) ToQueryString ¶

func (o BuildAppListOptions) ToQueryString() (url.Values, error)

func (*BuildClient) Create ¶

func (c *BuildClient) Create(ctx context.Context, r *resource.BuildCreate) (*resource.Build, error)

Create a new build

func (*BuildClient) Delete ¶

func (c *BuildClient) Delete(ctx context.Context, guid string) error

Delete the specified build

func (*BuildClient) First ¶

func (c *BuildClient) First(ctx context.Context, opts *BuildListOptions) (*resource.Build, error)

First returns the first build matching the options or an error when less than 1 match

func (*BuildClient) FirstForApp ¶

func (c *BuildClient) FirstForApp(ctx context.Context, appGUID string, opts *BuildAppListOptions) (*resource.Build, error)

FirstForApp returns the first build matching the options and app or an error when less than 1 match

func (*BuildClient) Get ¶

func (c *BuildClient) Get(ctx context.Context, guid string) (*resource.Build, error)

Get the specified build

func (*BuildClient) List ¶

func (c *BuildClient) List(ctx context.Context, opts *BuildListOptions) ([]*resource.Build, *Pager, error)

List pages all builds the user has access to

func (*BuildClient) ListAll ¶

func (c *BuildClient) ListAll(ctx context.Context, opts *BuildListOptions) ([]*resource.Build, error)

ListAll retrieves all builds the user has access to

func (*BuildClient) ListForApp ¶

func (c *BuildClient) ListForApp(ctx context.Context, appGUID string, opts *BuildAppListOptions) ([]*resource.Build, *Pager, error)

ListForApp pages all builds for the app the user has access to

func (*BuildClient) ListForAppAll ¶

func (c *BuildClient) ListForAppAll(ctx context.Context, appGUID string, opts *BuildAppListOptions) ([]*resource.Build, error)

ListForAppAll retrieves all builds for the app the user has access to

func (*BuildClient) PollStaged ¶

func (c *BuildClient) PollStaged(ctx context.Context, guid string, opts *PollingOptions) error

PollStaged waits until the build is staged, fails, or times out

func (*BuildClient) Single ¶

func (c *BuildClient) Single(ctx context.Context, opts *BuildListOptions) (*resource.Build, error)

Single returns a single build matching the options or an error if not exactly 1 match

func (*BuildClient) SingleForApp ¶

func (c *BuildClient) SingleForApp(ctx context.Context, appGUID string, opts *BuildAppListOptions) (*resource.Build, error)

SingleForApp returns a single build matching the options and app or an error if not exactly 1 match

func (*BuildClient) Update ¶

func (c *BuildClient) Update(ctx context.Context, guid string, r *resource.BuildUpdate) (*resource.Build, error)

Update the specified attributes of the build

func (BuildListOptions) ToQueryString ¶

func (o BuildListOptions) ToQueryString() (url.Values, error)

func (*BuildpackClient) Create ¶

func (c *BuildpackClient) Create(ctx context.Context, r *resource.BuildpackCreateOrUpdate) (*resource.Buildpack, error)

Create a new buildpack

func (*BuildpackClient) Delete ¶

func (c *BuildpackClient) Delete(ctx context.Context, guid string) error

Delete the specified buildpack

func (*BuildpackClient) First ¶

func (c *BuildpackClient) First(ctx context.Context, opts *BuildpackListOptions) (*resource.Buildpack, error)

First returns the first buildpack matching the options or an error when less than 1 match

func (*BuildpackClient) Get ¶

func (c *BuildpackClient) Get(ctx context.Context, guid string) (*resource.Buildpack, error)

Get retrieves the specified buildpack

func (*BuildpackClient) List ¶

func (c *BuildpackClient) List(ctx context.Context, opts *BuildpackListOptions) ([]*resource.Buildpack, *Pager, error)

List pages all buildpacks the user has access to

func (*BuildpackClient) ListAll ¶

func (c *BuildpackClient) ListAll(ctx context.Context, opts *BuildpackListOptions) ([]*resource.Buildpack, error)

ListAll retrieves all buildpacks the user has access to

func (*BuildpackClient) Single ¶

func (c *BuildpackClient) Single(ctx context.Context, opts *BuildpackListOptions) (*resource.Buildpack, error)

Single returns a single buildpack matching the options or an error if not exactly 1 match

func (*BuildpackClient) Update ¶

func (c *BuildpackClient) Update(ctx context.Context, guid string, r *resource.BuildpackCreateOrUpdate) (*resource.Buildpack, error)

Update the specified attributes of the buildpack

func (*BuildpackClient) Upload ¶

func (c *BuildpackClient) Upload(ctx context.Context, guid string, zipFile io.Reader) (string, *resource.Buildpack, error)

Upload a gzip compressed (zip) file containing a Cloud Foundry compatible buildpack

func (BuildpackListOptions) ToQueryString ¶

func (o BuildpackListOptions) ToQueryString() (url.Values, error)

func (*Client) AccessToken ¶

func (c *Client) AccessToken(ctx context.Context) (string, error)

AccessToken returns the raw encoded OAuth access token without the bearer prefix

func (*Client) SSHCode ¶

func (c *Client) SSHCode(ctx context.Context) (string, error)

SSHCode generates an SSH code that can be used by generic SSH clients to SSH into app instances

func (CloudFoundryHTTPError) Error ¶

func (e CloudFoundryHTTPError) Error() string

func (*DeploymentClient) Cancel ¶

func (c *DeploymentClient) Cancel(ctx context.Context, guid string) error

Cancel the ongoing deployment

func (*DeploymentClient) Create ¶

func (c *DeploymentClient) Create(ctx context.Context, r *resource.DeploymentCreate) (*resource.Deployment, error)

Create a new deployment

func (*DeploymentClient) First ¶

func (c *DeploymentClient) First(ctx context.Context, opts *DeploymentListOptions) (*resource.Deployment, error)

First returns the first deployment matching the options or an error when less than 1 match

func (*DeploymentClient) Get ¶

func (c *DeploymentClient) Get(ctx context.Context, guid string) (*resource.Deployment, error)

Get the specified deployment

func (*DeploymentClient) List ¶

func (c *DeploymentClient) List(ctx context.Context, opts *DeploymentListOptions) ([]*resource.Deployment, *Pager, error)

List pages deployments the user has access to

func (*DeploymentClient) ListAll ¶

func (c *DeploymentClient) ListAll(ctx context.Context, opts *DeploymentListOptions) ([]*resource.Deployment, error)

ListAll retrieves all deployments the user has access to

func (*DeploymentClient) Single ¶

func (c *DeploymentClient) Single(ctx context.Context, opts *DeploymentListOptions) (*resource.Deployment, error)

Single returns a single deployment matching the options or an error if not exactly 1 match

func (*DeploymentClient) Update ¶

func (c *DeploymentClient) Update(ctx context.Context, guid string, r *resource.DeploymentUpdate) (*resource.Deployment, error)

Update the specified attributes of the deployment

func (DeploymentListOptions) ToQueryString ¶

func (o DeploymentListOptions) ToQueryString() (url.Values, error)

func (*DomainClient) Create ¶

func (c *DomainClient) Create(ctx context.Context, r *resource.DomainCreate) (*resource.Domain, error)

Create a new domain

func (*DomainClient) Delete ¶

func (c *DomainClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified domain asynchronously and return a jobGUID.

func (*DomainClient) First ¶

func (c *DomainClient) First(ctx context.Context, opts *DomainListOptions) (*resource.Domain, error)

First returns the first domain matching the options or an error when less than 1 match

func (*DomainClient) FirstForOrganization ¶

func (c *DomainClient) FirstForOrganization(ctx context.Context, organizationGUID string, opts *DomainListOptions) (*resource.Domain, error)

FirstForOrganization returns the first domain matching the options and organization or an error when less than 1 match

func (*DomainClient) Get ¶

func (c *DomainClient) Get(ctx context.Context, guid string) (*resource.Domain, error)

Get the specified domain

func (*DomainClient) List ¶

func (c *DomainClient) List(ctx context.Context, opts *DomainListOptions) ([]*resource.Domain, *Pager, error)

List pages Domains the user has access to

func (*DomainClient) ListAll ¶

func (c *DomainClient) ListAll(ctx context.Context, opts *DomainListOptions) ([]*resource.Domain, error)

ListAll retrieves all domains the user has access to

func (*DomainClient) ListForOrganization ¶

func (c *DomainClient) ListForOrganization(ctx context.Context, organizationGUID string, opts *DomainListOptions) ([]*resource.Domain, *Pager, error)

ListForOrganization pages all domains for the specified org that the user has access to

func (*DomainClient) ListForOrganizationAll ¶

func (c *DomainClient) ListForOrganizationAll(ctx context.Context, organizationGUID string, opts *DomainListOptions) ([]*resource.Domain, error)

ListForOrganizationAll retrieves all domains for the specified org that the user has access to

func (*DomainClient) Share ¶

func (c *DomainClient) Share(ctx context.Context, domainGUID, organizationGUID string) (*resource.ToManyRelationships, error)

Share an organization-scoped domain to the organization specified by the org guid This will allow the organization to use the organization-scoped domain

func (*DomainClient) ShareMany ¶

func (c *DomainClient) ShareMany(ctx context.Context, guid string, r *resource.ToManyRelationships) (*resource.ToManyRelationships, error)

ShareMany shares an organization-scoped domain to other organizations specified by a list of organization guids This will allow any of the other organizations to use the organization-scoped domain.

func (*DomainClient) Single ¶

func (c *DomainClient) Single(ctx context.Context, opts *DomainListOptions) (*resource.Domain, error)

Single returns a single domain matching the options or an error if not exactly 1 match

func (*DomainClient) SingleForOrganization ¶

func (c *DomainClient) SingleForOrganization(ctx context.Context, organizationGUID string, opts *DomainListOptions) (*resource.Domain, error)

SingleForOrganization returns a single domain matching the options and org or an error if not exactly 1 match

func (*DomainClient) UnShare ¶

func (c *DomainClient) UnShare(ctx context.Context, domainGUID, organizationGUID string) error

UnShare an organization-scoped domain to other organizations specified by a list of organization guids This will allow any of the other organizations to use the organization-scoped domain.

func (*DomainClient) Update ¶

func (c *DomainClient) Update(ctx context.Context, guid string, r *resource.DomainUpdate) (*resource.Domain, error)

Update the specified attributes of the domain

func (DomainListOptions) ToQueryString ¶

func (o DomainListOptions) ToQueryString() (url.Values, error)

func (DropletAppListOptions) ToQueryString ¶

func (o DropletAppListOptions) ToQueryString() (url.Values, error)

func (*DropletClient) Copy ¶

func (c *DropletClient) Copy(ctx context.Context, srcDropletGUID string, destAppGUID string) (any, error)

Copy a droplet to a different app. The copied droplet excludes the environment variables listed on the source droplet

func (*DropletClient) Create ¶

func (c *DropletClient) Create(ctx context.Context, r *resource.DropletCreate) (*resource.Droplet, error)

Create a droplet without a package. To create a droplet based on a package, see Create a build

func (*DropletClient) Delete ¶

func (c *DropletClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified droplet asynchronously and return a jobGUID.

func (*DropletClient) Download ¶

func (c *DropletClient) Download(ctx context.Context, guid string) (io.ReadCloser, error)

Download a gzip compressed tarball file containing a Cloud Foundry compatible droplet It is the caller's responsibility to close the io.ReadCloser

func (*DropletClient) First ¶

func (c *DropletClient) First(ctx context.Context, opts *DropletListOptions) (*resource.Droplet, error)

First returns the first droplet matching the options or an error when less than 1 match

func (*DropletClient) FirstForApp ¶

func (c *DropletClient) FirstForApp(ctx context.Context, appGUID string, opts *DropletAppListOptions) (*resource.Droplet, error)

FirstForApp returns the first droplet matching the options and app or an error when less than 1 match

func (*DropletClient) FirstForPackage ¶

func (c *DropletClient) FirstForPackage(ctx context.Context, packageGUID string, opts *DropletPackageListOptions) (*resource.Droplet, error)

FirstForPackage returns the first droplet matching the options and package or an error when less than 1 match

func (*DropletClient) Get ¶

func (c *DropletClient) Get(ctx context.Context, guid string) (*resource.Droplet, error)

Get retrieves the droplet by ID

func (*DropletClient) GetCurrentAssociationForApp ¶

func (c *DropletClient) GetCurrentAssociationForApp(ctx context.Context, appGUID string) (*resource.DropletCurrent, error)

GetCurrentAssociationForApp retrieves the current droplet relationship for an app

func (*DropletClient) GetCurrentForApp ¶

func (c *DropletClient) GetCurrentForApp(ctx context.Context, appGUID string) (*resource.Droplet, error)

GetCurrentForApp retrieves the current droplet for an app

func (*DropletClient) List ¶

func (c *DropletClient) List(ctx context.Context, opts *DropletListOptions) ([]*resource.Droplet, *Pager, error)

List pages all droplets the user has access to

func (*DropletClient) ListAll ¶

func (c *DropletClient) ListAll(ctx context.Context, opts *DropletListOptions) ([]*resource.Droplet, error)

ListAll retrieves all droplets the user has access to

func (*DropletClient) ListForApp ¶

func (c *DropletClient) ListForApp(ctx context.Context, appGUID string, opts *DropletAppListOptions) ([]*resource.Droplet, *Pager, error)

ListForApp pages all droplets for the specified app

func (*DropletClient) ListForAppAll ¶

func (c *DropletClient) ListForAppAll(ctx context.Context, appGUID string, opts *DropletAppListOptions) ([]*resource.Droplet, error)

ListForAppAll retrieves all droplets for the specified app

func (*DropletClient) ListForPackage ¶

func (c *DropletClient) ListForPackage(ctx context.Context, packageGUID string, opts *DropletPackageListOptions) ([]*resource.Droplet, *Pager, error)

ListForPackage pages all droplets for the specified package

func (*DropletClient) ListForPackageAll ¶

func (c *DropletClient) ListForPackageAll(ctx context.Context, packageGUID string, opts *DropletPackageListOptions) ([]*resource.Droplet, error)

ListForPackageAll retrieves all droplets for the specified package

func (*DropletClient) SetCurrentAssociationForApp ¶

func (c *DropletClient) SetCurrentAssociationForApp(ctx context.Context, appGUID, dropletGUID string) (*resource.DropletCurrent, error)

SetCurrentAssociationForApp sets the current droplet for an app. The current droplet is the droplet that the app will use when running

func (*DropletClient) Single ¶

func (c *DropletClient) Single(ctx context.Context, opts *DropletListOptions) (*resource.Droplet, error)

Single returns a single droplet matching the options or an error if not exactly 1 match

func (*DropletClient) SingleForApp ¶

func (c *DropletClient) SingleForApp(ctx context.Context, appGUID string, opts *DropletAppListOptions) (*resource.Droplet, error)

SingleForApp returns a single droplet matching the options and app or an error if not exactly 1 match

func (*DropletClient) SingleForPackage ¶

func (c *DropletClient) SingleForPackage(ctx context.Context, packageGUID string, opts *DropletPackageListOptions) (*resource.Droplet, error)

SingleForPackage returns a single droplet matching the options and package or an error if not exactly 1 match

func (*DropletClient) Update ¶

func (c *DropletClient) Update(ctx context.Context, guid string, r *resource.DropletUpdate) (*resource.Droplet, error)

Update an existing droplet

func (*DropletClient) Upload ¶

func (c *DropletClient) Upload(ctx context.Context, guid string, tgzDroplet io.Reader) (string, *resource.Droplet, error)

Upload a gzip compressed tarball (tgz) file containing a Cloud Foundry compatible droplet

func (DropletListOptions) ToQueryString ¶

func (o DropletListOptions) ToQueryString() (url.Values, error)

func (DropletPackageListOptions) ToQueryString ¶

func (o DropletPackageListOptions) ToQueryString() (url.Values, error)

func (*EnvVarGroupClient) Get ¶

func (c *EnvVarGroupClient) Get(ctx context.Context, name string) (*resource.EnvVarGroup, error)

Get retrieves the specified envvar group

func (*EnvVarGroupClient) GetRunning ¶

func (c *EnvVarGroupClient) GetRunning(ctx context.Context) (*resource.EnvVarGroup, error)

GetRunning retrieves the running envvar group

func (*EnvVarGroupClient) GetStaging ¶

func (c *EnvVarGroupClient) GetStaging(ctx context.Context) (*resource.EnvVarGroup, error)

GetStaging retrieves the running envvar group

func (*EnvVarGroupClient) Update ¶

func (c *EnvVarGroupClient) Update(ctx context.Context, name string, r *resource.EnvVarGroupUpdate) (*resource.EnvVarGroup, error)

Update the specified attributes of the envar group

func (*EnvVarGroupClient) UpdateRunning ¶

func (c *EnvVarGroupClient) UpdateRunning(ctx context.Context, r *resource.EnvVarGroupUpdate) (*resource.EnvVarGroup, error)

UpdateRunning updates the specified attributes of the running envar group

func (*EnvVarGroupClient) UpdateStaging ¶

func (c *EnvVarGroupClient) UpdateStaging(ctx context.Context, r *resource.EnvVarGroupUpdate) (*resource.EnvVarGroup, error)

UpdateStaging updates the specified attributes of the staging envar group

func (*ExclusionFilter) NotEqualTo ¶

func (e *ExclusionFilter) NotEqualTo(v ...string)

func (ExclusionFilter) Serialize ¶

func (e ExclusionFilter) Serialize(values url.Values, tag string) error

func (*FeatureFlagClient) Get ¶

func (c *FeatureFlagClient) Get(ctx context.Context, featureFlag resource.FeatureFlagType) (*resource.FeatureFlag, error)

Get the specified feature flag

func (*FeatureFlagClient) List ¶

func (c *FeatureFlagClient) List(ctx context.Context, opts *FeatureFlagListOptions) ([]*resource.FeatureFlag, *Pager, error)

List pages feature flags

func (*FeatureFlagClient) ListAll ¶

func (c *FeatureFlagClient) ListAll(ctx context.Context, opts *FeatureFlagListOptions) ([]*resource.FeatureFlag, error)

ListAll retrieves all feature flags

func (*FeatureFlagClient) Update ¶

func (c *FeatureFlagClient) Update(ctx context.Context, featureFlag resource.FeatureFlagType, r *resource.FeatureFlagUpdate) (*resource.FeatureFlag, error)

Update the specified attributes of the feature flag

func (FeatureFlagListOptions) ToQueryString ¶

func (o FeatureFlagListOptions) ToQueryString() (url.Values, error)

func (*Filter) EqualTo ¶

func (f *Filter) EqualTo(v ...string)

func (Filter) Serialize ¶

func (f Filter) Serialize(values url.Values, tag string) error

func (FilterModifier) String ¶

func (r FilterModifier) String() string

func (*IsolationSegmentClient) Create ¶

func (c *IsolationSegmentClient) Create(ctx context.Context, r *resource.IsolationSegmentCreate) (*resource.IsolationSegment, error)

Create a new isolation segment

func (*IsolationSegmentClient) Delete ¶

func (c *IsolationSegmentClient) Delete(ctx context.Context, guid string) error

Delete the specified isolation segments

An isolation segment cannot be deleted if it is entitled to any organization.

func (*IsolationSegmentClient) EntitleOrganization ¶

func (c *IsolationSegmentClient) EntitleOrganization(ctx context.Context, guid string, organizationGUID string) (*resource.IsolationSegmentRelationship, error)

EntitleOrganization entitles the specified organization for the isolation segment.

In the case where the specified isolation segment is the system-wide shared segment, and if an organization is not already entitled for any other isolation segment, then the shared isolation segment automatically gets assigned as the default for that organization.

func (*IsolationSegmentClient) EntitleOrganizations ¶

func (c *IsolationSegmentClient) EntitleOrganizations(ctx context.Context, guid string, organizationGUIDs []string) (*resource.IsolationSegmentRelationship, error)

EntitleOrganizations entitles the specified organizations for the isolation segment.

In the case where the specified isolation segment is the system-wide shared segment, and if an organization is not already entitled for any other isolation segment, then the shared isolation segment automatically gets assigned as the default for that organization.

func (*IsolationSegmentClient) First ¶

func (c *IsolationSegmentClient) First(ctx context.Context, opts *IsolationSegmentListOptions) (*resource.IsolationSegment, error)

First returns the first isolation segment matching the options or an error when less than 1 match

func (*IsolationSegmentClient) Get ¶

func (c *IsolationSegmentClient) Get(ctx context.Context, guid string) (*resource.IsolationSegment, error)

Get the specified isolation segment

func (*IsolationSegmentClient) List ¶

func (c *IsolationSegmentClient) List(ctx context.Context, opts *IsolationSegmentListOptions) ([]*resource.IsolationSegment, *Pager, error)

List all isolation segments the user has access to in paged results

For admin, this is all the isolation segments in the system. For anyone else, this is the isolation segments in the allowed list for any organization to which the user belongs.

func (*IsolationSegmentClient) ListAll ¶

func (c *IsolationSegmentClient) ListAll(ctx context.Context, opts *IsolationSegmentListOptions) ([]*resource.IsolationSegment, error)

ListAll retrieves all isolation segments the user has access to

For admin, this is all the isolation segments in the system. For anyone else, this is the isolation segments in the allowed list for any organization to which the user belongs.

func (*IsolationSegmentClient) ListOrganizationRelationships ¶

func (c *IsolationSegmentClient) ListOrganizationRelationships(ctx context.Context, guid string) ([]string, error)

ListOrganizationRelationships lists the organizations entitled for the isolation segment.

For an Admin, this will list all entitled organizations in the system. For any other user, this will list only the entitled organizations to which the user belongs.

func (*IsolationSegmentClient) ListSpaceRelationships ¶

func (c *IsolationSegmentClient) ListSpaceRelationships(ctx context.Context, guid string) ([]string, error)

ListSpaceRelationships lists the spaces to which the isolation segment is assigned.

For an Admin, this will list all associated spaces in the system. For an organization manager, this will list only those associated spaces belonging to orgs for which the user is a manager. For any other user, this will list only those associated spaces to which the user has access.

func (*IsolationSegmentClient) RevokeOrganization ¶

func (c *IsolationSegmentClient) RevokeOrganization(ctx context.Context, guid string, organizationGUID string) error

RevokeOrganization revokes the entitlement for the specified organization to the isolation segment

If the isolation segment is assigned to a space within an organization, the entitlement cannot be revoked. If the isolation segment is the organization’s default, the entitlement cannot be revoked.

func (*IsolationSegmentClient) RevokeOrganizations ¶

func (c *IsolationSegmentClient) RevokeOrganizations(ctx context.Context, guid string, organizationGUIDs []string) error

RevokeOrganizations revokes the entitlement for all the specified organizations to the isolation segment

If the isolation segment is assigned to a space within an organization, the entitlement cannot be revoked. If the isolation segment is the organization’s default, the entitlement cannot be revoked.

func (*IsolationSegmentClient) Single ¶

func (c *IsolationSegmentClient) Single(ctx context.Context, opts *IsolationSegmentListOptions) (*resource.IsolationSegment, error)

Single returns a single iso segment matching the options or an error if not exactly 1 match

func (*IsolationSegmentClient) Update ¶

func (c *IsolationSegmentClient) Update(ctx context.Context, guid string, r *resource.IsolationSegmentUpdate) (*resource.IsolationSegment, error)

Update the specified attributes of the isolation segments

func (IsolationSegmentListOptions) ToQueryString ¶

func (o IsolationSegmentListOptions) ToQueryString() (url.Values, error)

func (*JobClient) Get ¶

func (c *JobClient) Get(ctx context.Context, guid string) (*resource.Job, error)

Get the specified job

func (*JobClient) PollComplete ¶

func (c *JobClient) PollComplete(ctx context.Context, jobGUID string, opts *PollingOptions) error

PollComplete waits until the job completes, fails, or times out

func (LabelSelector) EqualTo ¶

func (l LabelSelector) EqualTo(key string, values ...string)

func (LabelSelector) Existence ¶

func (l LabelSelector) Existence(key string)

func (LabelSelector) NotEqualTo ¶

func (l LabelSelector) NotEqualTo(key string, values ...string)

func (LabelSelector) NotExistence ¶

func (l LabelSelector) NotExistence(key string)

func (LabelSelector) Serialize ¶

func (l LabelSelector) Serialize(values url.Values, tag string) error

func (*ListOptions) CurrentPage ¶

func (lo *ListOptions) CurrentPage(page, perPage int)

func (ListOptions) Serialize ¶

func (lo ListOptions) Serialize(values url.Values, _ string) error

func (*ListOptions) ToQueryString ¶

func (lo *ListOptions) ToQueryString(subOptionsPtr any) (url.Values, error)

func (*ManifestClient) ApplyManifest ¶

func (c *ManifestClient) ApplyManifest(ctx context.Context, spaceGUID string, manifest string) (string, error)

ApplyManifest applies the changes specified in a manifest to the named apps and their underlying processes asynchronously and returns a jobGUID.

The apps must reside in the space. These changes are additive and will not modify any unspecified properties or remove any existing environment variables, routes, or services.

func (*ManifestClient) Generate ¶

func (c *ManifestClient) Generate(ctx context.Context, appGUID string) (string, error)

Generate the specified app manifest as a yaml text string

func (*OrganizationClient) AssignDefaultIsolationSegment ¶

func (c *OrganizationClient) AssignDefaultIsolationSegment(ctx context.Context, guid, isolationSegmentGUID string) error

AssignDefaultIsolationSegment assigns a default iso segment to the specified organization

Apps will not run in the new default isolation segment until they are restarted An empty isolationSegmentGUID will un-assign the default isolation segment

func (*OrganizationClient) Create ¶

func (c *OrganizationClient) Create(ctx context.Context, r *resource.OrganizationCreate) (*resource.Organization, error)

Create an organization

func (*OrganizationClient) Delete ¶

func (c *OrganizationClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified organization asynchronously and return a jobGUID

func (*OrganizationClient) First ¶

func (c *OrganizationClient) First(ctx context.Context, opts *OrganizationListOptions) (*resource.Organization, error)

First returns the first organization matching the options or an error when less than 1 match

func (*OrganizationClient) FirstForIsolationSegment ¶

func (c *OrganizationClient) FirstForIsolationSegment(ctx context.Context, isolationSegmentGUID string, opts *OrganizationListOptions) (*resource.Organization, error)

FirstForIsolationSegment returns the first organization matching the options and iso segment or an error when less than 1 match

func (*OrganizationClient) Get ¶

func (c *OrganizationClient) Get(ctx context.Context, guid string) (*resource.Organization, error)

Get the specified organization

func (*OrganizationClient) GetDefaultDomain ¶

func (c *OrganizationClient) GetDefaultDomain(ctx context.Context, guid string) (*resource.Domain, error)

GetDefaultDomain gets the specified organization's default domain if any

func (*OrganizationClient) GetDefaultIsolationSegment ¶

func (c *OrganizationClient) GetDefaultIsolationSegment(ctx context.Context, guid string) (string, error)

GetDefaultIsolationSegment gets the specified organization's default iso segment GUID if any

func (*OrganizationClient) GetUsageSummary ¶

func (c *OrganizationClient) GetUsageSummary(ctx context.Context, guid string) (*resource.OrganizationUsageSummary, error)

GetUsageSummary gets the specified organization's usage summary

func (*OrganizationClient) List ¶

func (c *OrganizationClient) List(ctx context.Context, opts *OrganizationListOptions) ([]*resource.Organization, *Pager, error)

List pages all organizations the user has access to

func (*OrganizationClient) ListAll ¶

func (c *OrganizationClient) ListAll(ctx context.Context, opts *OrganizationListOptions) ([]*resource.Organization, error)

ListAll retrieves all organizations the user has access to

func (*OrganizationClient) ListForIsolationSegment ¶

func (c *OrganizationClient) ListForIsolationSegment(ctx context.Context, isolationSegmentGUID string, opts *OrganizationListOptions) ([]*resource.Organization, *Pager, error)

ListForIsolationSegment pages all organizations for the specified isolation segment

func (*OrganizationClient) ListForIsolationSegmentAll ¶

func (c *OrganizationClient) ListForIsolationSegmentAll(ctx context.Context, isolationSegmentGUID string, opts *OrganizationListOptions) ([]*resource.Organization, error)

ListForIsolationSegmentAll retrieves all organizations for the specified isolation segment

func (*OrganizationClient) ListUsers ¶

func (c *OrganizationClient) ListUsers(ctx context.Context, guid string, opts *UserListOptions) ([]*resource.User, *Pager, error)

ListUsers pages of all users that are members of the specified organization

func (*OrganizationClient) ListUsersAll ¶

func (c *OrganizationClient) ListUsersAll(ctx context.Context, guid string, opts *UserListOptions) ([]*resource.User, error)

ListUsersAll retrieves all users that are members of the specified organization

func (*OrganizationClient) Single ¶

func (c *OrganizationClient) Single(ctx context.Context, opts *OrganizationListOptions) (*resource.Organization, error)

Single returns a single organization matching the options or an error if not exactly 1 match

func (*OrganizationClient) SingleForIsolationSegment ¶

func (c *OrganizationClient) SingleForIsolationSegment(ctx context.Context, isolationSegmentGUID string, opts *OrganizationListOptions) (*resource.Organization, error)

SingleForIsolationSegment returns a single organization matching the options and iso segment or an error if not exactly 1 match

func (*OrganizationClient) Update ¶

func (c *OrganizationClient) Update(ctx context.Context, guid string, r *resource.OrganizationUpdate) (*resource.Organization, error)

Update the organization's specified attributes

func (OrganizationListOptions) ToQueryString ¶

func (o OrganizationListOptions) ToQueryString() (url.Values, error)

func (*OrganizationQuotaClient) Apply ¶

func (c *OrganizationQuotaClient) Apply(ctx context.Context, guid string, organizationGUIDs []string) ([]string, error)

Apply the specified organization quota to the organizations

func (*OrganizationQuotaClient) Create ¶

func (c *OrganizationQuotaClient) Create(ctx context.Context, r *resource.OrganizationQuotaCreateOrUpdate) (*resource.OrganizationQuota, error)

Create a new organization quota

func (*OrganizationQuotaClient) Delete ¶

func (c *OrganizationQuotaClient) Delete(ctx context.Context, guid string) error

Delete the specified organization quota

func (*OrganizationQuotaClient) First ¶

func (c *OrganizationQuotaClient) First(ctx context.Context, opts *OrganizationQuotaListOptions) (*resource.OrganizationQuota, error)

First returns the first organization quota matching the options or an error when less than 1 match

func (*OrganizationQuotaClient) Get ¶

func (c *OrganizationQuotaClient) Get(ctx context.Context, guid string) (*resource.OrganizationQuota, error)

Get the specified organization quota

func (*OrganizationQuotaClient) List ¶

func (c *OrganizationQuotaClient) List(ctx context.Context, opts *OrganizationQuotaListOptions) ([]*resource.OrganizationQuota, *Pager, error)

List pages all organization quotas the user has access to

func (*OrganizationQuotaClient) ListAll ¶

func (c *OrganizationQuotaClient) ListAll(ctx context.Context, opts *OrganizationQuotaListOptions) ([]*resource.OrganizationQuota, error)

ListAll retrieves all organization quotas the user has access to

func (*OrganizationQuotaClient) Single ¶

func (c *OrganizationQuotaClient) Single(ctx context.Context, opts *OrganizationQuotaListOptions) (*resource.OrganizationQuota, error)

Single returns a single organization quota matching the options or an error if not exactly 1 match

func (*OrganizationQuotaClient) Update ¶

func (c *OrganizationQuotaClient) Update(ctx context.Context, guid string, r *resource.OrganizationQuotaCreateOrUpdate) (*resource.OrganizationQuota, error)

Update the specified attributes of the organization quota

func (OrganizationQuotaListOptions) ToQueryString ¶

func (o OrganizationQuotaListOptions) ToQueryString() (url.Values, error)

func (*PackageClient) Copy ¶

func (c *PackageClient) Copy(ctx context.Context, srcPackageGUID string, destAppGUID string) (*resource.Package, error)

Copy the bits of a source package to a target package

func (*PackageClient) Create ¶

func (c *PackageClient) Create(ctx context.Context, r *resource.PackageCreate) (*resource.Package, error)

Create a new package

func (*PackageClient) Delete ¶

func (c *PackageClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified package asynchronously and return a jobGUID

func (*PackageClient) Download ¶

func (c *PackageClient) Download(ctx context.Context, guid string) (io.ReadCloser, error)

Download the bits of an existing package It is the caller's responsibility to close the io.ReadCloser

func (*PackageClient) First ¶

func (c *PackageClient) First(ctx context.Context, opts *PackageListOptions) (*resource.Package, error)

First returns the first package matching the options or an error when less than 1 match

func (*PackageClient) FirstForApp ¶

func (c *PackageClient) FirstForApp(ctx context.Context, appGUID string, opts *PackageListOptions) (*resource.Package, error)

FirstForApp returns the first package matching the options and app or an error when less than 1 match

func (*PackageClient) Get ¶

func (c *PackageClient) Get(ctx context.Context, guid string) (*resource.Package, error)

Get the specified build

func (*PackageClient) List ¶

func (c *PackageClient) List(ctx context.Context, opts *PackageListOptions) ([]*resource.Package, *Pager, error)

List pages all the packages the user has access to

func (*PackageClient) ListAll ¶

func (c *PackageClient) ListAll(ctx context.Context, opts *PackageListOptions) ([]*resource.Package, error)

ListAll retrieves all the packages the user has access to

func (*PackageClient) ListForApp ¶

func (c *PackageClient) ListForApp(ctx context.Context, appGUID string, opts *PackageListOptions) ([]*resource.Package, *Pager, error)

ListForApp pages all the packages the user has access to

func (*PackageClient) ListForAppAll ¶

func (c *PackageClient) ListForAppAll(ctx context.Context, appGUID string, opts *PackageListOptions) ([]*resource.Package, error)

ListForAppAll retrieves all the packages the user has access to

func (*PackageClient) PollReady ¶

func (c *PackageClient) PollReady(ctx context.Context, guid string, opts *PollingOptions) error

PollReady waits until the package is ready, fails, or times out

func (*PackageClient) Single ¶

func (c *PackageClient) Single(ctx context.Context, opts *PackageListOptions) (*resource.Package, error)

Single returns a single package matching the options or an error if not exactly 1 match

func (*PackageClient) SingleForApp ¶

func (c *PackageClient) SingleForApp(ctx context.Context, appGUID string, opts *PackageListOptions) (*resource.Package, error)

SingleForApp returns a single package matching the options for the app or an error if not exactly 1 match

func (*PackageClient) Update ¶

func (c *PackageClient) Update(ctx context.Context, guid string, r *resource.PackageUpdate) (*resource.Package, error)

Update the specified attributes of the package

func (*PackageClient) Upload ¶

func (c *PackageClient) Upload(ctx context.Context, guid string, zipFile io.Reader) (*resource.Package, error)

Upload an app's zip file contents

func (PackageListOptions) ToQueryString ¶

func (o PackageListOptions) ToQueryString() (url.Values, error)

func (*Pager) HasNextPage ¶

func (p *Pager) HasNextPage() bool

func (*Pager) HasPreviousPage ¶

func (p *Pager) HasPreviousPage() bool

func (*Pager) NextPage ¶

func (p *Pager) NextPage(opts ListOptioner)

func (*Pager) PreviousPage ¶

func (p *Pager) PreviousPage(opts ListOptioner)

func (*ProcessClient) First ¶

func (c *ProcessClient) First(ctx context.Context, opts *ProcessListOptions) (*resource.Process, error)

First returns the first process matching the options or an error when less than 1 match

func (*ProcessClient) FirstForApp ¶

func (c *ProcessClient) FirstForApp(ctx context.Context, appGUID string, opts *ProcessListOptions) (*resource.Process, error)

FirstForApp returns the first process matching the options and app or an error when less than 1 match

func (*ProcessClient) Get ¶

func (c *ProcessClient) Get(ctx context.Context, guid string) (*resource.Process, error)

Get the specified process

func (*ProcessClient) GetStats ¶

func (c *ProcessClient) GetStats(ctx context.Context, guid string) (*resource.ProcessStats, error)

GetStats for the specified process

func (*ProcessClient) GetStatsForApp ¶

func (c *ProcessClient) GetStatsForApp(ctx context.Context, appGUID, processType string) (*resource.ProcessStats, error)

GetStatsForApp for the specified app

func (*ProcessClient) List ¶

func (c *ProcessClient) List(ctx context.Context, opts *ProcessListOptions) ([]*resource.Process, *Pager, error)

List pages all processes

func (*ProcessClient) ListAll ¶

func (c *ProcessClient) ListAll(ctx context.Context, opts *ProcessListOptions) ([]*resource.Process, error)

ListAll retrieves all processes

func (*ProcessClient) ListForApp ¶

func (c *ProcessClient) ListForApp(ctx context.Context, appGUID string, opts *ProcessListOptions) ([]*resource.Process, *Pager, error)

ListForApp pages all processes for the specified app

func (*ProcessClient) ListForAppAll ¶

func (c *ProcessClient) ListForAppAll(ctx context.Context, appGUID string, opts *ProcessListOptions) ([]*resource.Process, error)

ListForAppAll retrieves all processes for the specified app

func (*ProcessClient) Scale ¶

func (c *ProcessClient) Scale(ctx context.Context, guid string, scale *resource.ProcessScale) (*resource.Process, error)

Scale the process using the specified scaling requirements

func (*ProcessClient) Single ¶

func (c *ProcessClient) Single(ctx context.Context, opts *ProcessListOptions) (*resource.Process, error)

Single returns a single package matching the options or an error if not exactly 1 match

func (*ProcessClient) SingleForApp ¶

func (c *ProcessClient) SingleForApp(ctx context.Context, appGUID string, opts *ProcessListOptions) (*resource.Process, error)

SingleForApp returns a single package matching the options for the app or an error if not exactly 1 match

func (*ProcessClient) Terminate ¶

func (c *ProcessClient) Terminate(ctx context.Context, guid string, index int) error

Terminate an instance of a specific process. Health management will eventually restart the instance.

func (*ProcessClient) Update ¶

func (c *ProcessClient) Update(ctx context.Context, guid string, r *resource.ProcessUpdate) (*resource.Process, error)

Update the specified attributes of the process

func (ProcessListOptions) ToQueryString ¶

func (o ProcessListOptions) ToQueryString() (url.Values, error)

func (*ResourceMatchClient) Create ¶

func (c *ResourceMatchClient) Create(ctx context.Context, toMatch *resource.ResourceMatches) (*resource.ResourceMatches, error)

Create a list of cached resources from the input list

func (*RevisionClient) FirstForApp ¶

func (c *RevisionClient) FirstForApp(ctx context.Context, appGUID string, opts *RevisionListOptions) (*resource.Revision, error)

FirstForApp returns the first revision matching the options and app or an error when less than 1 match

func (*RevisionClient) Get ¶

func (c *RevisionClient) Get(ctx context.Context, guid string) (*resource.Revision, error)

Get the specified revision

func (*RevisionClient) GetEnvironmentVariables ¶

func (c *RevisionClient) GetEnvironmentVariables(ctx context.Context, guid string) (map[string]*string, error)

GetEnvironmentVariables retrieves the specified revision's environment variables

func (*RevisionClient) ListForApp ¶

func (c *RevisionClient) ListForApp(ctx context.Context, appGUID string, opts *RevisionListOptions) ([]*resource.Revision, *Pager, error)

ListForApp pages revisions that are associated with the specified app

func (*RevisionClient) ListForAppAll ¶

func (c *RevisionClient) ListForAppAll(ctx context.Context, appGUID string, opts *RevisionListOptions) ([]*resource.Revision, error)

ListForAppAll retrieves all revisions that are associated with the specified app

func (*RevisionClient) ListForAppDeployed ¶

func (c *RevisionClient) ListForAppDeployed(ctx context.Context, appGUID string, opts *RevisionListOptions) ([]*resource.Revision, *Pager, error)

ListForAppDeployed pages deployed revisions that are associated with the specified app

func (*RevisionClient) ListForAppDeployedAll ¶

func (c *RevisionClient) ListForAppDeployedAll(ctx context.Context, appGUID string, opts *RevisionListOptions) ([]*resource.Revision, error)

ListForAppDeployedAll pages deployed revisions that are associated with the specified app

func (*RevisionClient) SingleForApp ¶

func (c *RevisionClient) SingleForApp(ctx context.Context, appGUID string, opts *RevisionListOptions) (*resource.Revision, error)

SingleForApp returns a single revision matching the options and app or an error if not exactly 1 match

func (*RevisionClient) SingleForAppDeployed ¶

func (c *RevisionClient) SingleForAppDeployed(ctx context.Context, appGUID string, opts *RevisionListOptions) (*resource.Revision, error)

SingleForAppDeployed returns a single deployed revision matching the options and app or an error if not exactly 1 match

func (*RevisionClient) Update ¶

func (c *RevisionClient) Update(ctx context.Context, guid string, r *resource.RevisionUpdate) (*resource.Revision, error)

Update the specified attributes of the deployment

func (RevisionListOptions) ToQueryString ¶

func (o RevisionListOptions) ToQueryString() (url.Values, error)

func (*RoleClient) CreateOrganizationRole ¶

func (c *RoleClient) CreateOrganizationRole(ctx context.Context, organizationGUID, userGUID string, roleType resource.OrganizationRoleType) (*resource.Role, error)

CreateOrganizationRole creates a new role for a user in the organization

To create an organization role you must be an admin or organization manager in the organization associated with the role.

func (*RoleClient) CreateSpaceRole ¶

func (c *RoleClient) CreateSpaceRole(ctx context.Context, spaceGUID, userGUID string, roleType resource.SpaceRoleType) (*resource.Role, error)

CreateSpaceRole creates a new role for a user in the space

To create a space role you must be an admin, an organization manager in the parent organization of the space associated with the role, or a space manager in the space associated with the role.

For a user to be assigned a space role, the user must already have an organization role in the parent organization.

func (*RoleClient) Delete ¶

func (c *RoleClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified role asynchronously and return a jobGUID

func (*RoleClient) First ¶

func (c *RoleClient) First(ctx context.Context, opts *RoleListOptions) (*resource.Role, error)

First returns the first role matching the options or an error when less than 1 match

func (*RoleClient) Get ¶

func (c *RoleClient) Get(ctx context.Context, guid string) (*resource.Role, error)

Get the specified role

func (*RoleClient) GetIncludeOrganizations ¶

func (c *RoleClient) GetIncludeOrganizations(ctx context.Context, guid string) (*resource.Role, []*resource.Organization, error)

GetIncludeOrganizations allows callers to fetch a role and include any assigned organizations

func (*RoleClient) GetIncludeSpaces ¶

func (c *RoleClient) GetIncludeSpaces(ctx context.Context, guid string) (*resource.Role, []*resource.Space, error)

GetIncludeSpaces allows callers to fetch a role and include any assigned spaces

func (*RoleClient) GetIncludeUsers ¶

func (c *RoleClient) GetIncludeUsers(ctx context.Context, guid string) (*resource.Role, []*resource.User, error)

GetIncludeUsers allows callers to fetch a role and include any assigned users

func (*RoleClient) List ¶

func (c *RoleClient) List(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, *Pager, error)

List all roles the user has access to in paged results

func (*RoleClient) ListAll ¶

func (c *RoleClient) ListAll(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, error)

ListAll retrieves all roles the user has access to

func (*RoleClient) ListIncludeOrganizations ¶

func (c *RoleClient) ListIncludeOrganizations(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.Organization, *Pager, error)

ListIncludeOrganizations pages all roles and specified and includes organizations that have the roles

func (*RoleClient) ListIncludeOrganizationsAll ¶

func (c *RoleClient) ListIncludeOrganizationsAll(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.Organization, error)

ListIncludeOrganizationsAll retrieves all roles and specified and includes organizations that have the roles

func (*RoleClient) ListIncludeSpaces ¶

func (c *RoleClient) ListIncludeSpaces(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.Space, *Pager, error)

ListIncludeSpaces pages all roles and specified and includes spaces that have the roles

func (*RoleClient) ListIncludeSpacesAll ¶

func (c *RoleClient) ListIncludeSpacesAll(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.Space, error)

ListIncludeSpacesAll retrieves all roles and specified and includes spaces that have the roles

func (*RoleClient) ListIncludeUsers ¶

func (c *RoleClient) ListIncludeUsers(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.User, *Pager, error)

ListIncludeUsers pages all roles and specified and includes users that belong to the roles

func (*RoleClient) ListIncludeUsersAll ¶

func (c *RoleClient) ListIncludeUsersAll(ctx context.Context, opts *RoleListOptions) ([]*resource.Role, []*resource.User, error)

ListIncludeUsersAll retrieves all roles and all the users that belong to those roles

func (*RoleClient) Single ¶

func (c *RoleClient) Single(ctx context.Context, opts *RoleListOptions) (*resource.Role, error)

Single returns a single role matching the options or an error if not exactly 1 match

func (*RoleListOptions) ToQueryString ¶

func (o *RoleListOptions) ToQueryString() (url.Values, error)

func (*RoleListOptions) WithOrganizationRoleType ¶

func (o *RoleListOptions) WithOrganizationRoleType(roleType ...resource.OrganizationRoleType)

WithOrganizationRoleType returns only roles with the specified organization roles type

func (*RoleListOptions) WithSpaceRoleType ¶

func (o *RoleListOptions) WithSpaceRoleType(roleType ...resource.SpaceRoleType)

WithSpaceRoleType returns only roles with the specified space roles type

func (*RootClient) Get ¶

func (c *RootClient) Get(ctx context.Context) (*resource.Root, error)

Get queries the global API root /

These endpoints link to other resources, endpoints, and external services that are relevant to authenticated API clients.

func (*RouteClient) Create ¶

func (c *RouteClient) Create(ctx context.Context, r *resource.RouteCreate) (*resource.Route, error)

Create a new route

func (*RouteClient) Delete ¶

func (c *RouteClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified route asynchronously and return a jobGUID

func (*RouteClient) DeleteUnmappedRoutesForSpace ¶

func (c *RouteClient) DeleteUnmappedRoutesForSpace(ctx context.Context, spaceGUID string) (string, error)

DeleteUnmappedRoutesForSpace deletes all routes in a space that are not mapped to any applications and not bound to any service instances and returns the async JobGUID

func (*RouteClient) First ¶

func (c *RouteClient) First(ctx context.Context, opts *RouteListOptions) (*resource.Route, error)

First returns the first route matching the options or an error when less than 1 match

func (*RouteClient) FirstForApp ¶

func (c *RouteClient) FirstForApp(ctx context.Context, appGUID string, opts *RouteListOptions) (*resource.Route, error)

FirstForApp returns the first route matching the options and app or an error when less than 1 match

func (*RouteClient) Get ¶

func (c *RouteClient) Get(ctx context.Context, guid string) (*resource.Route, error)

Get the specified route

func (*RouteClient) GetDestinations ¶

func (c *RouteClient) GetDestinations(ctx context.Context, guid string) (*resource.RouteDestinations, error)

GetDestinations retrieves all destinations associated with a route

func (*RouteClient) GetIncludeDomain ¶

func (c *RouteClient) GetIncludeDomain(ctx context.Context, guid string) (*resource.Route, *resource.Domain, error)

GetIncludeDomain allows callers to fetch a route and include the parent domain

func (*RouteClient) GetIncludeSpace ¶

func (c *RouteClient) GetIncludeSpace(ctx context.Context, guid string) (*resource.Route, *resource.Space, error)

GetIncludeSpace allows callers to fetch a route and include the parent space

func (*RouteClient) GetIncludeSpaceAndOrganization ¶

func (c *RouteClient) GetIncludeSpaceAndOrganization(ctx context.Context, guid string) (*resource.Route, *resource.Space, *resource.Organization, error)

GetIncludeSpaceAndOrganization allows callers to fetch a route and include the parent space and organization

func (*RouteClient) GetSharedSpacesRelationships ¶

func (c *RouteClient) GetSharedSpacesRelationships(ctx context.Context, guid string) (*resource.RouteSharedSpaceRelationships, error)

GetSharedSpacesRelationships retrieves the spaces that the route has been shared to

func (*RouteClient) InsertDestinations ¶

func (c *RouteClient) InsertDestinations(ctx context.Context, guid string, dest []*resource.RouteDestinationInsertOrReplace) (*resource.RouteDestinations, error)

InsertDestinations add one or more destinations to a route, preserving any existing destinations

Note that weighted destinations cannot be added with this endpoint. To add weighted destinations, replace all destinations for a route at once using the replace destinations endpoint.

func (*RouteClient) IsRouteReserved ¶

func (c *RouteClient) IsRouteReserved(ctx context.Context, domainGUID string, opts *RouteReservationListOptions) (bool, error)

IsRouteReserved checks if a specific route for a domain exists, regardless of the user’s visibility for the route in case the route belongs to a space the user does not belong to

func (*RouteClient) List ¶

func (c *RouteClient) List(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, *Pager, error)

List pages routes the user has access to

func (*RouteClient) ListAll ¶

func (c *RouteClient) ListAll(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, error)

ListAll retrieves all routes the user has access to

func (*RouteClient) ListForApp ¶

func (c *RouteClient) ListForApp(ctx context.Context, appGUID string, opts *RouteListOptions) ([]*resource.Route, *Pager, error)

ListForApp pages routes for the specified app the user has access to

func (*RouteClient) ListForAppAll ¶

func (c *RouteClient) ListForAppAll(ctx context.Context, appGUID string, opts *RouteListOptions) ([]*resource.Route, error)

ListForAppAll retrieves all routes for the specified app the user has access to

func (*RouteClient) ListIncludeDomains ¶

func (c *RouteClient) ListIncludeDomains(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Domain, *Pager, error)

ListIncludeDomains page all routes the user has access to and include the parent domains

func (*RouteClient) ListIncludeDomainsAll ¶

func (c *RouteClient) ListIncludeDomainsAll(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Domain, error)

ListIncludeDomainsAll retrieves all routes the user has access to and includes the parent domains

func (*RouteClient) ListIncludeSpaces ¶

func (c *RouteClient) ListIncludeSpaces(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Space, *Pager, error)

ListIncludeSpaces page all routes the user has access to and include the parent spaces

func (*RouteClient) ListIncludeSpacesAll ¶

func (c *RouteClient) ListIncludeSpacesAll(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Space, error)

ListIncludeSpacesAll retrieves all routes the user has access to and includes the parent spaces

func (*RouteClient) ListIncludeSpacesAndOrganizations ¶

func (c *RouteClient) ListIncludeSpacesAndOrganizations(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Space, []*resource.Organization, *Pager, error)

ListIncludeSpacesAndOrganizations page all routes the user has access to and include the parent spaces and organizations

func (*RouteClient) ListIncludeSpacesAndOrganizationsAll ¶

func (c *RouteClient) ListIncludeSpacesAndOrganizationsAll(ctx context.Context, opts *RouteListOptions) ([]*resource.Route, []*resource.Space, []*resource.Organization, error)

ListIncludeSpacesAndOrganizationsAll retrieves all routes the user has access to and includes the parent spaces and organization

func (*RouteClient) RemoveDestination ¶

func (c *RouteClient) RemoveDestination(ctx context.Context, guid, destinationGUID string) error

RemoveDestination removes a destination from a route

func (*RouteClient) ReplaceDestinations ¶

func (c *RouteClient) ReplaceDestinations(ctx context.Context, guid string, dest []*resource.RouteDestinationInsertOrReplace) (*resource.RouteDestinations, error)

ReplaceDestinations replaces all destinations for a route, removing any destinations not included in the provided list

If using weighted destinations, all destinations provided here must have a weight specified, and all weights for this route must sum to 100. If not, all provided destinations must not have a weight. Mixing weighted and unweighted destinations for a route is not allowed.

func (*RouteClient) ShareWithSpace ¶

func (c *RouteClient) ShareWithSpace(ctx context.Context, guid string, spaceGUID string) (*resource.RouteSharedSpaceRelationships, error)

ShareWithSpace shares the route with the specified space

In order to share into a space the requesting user must be a space developer in the target space

func (*RouteClient) ShareWithSpaces ¶

func (c *RouteClient) ShareWithSpaces(ctx context.Context, guid string, spaceGUIDs []string) (*resource.RouteSharedSpaceRelationships, error)

ShareWithSpaces shares the route with the specified spaces

In order to share into a space the requesting user must be a space developer in the target space

func (*RouteClient) Single ¶

func (c *RouteClient) Single(ctx context.Context, opts *RouteListOptions) (*resource.Route, error)

Single returns a single route matching the options or an error if not exactly 1 match

func (*RouteClient) SingleForApp ¶

func (c *RouteClient) SingleForApp(ctx context.Context, appGUID string, opts *RouteListOptions) (*resource.Route, error)

SingleForApp returns a single route matching the options and app or an error if not exactly 1 match

func (*RouteClient) TransferOwnership ¶

func (c *RouteClient) TransferOwnership(ctx context.Context, guid string, spaceGUID string) error

TransferOwnership transfers the ownership of a route to another space

Users must have write access for both spaces to perform this action. The original owning space will still retain access to the route as a shared space. To completely remove a space from a route, users will have to un-share the route.

func (*RouteClient) UnShareWithSpace ¶

func (c *RouteClient) UnShareWithSpace(ctx context.Context, guid string, spaceGUID string) error

UnShareWithSpace un-shares the route with the specified space

This will automatically unbind any applications bound to this route in the specified space Un-sharing a route from a space will not delete any service keys

func (*RouteClient) UnShareWithSpaces ¶

func (c *RouteClient) UnShareWithSpaces(ctx context.Context, guid string, spaceGUIDs []string) error

UnShareWithSpaces un-shares the route with the specified spaces

This will automatically unbind any applications bound to this route in the specified space Un-sharing a route from a space will not delete any service keys

func (*RouteClient) Update ¶

func (c *RouteClient) Update(ctx context.Context, guid string, r *resource.RouteUpdate) (*resource.Route, error)

Update the specified attributes of the app

func (*RouteClient) UpdateDestinationProtocol ¶

func (c *RouteClient) UpdateDestinationProtocol(ctx context.Context, guid, destinationGUID, protocol string) (*resource.RouteDestinationWithLinks, error)

UpdateDestinationProtocol updates the protocol of a route destination (app, port and weight cannot be updated)

Protocol the destination will use. Valid protocols are http1 or http2 if route protocol is http, tcp if route protocol is tcp. An empty string will set it to either http1 or tcp based on the route protocol

func (RouteListOptions) ToQueryString ¶

func (o RouteListOptions) ToQueryString() (url.Values, error)

func (RouteReservationListOptions) ToQueryString ¶

func (o RouteReservationListOptions) ToQueryString() (url.Values, error)

func (*SecurityGroupClient) BindRunningSecurityGroup ¶

func (c *SecurityGroupClient) BindRunningSecurityGroup(ctx context.Context, guid string, spaceGUIDs []string) ([]string, error)

BindRunningSecurityGroup binds one or more spaces to a security group with the running lifecycle and returns the space GUIDs bound to the security group

Running app containers within these spaces will inherit the rules specified by this security group. Apps within these spaces must be restarted for these changes to take effect. Unless a security group is globally-enabled, an admin must add it to a space for it to be visible for the org and space managers. Once it’s visible, org and space managers can add it to additional spaces.

func (*SecurityGroupClient) BindStagingSecurityGroup ¶

func (c *SecurityGroupClient) BindStagingSecurityGroup(ctx context.Context, guid string, spaceGUIDs []string) ([]string, error)

BindStagingSecurityGroup binds one or more spaces to a security group with the staging lifecycle and returns the space GUIDs bound to the security group

Staging app containers within these spaces will inherit the rules specified by this security group. Apps within these spaces must be restaged for these changes to take effect. Unless a security group is globally-enabled, an admin must add it to a space for it to be visible for the org and space managers. Once it’s visible, org and space managers can add it to additional spaces.

func (*SecurityGroupClient) Create ¶

func (c *SecurityGroupClient) Create(ctx context.Context, r *resource.SecurityGroupCreate) (*resource.SecurityGroup, error)

Create a new domain

func (*SecurityGroupClient) Delete ¶

func (c *SecurityGroupClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified security group asynchronously and return a jobGUID

func (*SecurityGroupClient) First ¶

func (c *SecurityGroupClient) First(ctx context.Context, opts *SecurityGroupListOptions) (*resource.SecurityGroup, error)

First returns the first security group matching the options or an error when less than 1 match

func (*SecurityGroupClient) Get ¶

func (c *SecurityGroupClient) Get(ctx context.Context, guid string) (*resource.SecurityGroup, error)

Get the specified security group

func (*SecurityGroupClient) List ¶

func (c *SecurityGroupClient) List(ctx context.Context, opts *SecurityGroupListOptions) ([]*resource.SecurityGroup, *Pager, error)

List pages SecurityGroups the user has access to

func (*SecurityGroupClient) ListAll ¶

func (c *SecurityGroupClient) ListAll(ctx context.Context, opts *SecurityGroupListOptions) ([]*resource.SecurityGroup, error)

ListAll retrieves all SecurityGroups the user has access to

func (*SecurityGroupClient) ListRunningForSpace ¶

func (c *SecurityGroupClient) ListRunningForSpace(ctx context.Context, spaceGUID string, opts *SecurityGroupSpaceListOptions) ([]*resource.SecurityGroup, *Pager, error)

ListRunningForSpace pages security groups that are enabled for running globally or at the space level for the given space

func (*SecurityGroupClient) ListRunningForSpaceAll ¶

func (c *SecurityGroupClient) ListRunningForSpaceAll(ctx context.Context, spaceGUID string, opts *SecurityGroupSpaceListOptions) ([]*resource.SecurityGroup, error)

ListRunningForSpaceAll retrieves all security groups that are enabled for running globally or at the space level for the given space

func (*SecurityGroupClient) ListStagingForSpace ¶

func (c *SecurityGroupClient) ListStagingForSpace(ctx context.Context, spaceGUID string, opts *SecurityGroupSpaceListOptions) ([]*resource.SecurityGroup, *Pager, error)

ListStagingForSpace pages security groups that are enabled for staging globally or at the space level for the given space

func (*SecurityGroupClient) ListStagingForSpaceAll ¶

func (c *SecurityGroupClient) ListStagingForSpaceAll(ctx context.Context, spaceGUID string, opts *SecurityGroupSpaceListOptions) ([]*resource.SecurityGroup, error)

ListStagingForSpaceAll retrieves all security groups that are enabled for staging globally or at the space level for the given space

func (*SecurityGroupClient) Single ¶

func (c *SecurityGroupClient) Single(ctx context.Context, opts *SecurityGroupListOptions) (*resource.SecurityGroup, error)

Single returns a single security group matching the options or an error if not exactly 1 match

func (*SecurityGroupClient) UnBindRunningSecurityGroup ¶

func (c *SecurityGroupClient) UnBindRunningSecurityGroup(ctx context.Context, guid string, spaceGUID string) error

UnBindRunningSecurityGroup removes a space from a security group with the running lifecycle

Apps within this space must be restarted for these changes to take effect.

func (*SecurityGroupClient) UnBindStagingSecurityGroup ¶

func (c *SecurityGroupClient) UnBindStagingSecurityGroup(ctx context.Context, guid string, spaceGUID string) error

UnBindStagingSecurityGroup removes a space from a security group with the staging lifecycle

Apps within this space must be restarted for these changes to take effect.

func (*SecurityGroupClient) Update ¶

func (c *SecurityGroupClient) Update(ctx context.Context, guid string, r *resource.SecurityGroupUpdate) (*resource.SecurityGroup, error)

Update the specified attributes of the app

func (SecurityGroupListOptions) ToQueryString ¶

func (o SecurityGroupListOptions) ToQueryString() (url.Values, error)

func (SecurityGroupSpaceListOptions) ToQueryString ¶

func (o SecurityGroupSpaceListOptions) ToQueryString() (url.Values, error)

func (*ServiceBrokerClient) Create ¶

func (c *ServiceBrokerClient) Create(ctx context.Context, r *resource.ServiceBrokerCreate) (string, error)

Create a new service broker asynchronously and return a jobGUID

func (*ServiceBrokerClient) Delete ¶

func (c *ServiceBrokerClient) Delete(ctx context.Context, guid string) (string, error)

Delete the specified service broker asynchronously and return a jobGUID

func (*ServiceBrokerClient) First ¶

func (c *ServiceBrokerClient) First(ctx context.Context, opts *ServiceBrokerListOptions) (*resource.ServiceBroker, error)