• management
• SDK
• ConnectionProfilesClient

Class ConnectionProfilesClient

Index

Constructors

constructor

Methods

listcreatelistTemplatesgetTemplategetdeleteupdate

Properties

_options

Constructors

constructor

new ConnectionProfilesClient(
options: BaseClientOptions,
): ConnectionProfilesClient

Parameters

• options: BaseClientOptions

Returns ConnectionProfilesClient

Methods

list

list(
request?: ListConnectionProfileRequestParameters,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): Promise<
Page<ConnectionProfile, ListConnectionProfilesPaginatedResponseContent>,
>

Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.

Parameters

• request: ListConnectionProfileRequestParameters = {}
• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<ConnectionProfile, ListConnectionProfilesPaginatedResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.list({ from: "from", take: 1 })Copy

create

create(
request: CreateConnectionProfileRequestContent,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<CreateConnectionProfileResponseContent>

Create a Connection Profile.

Parameters

• request: CreateConnectionProfileRequestContent
• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateConnectionProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.create({ name: "name" })Copy

listTemplates

listTemplates(
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<ListConnectionProfileTemplateResponseContent>

Retrieve a list of Connection Profile Templates.

Parameters

• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<ListConnectionProfileTemplateResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.listTemplates()Copy

getTemplate

getTemplate(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<GetConnectionProfileTemplateResponseContent>

Retrieve a Connection Profile Template.

Parameters

• id: string

ID of the connection-profile-template to retrieve.

• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetConnectionProfileTemplateResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.getTemplate("id")Copy

get

get(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<GetConnectionProfileResponseContent>

Retrieve details about a single Connection Profile specified by ID.

Parameters

• id: string

ID of the connection-profile to retrieve.

• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetConnectionProfileResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.get("id")Copy

delete

delete(
id: string,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<void>

Delete a single Connection Profile specified by ID.

Parameters

• id: string

ID of the connection-profile to delete.

• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.delete("id")Copy

update

update(
id: string,
request?: UpdateConnectionProfileRequestContent,
requestOptions?: ConnectionProfilesClient.RequestOptions,
): HttpResponsePromise<UpdateConnectionProfileResponseContent>

Update the details of a specific Connection Profile.

Parameters

• id: string

ID of the connection profile to update.

• request: UpdateConnectionProfileRequestContent = {}
• OptionalrequestOptions: ConnectionProfilesClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateConnectionProfileResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connectionProfiles.update("id")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listcreatelistTemplatesgetTemplategetdeleteupdate Properties _options