Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for destroy method #2204

Merged
merged 1 commit into from
Apr 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions clients/client-accessanalyzer/AccessAnalyzerClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,11 @@ export class AccessAnalyzerClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-acm-pca/ACMPCAClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,11 @@ export class ACMPCAClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-acm/ACMClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,11 @@ export class ACMClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-alexa-for-business/AlexaForBusinessClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -602,6 +602,11 @@ export class AlexaForBusinessClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-amplify/AmplifyClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,11 @@ export class AmplifyClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-amplifybackend/AmplifyBackendClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,11 @@ export class AmplifyBackendClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-api-gateway/APIGatewayClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,11 @@ export class APIGatewayClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,11 @@ export class ApiGatewayManagementApiClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-apigatewayv2/ApiGatewayV2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,11 @@ export class ApiGatewayV2Client extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-app-mesh/AppMeshClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,11 @@ export class AppMeshClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-appconfig/AppConfigClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,11 @@ export class AppConfigClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-appflow/AppflowClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,11 @@ export class AppflowClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-appintegrations/AppIntegrationsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,11 @@ export class AppIntegrationsClient extends __Client<
this.middlewareStack.use(getOmitRetryHeadersPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,11 @@ export class ApplicationAutoScalingClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,11 @@ export class ApplicationDiscoveryServiceClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,11 @@ export class ApplicationInsightsClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-appstream/AppStreamClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,11 @@ export class AppStreamClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-appsync/AppSyncClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,11 @@ export class AppSyncClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-athena/AthenaClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,6 +307,11 @@ export class AthenaClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-auditmanager/AuditManagerClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,11 @@ export class AuditManagerClient extends __Client<
this.middlewareStack.use(getOmitRetryHeadersPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-auto-scaling-plans/AutoScalingPlansClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,11 @@ export class AutoScalingPlansClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-auto-scaling/AutoScalingClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,11 @@ export class AutoScalingClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-backup/BackupClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,11 @@ export class BackupClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-batch/BatchClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,11 @@ export class BatchClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-braket/BraketClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,11 @@ export class BraketClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-budgets/BudgetsClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,11 @@ export class BudgetsClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-chime/ChimeClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1095,6 +1095,11 @@ export class ChimeClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-cloud9/Cloud9Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,11 @@ export class Cloud9Client extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-clouddirectory/CloudDirectoryClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,11 @@ export class CloudDirectoryClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-cloudformation/CloudFormationClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,11 @@ export class CloudFormationClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-cloudfront/CloudFrontClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -570,6 +570,11 @@ export class CloudFrontClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-cloudhsm-v2/CloudHSMV2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,11 @@ export class CloudHSMV2Client extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
5 changes: 5 additions & 0 deletions clients/client-cloudhsm/CloudHSMClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,11 @@ export class CloudHSMClient extends __Client<
this.middlewareStack.use(getUserAgentPlugin(this.config));
}

/**
* Destroy underlying resources, like sockets. It's usually not necessary to do this.
* However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.
* Otherwise, sockets might stay open for quite a long time before the server terminates them.
*/
destroy(): void {
super.destroy();
}
Expand Down
Loading