/**
* (C) Copyright IBM Corp. 2024, 2025, 2026.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
///
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { AbortSignal, BaseService, SDKLogger, UserOptions } from 'ibm-cloud-sdk-core';
/**
* The IBM Cloud Virtual Private Cloud (VPC) API can be used to programmatically provision and manage virtual server
* instances, along with subnets, volumes, load balancers, and more.
*
* API Version: 2026-03-24
*/
declare class VpcV1 extends BaseService {
static _logger: SDKLogger;
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
private static _regionalEndpoints;
/**
* Returns the service URL associated with the specified region.
* @param region a string representing the region
* @returns the service URL associated with the specified region or undefined
* if no mapping for the region exists
*/
static getServiceUrlForRegion(region: string): string;
/*************************
* Factory method
************************/
/**
* Constructs an instance of VpcV1 with passed in options and external configuration.
*
* @param {UserOptions} [options] - The parameters to send to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
* @param {string} [options.serviceUrl] - The base URL for the service
* @returns {VpcV1}
*/
static newInstance(options: UserOptions): VpcV1;
/** The infrastructure generation. For the API behavior documented here, specify `2`. */
generation?: number;
/** The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between
* `2025-12-09` and `2026-03-25`.
*/
version: string;
/**
* Construct a VpcV1 object.
*
* @param {Object} options - Options for the service.
* @param {number} [options.generation] - The infrastructure generation. For the API behavior documented here, specify
* `2`.
* @param {string} options.version - The API version, in format `YYYY-MM-DD`. For the API behavior documented here,
* specify any date between `2025-12-09` and `2026-03-25`.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
* @constructor
* @returns {VpcV1}
*/
constructor(options: UserOptions);
/*************************
* backupPolicies
************************/
/**
* List backup policies.
*
* This request lists backup policies in the region. Backup policies control which sources are selected for backup and
* include a set of backup policy plans that provide the backup schedules and deletion triggers.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.tag] - Filters the collection to resources with an item in the `tags` property matching the
* exact specified tag.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBackupPolicies(params?: VpcV1.ListBackupPoliciesParams): Promise>;
/**
* Create a backup policy.
*
* This request creates a new backup policy from a backup policy prototype object. The prototype object is structured
* in the same way as a retrieved backup policy, and contains the information necessary to create the new backup
* policy.
*
* @param {Object} params - The parameters to send to the service.
* @param {BackupPolicyPrototype} params.backupPolicyPrototype - The backup policy prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBackupPolicy(params: VpcV1.CreateBackupPolicyParams): Promise>;
/**
* List jobs for a backup policy.
*
* This request retrieves jobs for a backup policy. A backup job represents the execution of a backup policy plan for
* a resource matching the policy's criteria.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} [params.status] - Filters the collection to backup policy jobs with a `status` property matching
* the specified value.
* @param {string} [params.backupPolicyPlanId] - Filters the collection to backup policy jobs with a
* `backup_policy_plan.id` property matching the specified identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {string} [params.sourceId] - Filters the collection to backup policy jobs with a `source.id` property
* matching the specified identifier.
* @param {string} [params.targetSnapshotsId] - Filters the collection to backup policy jobs with an item in the
* `target_snapshots` property with an `id` property matching the specified identifier.
* @param {string} [params.targetSnapshotsCrn] - Filters the collection to backup policy jobs with an item in the
* `target_snapshots` property with a `crn` property matching the specified CRN.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBackupPolicyJobs(params: VpcV1.ListBackupPolicyJobsParams): Promise>;
/**
* Retrieve a backup policy job.
*
* This request retrieves a single backup policy job specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} params.id - The backup policy job identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBackupPolicyJob(params: VpcV1.GetBackupPolicyJobParams): Promise>;
/**
* List plans for a backup policy.
*
* This request retrieves plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBackupPolicyPlans(params: VpcV1.ListBackupPolicyPlansParams): Promise>;
/**
* Create a plan for a backup policy.
*
* This request creates a new backup policy plan from a backup policy plan prototype object. The prototype object is
* structured in the same way as a retrieved backup policy plan, and contains the information necessary to create the
* new backup policy plan.
*
* Backups created by this plan will use the resource group of the source being backed up.
*
* Backups created by this plan will use the plan's name truncated to 46 characters, followed by a unique 16-character
* suffix.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} params.cronSpec - The cron specification for the backup schedule. The backup policy jobs
* (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes
* after this time.
*
* All backup schedules for plans in the same policy must be at least an hour apart.
* @param {boolean} [params.active] - Indicates whether the plan is active.
* @param {string[]} [params.attachUserTags] - The user tags to attach to each backup (snapshot) created by this plan.
* @param {BackupPolicyPlanClonePolicyPrototype} [params.clonePolicy] -
* @param {boolean} [params.copyUserTags] - Indicates whether to copy the source's user tags to the created backups
* (snapshots).
* @param {BackupPolicyPlanDeletionTriggerPrototype} [params.deletionTrigger] -
* @param {string} [params.name] - The name for this backup policy plan. The name must not be used by another plan for
* the backup policy. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {BackupPolicyPlanRemoteRegionPolicyPrototype[]} [params.remoteRegionPolicies] - The policies for additional
* backups in remote regions.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBackupPolicyPlan(params: VpcV1.CreateBackupPolicyPlanParams): Promise>;
/**
* Delete a backup policy plan.
*
* This request deletes a backup policy plan. This operation cannot be reversed. Any backups that have been created by
* the plan will remain but will no longer be subject to the plan's deletion trigger. Any running jobs associated with
* the plan will run to completion before the plan is deleted.
*
* If the request is accepted, the backup policy plan `status` will be set to `deleting`. Once deletion processing
* completes, the backup policy plan will no longer be retrievable.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} params.id - The backup policy plan identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBackupPolicyPlan(params: VpcV1.DeleteBackupPolicyPlanParams): Promise>;
/**
* Retrieve a backup policy plan.
*
* This request retrieves a single backup policy plan specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} params.id - The backup policy plan identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBackupPolicyPlan(params: VpcV1.GetBackupPolicyPlanParams): Promise>;
/**
* Update a backup policy plan.
*
* This request updates a backup policy plan with the information in a provided plan patch. The plan patch object is
* structured in the same way as a retrieved backup policy plan and can contains only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.backupPolicyId - The backup policy identifier.
* @param {string} params.id - The backup policy plan identifier.
* @param {boolean} [params.active] - Indicates whether the plan is active.
* @param {string[]} [params.attachUserTags] - The user tags to attach to backups (snapshots) created by this plan.
* Updating this value does not change the user tags for backups that have already been created by this plan.
* @param {BackupPolicyPlanClonePolicyPatch} [params.clonePolicy] -
* @param {boolean} [params.copyUserTags] - Indicates whether to copy the source's user tags to the created backups
* (snapshots).
* @param {string} [params.cronSpec] - The cron specification for the backup schedule. The backup policy jobs
* (which create and delete backups for this plan) will not start until this time, and may start for up to 90 minutes
* after this time.
*
* All backup schedules for plans in the same policy must be at least an hour apart.
* @param {BackupPolicyPlanDeletionTriggerPatch} [params.deletionTrigger] -
* @param {string} [params.name] - The name for this backup policy plan. The name must not be used by another plan for
* the backup policy.
* @param {BackupPolicyPlanRemoteRegionPolicyPrototype[]} [params.remoteRegionPolicies] - The policies for additional
* backups in remote regions (replacing any existing policies).
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBackupPolicyPlan(params: VpcV1.UpdateBackupPolicyPlanParams): Promise>;
/**
* Delete a backup policy.
*
* This request deletes a backup policy. This operation cannot be reversed.
*
* If the request is accepted, the backup policy `status` will be set to `deleting`. Once deletion processing
* completes, the backup policy will no longer be retrievable.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The backup policy identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBackupPolicy(params: VpcV1.DeleteBackupPolicyParams): Promise>;
/**
* Retrieve a backup policy.
*
* This request retrieves a single backup policy specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The backup policy identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBackupPolicy(params: VpcV1.GetBackupPolicyParams): Promise>;
/**
* Update a backup policy.
*
* This request updates a backup policy with the information in a provided backup policy patch. The backup policy
* patch object is structured in the same way as a retrieved backup policy and contains only the information to be
* updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The backup policy identifier.
* @param {string[]} [params.includedContent] - The included content for backups created using this policy:
* - `boot_volume`: Include the instance's boot volume.
* - `data_volumes`: Include the instance's data volumes.
* @param {string[]} [params.matchUserTags] - The user tags this backup policy will apply to (replacing any existing
* tags). Resources that have both a matching user tag and a matching type will be subject to the backup policy.
* @param {string} [params.name] - The name for this backup policy. The name must not be used by another backup policy
* in the region.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBackupPolicy(params: VpcV1.UpdateBackupPolicyParams): Promise>;
/*************************
* bareMetalServers
************************/
/**
* List bare metal server profiles.
*
* This request lists [bare metal server
* profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-bare-metal-servers-profile) available in the region. A bare
* metal server profile specifies the performance characteristics and pricing model for a bare metal server.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServerProfiles(params?: VpcV1.ListBareMetalServerProfilesParams): Promise>;
/**
* Retrieve a bare metal server profile.
*
* This request retrieves a single bare metal server profile specified by the name in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The bare metal server profile name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerProfile(params: VpcV1.GetBareMetalServerProfileParams): Promise>;
/**
* List bare metal servers.
*
* This request lists bare metal servers in the region.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.reservationId] - Filters the collection to resources with a `reservation.id` property
* matching the specified identifier.
* @param {string} [params.reservationCrn] - Filters the collection to resources with a `reservation.crn` property
* matching the specified identifier.
* @param {string} [params.reservationName] - Filters the collection to resources with a `reservation.name` property
* matching the specified identifier.
* @param {string} [params.vpcId] - Filters the collection to resources with a `vpc.id` property matching the
* specified identifier.
* @param {string} [params.vpcCrn] - Filters the collection to resources with a `vpc.crn` property matching the
* specified CRN.
* @param {string} [params.vpcName] - Filters the collection to resources with a `vpc.name` property matching the
* exact specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServers(params?: VpcV1.ListBareMetalServersParams): Promise>;
/**
* Create a bare metal server.
*
* This request provisions a new bare metal server from a prototype object. The prototype object is structured in the
* same way as a retrieved bare metal server, and contains the information necessary to provision the new bare metal
* server. The bare metal server is automatically started.
*
* For this request to succeed, the properties in the request must adhere to the source image's `allowed_use`
* property.
*
* @param {Object} params - The parameters to send to the service.
* @param {BareMetalServerPrototype} params.bareMetalServerPrototype - The bare metal server prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBareMetalServer(params: VpcV1.CreateBareMetalServerParams): Promise>;
/**
* Create a console access token for a bare metal server.
*
* This request creates a new single-use console access token for a bare metal server. All console configuration is
* provided at token create time, and the token is subsequently used in the `access_token` query parameter for the
* WebSocket request. The access token is only valid for a short period of time, and a maximum of one token is valid
* for a given bare metal server at a time. For this request to succeed, the server must have a `status` of
* `stopped`, `starting`, or `running`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.consoleType - The bare metal server console type for which this token may be used
*
* Must be `serial` for bare metal servers with a `cpu.architecture` of `s390x`.
* @param {boolean} [params.force] - Indicates whether to disconnect an existing serial console session as the serial
* console cannot be shared. This has no effect on VNC consoles.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBareMetalServerConsoleAccessToken(params: VpcV1.CreateBareMetalServerConsoleAccessTokenParams): Promise>;
/**
* List disks on a bare metal server.
*
* This request lists disks on a bare metal server. A disk is a block device that is locally attached to the
* physical server. By default, the listed disks are sorted by their `created_at` property values, with the newest
* disk first.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServerDisks(params: VpcV1.ListBareMetalServerDisksParams): Promise>;
/**
* Retrieve a bare metal server disk.
*
* This request retrieves a single disk specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server disk identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerDisk(params: VpcV1.GetBareMetalServerDiskParams): Promise>;
/**
* Update a bare metal server disk.
*
* This request updates the bare metal server disk with the information in a provided patch.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server disk identifier.
* @param {string} [params.name] - The name for this bare metal server disk. The name must not be used by another disk
* on the bare metal server.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBareMetalServerDisk(params: VpcV1.UpdateBareMetalServerDiskParams): Promise>;
/**
* List network attachments on a bare metal server.
*
* This request lists network attachments on a bare metal server. A bare metal server network attachment is an
* abstract representation of a network device and attaches a bare metal server to a single subnet. Each network
* interface on a bare metal server can attach to any subnet in the zone, including subnets that are already attached
* to the bare metal server.
*
* The network attachments will be sorted by their `created_at` property values, with newest network attachments
* first. Network attachments with identical `created_at` property values will in turn be sorted by ascending `name`
* property values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServerNetworkAttachments(params: VpcV1.ListBareMetalServerNetworkAttachmentsParams): Promise>;
/**
* Create a network attachment on a bare metal server.
*
* This request creates a new bare metal server network attachment from a bare metal server network attachment
* prototype object. The prototype object is structured in the same way as a retrieved bare metal server network
* attachment, and contains the information necessary to create the new bare metal server network attachment.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {BareMetalServerNetworkAttachmentPrototype} params.bareMetalServerNetworkAttachmentPrototype - The bare
* metal server network attachment prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBareMetalServerNetworkAttachment(params: VpcV1.CreateBareMetalServerNetworkAttachmentParams): Promise>;
/**
* Delete a bare metal server network attachment.
*
* This request deletes a bare metal server network attachment. This operation cannot be reversed. Any floating IPs
* associated with the bare metal server network attachment are implicitly disassociated.
*
* The bare metal server's primary network attachment cannot be deleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network attachment identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBareMetalServerNetworkAttachment(params: VpcV1.DeleteBareMetalServerNetworkAttachmentParams): Promise>;
/**
* Retrieve a bare metal server network attachment.
*
* This request retrieves a single bare metal server network attachment specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network attachment identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerNetworkAttachment(params: VpcV1.GetBareMetalServerNetworkAttachmentParams): Promise>;
/**
* Update a bare metal server network attachment.
*
* This request updates a bare metal server network attachment with the information provided in a bare metal server
* network attachment patch object. The bare metal server network attachment patch object is structured in the same
* way as a retrieved bare metal server network attachment and contains only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network attachment identifier.
* @param {number[]} [params.allowedVlans] - The VLAN IDs to allow for `vlan` attachments using this PCI attachment,
* replacing any existing VLAN IDs. The specified values must include IDs for all `vlan` attachments currently using
* this PCI attachment.
* @param {string} [params.name] - The name for this network attachment. The name must not be used by another network
* attachment for the bare metal server.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBareMetalServerNetworkAttachment(params: VpcV1.UpdateBareMetalServerNetworkAttachmentParams): Promise>;
/**
* List network interfaces on a bare metal server.
*
* This request lists network interfaces on a bare metal server. A bare metal server network interface is an abstract
* representation of a network device and attaches a bare metal server to a single subnet. Each network interface on a
* bare metal server can attach to any subnet in the zone, including subnets that are already attached to the bare
* metal server.
*
* If this bare metal server has network attachments, each returned network interface is a [read-only
* representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding
* network attachment and its attached virtual network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServerNetworkInterfaces(params: VpcV1.ListBareMetalServerNetworkInterfacesParams): Promise>;
/**
* Create a network interface on a bare metal server.
*
* This request creates a new bare metal server network interface from a bare metal server network interface prototype
* object. The prototype object is structured in the same way as a retrieved bare metal server network interface, and
* contains the information necessary to create the new bare metal server network interface. Any subnet in the bare
* metal server's VPC may be specified, even if it is already attached to another bare metal server network interface.
* Addresses on the bare metal server network interface must be within the specified subnet's CIDR blocks.
*
* If this bare metal server has network attachments, each network interface is a [read-only
* representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding
* network attachment and its attached virtual network interface, and new network interfaces are not allowed to be
* created.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {BareMetalServerNetworkInterfacePrototype} params.bareMetalServerNetworkInterfacePrototype - The bare metal
* server network interface prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createBareMetalServerNetworkInterface(params: VpcV1.CreateBareMetalServerNetworkInterfaceParams): Promise>;
/**
* Delete a bare metal server network interface.
*
* This request deletes a bare metal server network interface. This operation cannot be reversed. Any floating IPs
* associated with the bare metal server network interface are implicitly disassociated. The primary bare metal
* server network interface is not allowed to be deleted.
*
* If this bare metal server has network attachments, this network interface is a [read-only
* representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding
* network attachment and its attached virtual network interface, and is not allowed to be deleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network interface identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBareMetalServerNetworkInterface(params: VpcV1.DeleteBareMetalServerNetworkInterfaceParams): Promise>;
/**
* Retrieve a bare metal server network interface.
*
* This request retrieves a single bare metal server network interface specified by the identifier in the URL.
*
* If this bare metal server has network attachments, the retrieved network interface is a [read-only
* representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding
* network attachment and its attached virtual network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network interface identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerNetworkInterface(params: VpcV1.GetBareMetalServerNetworkInterfaceParams): Promise>;
/**
* Update a bare metal server network interface.
*
* This request updates a bare metal server network interface with the information provided in a bare metal server
* network interface patch object. The bare metal server network interface patch object is structured in the same way
* as a retrieved bare metal server network interface and needs to contain only the information to be updated.
*
* If this bare metal server has network attachments, this network interface is a [read-only
* representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its corresponding
* network attachment and its attached virtual network interface, and is not allowed to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.id - The bare metal server network interface identifier.
* @param {boolean} [params.allowIpSpoofing] - Indicates whether source IP spoofing is allowed on this bare metal
* server network interface.
*
* If this bare metal server has network attachments, this network interface is a
* [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its
* corresponding network attachment and its attached virtual network interface, and source IP spoofing is managed on
* the attached virtual network interface.
* @param {number[]} [params.allowedVlans] - The VLAN IDs to allow for `vlan` interfaces using this PCI interface,
* replacing any existing VLAN IDs. The specified values must include IDs for all `vlan` interfaces currently using
* this PCI interface.
* @param {boolean} [params.enableInfrastructureNat] - If `true`:
* - The VPC infrastructure performs any needed NAT operations.
* - `floating_ips` must not have more than one floating IP.
*
* If `false`:
* - Packets are passed unchanged to/from the bare metal server network interface,
* allowing the workload to perform any needed NAT operations.
* - `allow_ip_spoofing` must be `false`.
* - `interface_type` must not be `hipersocket`.
*
* If this bare metal server has network attachments, this network interface is a
* [read-only representation](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about#vni-old-api-clients) of its
* corresponding network attachment and its attached virtual network interface, and infrastructure NAT is managed on
* the attached virtual network interface.
* @param {string} [params.name] - The name for this bare metal server network interface. The name must not be used by
* another network interface on the bare metal server.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBareMetalServerNetworkInterface(params: VpcV1.UpdateBareMetalServerNetworkInterfaceParams): Promise>;
/**
* List floating IPs associated with a bare metal server network interface.
*
* This request lists floating IPs associated with a bare metal server network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listBareMetalServerNetworkInterfaceFloatingIps(params: VpcV1.ListBareMetalServerNetworkInterfaceFloatingIpsParams): Promise>;
/**
* Disassociate a floating IP from a bare metal server network interface.
*
* This request disassociates the specified floating IP from the specified bare metal server network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {string} params.id - The floating IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
removeBareMetalServerNetworkInterfaceFloatingIp(params: VpcV1.RemoveBareMetalServerNetworkInterfaceFloatingIpParams): Promise>;
/**
* Retrieve associated floating IP.
*
* This request retrieves a specified floating IP if it is associated with the bare metal server network interface
* specified in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {string} params.id - The floating IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerNetworkInterfaceFloatingIp(params: VpcV1.GetBareMetalServerNetworkInterfaceFloatingIpParams): Promise>;
/**
* Associate a floating IP with a bare metal server network interface.
*
* This request associates the specified floating IP with the specified bare metal server network interface. If
* `enable_infrastructure_nat` is `false`, this adds the IP to any existing associations. If
* `enable_infrastructure_nat` is `true`, this replaces any existing association.
*
* The existing floating IP must:
* - not be required by another resource, such as a public gateway
* - be in the same `zone` as the bare metal server
*
* A request body is not required, and if provided, is ignored.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {string} params.id - The floating IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addBareMetalServerNetworkInterfaceFloatingIp(params: VpcV1.AddBareMetalServerNetworkInterfaceFloatingIpParams): Promise>;
/**
* List the primary reserved IP for a bare metal server network interface.
*
* This request lists the primary reserved IP for a bare metal server network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
listBareMetalServerNetworkInterfaceIps(params: VpcV1.ListBareMetalServerNetworkInterfaceIpsParams): Promise>;
/**
* Retrieve the primary reserved IP.
*
* This request retrieves the primary reserved IP for a bare metal server network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.bareMetalServerId - The bare metal server identifier.
* @param {string} params.networkInterfaceId - The bare metal server network interface identifier.
* @param {string} params.id - The reserved IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
* @deprecated this method is deprecated and may be removed in a future release
*/
getBareMetalServerNetworkInterfaceIp(params: VpcV1.GetBareMetalServerNetworkInterfaceIpParams): Promise>;
/**
* Delete a bare metal server.
*
* This request deletes a bare metal server. This operation cannot be reversed. Any floating IPs associated with the
* bare metal server network interfaces are implicitly disassociated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteBareMetalServer(params: VpcV1.DeleteBareMetalServerParams): Promise>;
/**
* Retrieve a bare metal server.
*
* This request retrieves a single bare metal server specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServer(params: VpcV1.GetBareMetalServerParams): Promise>;
/**
* Update a bare metal server.
*
* This request updates a bare metal server with the information in a provided patch. The bare metal server patch
* object is structured in the same way as a retrieved bare metal server and contains only the information to be
* updated.
*
* For this request to succeed, the properties in the request must adhere to the `allowed_use` property of the disk
* referenced in the server's `boot_target`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {number} [params.bandwidth] - The total bandwidth (in megabits per second) shared across the bare metal
* server's network interfaces. The specified value must match one of the bandwidth values in the bare metal server's
* profile.
* @param {boolean} [params.enableSecureBoot] - Indicates whether secure boot is enabled. If enabled, the image must
* support secure boot or the bare metal server will fail to boot.
*
* For `enable_secure_boot` to be changed, the bare metal server `status` must be
* `stopped`.
* @param {BareMetalServerMetadataServicePatch} [params.metadataService] - The metadata service configuration for the
* bare metal server.
* @param {string} [params.name] - The name for this bare metal server. The name must not be used by another bare
* metal server in the region. Changing the name will not affect the system hostname.
* @param {BareMetalServerReservationAffinityPatch} [params.reservationAffinity] -
* @param {BareMetalServerTrustedPlatformModulePatch} [params.trustedPlatformModule] -
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateBareMetalServer(params: VpcV1.UpdateBareMetalServerParams): Promise>;
/**
* Update firmware for a bare metal server.
*
* This request updates a bare metal server to the latest available firmware. The server must be stopped.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {boolean} [params.autoStart] - Indicates whether to automatically start the bare metal server after the
* firmware update is successfully completed.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateFirmwareForBareMetalServer(params: VpcV1.UpdateFirmwareForBareMetalServerParams): Promise>;
/**
* Retrieve initialization configuration for a bare metal server.
*
* This request retrieves configuration used to initialize the bare metal server, such as the image used, SSH keys,
* and any configured usernames and passwords. These can subsequently be changed on the server and therefore may not
* be current.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getBareMetalServerInitialization(params: VpcV1.GetBareMetalServerInitializationParams): Promise>;
/**
* Reinitialize a bare metal server.
*
* This request reinitializes a bare metal server with the specified image and SSH keys. The server must be stopped.
* Upon successful reinitiatilization, the bare metal server will be started automatically.
*
* For this request to succeed, the properties of the server which would result from the reinitialization must adhere
* to the specified image's `allowed_use` property.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {ImageIdentity} params.image - The image to be used when provisioning the bare metal server.
* @param {KeyIdentity[]} params.keys - The public SSH keys to install on the bare metal server. Keys will be made
* available to the bare metal server as cloud-init vendor data. For cloud-init enabled images, these keys will also
* be added as SSH authorized keys for the [default
* user](https://cloud.ibm.com/docs/vpc?topic=vpc-vsi_is_connecting_linux#determining-default-user-account).
*
* For Windows images, at least one key must be specified, and one will be selected to encrypt the administrator
* password. Keys are optional for other images, but if no keys are specified, the bare metal server will be
* inaccessible unless the specified image provides another means of access.
* @param {BareMetalServerInitializationDefaultTrustedProfilePrototype} [params.defaultTrustedProfile] - The default
* trusted profile to be used when initializing the bare metal server.
*
* If unspecified, no default trusted profile will be made available.
* @param {string} [params.userData] - The user data to be made available when initializing the bare metal server.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceBareMetalServerInitialization(params: VpcV1.ReplaceBareMetalServerInitializationParams): Promise>;
/**
* Restart a bare metal server.
*
* This request immediately restarts a bare metal server. For this request to succeed, the server must have a
* `status` of `running`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
restartBareMetalServer(params: VpcV1.RestartBareMetalServerParams): Promise>;
/**
* Start a bare metal server.
*
* This request starts a bare metal server. It will run immediately provided the server is stopped.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
startBareMetalServer(params: VpcV1.StartBareMetalServerParams): Promise>;
/**
* Stop a bare metal server.
*
* This request stops a bare metal server. It will run immediately provided the server is running. Note: A soft stop
* may not complete as it relies on the operating system to perform the operation.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The bare metal server identifier.
* @param {string} params.type - The type of stop operation:
* - `soft`: signal running operating system to quiesce and shutdown cleanly
* - `hard`: immediately stop the server.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
stopBareMetalServer(params: VpcV1.StopBareMetalServerParams): Promise>;
/*************************
* clusterNetworks
************************/
/**
* List cluster network profiles.
*
* This request lists cluster network profiles available in the region. A cluster network profile specifies the
* performance characteristics and capabilities for a cluster network.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listClusterNetworkProfiles(params?: VpcV1.ListClusterNetworkProfilesParams): Promise>;
/**
* Retrieve a cluster network profile.
*
* This request retrieves a single cluster network profile specified by the name in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The cluster network profile name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getClusterNetworkProfile(params: VpcV1.GetClusterNetworkProfileParams): Promise>;
/**
* List cluster networks.
*
* This request lists [cluster networks](https://cloud.ibm.com/docs/vpc?topic=vpc-about-cluster-network) in the
* region. A cluster network is a grouping of resources in a separate networking space for high performance computing
* and networking.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {string} [params.vpcId] - Filters the collection to cluster networks with a `vpc.id` property matching the
* specified id.
* @param {string} [params.vpcCrn] - Filters the collection to cluster networks with a `vpc.crn` property matching the
* specified CRN.
* @param {string} [params.vpcName] - Filters the collection to cluster networks with a `vpc.name` property matching
* the specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listClusterNetworks(params?: VpcV1.ListClusterNetworksParams): Promise>;
/**
* Create a cluster network.
*
* This request creates a new cluster network from a cluster network prototype object. The prototype object is
* structured in the same way as a retrieved cluster network, and contains the information necessary to create the new
* cluster network.
*
* @param {Object} params - The parameters to send to the service.
* @param {ClusterNetworkProfileIdentity} params.profile - The profile to use for this cluster network.
* @param {VPCIdentity} params.vpc - The VPC this cluster network will reside in.
* @param {ZoneIdentity} params.zone - The zone this cluster network will reside in. The zone must be listed
* as supported on the specified cluster network profile.
* @param {string} [params.name] - The name for this cluster network. The name must not be used by another cluster
* network in the region. Names starting with `ibm-` are reserved for provider-owned resources, and are not allowed.
* If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {ResourceGroupIdentity} [params.resourceGroup] - The resource group to use. If unspecified, the account's
* [default resource
* group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.
* @param {ClusterNetworkSubnetPrefixPrototype[]} [params.subnetPrefixes] -
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createClusterNetwork(params: VpcV1.CreateClusterNetworkParams): Promise>;
/**
* List cluster network interfaces.
*
* This request lists cluster network interfaces in the region. A cluster network interface is a logical abstraction
* of a cluster network interface in a subnet, and may be attached to a target resource.
*
* The cluster network interfaces will be sorted by their `created_at` property values, with newest cluster network
* interfaces first. Cluster network interfaces with identical
* `created_at` property values will in turn be sorted by ascending `name` property values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listClusterNetworkInterfaces(params: VpcV1.ListClusterNetworkInterfacesParams): Promise>;
/**
* Create a cluster network interface.
*
* This request creates a new cluster network interface from a cluster network interface prototype object. The
* prototype object is structured in the same way as a retrieved cluster network interface, and contains the
* information necessary to create the new cluster network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} [params.name] - The name for this cluster network interface. The name must not be used by another
* interface in the cluster network. Names beginning with `ibm-` are reserved for provider-owned resources, and are
* not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {ClusterNetworkInterfacePrimaryIPPrototype} [params.primaryIp] - The primary IP address to bind to the
* cluster network interface. May be either
* a cluster network subnet reserved IP identity, or a cluster network subnet reserved IP
* prototype object which will be used to create a new cluster network subnet reserved IP.
*
* If a cluster network subnet reserved IP identity is provided, the specified cluster
* network subnet reserved IP must be unbound.
*
* If a cluster network subnet reserved IP prototype object with an address is provided,
* the address must be available on the cluster network interface's cluster network
* subnet. If no address is specified, an available address on the cluster network subnet
* will be automatically selected and reserved.
* @param {ClusterNetworkSubnetIdentity} [params.subnet] - The associated cluster network subnet. Required if
* `primary_ip` does not specify a cluster
* network subnet reserved IP identity.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createClusterNetworkInterface(params: VpcV1.CreateClusterNetworkInterfaceParams): Promise>;
/**
* Delete a cluster network interface.
*
* This request deletes a cluster network interface. This operation cannot be reversed. For this request to succeed,
* the cluster network interface must not be required by another resource, such as a cluster network attachment for a
* virtual server instance.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network interface identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteClusterNetworkInterface(params: VpcV1.DeleteClusterNetworkInterfaceParams): Promise>;
/**
* Retrieve a cluster network interface.
*
* This request retrieves a single cluster network interface specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network interface identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getClusterNetworkInterface(params: VpcV1.GetClusterNetworkInterfaceParams): Promise>;
/**
* Update a cluster network interface.
*
* This request updates a cluster network interface with the information provided in a cluster network interface patch
* object. The patch object is structured in the same way as a retrieved cluster network interface and needs to
* contain only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network interface identifier.
* @param {boolean} [params.autoDelete] - Indicates whether this cluster network interface will be automatically
* deleted when `target` is deleted. Must be `false` if the cluster network interface is unbound.
* @param {string} [params.name] - The name for this cluster network interface. The name must not be used by another
* interface in the cluster network. Names beginning with `ibm-` are reserved for provider-owned resources, and are
* not allowed.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateClusterNetworkInterface(params: VpcV1.UpdateClusterNetworkInterfaceParams): Promise>;
/**
* List cluster network subnets.
*
* This request lists cluster network subnets in the cluster network. A cluster network subnet provides network
* routing between other cluster network subnets within a cluster network.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listClusterNetworkSubnets(params: VpcV1.ListClusterNetworkSubnetsParams): Promise>;
/**
* Create a cluster network subnet.
*
* This request creates a new cluster network subnet from a cluster network subnet prototype object. The prototype
* object is structured in the same way as a retrieved cluster network subnet, and contains the information necessary
* to create the new cluster network subnet.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {ClusterNetworkSubnetPrototype} params.clusterNetworkSubnetPrototype - The cluster network subnet prototype
* object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createClusterNetworkSubnet(params: VpcV1.CreateClusterNetworkSubnetParams): Promise>;
/**
* List cluster network subnet reserved IPs.
*
* This request lists cluster network subnet reserved IPs in the cluster network.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.clusterNetworkSubnetId - The cluster network subnet identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listClusterNetworkSubnetReservedIps(params: VpcV1.ListClusterNetworkSubnetReservedIpsParams): Promise>;
/**
* Create a cluster network subnet reserved IP.
*
* This request creates a new cluster network subnet reserved IP from a cluster network subnet reserved IP prototype
* object. The prototype object is structured in the same way as a retrieved cluster network subnet reserved IP, and
* contains the information necessary to create the new cluster network subnet reserved IP.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.clusterNetworkSubnetId - The cluster network subnet identifier.
* @param {string} [params.address] - The IP address to reserve, which must not already be reserved on the subnet.
*
* If unspecified, an available address on the subnet will automatically be selected.
* @param {string} [params.name] - The name for this cluster network subnet reserved IP. The name must not be used by
* another reserved IP in the cluster network subnet. Names starting with `ibm-` are reserved for provider-owned
* resources, and are not allowed. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createClusterNetworkSubnetReservedIp(params: VpcV1.CreateClusterNetworkSubnetReservedIpParams): Promise>;
/**
* Delete a cluster network subnet reserved IP.
*
* This request deletes a cluster network subnet reserved IP. This operation cannot be reversed.
*
* For this request to succeed, the reserved IP must be unbound. A provider-owned reserved IP is not allowed to be
* deleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.clusterNetworkSubnetId - The cluster network subnet identifier.
* @param {string} params.id - The cluster network subnet reserved IP identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteClusterNetworkSubnetReservedIp(params: VpcV1.DeleteClusterNetworkSubnetReservedIpParams): Promise>;
/**
* Retrieve a cluster network subnet reserved IP.
*
* This request retrieves a single cluster network subnet reserved IP specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.clusterNetworkSubnetId - The cluster network subnet identifier.
* @param {string} params.id - The cluster network subnet reserved IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getClusterNetworkSubnetReservedIp(params: VpcV1.GetClusterNetworkSubnetReservedIpParams): Promise>;
/**
* Update a cluster network subnet reserved IP.
*
* This request updates a cluster network subnet reserved IP with the information provided in a cluster network subnet
* reserved IP patch object. The patch object is structured in the same way as a retrieved cluster network subnet
* reserved IP and needs to contain only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.clusterNetworkSubnetId - The cluster network subnet identifier.
* @param {string} params.id - The cluster network subnet reserved IP identifier.
* @param {boolean} [params.autoDelete] - Indicates whether this cluster network subnet reserved IP member will be
* automatically deleted when either `target` is deleted, or the cluster network subnet reserved IP is unbound. Must
* be `false` if the cluster network subnet reserved IP is unbound.
* @param {string} [params.name] - The name for this cluster network subnet reserved IP. The name must not be used by
* another reserved IP in the cluster network subnet. Names starting with `ibm-` are reserved for provider-owned
* resources, and are not allowed.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateClusterNetworkSubnetReservedIp(params: VpcV1.UpdateClusterNetworkSubnetReservedIpParams): Promise>;
/**
* Delete a cluster network subnet.
*
* This request deletes a cluster network subnet. This operation cannot be reversed.
*
* For this request to succeed, this cluster subnet must not be attached to a cluster network interface.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network subnet identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteClusterNetworkSubnet(params: VpcV1.DeleteClusterNetworkSubnetParams): Promise>;
/**
* Retrieve a cluster network subnet.
*
* This request retrieves a single cluster network subnet specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network subnet identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getClusterNetworkSubnet(params: VpcV1.GetClusterNetworkSubnetParams): Promise>;
/**
* Update a cluster network subnet.
*
* This request updates a cluster network subnet with the information provided in a cluster network subnet patch
* object. The patch object is structured in the same way as a retrieved cluster network subnet and needs to contain
* only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.clusterNetworkId - The cluster network identifier.
* @param {string} params.id - The cluster network subnet identifier.
* @param {string} [params.name] - The name for this cluster network subnet. The name must not be used by another
* cluster network subnet in the cluster network. Names starting with `ibm-` are reserved for provider-owned
* resources, and are not allowed.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateClusterNetworkSubnet(params: VpcV1.UpdateClusterNetworkSubnetParams): Promise>;
/**
* Delete a cluster network.
*
* This request deletes a cluster network. This operation cannot be reversed.
*
* For this request to succeed, virtual server instances must not reside in this cluster network.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The cluster network identifier.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteClusterNetwork(params: VpcV1.DeleteClusterNetworkParams): Promise>;
/**
* Retrieve a cluster network.
*
* This request retrieves a single cluster network specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The cluster network identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getClusterNetwork(params: VpcV1.GetClusterNetworkParams): Promise>;
/**
* Update a cluster.
*
* This request updates a cluster network with the information provided in a cluster network patch object. The patch
* object is structured in the same way as a retrieved cluster network and needs to contain only the information to be
* updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The cluster network identifier.
* @param {string} [params.name] - The name for this cluster network. The name must not be used by another cluster
* network in the region. Names starting with `ibm-` are reserved for provider-owned resources, and are not allowed.
* @param {string} [params.ifMatch] - If present, the request will fail if the specified ETag value does not match the
* resource's current ETag value. Required if the request body includes an array.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateClusterNetwork(params: VpcV1.UpdateClusterNetworkParams): Promise>;
/*************************
* dedicatedHosts
************************/
/**
* List dedicated host groups.
*
* This request lists dedicated host groups in the region. Each dedicated host must belong to exactly one group, which
* controls placement of instances. Dedicated host groups do not span zones.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.zoneName] - Filters the collection to resources with a `zone.name` property matching the
* exact specified name.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDedicatedHostGroups(params?: VpcV1.ListDedicatedHostGroupsParams): Promise>;
/**
* Create a dedicated host group.
*
* This request creates a new dedicated host group.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params._class - The dedicated host profile class for hosts in this group.
* @param {string} params.family - The dedicated host profile family for hosts in this group.
* @param {ZoneIdentity} params.zone - The zone this dedicated host group will reside in.
* @param {string} [params.name] - The name for this dedicated host group. The name must not be used by another
* dedicated host group in the region. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {ResourceGroupIdentity} [params.resourceGroup] - The resource group to use. If unspecified, the account's
* [default resource
* group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createDedicatedHostGroup(params: VpcV1.CreateDedicatedHostGroupParams): Promise>;
/**
* Delete a dedicated host group.
*
* This request deletes a dedicated host group.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host group identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDedicatedHostGroup(params: VpcV1.DeleteDedicatedHostGroupParams): Promise>;
/**
* Retrieve a dedicated host group.
*
* This request retrieves a single dedicated host group specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host group identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDedicatedHostGroup(params: VpcV1.GetDedicatedHostGroupParams): Promise>;
/**
* Update a dedicated host group.
*
* This request updates a dedicated host group with the information in a provided dedicated host group patch. The
* dedicated host group patch object is structured in the same way as a retrieved dedicated host group and contains
* only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host group identifier.
* @param {string} [params.name] - The name for this dedicated host group. The name must not be used by another
* dedicated host group in the region.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDedicatedHostGroup(params: VpcV1.UpdateDedicatedHostGroupParams): Promise>;
/**
* List dedicated host profiles.
*
* This request lists provisionable [dedicated host profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-dh-profiles) in
* the region. A dedicated host profile specifies the hardware characteristics for a dedicated host.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDedicatedHostProfiles(params?: VpcV1.ListDedicatedHostProfilesParams): Promise>;
/**
* Retrieve a dedicated host profile.
*
* This request retrieves a single dedicated host profile specified by the name in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The dedicated host profile name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDedicatedHostProfile(params: VpcV1.GetDedicatedHostProfileParams): Promise>;
/**
* List dedicated hosts.
*
* This request lists dedicated hosts in the region.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.dedicatedHostGroupId] - Filters the collection to dedicated hosts with a `group.id`
* property matching the specified identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.zoneName] - Filters the collection to resources with a `zone.name` property matching the
* exact specified name.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDedicatedHosts(params?: VpcV1.ListDedicatedHostsParams): Promise>;
/**
* Create a dedicated host.
*
* This request creates a new dedicated host.
*
* @param {Object} params - The parameters to send to the service.
* @param {DedicatedHostPrototype} params.dedicatedHostPrototype - The dedicated host prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createDedicatedHost(params: VpcV1.CreateDedicatedHostParams): Promise>;
/**
* List disks on a dedicated host.
*
* This request lists disks on a dedicated host. A disk is a physical device that is locally attached to the compute
* node. By default, the listed disks are sorted by their
* `created_at` property values, with the newest disk first.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.dedicatedHostId - The dedicated host identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listDedicatedHostDisks(params: VpcV1.ListDedicatedHostDisksParams): Promise>;
/**
* Retrieve a dedicated host disk.
*
* This request retrieves a single dedicated host disk specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.dedicatedHostId - The dedicated host identifier.
* @param {string} params.id - The dedicated host disk identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDedicatedHostDisk(params: VpcV1.GetDedicatedHostDiskParams): Promise>;
/**
* Update a dedicated host disk.
*
* This request updates the dedicated host disk with the information in a provided patch.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.dedicatedHostId - The dedicated host identifier.
* @param {string} params.id - The dedicated host disk identifier.
* @param {string} [params.name] - The name for this dedicated host disk. The name must not be used by another disk on
* the dedicated host.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDedicatedHostDisk(params: VpcV1.UpdateDedicatedHostDiskParams): Promise>;
/**
* Delete a dedicated host.
*
* This request deletes a dedicated host. This operation cannot be reversed. For this request to succeed, `instances`
* must be empty and `instance_placement_enabled` must be `false`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteDedicatedHost(params: VpcV1.DeleteDedicatedHostParams): Promise>;
/**
* Retrieve a dedicated host.
*
* This request retrieves a single dedicated host specified by the identifiers in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getDedicatedHost(params: VpcV1.GetDedicatedHostParams): Promise>;
/**
* Update a dedicated host.
*
* This request updates a dedicated host with the information in a provided dedicated host patch. The dedicated host
* patch object is structured in the same way as a retrieved dedicated host and contains only the information to be
* updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The dedicated host identifier.
* @param {boolean} [params.instancePlacementEnabled] - If set to true, instances can be placed on this dedicated
* host.
* @param {string} [params.name] - The name for this dedicated host. The name must not be used by another dedicated
* host in the region.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateDedicatedHost(params: VpcV1.UpdateDedicatedHostParams): Promise>;
/*************************
* endpointGateways
************************/
/**
* List endpoint gateways.
*
* This request lists endpoint gateways in the region. An endpoint gateway maps one or more reserved IPs in a VPC to a
* target outside the VPC.
*
* The endpoint gateways will be sorted by their `created_at` property values, with newest endpoint gateway first.
* Endpoint gateways with identical `created_at` property values will in turn be sorted by ascending `name` property
* values.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string[]} [params.lifecycleState] - Filters the collection to resources with a `lifecycle_state` property
* matching one of the specified comma-separated values.
* @param {string} [params.vpcId] - Filters the collection to resources with a `vpc.id` property matching the
* specified identifier.
* @param {string} [params.vpcCrn] - Filters the collection to resources with a `vpc.crn` property matching the
* specified CRN.
* @param {string} [params.vpcName] - Filters the collection to resources with a `vpc.name` property matching the
* exact specified name.
* @param {string[]} [params.dnsResolutionBindingMode] - Filters the collection to endpoint gateways with a
* `dns_resolution_binding_mode` property matching one of the specified comma-separated values.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listEndpointGateways(params?: VpcV1.ListEndpointGatewaysParams): Promise>;
/**
* Create an endpoint gateway.
*
* This request creates a new endpoint gateway from an endpoint gateway prototype object. The prototype object is
* structured in the same way as a retrieved endpoint gateway, and contains the information necessary to create a new
* endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target service outside the VPC.
*
* @param {Object} params - The parameters to send to the service.
* @param {EndpointGatewayTargetPrototype} params.target - The target to use for this endpoint gateway. The target:
* - Must not already be the target of another endpoint gateway in the VPC
* - Must not have a service endpoint that overlaps with any `service_endpoints` of
* another endpoint gateway in the VPC.
*
* If `dns_resolution_binding_mode` is set to `primary`, then there must not be
* another endpoint gateway in the [DNS sharing](/docs/vpc?topic=vpc-vpe-dns-sharing)
* connected topology that:
* - Has the same `target` as this endpoint gateway
* - Has `service_endpoints` that overlap with the `service_endpoints` for this endpoint
* gateway.
*
* If `dns_resolution_binding_mode` is set to `per_resource_binding`, then:
* - The VPC in the topology with `dns.enable_hub` set to `true` must have an endpoint
* gateway with the same `target` as this endpoint gateway.
* - The VPC in the topology with `dns.enable_hub` set to `true` must have an endpoint
* gateway with `dns_resolution_binding_mode` set to `primary`.
* - No other VPC in the topology can have an endpoint gateway with a resource binding
* using the same `service_endpoint` as a resource binding for this endpoint gateway.
* @param {VPCIdentity} params.vpc - The VPC this endpoint gateway will reside in.
* @param {string} [params.dnsResolutionBindingMode] - The DNS resolution binding mode to use for this endpoint
* gateway:
* - `disabled`: The endpoint gateway will not participate in [DNS sharing for VPE
* gateways](/docs/vpc?topic=vpc-vpe-dns-sharing) with other VPCs in a connected
* topology.
* - `primary`: The endpoint gateway will participate in [DNS sharing for VPE gateways]
* (/docs/vpc?topic=vpc-vpe-dns-sharing) if the VPC this endpoint gateway resides in
* has a DNS resolution binding to another VPC. If the VPC this endpoint gateway
* resides in has a DNS resolution binding to another VPC, then no other VPC in the
* topology can have an endpoint gateway with the same `target` as this endpoint
* gateway.
* - `per_resource_binding`: The endpoint gateway will participate in [DNS sharing for VPE
* gateways](/docs/vpc?topic=vpc-vpe-dns-sharing) if the VPC this endpoint gateway
* resides in has a DNS resolution binding to another VPC. Resource binding must be
* enabled for the `target` service.
*
* The VPC this endpoint gateway resides in must have `dns.enable_hub` set to
* `false`.
*
* If the VPC this endpoint gateway resides in has DNS resolution binding to another
* VPC, the other VPC must:
* - have `dns.enable_hub` set to `true`
* - contain an endpoint gateway for the same `target` service with
* `dns_resolution_binding_mode` set to `primary`.
* @param {EndpointGatewayReservedIP[]} [params.ips] - The reserved IPs to bind to this endpoint gateway. At most one
* reserved IP per zone is allowed.
* @param {string} [params.name] - The name for this endpoint gateway. The name must not be used by another endpoint
* gateway in the VPC. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {ResourceGroupIdentity} [params.resourceGroup] - The resource group to use. If unspecified, the account's
* [default resource
* group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.
* @param {SecurityGroupIdentity[]} [params.securityGroups] - The security groups to use for this endpoint gateway. If
* unspecified, the VPC's default security group is used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createEndpointGateway(params: VpcV1.CreateEndpointGatewayParams): Promise>;
/**
* List reserved IPs bound to an endpoint gateway.
*
* This request lists reserved IPs bound to an endpoint gateway.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listEndpointGatewayIps(params: VpcV1.ListEndpointGatewayIpsParams): Promise>;
/**
* Unbind a reserved IP from an endpoint gateway.
*
* This request unbinds the specified reserved IP from the specified endpoint gateway. If the reserved IP has
* `auto_delete` set to `true`, the reserved IP will be deleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The reserved IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
removeEndpointGatewayIp(params: VpcV1.RemoveEndpointGatewayIpParams): Promise>;
/**
* Retrieve a reserved IP bound to an endpoint gateway.
*
* This request retrieves the specified reserved IP address if it is bound to the endpoint gateway specified in the
* URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The reserved IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getEndpointGatewayIp(params: VpcV1.GetEndpointGatewayIpParams): Promise>;
/**
* Bind a reserved IP to an endpoint gateway.
*
* This request binds the specified reserved IP to the specified endpoint gateway. The reserved IP:
*
* - must currently be unbound, or not required by its target
* - must not be in the same zone as any other reserved IP bound to the endpoint gateway.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The reserved IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
addEndpointGatewayIp(params: VpcV1.AddEndpointGatewayIpParams): Promise>;
/**
* List resource bindings for an endpoint gateway.
*
* This request lists resource bindings for an endpoint gateway. A resource binding is an association between the
* endpoint gateway and a resource in the endpoint gateway's `target` service. The resource binding provides a fully
* qualified domain name for the
* `service_endpoint` to access the resource from the endpoint gateway's VPC.
*
* The resource bindings will be sorted by their `created_at` property values, with newest resource bindings first.
* Resource bindings with identical `created_at` property values will in turn be sorted by ascending `name` property
* values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listEndpointGatewayResourceBindings(params: VpcV1.ListEndpointGatewayResourceBindingsParams): Promise>;
/**
* Create a resource binding for an endpoint gateway.
*
* This request creates a new resource binding for an endpoint gateway from an endpoint gateway resource binding
* prototype object. The prototype object is structured in the same way as a retrieved endpoint gateway resource
* binding, and contains the information necessary to create the new resource binding.
*
* For this request to succeed, resource binding must be enabled for this endpoint gateway's
* `target` service and this endpoint gateway resource binding must not conflict with another resource binding in the
* [DNS sharing](/docs/vpc?topic=vpc-vpe-dns-sharing) connected topology.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {EndpointGatewayResourceBindingTargetPrototype} params.target - The target to use for this resource binding.
* @param {string} [params.name] - The name for this resource binding. The name must not be used by another resource
* binding for the endpoint gateway. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createEndpointGatewayResourceBinding(params: VpcV1.CreateEndpointGatewayResourceBindingParams): Promise>;
/**
* Delete a resource binding from an endpoint gateway.
*
* This request deletes the specified resource binding from the specified endpoint gateway. This operation cannot be
* reversed.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The resource binding identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteEndpointGatewayResourceBinding(params: VpcV1.DeleteEndpointGatewayResourceBindingParams): Promise>;
/**
* Retrieve an endpoint gateway resource binding.
*
* This request retrieves a single endpoint gateway resource binding specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The resource binding identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getEndpointGatewayResourceBinding(params: VpcV1.GetEndpointGatewayResourceBindingParams): Promise>;
/**
* Update an endpoint gateway resource binding.
*
* This request updates an endpoint gateway resource binding with the information in a provided endpoint gateway
* resource binding patch. The endpoint gateway resource binding patch object is structured in the same way as a
* retrieved endpoint gateway resource binding and contains only the information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.endpointGatewayId - The endpoint gateway identifier.
* @param {string} params.id - The resource binding identifier.
* @param {string} [params.name] - The name for this resource binding. The name must not be used by another resource
* binding for the endpoint gateway.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateEndpointGatewayResourceBinding(params: VpcV1.UpdateEndpointGatewayResourceBindingParams): Promise>;
/**
* Delete an endpoint gateway.
*
* This request deletes an endpoint gateway. This operation cannot be reversed.
*
* Reserved IPs that were bound to the endpoint gateway will be released if their
* `auto_delete` property is set to true.
*
* If the VPC this endpoint gateway resides in has `dns.enable_hub` set to `true`, then no other VPC in the [DNS
* sharing](/docs/vpc?topic=vpc-vpe-dns-sharing) topology must contain an endpoint gateway with the same `target`
* service as this endpoint gateway.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The endpoint gateway identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteEndpointGateway(params: VpcV1.DeleteEndpointGatewayParams): Promise>;
/**
* Retrieve an endpoint gateway.
*
* This request retrieves a single endpoint gateway specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The endpoint gateway identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getEndpointGateway(params: VpcV1.GetEndpointGatewayParams): Promise>;
/**
* Update an endpoint gateway.
*
* This request updates an endpoint gateway with the information in a provided endpoint gateway patch. The endpoint
* gateway patch object is structured in the same way as a retrieved endpoint gateway and contains only the
* information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The endpoint gateway identifier.
* @param {string} [params.dnsResolutionBindingMode] - The DNS resolution binding mode to use for this endpoint
* gateway:
* - `disabled`: The endpoint gateway will not participate in [DNS sharing for VPE
* gateways](/docs/vpc?topic=vpc-vpe-dns-sharing) with other VPCs in a connected
* topology.
* - `primary`: The endpoint gateway will participate in [DNS sharing for VPE gateways]
* (/docs/vpc?topic=vpc-vpe-dns-sharing) if the VPC this endpoint gateway resides in
* has a DNS resolution binding to another VPC. If the VPC this endpoint gateway
* resides in has a DNS resolution binding to another VPC, then no other VPC in the
* topology can have an endpoint gateway with the same `target` as this endpoint
* gateway.
* - `per_resource_binding`: The endpoint gateway will participate in [DNS sharing for VPE
* gateways](/docs/vpc?topic=vpc-vpe-dns-sharing) if the VPC this endpoint gateway
* resides in has a DNS resolution binding to another VPC. Resource binding must be
* enabled for the `target` service.
*
* The VPC this endpoint gateway resides in must have `dns.enable_hub` set to
* `false`.
*
* If the VPC this endpoint gateway resides in has DNS resolution binding to another
* VPC, the other VPC must:
* - have `dns.enable_hub` set to `true`
* - contain an endpoint gateway for the same `target` service with
* `dns_resolution_binding_mode` set to `primary`.
* @param {string} [params.name] - The name for this endpoint gateway. The name must not be used by another endpoint
* gateway in the VPC.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateEndpointGateway(params: VpcV1.UpdateEndpointGatewayParams): Promise>;
/*************************
* floatingIPs
************************/
/**
* List floating IPs.
*
* This request lists floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to
* an instance.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.sort] - Sorts the returned collection by the specified property name in ascending order. A
* `-` may be prepended to the name to sort in descending order. For example, the value `-created_at` sorts the
* collection by the `created_at` property in descending order, and the value `name` sorts it by the `name` property
* in ascending order.
* @param {string} [params.targetId] - Filters the collection to resources with a `target.id` property matching the
* specified identifier.
* @param {string} [params.targetCrn] - Filters the collection to resources with a `target.crn` property matching the
* specified CRN.
* @param {string} [params.targetName] - Filters the collection to resources with a `target.name` property matching
* the exact specified name.
* @param {string} [params.targetResourceType] - Filters the collection to resources with a `target.resource_type`
* property matching the specified value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listFloatingIps(params?: VpcV1.ListFloatingIpsParams): Promise>;
/**
* Reserve a floating IP.
*
* This request reserves a new floating IP.
*
* @param {Object} params - The parameters to send to the service.
* @param {FloatingIPPrototype} params.floatingIpPrototype - The floating IP prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createFloatingIp(params: VpcV1.CreateFloatingIpParams): Promise>;
/**
* Delete a floating IP.
*
* This request disassociates (if associated) and releases a floating IP. This operation cannot be reversed. For this
* request to succeed, the floating IP must not be required by another resource, such as a public gateway.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The floating IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteFloatingIp(params: VpcV1.DeleteFloatingIpParams): Promise>;
/**
* Retrieve a floating IP.
*
* This request retrieves a single floating IP specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The floating IP identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getFloatingIp(params: VpcV1.GetFloatingIpParams): Promise>;
/**
* Update a floating IP.
*
* This request updates a floating IP's name and/or target.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The floating IP identifier.
* @param {string} [params.name] - The name for this floating IP. The name must not be used by another floating IP in
* the region.
* @param {FloatingIPTargetPatch} [params.target] - The target resource to bind this floating IP to, replacing any
* existing binding.
* The floating IP must not be required by another resource, such as a public gateway.
*
* The target resource must not already have a floating IP bound to it if the target
* resource is:
*
* - an instance network interface
* - a bare metal server network interface with `enable_infrastructure_nat` set to `true`
* - a virtual network interface with `enable_infrastructure_nat` set to `true`
*
* Specify `null` to remove an existing binding.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateFloatingIp(params: VpcV1.UpdateFloatingIpParams): Promise>;
/*************************
* flowLogCollectors
************************/
/**
* List flow log collectors.
*
* This request lists flow log collectors in the region. A [flow log
* collector](https://cloud.ibm.com/docs/vpc?topic=vpc-flow-logs) summarizes TCP and UDP data sent over the instance
* network interfaces and instance network attachments contained within its target. The collected flow logs are
* written to a cloud object storage bucket, where they can be
* [viewed](https://cloud.ibm.com/docs/vpc?topic=vpc-fl-analyze).
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string} [params.vpcId] - Filters the collection to resources with a `vpc.id` property matching the
* specified identifier.
* @param {string} [params.vpcCrn] - Filters the collection to resources with a `vpc.crn` property matching the
* specified CRN.
* @param {string} [params.vpcName] - Filters the collection to resources with a `vpc.name` property matching the
* exact specified name.
* @param {string} [params.targetId] - Filters the collection to resources with a `target.id` property matching the
* specified identifier.
* @param {string} [params.targetResourceType] - Filters the collection to resources with a `target.resource_type`
* property matching the specified value.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listFlowLogCollectors(params?: VpcV1.ListFlowLogCollectorsParams): Promise>;
/**
* Create a flow log collector.
*
* This request creates and starts a new flow log collector from a flow log collector prototype object. The prototype
* object is structured in the same way as a retrieved flow log collector, and contains the information necessary to
* create and start the new flow log collector.
*
* @param {Object} params - The parameters to send to the service.
* @param {LegacyCloudObjectStorageBucketIdentity} params.storageBucket - The Cloud Object Storage bucket where the
* collected flows will be logged.
* The bucket must exist and an IAM service authorization must grant
* `IBM Cloud Flow Logs` resources of `VPC Infrastructure Services` writer
* access to the bucket. For more information, see [Creating a flow log
* collector](https://cloud.ibm.com/docs/vpc?topic=vpc-ordering-flow-log-collector).
* @param {FlowLogCollectorTargetPrototype} params.target - The target this collector will collect flow logs for.
*
* If the target is an instance, subnet, or VPC, flow logs will not be collected for any
* instance network attachments, virtual network interfaces or instance network interfaces
* within the target that are themselves the target of a more specific flow log collector.
*
* For this request to succeed, the target must:
* - not be a virtual network interface that is attached to a bare metal server network
* attachment or to a file share mount target
* - not already be the target of another flow log collector.
* @param {boolean} [params.active] - Indicates whether this collector will be active upon creation.
* @param {string} [params.name] - The name for this flow log collector. The name must not be used by another flow log
* collector in the VPC. If unspecified, the name will be a hyphenated list of randomly-selected words.
* @param {ResourceGroupIdentity} [params.resourceGroup] - The resource group to use. If unspecified, the account's
* [default resource
* group](https://cloud.ibm.com/apidocs/resource-manager#introduction) will be used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createFlowLogCollector(params: VpcV1.CreateFlowLogCollectorParams): Promise>;
/**
* Delete a flow log collector.
*
* This request stops and deletes a flow log collector. This operation cannot be reversed.
*
* Collected flow logs remain available within the flow log collector's Cloud Object Storage bucket.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The flow log collector identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteFlowLogCollector(params: VpcV1.DeleteFlowLogCollectorParams): Promise>;
/**
* Retrieve a flow log collector.
*
* This request retrieves a single flow log collector specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The flow log collector identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getFlowLogCollector(params: VpcV1.GetFlowLogCollectorParams): Promise>;
/**
* Update a flow log collector.
*
* This request updates a flow log collector with the information in a provided flow log collector patch. The flow log
* collector patch object is structured in the same way as a retrieved flow log collector and contains only the
* information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The flow log collector identifier.
* @param {boolean} [params.active] - Indicates whether this collector is active. Updating to false deactivates the
* collector and updating to true activates the collector.
* @param {string} [params.name] - The name for this flow log collector. The name must not be used by another flow log
* collector in the VPC.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateFlowLogCollector(params: VpcV1.UpdateFlowLogCollectorParams): Promise>;
/*************************
* geography
************************/
/**
* List regions.
*
* This request lists regions. Each region is a separate geographic area that contains multiple isolated zones.
* Resources can be provisioned into one or more zones in a region. Each zone is isolated, but connected to other
* zones in the same region with low-latency and high-bandwidth links. Regions represent the top-level of fault
* isolation available. Resources deployed within a single region also benefit from the low latency afforded by
* geographic proximity.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listRegions(params?: VpcV1.ListRegionsParams): Promise>;
/**
* Retrieve a region.
*
* This request retrieves a single region specified by the name in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The region name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getRegion(params: VpcV1.GetRegionParams): Promise>;
/**
* List zones in a region.
*
* This request lists zones in a region. Zones represent logically-isolated data centers with high-bandwidth and
* low-latency interconnects to other zones in the same region. Faults in a zone do not affect other zones.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.regionName - The region name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listRegionZones(params: VpcV1.ListRegionZonesParams): Promise>;
/**
* Retrieve a zone.
*
* This request retrieves a single zone specified by the region and zone names in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.regionName - The region name.
* @param {string} params.name - The zone name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getRegionZone(params: VpcV1.GetRegionZoneParams): Promise>;
/*************************
* images
************************/
/**
* List images.
*
* This request lists images available in the region. An image provides source data for a volume. Images are either
* system-provided, or created from another source, such as importing from Cloud Object Storage.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {string} [params.resourceGroupId] - Filters the collection to resources with a `resource_group.id` property
* matching the specified identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {string[]} [params.status] - Filters the collection to images with a `status` property matching one of the
* specified comma-separated values.
* @param {string} [params.visibility] - Filters the collection to images with a `visibility` property matching the
* specified value.
* @param {string[]} [params.userDataFormat] - Filters the collection to images with a `user_data_format` property
* matching one of the specified comma-separated values.
* @param {string} [params.remoteAccountId] - Filters the collection to images with a `remote.account.id` property
* matching the specified account identifier.
*
* This parameter also supports the values null and not:null which filter the collection to resources which have no
* remote account identifier or any remote account identifier, respectively.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listImages(params?: VpcV1.ListImagesParams): Promise>;
/**
* Create an image.
*
* This request creates a new image from an image prototype object. The prototype object is structured in the same way
* as a retrieved image, and contains the information necessary to create the new image. If an image is being
* imported, a URL to the image file on object storage must be specified. If an image is being created from an
* existing volume, that volume must be specified.
*
* @param {Object} params - The parameters to send to the service.
* @param {ImagePrototype} params.imagePrototype - The image prototype object.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createImage(params: VpcV1.CreateImageParams): Promise>;
/**
* Delete an image.
*
* This request deletes an image. Any active image export jobs will be completed first. This operation cannot be
* reversed. An image with `remote.account` set is not allowed to be deleted. Additionally, an image cannot be deleted
* if it:
* - has a `status` of `deleting`
* - has a `status` of `pending` with a `status_reasons` code of
* `image_request_in_progress`
* - has `catalog_offering.managed` set to `true`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteImage(params: VpcV1.DeleteImageParams): Promise>;
/**
* Retrieve an image.
*
* This request retrieves a single image specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getImage(params: VpcV1.GetImageParams): Promise>;
/**
* Update an image.
*
* This request updates an image with the information in a provided image patch. The image patch object is structured
* in the same way as a retrieved image and contains only the information to be updated. An image with
* `remote.account` set is not allowed to be updated. An image with a `status` of `deleting` cannot be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {ImageAllowedUsePatch} [params.allowedUse] - The usage constraints to be matched against the requested
* instance or bare metal server
* properties to determine compatibility.
* @param {string} [params.deprecationAt] - The deprecation date and time to set for this image.
*
* This cannot be set if the image has a `status` of `failed` or `deleting`, or if
* `catalog_offering.managed` is `true`.
*
* The date and time must not be in the past, and must be earlier than `obsolescence_at`
* (if `obsolescence_at` is set). Additionally, if the image status is currently
* `deprecated`, the value cannot be changed (but may be removed).
*
* Specify `null` to remove an existing deprecation date and time. If the image status is currently `deprecated`, it
* will become `available`.
*
* If the deprecation date and time is reached while the image has a status of `pending`, the image's status will
* transition to `deprecated` upon its successful creation (or
* `obsolete` if the obsolescence date and time was also reached).
* @param {string} [params.name] - The name for this image. The name must not be used by another image in the region.
* Names starting with `ibm-` are reserved for system-provided images, and are not allowed.
* @param {string} [params.obsolescenceAt] - The obsolescence date and time to set for this image.
*
* This cannot be set if the image has a `status` of `failed` or `deleting`, or if
* `catalog_offering.managed` is `true`.
*
* The date and time must not be in the past, and must be later than `deprecation_at` (if
* `deprecation_at` is set). Additionally, if the image status is currently `obsolete`, the value cannot be changed
* (but may be removed).
*
* Specify `null` to remove an existing obsolescence date and time. If the image status is currently `obsolete`, it
* will become `deprecated` if `deprecation_at` is in the past. Otherwise, it will become `available`.
*
* If the obsolescence date and time is reached while the image has a status of `pending`, the image's status will
* transition to `obsolete` upon its successful creation.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateImage(params: VpcV1.UpdateImageParams): Promise>;
/**
* List bare metal server profiles compatible with an image.
*
* This request lists bare metal server profiles compatible with an image's
* `allowed_use.bare_metal_server`, `operating_system.architecture` and
* `user_data_format` properties, sorted by ascending `name` property values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listImageBareMetalServerProfiles(params: VpcV1.ListImageBareMetalServerProfilesParams): Promise>;
/**
* Deprecate an image.
*
* This request deprecates an image, resulting in its `status` becoming `deprecated` and
* `deprecation_at` being set to the current date and time.
*
* The image must:
* - have a `status` of `available`
* - have `catalog_offering.managed` set to `false`
* - not have `deprecation_at` set
*
* An image with `remote.account` set is not allowed to be deprecated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deprecateImage(params: VpcV1.DeprecateImageParams): Promise>;
/**
* List instance profiles compatible with an image.
*
* This request lists instance profiles compatible with an image's
* `allowed_use.instance`, `operating_system.architecture` and
* `user_data_format` properties, sorted by ascending `name` property values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listImageInstanceProfiles(params: VpcV1.ListImageInstanceProfilesParams): Promise>;
/**
* Obsolete an image.
*
* This request obsoletes an image, resulting in its `status` becoming `obsolete` and
* `obsolescence_at` being set to the current date and time.
*
* The image must:
* - have a `status` of `available` or `deprecated`
* - have `catalog_offering.managed` set to `false`
* - not have `deprecation_at` set in the future
* - not have `obsolescence_at` set
*
* An image with `remote.account` set is not allowed to be obsoleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The image identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
obsoleteImage(params: VpcV1.ObsoleteImageParams): Promise>;
/**
* List export jobs for an image.
*
* This request lists export jobs for an image. Each job tracks the exporting of the image to another location, such
* as a bucket within cloud object storage.
*
* The jobs will be sorted by their `created_at` property values, with newest jobs first. Jobs with identical
* `created_at` property values will in turn be sorted by ascending
* `name` property values.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.imageId - The image identifier.
* @param {string} [params.name] - Filters the collection to resources with a `name` property matching the exact
* specified name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listImageExportJobs(params: VpcV1.ListImageExportJobsParams): Promise>;
/**
* Create an export job for an image.
*
* This request creates and queues a new export job for the image specified in the URL using the image export job
* prototype object. The image must be owned by the account and be in the `available`, `deprecated`, `obsolete`, or
* `unusable` state. The prototype object is structured in the same way as a retrieved image export job, and contains
* the information necessary to create and queue the new image export job.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.imageId - The image identifier.
* @param {CloudObjectStorageBucketIdentity} params.storageBucket - The Cloud Object Storage bucket to export the
* image to. The bucket must exist and an IAM
* service authorization must grant `Image Service for VPC` of
* `VPC Infrastructure Services` writer access to the bucket.
* @param {string} [params.format] - The format to use for the exported image. If the image is encrypted, only `qcow2`
* is supported.
* @param {string} [params.name] - The name for this image export job. The name must not be used by another export job
* for the image. If unspecified, the name will be a hyphenated list of randomly-selected words prefixed with the
* first 16 characters of the parent image name.
*
* The exported image object name in Cloud Object Storage (`storage_object.name` in the response) will be based on
* this name. The object name will be unique within the bucket.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createImageExportJob(params: VpcV1.CreateImageExportJobParams): Promise>;
/**
* Delete an image export job.
*
* This request deletes an image export job. This operation cannot be reversed. If the job has not completed, the job
* will be canceled, and the incomplete exported image object deleted. If the job has completed, the exported image
* object will not be deleted.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.imageId - The image identifier.
* @param {string} params.id - The image export job identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteImageExportJob(params: VpcV1.DeleteImageExportJobParams): Promise>;
/**
* Retrieve an image export job.
*
* This request retrieves a single image export job specified by the identifier in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.imageId - The image identifier.
* @param {string} params.id - The image export job identifier.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getImageExportJob(params: VpcV1.GetImageExportJobParams): Promise>;
/**
* Update an image export job.
*
* This request updates an image export job with the information in a provided image export job patch. The image
* export job patch object is structured in the same way as a retrieved image export job and contains only the
* information to be updated.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.imageId - The image identifier.
* @param {string} params.id - The image export job identifier.
* @param {string} [params.name] - The name for this image export job. The name must not be used by another export job
* for the image. Changing the name will not affect the exported image name,
* `storage_object.name`, or `storage_href` values.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateImageExportJob(params: VpcV1.UpdateImageExportJobParams): Promise>;
/**
* List operating systems.
*
* This request lists operating systems in the region.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listOperatingSystems(params?: VpcV1.ListOperatingSystemsParams): Promise>;
/**
* Retrieve an operating system.
*
* This request retrieves a single operating system specified by the name in the URL.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.name - The operating system name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getOperatingSystem(params: VpcV1.GetOperatingSystemParams): Promise>;
/*************************
* instanceGroups
************************/
/**
* List instance groups.
*
* This request lists instance groups in the region.
*
* @param {Object} [params] - The parameters to send to the service.
* @param {string} [params.start] - A server-provided token determining what resource to start the page on.
* @param {number} [params.limit] - The number of resources to return on a page.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listInstanceGroups(params?: VpcV1.ListInstanceGroupsParams): Promise