internal

Documentation

Index

• Constants
• Variables
• type Metadata

Constants

const (
	DeleteAppRequest                                     = "DeleteApp"
	DeleteBuildpackRequest                               = "DeleteBuildpackSpace"
	DeleteConfigRunningSecurityGroupRequest              = "DeleteConfigRunningSecurityGroup"
	DeleteConfigStagingSecurityGroupRequest              = "DeleteConfigStagingSecurityGroup"
	DeleteOrganizationRequest                            = "DeleteOrganization"
	DeleteOrganizationPrivateDomainRequest               = "DeleteOrganizationPrivateDomain"
	DeleteOrganizationQuotaDefinitionRequest             = "DeleteOrganizationQuotaDefinition"
	DeleteOrganizationManagerRequest                     = "DeleteOrganizationManager"
	DeleteOrganizationBillingManagerRequest              = "DeleteOrganizationBillingManager"
	DeleteOrganizationAuditorRequest                     = "DeleteOrganizationAuditorRequest"
	DeleteOrganizationUserRequest                        = "DeleteOrganizationUser"
	DeletePrivateDomainRequest                           = "DeletePrivateDomain"
	DeleteRouteAppRequest                                = "DeleteRouteApp"
	DeleteRouteRequest                                   = "DeleteRoute"
	DeleteRouteMappingRequest                            = "DeleteRouteMapping"
	DeleteSecurityGroupRequest                           = "DeleteSecurityGroup"
	DeleteSecurityGroupSpaceRequest                      = "DeleteSecurityGroupSpace"
	DeleteSecurityGroupStagingSpaceRequest               = "DeleteSecurityGroupStagingSpace"
	DeleteServiceBrokerRequest                           = "DeleteServiceBroker"
	DeleteServiceBindingRequest                          = "DeleteServiceBinding"
	DeleteServiceInstanceRequest                         = "DeleteServiceInstance"
	DeleteServicePlanRequest                             = "DeleteServicePlan"
	DeleteServicePlanVisibilityRequest                   = "DeleteServicePlanVisibility"
	DeleteServiceRequest                                 = "DeleteService"
	DeleteServiceBindingRouteRequest                     = "DeleteServiceBindingRoute"
	DeleteServiceKeyRequest                              = "DeleteServiceKey"
	DeleteSpaceRequest                                   = "DeleteSpace"
	DeleteSpaceAuditorRequest                            = "DeleteSpaceAuditor"
	DeleteSpaceDeveloperRequest                          = "DeleteSpaceDeveloper"
	DeleteSpaceManagerRequest                            = "DeleteSpaceManager"
	DeleteSpaceQuotaRequest                              = "DeleteSpaceQuota"
	DeleteSpaceQuotaDefinitionRequest                    = "DeleteSpaceQuotaDefinition"
	DeleteSharedDomainRequest                            = "DeleteSharedDomain"
	DeleteSpaceUnmappedRoutesRequest                     = "DeleteUnmappedRoutes"
	DeleteUserProvidedServiceInstanceRequest             = "DeleteUserProvidedServiceInstance"
	GetAppInstancesRequest                               = "GetAppInstances"
	GetAppRequest                                        = "GetApp"
	GetAppRoutesRequest                                  = "GetAppRoutes"
	GetAppsRequest                                       = "GetApps"
	GetAppStatsRequest                                   = "GetAppStats"
	GetBuildpacksRequest                                 = "GetBuildpacks"
	GetBuildpackRequest                                  = "GetBuildpack"
	GetConfigFeatureFlagsRequest                         = "GetConfigFeatureFlags"
	GetConfigEnvVarGroupRunningRequest                   = "GetConfigEnvVarGroupRunning"
	GetConfigEnvVarGroupStagingRequest                   = "GetConfigEnvVarGroupStaging"
	GetConfigRunningSecurityGroupsRequest                = "GetConfigRunningSecurityGroups"
	GetConfigStagingSecurityGroupsRequest                = "GetConfigStagingSecurityGroups"
	GetEventsRequest                                     = "GetEvents"
	GetInfoRequest                                       = "GetInfo"
	GetJobRequest                                        = "GetJob"
	GetOrganizationPrivateDomainsRequest                 = "GetOrganizationPrivateDomains"
	GetOrganizationQuotaDefinitionsRequest               = "GetOrganizationQuotaDefinitions"
	GetOrganizationQuotaDefinitionRequest                = "GetOrganizationQuotaDefinition"
	GetOrganizationAuditorsRequest                       = "GetOrganizationAuditors"
	GetOrganizationManagersRequest                       = "GetOrganizationManagers"
	GetOrganizationBillingManagersRequest                = "GetOrganizationBillingManagers"
	GetOrganizationUsersRequest                          = "GetOrganizationUsers"
	GetOrganizationRequest                               = "GetOrganization"
	GetOrganizationsRequest                              = "GetOrganizations"
	GetPrivateDomainRequest                              = "GetPrivateDomain"
	GetPrivateDomainsRequest                             = "GetPrivateDomains"
	GetRouteAppsRequest                                  = "GetRouteApps"
	GetRouteMappingRequest                               = "GetRouteMapping"
	GetRouteMappingsRequest                              = "GetRouteMappings"
	GetRouteRequest                                      = "GetRoute"
	GetRouteReservedDeprecatedRequest                    = "GetRouteReservedDeprecated"
	GetRouteReservedRequest                              = "GetRouteReserved"
	GetRouteRouteMappingsRequest                         = "GetRouteRouteMappings"
	GetRoutesRequest                                     = "GetRoutes"
	GetSecurityGroupSpacesRequest                        = "GetSecurityGroupSpaces"
	GetSecurityGroupsRequest                             = "GetSecurityGroups"
	GetSecurityGroupStagingSpacesRequest                 = "GetSecurityGroupStagingSpaces"
	GetServiceBindingRequest                             = "GetServiceBinding"
	GetServiceBindingsRequest                            = "GetServiceBindings"
	GetServiceBindingRouteRequest                        = "GetServiceBindingRoute"
	GetServiceBindingRoutesRequest                       = "GetServiceBindingRoutes"
	GetServiceBrokersRequest                             = "GetServiceBrokers"
	GetServiceInstanceRequest                            = "GetServiceInstance"
	GetServiceInstanceServiceBindingsRequest             = "GetServiceInstanceServiceBindings"
	GetServiceInstanceSharedFromRequest                  = "GetServiceInstanceSharedFrom"
	GetServiceInstanceSharedToRequest                    = "GetServiceInstanceSharedTo"
	GetServiceInstancesRequest                           = "GetServiceInstances"
	GetServicePlanRequest                                = "GetServicePlan"
	GetServicePlansRequest                               = "GetServicePlans"
	GetServicePlanVisibilitiesRequest                    = "GetServicePlanVisibilities"
	GetServiceRequest                                    = "GetService"
	GetServicesRequest                                   = "GetServices"
	GetServiceKeyRequest                                 = "GetServiceKey"
	GetSharedDomainRequest                               = "GetSharedDomain"
	GetSharedDomainsRequest                              = "GetSharedDomains"
	GetSpaceRequest                                      = "GetSpace"
	GetSpaceQuotaDefinitionsRequest                      = "GetSpaceQuotaDefinitions"
	GetOrganizationSpaceQuotasRequest                    = "GetOrganizationSpaceQuotas"
	GetSecurityGroupRequest                              = "GetSecurityGroup"
	GetServiceBrokerRequest                              = "GetServiceBroker"
	GetServicePlanVisibilityRequest                      = "GetServicePlanVisibility"
	GetSpaceAuditorsRequest                              = "GetSpaceAuditors"
	GetSpaceManagersRequest                              = "GetSpaceManagers"
	GetSpaceDevelopersRequest                            = "GetSpaceDevelopers"
	GetSpaceQuotaDefinitionRequest                       = "GetSpaceQuotaDefinition"
	GetSpaceRoutesRequest                                = "GetSpaceRoutes"
	GetSpaceSecurityGroupsRequest                        = "GetSpaceSecurityGroups"
	GetSpaceServicesRequest                              = "GetSpaceServices"
	GetSpaceServiceInstancesRequest                      = "GetSpaceServiceInstances"
	GetSpaceSummaryRequest                               = "GetSpaceSummary"
	GetSpacesRequest                                     = "GetSpaces"
	GetSpaceStagingSecurityGroupsRequest                 = "GetSpaceStagingSecurityGroups"
	PostSpaceQuotaDefinitionsRequest                     = "PostSpaceQuotaDefinitions"
	GetStackRequest                                      = "GetStack"
	GetStacksRequest                                     = "GetStacks"
	GetUserProvidedServiceInstanceServiceBindingsRequest = "GetUserProvidedServiceInstanceServiceBindings"
	GetUserProvidedServiceInstanceRequest                = "GetUserProvidedServiceInstance"
	GetUserProvidedServiceInstancesRequest               = "GetUserProvidedServiceInstances"
	GetUsersRequest                                      = "GetUsers"
	GetUserOrganizationsRequest                          = "GetUserOrganizations"
	GetUserSpacesRequest                                 = "GetUserSpaces"
	PostAppRequest                                       = "PostApp"
	PostAppRestageRequest                                = "PostAppRestage"
	PostBuildpackRequest                                 = "PostBuildpack"
	PutConfigFeatureFlagsRequest                         = "PutConfigFeatureFlags"
	PostOrganizationRequest                              = "PostOrganization"
	PostOrganizationQuotaDefinitionsRequest              = "PostOrganizationQuotaDefinitions"
	PostPrivateDomainRequest                             = "PostPrivateDomain"
	PostRouteRequest                                     = "PostRoute"
	PostRouteMappingsRequest                             = "PostRouteMappings"
	PostSecurityGroupsRequest                            = "PostSecurityGroups"
	PostSecurityGroupRequest                             = "PostSecurityGroup"
	PostServiceBindingRequest                            = "PostServiceBinding"
	PostServiceInstancesRequest                          = "PostServiceInstance"
	PostSharedDomainRequest                              = "PostSharedDomain"
	PostServicesRequest                                  = "PostServicesRequest"
	PostServiceBrokerRequest                             = "PostServiceBroker"
	PostServiceKeyRequest                                = "PostServiceKey"
	GetServiceKeysRequest                                = "GetServiceKeys"
	PostServicePlanVisibilityRequest                     = "PostServicePlanVisibility"
	PostSpaceRequest                                     = "PostSpace"
	PostUserRequest                                      = "PostUser"
	PostUserProvidedServiceInstancesRequest              = "PostUserProvidedServiceInstances"
	PutAppBitsRequest                                    = "PutAppBits"
	PutAppRequest                                        = "PutApp"
	PutBuildpackRequest                                  = "PutBuildpack"
	PutBuildpackBitsRequest                              = "PutBuildpackBits"
	PutConfigRunningSecurityGroupRequest                 = "PutConfigRunningSecurityGroup"
	PutConfigEnvVarGroupRunningRequest                   = "PutConfigEnvVarGroupRunning"
	PutConfigEnvVarGroupStagingRequest                   = "PutConfigEnvVarGroupStaging"
	PutConfigStagingSecurityGroupRequest                 = "PutConfigStagingSecurityGroup"
	PutDropletRequest                                    = "PutDroplet"
	PutOrganizationManagerByUsernameRequest              = "PutOrganizationManagerByUsername"
	PutOrganizationManagerRequest                        = "PutOrganizationManager"
	PutOrganizationUserRequest                           = "PutOrganizationUser"
	PutOrganizationAuditorRequest                        = "PutOrganizationAuditorRequest"
	PutOrganizationBillingManagerRequest                 = "PutOrganizationBillingManager"
	PutOrganizationRequest                               = "PutOrganizationRequest"
	PutOrganizationUserByUsernameRequest                 = "PutOrganizationUserByUsername"
	PutOrganizationPrivateDomainRequest                  = "PutOrganizationPrivateDomain"
	PutOrganizationQuotaDefinitionRequest                = "PutOrganizationQuotaDefinition"
	PutResourceMatchRequest                              = "PutResourceMatch"
	PutRouteAppRequest                                   = "PutRouteApp"
	PutRouteRequest                                      = "PutRoute"
	PutServiceRequest                                    = "PutServiceRequest"
	PutServiceBrokerRequest                              = "PutServiceBroker"
	PutServiceBindingRoutesRequest                       = "PutServiceBindingRoutes"
	PutServiceInstanceRequest                            = "PutServiceInstance"
	PutServicePlanRequest                                = "PutServicePlan"
	PutServicePlanVisibilityRequest                      = "PutServicePlanVisibility"
	PutSpaceRequest                                      = "PutSpace"
	PutSpaceQuotaRequest                                 = "PutSpaceQuotaRequest"
	PutSpaceDeveloperRequest                             = "PutSpaceDeveloper"
	PutSpaceDeveloperByUsernameRequest                   = "PutSpaceDeveloperByUsername"
	PutSpaceManagerRequest                               = "PutSpaceManager"
	PutSpaceAuditorRequest                               = "PutSpaceAuditor"
	PutSpaceManagerByUsernameRequest                     = "PutSpaceManagerByUsername"
	PutSpaceQuotaDefinitionRequest                       = "PutSpaceQuotaDefinition"
	PutSecurityGroupSpaceRequest                         = "PutSecurityGroupSpace"
	PutSecurityGroupStagingSpaceRequest                  = "PutSecurityGroupStagingSpace"
	PutUserProvidedServiceInstanceRequest                = "PutUserProvidedServiceInstance"
)

Naming convention:

Method + non-parameter parts of the path

If the request returns a single entity by GUID, use the singular (for example /v2/organizations/:organization_guid is GetOrganization).

The const name should always be the const value + Request.

Variables

var APIRoutes = rata.Routes{}/* 176 elements not displayed */

APIRoutes is a list of routes used by the rata library to construct request URLs.

Types

type Metadata

type Metadata struct {
	GUID      string    `json:"guid"`
	URL       string    `json:"url"`
	CreatedAt time.Time `json:"created_at"`

	// UpdatedAt is the update time for a given object, it can be null
	UpdatedAt *time.Time `json:"updated_at"`
}

Metadata represents the "metadata" object of a resource item in a Cloud Controller response.