Class ServerConfiguration<T>

Represents the configuration of a server including its url template and variable configuration based on the url.

Type Parameters

T extends {
[key: string]: string;
}

Hierarchy

BaseServerConfiguration
- ServerConfiguration

Index

Constructors

Methods

clone getConfiguration makeRequestContext setVariables

Constructors

constructor

new ServerConfiguration<T>(url: string, variableConfiguration: {
[key: string]: string;
}): ServerConfiguration<T>
Type Parameters
- T extends {
  [key: string]: string;
  }
Parameters
- url: string
- variableConfiguration: {
  [key: string]: string;
  }
  - [key: string]: string
Returns ServerConfiguration<T>
Inherited from BaseServerConfiguration.constructor
- Defined in packages/datadog-api-client-common/servers.ts:9

Methods

clone

clone(): BaseServerConfiguration
Returns BaseServerConfiguration
Inherited from BaseServerConfiguration.clone
- Defined in packages/datadog-api-client-common/servers.ts:27

getConfiguration

getConfiguration(): {
[key: string]: string;
}
Returns {
[key: string]: string;
}
- [key: string]: string
Inherited from BaseServerConfiguration.getConfiguration
- Defined in packages/datadog-api-client-common/servers.ts:23

makeRequestContext

makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext
Creates a new request context for this server using the url with variables replaced with their respective values and the endpoint of the request appended.
Parameters
- endpoint: string
  
  the endpoint to be queried on the server
- httpMethod: HttpMethod
  
  httpMethod to be used
Returns RequestContext
Inherited from BaseServerConfiguration.makeRequestContext
- Defined in packages/datadog-api-client-common/servers.ts:50

setVariables

setVariables(variableConfiguration: {
[key: string]: string;
}): void
Sets the value of the variables of this server.
Parameters
- variableConfiguration: {
  [key: string]: string;
  }
  
  a partial variable configuration for the variables contained in the url
  - [key: string]: string
Returns void
Inherited from BaseServerConfiguration.setVariables
- Defined in packages/datadog-api-client-common/servers.ts:19

Generated using TypeDoc