Class EnvironmentRepository

Hierarchy

SpaceScopedBasicRepository<DeploymentEnvironment, NewDeploymentEnvironment, EnvironmentRepositoryListArgs>
- EnvironmentRepository

Constructors

constructor

new EnvironmentRepository(client: Client, spaceName: string): EnvironmentRepository
Parameters
- client: Client
- spaceName: string
Returns EnvironmentRepository
Overrides SpaceScopedBasicRepository.constructor
- Defined in src/features/deploymentEnvironments/environmentRepository.ts:13

Properties

`Protected` `Readonly` baseApiPathTemplate

baseApiPathTemplate: string

`Protected` client

client: Client

`Protected` `Readonly` spaceName

spaceName: string

`Readonly` takeAll

takeAll: 2147483647 = 2147483647

`Readonly` takeDefaultPageSize

takeDefaultPageSize: 30 = 30

Methods

create

create(resource: NewDeploymentEnvironment, args?: RouteArgs<RouteArgLookup>): Promise<DeploymentEnvironment>
Parameters
- resource: NewDeploymentEnvironment
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<DeploymentEnvironment>
Inherited from SpaceScopedBasicRepository.create
- Defined in src/features/spaceScopedBasicRepository.ts:31

del

del(resource: DeploymentEnvironment): Promise<DeploymentEnvironment>
Parameters
- resource: DeploymentEnvironment
Returns Promise<DeploymentEnvironment>
Inherited from SpaceScopedBasicRepository.del
- Defined in src/features/spaceScopedBasicRepository.ts:25

`Protected` extend

extend(arg1: any, arg2: any): any
Parameters
- arg1: any
- arg2: any
Returns any
Inherited from SpaceScopedBasicRepository.extend
- Defined in src/features/basicRepository.ts:85

get

get(id: string): Promise<DeploymentEnvironment>
Parameters
- id: string
Returns Promise<DeploymentEnvironment>
Inherited from SpaceScopedBasicRepository.get
- Defined in src/features/spaceScopedBasicRepository.ts:36

list

list(args?: EnvironmentRepositoryListArgs): Promise<ResourceCollection<DeploymentEnvironment>>
Parameters
- Optional args: EnvironmentRepositoryListArgs
Returns Promise<ResourceCollection<DeploymentEnvironment>>
Inherited from SpaceScopedBasicRepository.list
- Defined in src/features/spaceScopedBasicRepository.ts:40

machines

machines(environment: DeploymentEnvironment, args?: Partial<EnvironmentMachinesArgs>): Promise<ResourceCollection<DeploymentEnvironment>>
Parameters
- environment: DeploymentEnvironment
- Optional args: Partial<EnvironmentMachinesArgs>
Returns Promise<ResourceCollection<DeploymentEnvironment>>
- Defined in src/features/deploymentEnvironments/environmentRepository.ts:32

modify

modify(resource: DeploymentEnvironment, args?: RouteArgs<RouteArgLookup>): Promise<DeploymentEnvironment>
Parameters
- resource: DeploymentEnvironment
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<DeploymentEnvironment>
Inherited from SpaceScopedBasicRepository.modify
- Defined in src/features/spaceScopedBasicRepository.ts:45

`Protected` notifySubscribersToDataModifications

notifySubscribersToDataModifications(resource: TExistingResource): TExistingResource
Parameters
- resource: TExistingResource
Returns TExistingResource
Inherited from SpaceScopedBasicRepository.notifySubscribersToDataModifications
- Defined in src/features/basicRepository.ts:89

save

save(resource: DeploymentEnvironment | NewDeploymentEnvironment): Promise<DeploymentEnvironment>
Parameters
- resource: DeploymentEnvironment | NewDeploymentEnvironment
Returns Promise<DeploymentEnvironment>
Inherited from SpaceScopedBasicRepository.save
- Defined in src/features/basicRepository.ts:61

sort

sort(order: string[]): Promise<unknown>
Parameters
- order: string[]
Returns Promise<unknown>
- Defined in src/features/deploymentEnvironments/environmentRepository.ts:21

subscribeToDataModifications

subscribeToDataModifications(key: string, callback: ((data: DeploymentEnvironment) => void)): void
Parameters
- key: string
- callback: ((data: DeploymentEnvironment) => void)
  - - (data: DeploymentEnvironment): void
    - Parameters
      
      data: DeploymentEnvironment
      
      Returns void
Returns void
Inherited from SpaceScopedBasicRepository.subscribeToDataModifications
- Defined in src/features/basicRepository.ts:77

summary

summary(args?: Partial<EnvironmentSummaryArgs>): Promise<DeploymentEnvironment>
Parameters
- Optional args: Partial<EnvironmentSummaryArgs>
Returns Promise<DeploymentEnvironment>
- Defined in src/features/deploymentEnvironments/environmentRepository.ts:25

unsubscribeFromDataModifications

unsubscribeFromDataModifications(key: string): void
Parameters
- key: string
Returns void
Inherited from SpaceScopedBasicRepository.unsubscribeFromDataModifications
- Defined in src/features/basicRepository.ts:81

variablesScopedOnlyToThisEnvironment

variablesScopedOnlyToThisEnvironment(environment: DeploymentEnvironment): Promise<VariablesScopedToEnvironmentResponse>
Parameters
- environment: DeploymentEnvironment
Returns Promise<VariablesScopedToEnvironmentResponse>
- Defined in src/features/deploymentEnvironments/environmentRepository.ts:39

Generated using TypeDoc