Class Vpc

java.lang.Object
com.ibm.cloud.sdk.core.service.BaseService
com.ibm.cloud.is.vpc.v1.Vpc
public class Vpc extends com.ibm.cloud.sdk.core.service.BaseService
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: 2024-12-26

  • Field Details

    • DEFAULT_SERVICE_NAME

      public static final String DEFAULT_SERVICE_NAME
      Default service name used when configuring the `Vpc` client.
      See Also:

    • DEFAULT_SERVICE_URL

      public static final String DEFAULT_SERVICE_URL
      Default service endpoint URL.
      See Also:

  • Constructor Details

    • Vpc

      public Vpc(String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
      Constructs an instance of the `Vpc` client. The specified service name and authenticator are used to configure the client instance.
      Parameters:
      serviceName - the service name to be used when configuring the client instance
      authenticator - the Authenticator instance to be configured for this client

  • Method Details

    • newInstance

      public static Vpc newInstance()
      Class method which constructs an instance of the `Vpc` client. The default service name is used to configure the client instance.
      Returns:
      an instance of the `Vpc` client using external configuration

    • newInstance

      public static Vpc newInstance(String serviceName)
      Class method which constructs an instance of the `Vpc` client. The specified service name is used to configure the client instance.
      Parameters:
      serviceName - the service name to be used when configuring the client instance
      Returns:
      an instance of the `Vpc` client using external configuration

    • getGeneration

      public Long getGeneration()
      Gets the generation. The infrastructure generation. For the API behavior documented here, specify `2`.
      Returns:
      the generation

    • setGeneration

      public void setGeneration(long generation)
      Sets the generation.
      Parameters:
      generation - the new generation

    • getVersion

      public String getVersion()
      Gets the version. The API version, in format `YYYY-MM-DD`. For the API behavior documented here, specify any date between `2024-04-30` and `2024-11-13`.
      Returns:
      the version

    • setVersion

      public void setVersion(String version)
      Sets the version.
      Parameters:
      version - the new version

    • listVpcs

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCCollection> listVpcs(ListVpcsOptions listVpcsOptions)
      List VPCs. This request lists VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.
      Parameters:
      listVpcsOptions - the ListVpcsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCCollection

    • listVpcs

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCCollection> listVpcs()
      List VPCs. This request lists VPCs in the region. A VPC is a virtual network that belongs to an account and provides logical isolation from other networks. A VPC is made up of resources in one or more zones. VPCs are regional, and each VPC can contain resources in multiple zones in a region.
      Returns:
      a ServiceCall with a result of type VPCCollection

    • createVpc

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPC> createVpc(CreateVpcOptions createVpcOptions)
      Create a VPC. This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.
      Parameters:
      createVpcOptions - the CreateVpcOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPC

    • createVpc

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPC> createVpc()
      Create a VPC. This request creates a new VPC from a VPC prototype object. The prototype object is structured in the same way as a retrieved VPC, and contains the information necessary to create the new VPC.
      Returns:
      a ServiceCall with a result of type VPC

    • deleteVpc

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpc(DeleteVpcOptions deleteVpcOptions)
      Delete a VPC. This request deletes a VPC. This operation cannot be reversed. For this request to succeed: - Instances, subnets, public gateways, endpoint gateways, and private path service gateways must not reside in this VPC - The VPC must not be providing DNS resolution for any other VPCs - If `dns.enable_hub` is `true`, `dns.resolution_binding_count` must be zero All security groups and network ACLs associated with the VPC are automatically deleted. All flow log collectors with `auto_delete` set to `true` targeting the VPC or any resource in the VPC are automatically deleted.
      Parameters:
      deleteVpcOptions - the DeleteVpcOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpc

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPC> getVpc(GetVpcOptions getVpcOptions)
      Retrieve a VPC. This request retrieves a single VPC specified by the identifier in the URL.
      Parameters:
      getVpcOptions - the GetVpcOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPC

    • updateVpc

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPC> updateVpc(UpdateVpcOptions updateVpcOptions)
      Update a VPC. This request updates a VPC with the information provided in a VPC patch object. The patch object is structured in the same way as a retrieved VPC and needs to contain only the information to be updated.
      Parameters:
      updateVpcOptions - the UpdateVpcOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPC

    • getVpcDefaultNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<DefaultNetworkACL> getVpcDefaultNetworkAcl(GetVpcDefaultNetworkAclOptions getVpcDefaultNetworkAclOptions)
      Retrieve a VPC's default network ACL. This request retrieves the default network ACL for the VPC specified by the identifier in the URL. The default network ACL is applied to any new subnets in the VPC which do not specify a network ACL.
      Parameters:
      getVpcDefaultNetworkAclOptions - the GetVpcDefaultNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DefaultNetworkACL

    • getVpcDefaultRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<DefaultRoutingTable> getVpcDefaultRoutingTable(GetVpcDefaultRoutingTableOptions getVpcDefaultRoutingTableOptions)
      Retrieve a VPC's default routing table. This request retrieves the default routing table for the VPC specified by the identifier in the URL. The default routing table is associated with any subnets in the VPC which have not been explicitly associated with another routing table.
      Parameters:
      getVpcDefaultRoutingTableOptions - the GetVpcDefaultRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DefaultRoutingTable

    • getVpcDefaultSecurityGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<DefaultSecurityGroup> getVpcDefaultSecurityGroup(GetVpcDefaultSecurityGroupOptions getVpcDefaultSecurityGroupOptions)
      Retrieve a VPC's default security group. This request retrieves the default security group for the VPC specified by the identifier in the URL. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.
      Parameters:
      getVpcDefaultSecurityGroupOptions - the GetVpcDefaultSecurityGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DefaultSecurityGroup

    • listVpcAddressPrefixes

      public com.ibm.cloud.sdk.core.http.ServiceCall<AddressPrefixCollection> listVpcAddressPrefixes(ListVpcAddressPrefixesOptions listVpcAddressPrefixesOptions)
      List address prefixes for a VPC. This request lists address pool prefixes for a VPC.
      Parameters:
      listVpcAddressPrefixesOptions - the ListVpcAddressPrefixesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AddressPrefixCollection

    • createVpcAddressPrefix

      public com.ibm.cloud.sdk.core.http.ServiceCall<AddressPrefix> createVpcAddressPrefix(CreateVpcAddressPrefixOptions createVpcAddressPrefixOptions)
      Create an address prefix for a VPC. This request creates a new prefix from a prefix prototype object. The prototype object is structured in the same way as a retrieved prefix, and contains the information necessary to create the new prefix.
      Parameters:
      createVpcAddressPrefixOptions - the CreateVpcAddressPrefixOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AddressPrefix

    • deleteVpcAddressPrefix

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpcAddressPrefix(DeleteVpcAddressPrefixOptions deleteVpcAddressPrefixOptions)
      Delete an address prefix. This request deletes a prefix. This operation cannot be reversed. The request will fail if any subnets use addresses from this prefix.
      Parameters:
      deleteVpcAddressPrefixOptions - the DeleteVpcAddressPrefixOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpcAddressPrefix

      public com.ibm.cloud.sdk.core.http.ServiceCall<AddressPrefix> getVpcAddressPrefix(GetVpcAddressPrefixOptions getVpcAddressPrefixOptions)
      Retrieve an address prefix. This request retrieves a single prefix specified by the identifier in the URL.
      Parameters:
      getVpcAddressPrefixOptions - the GetVpcAddressPrefixOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AddressPrefix

    • updateVpcAddressPrefix

      public com.ibm.cloud.sdk.core.http.ServiceCall<AddressPrefix> updateVpcAddressPrefix(UpdateVpcAddressPrefixOptions updateVpcAddressPrefixOptions)
      Update an address prefix. This request updates a prefix with the information in a provided prefix patch. The prefix patch object is structured in the same way as a retrieved prefix and contains only the information to be updated.
      Parameters:
      updateVpcAddressPrefixOptions - the UpdateVpcAddressPrefixOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type AddressPrefix

    • listVpcDnsResolutionBindings

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCDNSResolutionBindingCollection> listVpcDnsResolutionBindings(ListVpcDnsResolutionBindingsOptions listVpcDnsResolutionBindingsOptions)
      List DNS resolution bindings for a VPC. This request lists DNS resolution bindings for a VPC. A DNS resolution binding represents an association with another VPC for centralizing DNS name resolution. If the VPC specified by the identifier in the URL is a DNS hub VPC (has `dns.enable_hub` set to `true`) then there is one binding for each VPC bound to the hub VPC. The endpoint gateways in the bound VPCs can allow (using `allow_dns_resolution_binding`) the hub VPC to centralize resolution of their DNS names. If the VPC specified by the identifier in the URL is not a DNS hub VPC, then there is at most one binding (to a hub VPC). The endpoint gateways in the VPC specified by the identifier in the URL can allow (using `allow_dns_resolution_binding`) its hub VPC to centralize resolution of their DNS names. To make use of centralized DNS resolution, a VPC bound to a DNS hub VPC must delegate DNS resolution to its hub VPC by setting `dns.resolver.type` to `delegate`. The bindings will be sorted by their `created_at` property values, with newest bindings first. Bindings with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Parameters:
      listVpcDnsResolutionBindingsOptions - the ListVpcDnsResolutionBindingsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCDNSResolutionBindingCollection

    • createVpcDnsResolutionBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCDNSResolutionBinding> createVpcDnsResolutionBinding(CreateVpcDnsResolutionBindingOptions createVpcDnsResolutionBindingOptions)
      Create a DNS resolution binding. This request creates a new DNS resolution binding from a DNS resolution binding prototype object. The prototype object is structured in the same way as a retrieved DNS resolution binding, and contains the information necessary to create the new DNS resolution binding. For this request to succeed, `dns.enable_hub` must be `false` for the VPC specified by the identifier in the URL, and the VPC must not already have a DNS resolution binding. See [About DNS sharing for VPE gateways](/docs/vpc?topic=vpc-vpe-dns-sharing) for more information.
      Parameters:
      createVpcDnsResolutionBindingOptions - the CreateVpcDnsResolutionBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCDNSResolutionBinding

    • deleteVpcDnsResolutionBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCDNSResolutionBinding> deleteVpcDnsResolutionBinding(DeleteVpcDnsResolutionBindingOptions deleteVpcDnsResolutionBindingOptions)
      Delete a DNS resolution binding. This request deletes a DNS resolution binding. This operation cannot be reversed. For this request to succeed, the VPC specified by the identifier in the URL must not have `dns.resolver.type` set to `delegated`.
      Parameters:
      deleteVpcDnsResolutionBindingOptions - the DeleteVpcDnsResolutionBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCDNSResolutionBinding

    • getVpcDnsResolutionBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCDNSResolutionBinding> getVpcDnsResolutionBinding(GetVpcDnsResolutionBindingOptions getVpcDnsResolutionBindingOptions)
      Retrieve a DNS resolution binding. This request retrieves a single DNS resolution binding specified by the identifier in the URL.
      Parameters:
      getVpcDnsResolutionBindingOptions - the GetVpcDnsResolutionBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCDNSResolutionBinding

    • updateVpcDnsResolutionBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPCDNSResolutionBinding> updateVpcDnsResolutionBinding(UpdateVpcDnsResolutionBindingOptions updateVpcDnsResolutionBindingOptions)
      Update a DNS resolution binding. This request updates a DNS resolution binding with the information in a provided DNS resolution binding patch. The DNS resolution binding patch object is structured in the same way as a retrieved DNS resolution binding and contains only the information to be updated.
      Parameters:
      updateVpcDnsResolutionBindingOptions - the UpdateVpcDnsResolutionBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPCDNSResolutionBinding

    • listVpcRoutes

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<RouteCollectionVPCContext> listVpcRoutes(ListVpcRoutesOptions listVpcRoutesOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      List routes in a VPC's default routing table. This request lists routes in the VPC's default routing table. Each route is zone-specific and directs any packets matching its destination CIDR block to a `next_hop` IP address. The most specific route matching a packet's destination will be used. If multiple equally-specific routes exist, traffic will be distributed across them.
      Parameters:
      listVpcRoutesOptions - the ListVpcRoutesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RouteCollectionVPCContext

    • createVpcRoute

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<Route> createVpcRoute(CreateVpcRouteOptions createVpcRouteOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Create a route in a VPC's default routing table. This request creates a new route in the VPC's default routing table. The route prototype object is structured in the same way as a retrieved route, and contains the information necessary to create the new route. The request will fail if the new route will cause a loop.
      Parameters:
      createVpcRouteOptions - the CreateVpcRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • deleteVpcRoute

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpcRoute(DeleteVpcRouteOptions deleteVpcRouteOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Delete a VPC route. This request deletes a route. This operation cannot be reversed.
      Parameters:
      deleteVpcRouteOptions - the DeleteVpcRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpcRoute

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<Route> getVpcRoute(GetVpcRouteOptions getVpcRouteOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Retrieve a VPC route. This request retrieves a single route specified by the identifier in the URL.
      Parameters:
      getVpcRouteOptions - the GetVpcRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • updateVpcRoute

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<Route> updateVpcRoute(UpdateVpcRouteOptions updateVpcRouteOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Update a VPC route. This request updates a route with the information in a provided route patch. The route patch object is structured in the same way as a retrieved route and contains only the information to be updated.
      Parameters:
      updateVpcRouteOptions - the UpdateVpcRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • listVpcRoutingTables

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTableCollection> listVpcRoutingTables(ListVpcRoutingTablesOptions listVpcRoutingTablesOptions)
      List routing tables for a VPC. This request lists routing tables for a VPC. Each subnet in a VPC is associated with a routing table, which controls delivery of packets sent on that subnet according to the action of the most specific matching route in the table. If multiple equally-specific routes exist, traffic will be distributed across them. If no routes match, delivery will be controlled by the system's built-in routes.
      Parameters:
      listVpcRoutingTablesOptions - the ListVpcRoutingTablesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTableCollection

    • createVpcRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTable> createVpcRoutingTable(CreateVpcRoutingTableOptions createVpcRoutingTableOptions)
      Create a routing table for a VPC. This request creates a routing table from a routing table prototype object. The prototype object is structured in the same way as a retrieved routing table, and contains the information necessary to create the new routing table. At present, the routing table's `resource_group` will be inherited from its VPC, but may be specifiable in the future.
      Parameters:
      createVpcRoutingTableOptions - the CreateVpcRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTable

    • deleteVpcRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpcRoutingTable(DeleteVpcRoutingTableOptions deleteVpcRoutingTableOptions)
      Delete a VPC routing table. This request deletes a routing table. A routing table cannot be deleted if it is associated with any subnets in the VPC. Additionally, a VPC's default routing table cannot be deleted. This operation cannot be reversed.
      Parameters:
      deleteVpcRoutingTableOptions - the DeleteVpcRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpcRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTable> getVpcRoutingTable(GetVpcRoutingTableOptions getVpcRoutingTableOptions)
      Retrieve a VPC routing table. This request retrieves a single routing table specified by the identifier in the URL.
      Parameters:
      getVpcRoutingTableOptions - the GetVpcRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTable

    • updateVpcRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTable> updateVpcRoutingTable(UpdateVpcRoutingTableOptions updateVpcRoutingTableOptions)
      Update a VPC routing table. This request updates a routing table with the information in a provided routing table patch. The patch object is structured in the same way as a retrieved table and contains only the information to be updated.
      Parameters:
      updateVpcRoutingTableOptions - the UpdateVpcRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTable

    • listVpcRoutingTableRoutes

      public com.ibm.cloud.sdk.core.http.ServiceCall<RouteCollection> listVpcRoutingTableRoutes(ListVpcRoutingTableRoutesOptions listVpcRoutingTableRoutesOptions)
      List routes in a VPC routing table. This request lists routes in a VPC routing table. If subnets are associated with this routing table, delivery of packets sent on a subnet is performed according to the action of the most specific matching route in the table (provided the subnet and route are in the same zone). If multiple equally-specific routes exist, the route with the highest priority will be used. If two matching routes have the same destination and priority, traffic will be distributed between them. If no routes match, delivery will be controlled by the system's built-in routes.
      Parameters:
      listVpcRoutingTableRoutesOptions - the ListVpcRoutingTableRoutesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RouteCollection

    • createVpcRoutingTableRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<Route> createVpcRoutingTableRoute(CreateVpcRoutingTableRouteOptions createVpcRoutingTableRouteOptions)
      Create a route in a VPC routing table. This request creates a new VPC route from a VPC route prototype object. The prototype object is structured in the same way as a retrieved VPC route and contains the information necessary to create the route.
      Parameters:
      createVpcRoutingTableRouteOptions - the CreateVpcRoutingTableRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • deleteVpcRoutingTableRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpcRoutingTableRoute(DeleteVpcRoutingTableRouteOptions deleteVpcRoutingTableRouteOptions)
      Delete a VPC routing table route. This request deletes a VPC route. This operation cannot be reversed. Only VPC routes with an `origin` of `user` are allowed to be deleted.
      Parameters:
      deleteVpcRoutingTableRouteOptions - the DeleteVpcRoutingTableRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpcRoutingTableRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<Route> getVpcRoutingTableRoute(GetVpcRoutingTableRouteOptions getVpcRoutingTableRouteOptions)
      Retrieve a VPC routing table route. This request retrieves a single VPC route specified by the identifier in the URL path.
      Parameters:
      getVpcRoutingTableRouteOptions - the GetVpcRoutingTableRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • updateVpcRoutingTableRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<Route> updateVpcRoutingTableRoute(UpdateVpcRoutingTableRouteOptions updateVpcRoutingTableRouteOptions)
      Update a VPC routing table route. This request updates a VPC route with the information provided in a route patch object. The patch object is structured in the same way as a retrieved VPC route and needs to contain only the information to be updated. Only VPC routes with an `origin` of `user` are allowed to be updated.
      Parameters:
      updateVpcRoutingTableRouteOptions - the UpdateVpcRoutingTableRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Route

    • listSubnets

      public com.ibm.cloud.sdk.core.http.ServiceCall<SubnetCollection> listSubnets(ListSubnetsOptions listSubnetsOptions)
      List subnets. This request lists subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.
      Parameters:
      listSubnetsOptions - the ListSubnetsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SubnetCollection

    • listSubnets

      public com.ibm.cloud.sdk.core.http.ServiceCall<SubnetCollection> listSubnets()
      List subnets. This request lists subnets in the region. Subnets are contiguous ranges of IP addresses specified in CIDR block notation. Each subnet is within a particular zone and cannot span multiple zones or regions.
      Returns:
      a ServiceCall with a result of type SubnetCollection

    • createSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<Subnet> createSubnet(CreateSubnetOptions createSubnetOptions)
      Create a subnet. This request creates a new subnet from a subnet prototype object. The prototype object is structured in the same way as a retrieved subnet, and contains the information necessary to create the new subnet. For this request to succeed, the prototype's CIDR block must not overlap with an existing subnet in the VPC.
      Parameters:
      createSubnetOptions - the CreateSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Subnet

    • deleteSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSubnet(DeleteSubnetOptions deleteSubnetOptions)
      Delete a subnet. This request deletes a subnet. This operation cannot be reversed. For this request to succeed, the subnet must not be referenced by any bare metal server network interfaces, instance network interfaces, virtual network interfaces, VPN gateways, or load balancers. A delete operation automatically detaches the subnet from any network ACLs, public gateways, or endpoint gateways. All flow log collectors with `auto_delete` set to `true` targeting the subnet or any resource in the subnet are automatically deleted.
      Parameters:
      deleteSubnetOptions - the DeleteSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<Subnet> getSubnet(GetSubnetOptions getSubnetOptions)
      Retrieve a subnet. This request retrieves a single subnet specified by the identifier in the URL.
      Parameters:
      getSubnetOptions - the GetSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Subnet

    • updateSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<Subnet> updateSubnet(UpdateSubnetOptions updateSubnetOptions)
      Update a subnet. This request updates a subnet with the information in a provided subnet patch. The subnet patch object is structured in the same way as a retrieved subnet and contains only the information to be updated.
      Parameters:
      updateSubnetOptions - the UpdateSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Subnet

    • getSubnetNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACL> getSubnetNetworkAcl(GetSubnetNetworkAclOptions getSubnetNetworkAclOptions)
      Retrieve a subnet's attached network ACL. This request retrieves the network ACL attached to the subnet specified by the identifier in the URL.
      Parameters:
      getSubnetNetworkAclOptions - the GetSubnetNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACL

    • replaceSubnetNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACL> replaceSubnetNetworkAcl(ReplaceSubnetNetworkAclOptions replaceSubnetNetworkAclOptions)
      Replace the network ACL for a subnet. This request replaces the existing network ACL for a subnet with the network ACL specified in the request body.
      Parameters:
      replaceSubnetNetworkAclOptions - the ReplaceSubnetNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACL

    • unsetSubnetPublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> unsetSubnetPublicGateway(UnsetSubnetPublicGatewayOptions unsetSubnetPublicGatewayOptions)
      Detach a public gateway from a subnet. This request detaches the public gateway from the subnet specified by the subnet identifier in the URL.
      Parameters:
      unsetSubnetPublicGatewayOptions - the UnsetSubnetPublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSubnetPublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGateway> getSubnetPublicGateway(GetSubnetPublicGatewayOptions getSubnetPublicGatewayOptions)
      Retrieve a subnet's attached public gateway. This request retrieves the public gateway attached to the subnet specified by the identifier in the URL.
      Parameters:
      getSubnetPublicGatewayOptions - the GetSubnetPublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGateway

    • setSubnetPublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGateway> setSubnetPublicGateway(SetSubnetPublicGatewayOptions setSubnetPublicGatewayOptions)
      Attach a public gateway to a subnet. This request attaches the public gateway, specified in the request body, to the subnet specified by the subnet identifier in the URL. The public gateway must have the same VPC and zone as the subnet.
      Parameters:
      setSubnetPublicGatewayOptions - the SetSubnetPublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGateway

    • getSubnetRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTable> getSubnetRoutingTable(GetSubnetRoutingTableOptions getSubnetRoutingTableOptions)
      Retrieve a subnet's attached routing table. This request retrieves the routing table attached to the subnet specified by the identifier in the URL.
      Parameters:
      getSubnetRoutingTableOptions - the GetSubnetRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTable

    • replaceSubnetRoutingTable

      public com.ibm.cloud.sdk.core.http.ServiceCall<RoutingTable> replaceSubnetRoutingTable(ReplaceSubnetRoutingTableOptions replaceSubnetRoutingTableOptions)
      Replace the routing table for a subnet. This request replaces the existing routing table for a subnet with the routing table specified in the request body. For this request to succeed, the routing table `route_direct_link_ingress`, `route_internet_ingress`, `route_transit_gateway_ingress`, and `route_vpc_zone_ingress` properties must be `false`.
      Parameters:
      replaceSubnetRoutingTableOptions - the ReplaceSubnetRoutingTableOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RoutingTable

    • listSubnetReservedIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPCollection> listSubnetReservedIps(ListSubnetReservedIpsOptions listSubnetReservedIpsOptions)
      List reserved IPs in a subnet. This request lists reserved IPs in a subnet. A reserved IP resource will exist for every address in the subnet which is not available for use.
      Parameters:
      listSubnetReservedIpsOptions - the ListSubnetReservedIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPCollection

    • createSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> createSubnetReservedIp(CreateSubnetReservedIpOptions createSubnetReservedIpOptions)
      Reserve an IP in a subnet. This request reserves an IP address in a subnet. If the provided prototype object includes an `address`, the address must not already be reserved.
      Parameters:
      createSubnetReservedIpOptions - the CreateSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • deleteSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSubnetReservedIp(DeleteSubnetReservedIpOptions deleteSubnetReservedIpOptions)
      Delete a reserved IP. This request releases a reserved IP. This operation cannot be reversed. For this request to succeed, the reserved IP must not be required by another resource, such as a bare metal server network interface, instance network interface or virtual network interface for which it is the primary IP. A provider-owned reserved IP is not allowed to be deleted.
      Parameters:
      deleteSubnetReservedIpOptions - the DeleteSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> getSubnetReservedIp(GetSubnetReservedIpOptions getSubnetReservedIpOptions)
      Retrieve a reserved IP. This request retrieves a single reserved IP specified by the identifier in the URL.
      Parameters:
      getSubnetReservedIpOptions - the GetSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • updateSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> updateSubnetReservedIp(UpdateSubnetReservedIpOptions updateSubnetReservedIpOptions)
      Update a reserved IP. This request updates a reserved IP with the information in a provided reserved IP patch. The reserved IP patch object is structured in the same way as a retrieved reserved IP and contains only the information to be updated. A provider-owned reserved IP is not allowed to be updated.
      Parameters:
      updateSubnetReservedIpOptions - the UpdateSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • listImages

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageCollection> listImages(ListImagesOptions listImagesOptions)
      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.
      Parameters:
      listImagesOptions - the ListImagesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ImageCollection

    • listImages

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageCollection> listImages()
      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.
      Returns:
      a ServiceCall with a result of type ImageCollection

    • createImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Image> createImage(CreateImageOptions createImageOptions)
      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.
      Parameters:
      createImageOptions - the CreateImageOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Image

    • deleteImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteImage(DeleteImageOptions deleteImageOptions)
      Delete an image. This request deletes an image. Any active image export jobs will be completed first. This operation cannot be reversed. A system-provided image 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`.
      Parameters:
      deleteImageOptions - the DeleteImageOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Image> getImage(GetImageOptions getImageOptions)
      Retrieve an image. This request retrieves a single image specified by the identifier in the URL.
      Parameters:
      getImageOptions - the GetImageOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Image

    • updateImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Image> updateImage(UpdateImageOptions updateImageOptions)
      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. A system-provided image is not allowed to be updated. An image with a `status` of `deleting` cannot be updated.
      Parameters:
      updateImageOptions - the UpdateImageOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Image

    • deprecateImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deprecateImage(DeprecateImageOptions deprecateImageOptions)
      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 The image must not have `deprecation_at` set, must have `catalog_offering.managed` set to `false`, and must have a `status` of `available`. A system-provided image is not allowed to be deprecated.
      Parameters:
      deprecateImageOptions - the DeprecateImageOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • obsoleteImage

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> obsoleteImage(ObsoleteImageOptions obsoleteImageOptions)
      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 A system-provided image is not allowed to be obsoleted.
      Parameters:
      obsoleteImageOptions - the ObsoleteImageOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listImageExportJobs

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageExportJobUnpaginatedCollection> listImageExportJobs(ListImageExportJobsOptions listImageExportJobsOptions)
      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.
      Parameters:
      listImageExportJobsOptions - the ListImageExportJobsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ImageExportJobUnpaginatedCollection

    • createImageExportJob

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageExportJob> createImageExportJob(CreateImageExportJobOptions createImageExportJobOptions)
      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.
      Parameters:
      createImageExportJobOptions - the CreateImageExportJobOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ImageExportJob

    • deleteImageExportJob

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteImageExportJob(DeleteImageExportJobOptions deleteImageExportJobOptions)
      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.
      Parameters:
      deleteImageExportJobOptions - the DeleteImageExportJobOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getImageExportJob

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageExportJob> getImageExportJob(GetImageExportJobOptions getImageExportJobOptions)
      Retrieve an image export job. This request retrieves a single image export job specified by the identifier in the URL.
      Parameters:
      getImageExportJobOptions - the GetImageExportJobOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ImageExportJob

    • updateImageExportJob

      public com.ibm.cloud.sdk.core.http.ServiceCall<ImageExportJob> updateImageExportJob(UpdateImageExportJobOptions updateImageExportJobOptions)
      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.
      Parameters:
      updateImageExportJobOptions - the UpdateImageExportJobOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ImageExportJob

    • listOperatingSystems

      public com.ibm.cloud.sdk.core.http.ServiceCall<OperatingSystemCollection> listOperatingSystems(ListOperatingSystemsOptions listOperatingSystemsOptions)
      List operating systems. This request lists operating systems in the region.
      Parameters:
      listOperatingSystemsOptions - the ListOperatingSystemsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type OperatingSystemCollection

    • listOperatingSystems

      public com.ibm.cloud.sdk.core.http.ServiceCall<OperatingSystemCollection> listOperatingSystems()
      List operating systems. This request lists operating systems in the region.
      Returns:
      a ServiceCall with a result of type OperatingSystemCollection

    • getOperatingSystem

      public com.ibm.cloud.sdk.core.http.ServiceCall<OperatingSystem> getOperatingSystem(GetOperatingSystemOptions getOperatingSystemOptions)
      Retrieve an operating system. This request retrieves a single operating system specified by the name in the URL.
      Parameters:
      getOperatingSystemOptions - the GetOperatingSystemOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type OperatingSystem

    • listKeys

      public com.ibm.cloud.sdk.core.http.ServiceCall<KeyCollection> listKeys(ListKeysOptions listKeysOptions)
      List keys. This request lists keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.
      Parameters:
      listKeysOptions - the ListKeysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type KeyCollection

    • listKeys

      public com.ibm.cloud.sdk.core.http.ServiceCall<KeyCollection> listKeys()
      List keys. This request lists keys in the region. A key contains a public SSH key which may be installed on instances when they are created. Private keys are not stored.
      Returns:
      a ServiceCall with a result of type KeyCollection

    • createKey

      public com.ibm.cloud.sdk.core.http.ServiceCall<Key> createKey(CreateKeyOptions createKeyOptions)
      Create a key. This request creates a new SSH key from an key prototype object. The prototype object is structured in the same way as a retrieved key, and contains the information necessary to create the new key. The public key value must be provided.
      Parameters:
      createKeyOptions - the CreateKeyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Key

    • deleteKey

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteKey(DeleteKeyOptions deleteKeyOptions)
      Delete a key. This request deletes a key. This operation cannot be reversed.
      Parameters:
      deleteKeyOptions - the DeleteKeyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getKey

      public com.ibm.cloud.sdk.core.http.ServiceCall<Key> getKey(GetKeyOptions getKeyOptions)
      Retrieve a key. This request retrieves a single key specified by the identifier in the URL.
      Parameters:
      getKeyOptions - the GetKeyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Key

    • updateKey

      public com.ibm.cloud.sdk.core.http.ServiceCall<Key> updateKey(UpdateKeyOptions updateKeyOptions)
      Update a key. This request updates a key's name.
      Parameters:
      updateKeyOptions - the UpdateKeyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Key

    • listInstanceProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceProfileCollection> listInstanceProfiles(ListInstanceProfilesOptions listInstanceProfilesOptions)
      List instance profiles. This request lists provisionable [instance profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) in the region. An instance profile specifies the performance characteristics and pricing model for an instance.
      Parameters:
      listInstanceProfilesOptions - the ListInstanceProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceProfileCollection

    • listInstanceProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceProfileCollection> listInstanceProfiles()
      List instance profiles. This request lists provisionable [instance profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles) in the region. An instance profile specifies the performance characteristics and pricing model for an instance.
      Returns:
      a ServiceCall with a result of type InstanceProfileCollection

    • getInstanceProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceProfile> getInstanceProfile(GetInstanceProfileOptions getInstanceProfileOptions)
      Retrieve an instance profile. This request retrieves a single instance profile specified by the name in the URL.
      Parameters:
      getInstanceProfileOptions - the GetInstanceProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceProfile

    • listInstanceTemplates

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceTemplateCollection> listInstanceTemplates(ListInstanceTemplatesOptions listInstanceTemplatesOptions)
      List instance templates. This request lists instance templates in the region.
      Parameters:
      listInstanceTemplatesOptions - the ListInstanceTemplatesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceTemplateCollection

    • listInstanceTemplates

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceTemplateCollection> listInstanceTemplates()
      List instance templates. This request lists instance templates in the region.
      Returns:
      a ServiceCall with a result of type InstanceTemplateCollection

    • createInstanceTemplate

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceTemplate> createInstanceTemplate(CreateInstanceTemplateOptions createInstanceTemplateOptions)
      Create an instance template. This request creates a new instance template. The prototype object is structured in the same way as a retrieved instance template, and contains the information necessary to provision a new instance from the template. If a `source_template` is specified in the prototype object, its contents are copied into the new template prior to copying any other properties provided in the prototype object.
      Parameters:
      createInstanceTemplateOptions - the CreateInstanceTemplateOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceTemplate

    • deleteInstanceTemplate

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceTemplate(DeleteInstanceTemplateOptions deleteInstanceTemplateOptions)
      Delete an instance template. This request deletes the instance template. This operation cannot be reversed.
      Parameters:
      deleteInstanceTemplateOptions - the DeleteInstanceTemplateOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceTemplate

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceTemplate> getInstanceTemplate(GetInstanceTemplateOptions getInstanceTemplateOptions)
      Retrieve an instance template. This request retrieves a single instance template specified by the identifier in the URL.
      Parameters:
      getInstanceTemplateOptions - the GetInstanceTemplateOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceTemplate

    • updateInstanceTemplate

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceTemplate> updateInstanceTemplate(UpdateInstanceTemplateOptions updateInstanceTemplateOptions)
      Update an instance template. This request updates an instance template with the information provided in the instance template patch. The instance template patch object is structured in the same way as a retrieved instance template and contains only the information to be updated.
      Parameters:
      updateInstanceTemplateOptions - the UpdateInstanceTemplateOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceTemplate

    • listInstances

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceCollection> listInstances(ListInstancesOptions listInstancesOptions)
      List instances. This request lists instances in the region.
      Parameters:
      listInstancesOptions - the ListInstancesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceCollection

    • listInstances

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceCollection> listInstances()
      List instances. This request lists instances in the region.
      Returns:
      a ServiceCall with a result of type InstanceCollection

    • createInstance

      public com.ibm.cloud.sdk.core.http.ServiceCall<Instance> createInstance(CreateInstanceOptions createInstanceOptions)
      Create an instance. This request provisions a new instance from an instance prototype object. The prototype object is structured in the same way as a retrieved instance, and contains the information necessary to provision the new instance. The instance is automatically started.
      Parameters:
      createInstanceOptions - the CreateInstanceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Instance

    • deleteInstance

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstance(DeleteInstanceOptions deleteInstanceOptions)
      Delete an instance. This request deletes an instance. This operation cannot be reversed. Any floating IPs associated with instance network interfaces are implicitly disassociated. All virtual network interfaces with `auto_delete` set to `true` targeting instance network attachments on the instance are automatically deleted. All flow log collectors with `auto_delete` set to `true` targeting the instance, the instance network attachments, the instance network interfaces, or the automatically deleted virtual network interfaces are automatically deleted.
      Parameters:
      deleteInstanceOptions - the DeleteInstanceOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstance

      public com.ibm.cloud.sdk.core.http.ServiceCall<Instance> getInstance(GetInstanceOptions getInstanceOptions)
      Retrieve an instance. This request retrieves a single instance specified by the identifier in the URL.
      Parameters:
      getInstanceOptions - the GetInstanceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Instance

    • updateInstance

      public com.ibm.cloud.sdk.core.http.ServiceCall<Instance> updateInstance(UpdateInstanceOptions updateInstanceOptions)
      Update an instance. This request updates an instance with the information in a provided instance patch. The instance patch object is structured in the same way as a retrieved instance and contains only the information to be updated.
      Parameters:
      updateInstanceOptions - the UpdateInstanceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Instance

    • getInstanceInitialization

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceInitialization> getInstanceInitialization(GetInstanceInitializationOptions getInstanceInitializationOptions)
      Retrieve initialization configuration for an instance. This request retrieves configuration used to initialize the instance, such as SSH keys and the Windows administrator password. These can subsequently be changed on the instance and therefore may not be current.
      Parameters:
      getInstanceInitializationOptions - the GetInstanceInitializationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceInitialization

    • createInstanceAction

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceAction> createInstanceAction(CreateInstanceActionOptions createInstanceActionOptions)
      Create an instance action. This request creates a new action which will be queued up to run as soon as any pending or running actions have completed.
      Parameters:
      createInstanceActionOptions - the CreateInstanceActionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceAction

    • listInstanceClusterNetworkAttachments

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceClusterNetworkAttachmentCollection> listInstanceClusterNetworkAttachments(ListInstanceClusterNetworkAttachmentsOptions listInstanceClusterNetworkAttachmentsOptions)
      List cluster network attachments on an instance. This request lists cluster network attachments on an instance. A cluster network attachment represents a device on the instance to which a cluster network interface is attached.
      Parameters:
      listInstanceClusterNetworkAttachmentsOptions - the ListInstanceClusterNetworkAttachmentsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceClusterNetworkAttachmentCollection

    • createClusterNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceClusterNetworkAttachment> createClusterNetworkAttachment(CreateClusterNetworkAttachmentOptions createClusterNetworkAttachmentOptions)
      Create a cluster network attachment. This request creates a cluster network attachment from an instance cluster network attachment prototype object. A cluster network attachment will attach the instance to a cluster network. The cluster network attachment prototype must specify a cluster network interface identity or a cluster network interface prototype. The instance must be in a `stopped` or `stopping` state to create an instance cluster network attachment.
      Parameters:
      createClusterNetworkAttachmentOptions - the CreateClusterNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceClusterNetworkAttachment

    • deleteInstanceClusterNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceClusterNetworkAttachment> deleteInstanceClusterNetworkAttachment(DeleteInstanceClusterNetworkAttachmentOptions deleteInstanceClusterNetworkAttachmentOptions)
      Delete an instance cluster network attachment. This request deletes an instance cluster network attachment. The instance must be in a `stopped` or `stopping` state to delete an instance cluster network attachment. This operation cannot be reversed.
      Parameters:
      deleteInstanceClusterNetworkAttachmentOptions - the DeleteInstanceClusterNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceClusterNetworkAttachment

    • getInstanceClusterNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceClusterNetworkAttachment> getInstanceClusterNetworkAttachment(GetInstanceClusterNetworkAttachmentOptions getInstanceClusterNetworkAttachmentOptions)
      Retrieve an instance cluster network attachment. This request retrieves a single instance cluster network attachment specified by the identifier in the URL.
      Parameters:
      getInstanceClusterNetworkAttachmentOptions - the GetInstanceClusterNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceClusterNetworkAttachment

    • updateInstanceClusterNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceClusterNetworkAttachment> updateInstanceClusterNetworkAttachment(UpdateInstanceClusterNetworkAttachmentOptions updateInstanceClusterNetworkAttachmentOptions)
      Update an instance cluster network attachment. This request updates an instance cluster network attachment with the information provided in an instance network interface patch object. The instance cluster network attachment patch object is structured in the same way as a retrieved instance cluster network attachment and needs to contain only the information to be updated.
      Parameters:
      updateInstanceClusterNetworkAttachmentOptions - the UpdateInstanceClusterNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceClusterNetworkAttachment

    • createInstanceConsoleAccessToken

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceConsoleAccessToken> createInstanceConsoleAccessToken(CreateInstanceConsoleAccessTokenOptions createInstanceConsoleAccessTokenOptions)
      Create a console access token for an instance. This request creates a new single-use console access token for an instance. 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 instance at a time.
      Parameters:
      createInstanceConsoleAccessTokenOptions - the CreateInstanceConsoleAccessTokenOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceConsoleAccessToken

    • listInstanceDisks

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceDiskCollection> listInstanceDisks(ListInstanceDisksOptions listInstanceDisksOptions)
      List disks on an instance. This request lists disks on an instance. A disk is a block device that is locally attached to the instance's physical host and is also referred to as instance storage. By default, the listed disks are sorted by their `created_at` property values, with the newest disk first.
      Parameters:
      listInstanceDisksOptions - the ListInstanceDisksOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceDiskCollection

    • getInstanceDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceDisk> getInstanceDisk(GetInstanceDiskOptions getInstanceDiskOptions)
      Retrieve an instance disk. This request retrieves a single instance disk specified by the identifier in the URL.
      Parameters:
      getInstanceDiskOptions - the GetInstanceDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceDisk

    • updateInstanceDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceDisk> updateInstanceDisk(UpdateInstanceDiskOptions updateInstanceDiskOptions)
      Update an instance disk. This request updates the instance disk with the information in a provided patch.
      Parameters:
      updateInstanceDiskOptions - the UpdateInstanceDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceDisk

    • listInstanceNetworkAttachments

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceNetworkAttachmentCollection> listInstanceNetworkAttachments(ListInstanceNetworkAttachmentsOptions listInstanceNetworkAttachmentsOptions)
      List network attachments on an instance. This request lists network attachments on an instance. A network attachment represents a device on the instance to which a virtual network interface is attached. 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.
      Parameters:
      listInstanceNetworkAttachmentsOptions - the ListInstanceNetworkAttachmentsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceNetworkAttachmentCollection

    • createInstanceNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceNetworkAttachment> createInstanceNetworkAttachment(CreateInstanceNetworkAttachmentOptions createInstanceNetworkAttachmentOptions)
      Create a network attachment on an instance. This request creates a new instance network attachment from an instance network attachment prototype object. The prototype object is structured in the same way as a retrieved instance network attachment, and contains the information necessary to create the new instance network attachment.
      Parameters:
      createInstanceNetworkAttachmentOptions - the CreateInstanceNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceNetworkAttachment

    • deleteInstanceNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceNetworkAttachment(DeleteInstanceNetworkAttachmentOptions deleteInstanceNetworkAttachmentOptions)
      Delete an instance network attachment. This request deletes an instance network attachment. This operation cannot be reversed. Any floating IPs associated with the instance network attachment are implicitly disassociated. All flow log collectors with `auto_delete` set to `true` targeting the instance network attachment are automatically deleted. The primary instance network attachment is not allowed to be deleted.
      Parameters:
      deleteInstanceNetworkAttachmentOptions - the DeleteInstanceNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceNetworkAttachment> getInstanceNetworkAttachment(GetInstanceNetworkAttachmentOptions getInstanceNetworkAttachmentOptions)
      Retrieve an instance network attachment. This request retrieves a single instance network attachment specified by the identifier in the URL.
      Parameters:
      getInstanceNetworkAttachmentOptions - the GetInstanceNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceNetworkAttachment

    • updateInstanceNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceNetworkAttachment> updateInstanceNetworkAttachment(UpdateInstanceNetworkAttachmentOptions updateInstanceNetworkAttachmentOptions)
      Update an instance network attachment. This request updates an instance network attachment with the information provided in an instance network interface patch object. The instance network attachment patch object is structured in the same way as a retrieved instance network attachment and needs to contain only the information to be updated.
      Parameters:
      updateInstanceNetworkAttachmentOptions - the UpdateInstanceNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceNetworkAttachment

    • listInstanceNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkInterfaceUnpaginatedCollection> listInstanceNetworkInterfaces(ListInstanceNetworkInterfacesOptions listInstanceNetworkInterfacesOptions)
      List network interfaces on an instance. This request lists network interfaces on an instance. An instance network interface is an abstract representation of a network device and attaches an instance to a single subnet. Each network interface on an instance can attach to any subnet in the zone, including subnets that are already attached to the instance. Multiple network interfaces on the instance may also attach to the same subnet. If this instance 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.
      Parameters:
      listInstanceNetworkInterfacesOptions - the ListInstanceNetworkInterfacesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkInterfaceUnpaginatedCollection

    • createInstanceNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkInterface> createInstanceNetworkInterface(CreateInstanceNetworkInterfaceOptions createInstanceNetworkInterfaceOptions)
      Create a network interface on an instance. This request creates a new instance network interface from an instance network interface prototype object. The prototype object is structured in the same way as a retrieved instance network interface, and contains the information necessary to create the new instance network interface. Any subnet in the instance's VPC may be specified. Addresses on the instance network interface must be within the specified subnet's CIDR blocks. If this instance 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.
      Parameters:
      createInstanceNetworkInterfaceOptions - the CreateInstanceNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkInterface

    • deleteInstanceNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceNetworkInterface(DeleteInstanceNetworkInterfaceOptions deleteInstanceNetworkInterfaceOptions)
      Delete an instance network interface. This request deletes an instance network interface. This operation cannot be reversed. Any floating IPs associated with the instance network interface are implicitly disassociated. All flow log collectors with `auto_delete` set to `true` targeting the instance network interface are automatically deleted. The primary instance network interface is not allowed to be deleted. If this instance 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.
      Parameters:
      deleteInstanceNetworkInterfaceOptions - the DeleteInstanceNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkInterface> getInstanceNetworkInterface(GetInstanceNetworkInterfaceOptions getInstanceNetworkInterfaceOptions)
      Retrieve an instance network interface. This request retrieves a single instance network interface specified by the identifier in the URL. If this instance 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.
      Parameters:
      getInstanceNetworkInterfaceOptions - the GetInstanceNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkInterface

    • updateInstanceNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkInterface> updateInstanceNetworkInterface(UpdateInstanceNetworkInterfaceOptions updateInstanceNetworkInterfaceOptions)
      Update an instance network interface. This request updates an instance network interface with the information provided in an instance network interface patch object. The instance network interface patch object is structured in the same way as a retrieved instance network interface and needs to contain only the information to be updated. If this instance 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.
      Parameters:
      updateInstanceNetworkInterfaceOptions - the UpdateInstanceNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkInterface

    • listInstanceNetworkInterfaceFloatingIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPUnpaginatedCollection> listInstanceNetworkInterfaceFloatingIps(ListInstanceNetworkInterfaceFloatingIpsOptions listInstanceNetworkInterfaceFloatingIpsOptions)
      List floating IPs associated with an instance network interface. This request lists floating IPs associated with an instance network interface.
      Parameters:
      listInstanceNetworkInterfaceFloatingIpsOptions - the ListInstanceNetworkInterfaceFloatingIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPUnpaginatedCollection

    • removeInstanceNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeInstanceNetworkInterfaceFloatingIp(RemoveInstanceNetworkInterfaceFloatingIpOptions removeInstanceNetworkInterfaceFloatingIpOptions)
      Disassociate a floating IP from an instance network interface. This request disassociates the specified floating IP from the specified instance network interface.
      Parameters:
      removeInstanceNetworkInterfaceFloatingIpOptions - the RemoveInstanceNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> getInstanceNetworkInterfaceFloatingIp(GetInstanceNetworkInterfaceFloatingIpOptions getInstanceNetworkInterfaceFloatingIpOptions)
      Retrieve associated floating IP. This request retrieves a specified floating IP address if it is associated with the instance network interface and instance specified in the URL.
      Parameters:
      getInstanceNetworkInterfaceFloatingIpOptions - the GetInstanceNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • addInstanceNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> addInstanceNetworkInterfaceFloatingIp(AddInstanceNetworkInterfaceFloatingIpOptions addInstanceNetworkInterfaceFloatingIpOptions)
      Associate a floating IP with an instance network interface. This request associates the specified floating IP with the specified instance network interface, replacing 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 instance A request body is not required, and if provided, is ignored.
      Parameters:
      addInstanceNetworkInterfaceFloatingIpOptions - the AddInstanceNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • listInstanceNetworkInterfaceIps

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPCollectionInstanceNetworkInterfaceContext> listInstanceNetworkInterfaceIps(ListInstanceNetworkInterfaceIpsOptions listInstanceNetworkInterfaceIpsOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      List the primary reserved IP for an instance network interface. This request lists the primary reserved IP for an instance network interface.
      Parameters:
      listInstanceNetworkInterfaceIpsOptions - the ListInstanceNetworkInterfaceIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPCollectionInstanceNetworkInterfaceContext

    • getInstanceNetworkInterfaceIp

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> getInstanceNetworkInterfaceIp(GetInstanceNetworkInterfaceIpOptions getInstanceNetworkInterfaceIpOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Retrieve the primary reserved IP. This request retrieves the primary reserved IP for an instance network interface.
      Parameters:
      getInstanceNetworkInterfaceIpOptions - the GetInstanceNetworkInterfaceIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • listInstanceVolumeAttachments

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeAttachmentCollection> listInstanceVolumeAttachments(ListInstanceVolumeAttachmentsOptions listInstanceVolumeAttachmentsOptions)
      List volumes attachments on an instance. This request lists volume attachments on an instance. A volume attachment connects a volume to an instance. Each instance may have many volume attachments but each volume attachment connects exactly one instance to exactly one volume.
      Parameters:
      listInstanceVolumeAttachmentsOptions - the ListInstanceVolumeAttachmentsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeAttachmentCollection

    • createInstanceVolumeAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeAttachment> createInstanceVolumeAttachment(CreateInstanceVolumeAttachmentOptions createInstanceVolumeAttachmentOptions)
      Create a volume attachment on an instance. This request creates a new volume attachment from a volume attachment prototype object, connecting a volume to an instance. For this request to succeed, the specified volume must not be busy. The prototype object is structured in the same way as a retrieved volume attachment, and contains the information necessary to create the new volume attachment.
      Parameters:
      createInstanceVolumeAttachmentOptions - the CreateInstanceVolumeAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeAttachment

    • deleteInstanceVolumeAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceVolumeAttachment(DeleteInstanceVolumeAttachmentOptions deleteInstanceVolumeAttachmentOptions)
      Delete a volume attachment. This request deletes a volume attachment. This operation cannot be reversed, but a new volume attachment may subsequently be created for the volume. For this request to succeed, the volume must not be busy.
      Parameters:
      deleteInstanceVolumeAttachmentOptions - the DeleteInstanceVolumeAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceVolumeAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeAttachment> getInstanceVolumeAttachment(GetInstanceVolumeAttachmentOptions getInstanceVolumeAttachmentOptions)
      Retrieve a volume attachment. This request retrieves a single volume attachment specified by the identifier in the URL.
      Parameters:
      getInstanceVolumeAttachmentOptions - the GetInstanceVolumeAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeAttachment

    • updateInstanceVolumeAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeAttachment> updateInstanceVolumeAttachment(UpdateInstanceVolumeAttachmentOptions updateInstanceVolumeAttachmentOptions)
      Update a volume attachment. This request updates a volume attachment with the information provided in a volume attachment patch object. The volume attachment patch object is structured in the same way as a retrieved volume attachment and needs to contain only the information to be updated.
      Parameters:
      updateInstanceVolumeAttachmentOptions - the UpdateInstanceVolumeAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeAttachment

    • listInstanceGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupCollection> listInstanceGroups(ListInstanceGroupsOptions listInstanceGroupsOptions)
      List instance groups. This request lists instance groups in the region.
      Parameters:
      listInstanceGroupsOptions - the ListInstanceGroupsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupCollection

    • listInstanceGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupCollection> listInstanceGroups()
      List instance groups. This request lists instance groups in the region.
      Returns:
      a ServiceCall with a result of type InstanceGroupCollection

    • createInstanceGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroup> createInstanceGroup(CreateInstanceGroupOptions createInstanceGroupOptions)
      Create an instance group. This request creates a new instance group.
      Parameters:
      createInstanceGroupOptions - the CreateInstanceGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroup

    • deleteInstanceGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroup(DeleteInstanceGroupOptions deleteInstanceGroupOptions)
      Delete an instance group. This request deletes an instance group. This operation cannot be reversed. Any instances associated with the group will be deleted.
      Parameters:
      deleteInstanceGroupOptions - the DeleteInstanceGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroup> getInstanceGroup(GetInstanceGroupOptions getInstanceGroupOptions)
      Retrieve an instance group. This request retrieves a single instance group specified by identifier in the URL.
      Parameters:
      getInstanceGroupOptions - the GetInstanceGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroup

    • updateInstanceGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroup> updateInstanceGroup(UpdateInstanceGroupOptions updateInstanceGroupOptions)
      Update an instance group. This request updates an instance group with the information provided instance group patch. The instance group patch object is structured in the same way as a retrieved instance group and contains only the information to be updated.
      Parameters:
      updateInstanceGroupOptions - the UpdateInstanceGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroup

    • deleteInstanceGroupLoadBalancer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupLoadBalancer(DeleteInstanceGroupLoadBalancerOptions deleteInstanceGroupLoadBalancerOptions)
      Delete an instance group load balancer. This request unbinds the instance group from the load balancer pool, and deletes the load balancer pool members.
      Parameters:
      deleteInstanceGroupLoadBalancerOptions - the DeleteInstanceGroupLoadBalancerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listInstanceGroupManagers

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerCollection> listInstanceGroupManagers(ListInstanceGroupManagersOptions listInstanceGroupManagersOptions)
      List managers for an instance group. This request lists managers for an instance group.
      Parameters:
      listInstanceGroupManagersOptions - the ListInstanceGroupManagersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerCollection

    • createInstanceGroupManager

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManager> createInstanceGroupManager(CreateInstanceGroupManagerOptions createInstanceGroupManagerOptions)
      Create a manager for an instance group. This request creates a new instance group manager.
      Parameters:
      createInstanceGroupManagerOptions - the CreateInstanceGroupManagerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManager

    • deleteInstanceGroupManager

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupManager(DeleteInstanceGroupManagerOptions deleteInstanceGroupManagerOptions)
      Delete an instance group manager. This request deletes an instance group manager. This operation cannot be reversed.
      Parameters:
      deleteInstanceGroupManagerOptions - the DeleteInstanceGroupManagerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceGroupManager

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManager> getInstanceGroupManager(GetInstanceGroupManagerOptions getInstanceGroupManagerOptions)
      Retrieve an instance group manager. This request retrieves a single instance group manager specified by identifier in the URL.
      Parameters:
      getInstanceGroupManagerOptions - the GetInstanceGroupManagerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManager

    • updateInstanceGroupManager

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManager> updateInstanceGroupManager(UpdateInstanceGroupManagerOptions updateInstanceGroupManagerOptions)
      Update an instance group manager. This request updates an instance group manager with the information provided instance group manager patch.
      Parameters:
      updateInstanceGroupManagerOptions - the UpdateInstanceGroupManagerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManager

    • listInstanceGroupManagerActions

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerActionsCollection> listInstanceGroupManagerActions(ListInstanceGroupManagerActionsOptions listInstanceGroupManagerActionsOptions)
      List actions for an instance group manager. This request lists instance group actions for an instance group manager.
      Parameters:
      listInstanceGroupManagerActionsOptions - the ListInstanceGroupManagerActionsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerActionsCollection

    • createInstanceGroupManagerAction

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerAction> createInstanceGroupManagerAction(CreateInstanceGroupManagerActionOptions createInstanceGroupManagerActionOptions)
      Create an instance group manager action. This request creates a new instance group manager action.
      Parameters:
      createInstanceGroupManagerActionOptions - the CreateInstanceGroupManagerActionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerAction

    • deleteInstanceGroupManagerAction

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupManagerAction(DeleteInstanceGroupManagerActionOptions deleteInstanceGroupManagerActionOptions)
      Delete specified instance group manager action. This request deletes an instance group manager action. This operation cannot be reversed.
      Parameters:
      deleteInstanceGroupManagerActionOptions - the DeleteInstanceGroupManagerActionOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceGroupManagerAction

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerAction> getInstanceGroupManagerAction(GetInstanceGroupManagerActionOptions getInstanceGroupManagerActionOptions)
      Retrieve specified instance group manager action. This request retrieves a single instance group manager action specified by identifier in the URL.
      Parameters:
      getInstanceGroupManagerActionOptions - the GetInstanceGroupManagerActionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerAction

    • updateInstanceGroupManagerAction

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerAction> updateInstanceGroupManagerAction(UpdateInstanceGroupManagerActionOptions updateInstanceGroupManagerActionOptions)
      Update specified instance group manager action. This request updates an instance group manager action.
      Parameters:
      updateInstanceGroupManagerActionOptions - the UpdateInstanceGroupManagerActionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerAction

    • listInstanceGroupManagerPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerPolicyCollection> listInstanceGroupManagerPolicies(ListInstanceGroupManagerPoliciesOptions listInstanceGroupManagerPoliciesOptions)
      List policies for an instance group manager. This request lists policies for an instance group manager.
      Parameters:
      listInstanceGroupManagerPoliciesOptions - the ListInstanceGroupManagerPoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerPolicyCollection

    • createInstanceGroupManagerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerPolicy> createInstanceGroupManagerPolicy(CreateInstanceGroupManagerPolicyOptions createInstanceGroupManagerPolicyOptions)
      Create a policy for an instance group manager. This request creates a new instance group manager policy.
      Parameters:
      createInstanceGroupManagerPolicyOptions - the CreateInstanceGroupManagerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerPolicy

    • deleteInstanceGroupManagerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupManagerPolicy(DeleteInstanceGroupManagerPolicyOptions deleteInstanceGroupManagerPolicyOptions)
      Delete an instance group manager policy. This request deletes an instance group manager policy. This operation cannot be reversed.
      Parameters:
      deleteInstanceGroupManagerPolicyOptions - the DeleteInstanceGroupManagerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceGroupManagerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerPolicy> getInstanceGroupManagerPolicy(GetInstanceGroupManagerPolicyOptions getInstanceGroupManagerPolicyOptions)
      Retrieve an instance group manager policy. This request retrieves a single instance group manager policy specified by identifier in the URL.
      Parameters:
      getInstanceGroupManagerPolicyOptions - the GetInstanceGroupManagerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerPolicy

    • updateInstanceGroupManagerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupManagerPolicy> updateInstanceGroupManagerPolicy(UpdateInstanceGroupManagerPolicyOptions updateInstanceGroupManagerPolicyOptions)
      Update an instance group manager policy. This request updates an instance group manager policy.
      Parameters:
      updateInstanceGroupManagerPolicyOptions - the UpdateInstanceGroupManagerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupManagerPolicy

    • deleteInstanceGroupMemberships

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupMemberships(DeleteInstanceGroupMembershipsOptions deleteInstanceGroupMembershipsOptions)
      Delete memberships from an instance group. This request deletes memberships of an instance group. This operation cannot be reversed. Memberships that have `delete_instance_on_membership_delete` set to `true` will also have their instances deleted.
      Parameters:
      deleteInstanceGroupMembershipsOptions - the DeleteInstanceGroupMembershipsOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listInstanceGroupMemberships

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupMembershipCollection> listInstanceGroupMemberships(ListInstanceGroupMembershipsOptions listInstanceGroupMembershipsOptions)
      List memberships for an instance group. This request lists instance group memberships for an instance group.
      Parameters:
      listInstanceGroupMembershipsOptions - the ListInstanceGroupMembershipsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupMembershipCollection

    • deleteInstanceGroupMembership

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteInstanceGroupMembership(DeleteInstanceGroupMembershipOptions deleteInstanceGroupMembershipOptions)
      Delete an instance group membership. This request deletes a memberships of an instance group. This operation cannot be reversed. reversed. If the membership has `delete_instance_on_membership_delete` set to `true`, the instance will also be deleted.
      Parameters:
      deleteInstanceGroupMembershipOptions - the DeleteInstanceGroupMembershipOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getInstanceGroupMembership

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupMembership> getInstanceGroupMembership(GetInstanceGroupMembershipOptions getInstanceGroupMembershipOptions)
      Retrieve an instance group membership. This request retrieves a single instance group membership specified by identifier in the URL.
      Parameters:
      getInstanceGroupMembershipOptions - the GetInstanceGroupMembershipOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupMembership

    • updateInstanceGroupMembership

      public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceGroupMembership> updateInstanceGroupMembership(UpdateInstanceGroupMembershipOptions updateInstanceGroupMembershipOptions)
      Update an instance group membership. This request updates an instance group membership with the information provided instance group membership patch.
      Parameters:
      updateInstanceGroupMembershipOptions - the UpdateInstanceGroupMembershipOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type InstanceGroupMembership

    • listReservations

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservationCollection> listReservations(ListReservationsOptions listReservationsOptions)
      List reservations. This request lists reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount. The reservations will be sorted by their `created_at` property values, with newest reservations first. Reservations with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Parameters:
      listReservationsOptions - the ListReservationsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservationCollection

    • listReservations

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservationCollection> listReservations()
      List reservations. This request lists reservations in the region. A reservation provides reserved capacity for a specified profile in a specified zone. A reservation can also include a long-term committed use discount. The reservations will be sorted by their `created_at` property values, with newest reservations first. Reservations with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Returns:
      a ServiceCall with a result of type ReservationCollection

    • createReservation

      public com.ibm.cloud.sdk.core.http.ServiceCall<Reservation> createReservation(CreateReservationOptions createReservationOptions)
      Create a reservation. This request creates a new reservation from a reservation prototype object. The prototype object is structured in the same way as a retrieved reservation, and contains the information necessary to create the new reservation.
      Parameters:
      createReservationOptions - the CreateReservationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Reservation

    • deleteReservation

      public com.ibm.cloud.sdk.core.http.ServiceCall<Reservation> deleteReservation(DeleteReservationOptions deleteReservationOptions)
      Delete a reservation. This request deletes a reservation. This operation cannot be reversed. Reservations with a `status` of `active` are not allowed to be deleted.
      Parameters:
      deleteReservationOptions - the DeleteReservationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Reservation

    • getReservation

      public com.ibm.cloud.sdk.core.http.ServiceCall<Reservation> getReservation(GetReservationOptions getReservationOptions)
      Retrieve a reservation. This request retrieves a single reservation specified by identifier in the URL.
      Parameters:
      getReservationOptions - the GetReservationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Reservation

    • updateReservation

      public com.ibm.cloud.sdk.core.http.ServiceCall<Reservation> updateReservation(UpdateReservationOptions updateReservationOptions)
      Update a reservation. This request updates a reservation with the information provided in a reservation patch object. The patch object is structured in the same way as a retrieved reservation and needs to contain only the information to be updated.
      Parameters:
      updateReservationOptions - the UpdateReservationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Reservation

    • activateReservation

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> activateReservation(ActivateReservationOptions activateReservationOptions)
      Activate a reservation. This request activates a reservation. For this request to succeed, the reservation status must be `inactive`.
      Parameters:
      activateReservationOptions - the ActivateReservationOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listDedicatedHostGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostGroupCollection> listDedicatedHostGroups(ListDedicatedHostGroupsOptions listDedicatedHostGroupsOptions)
      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.
      Parameters:
      listDedicatedHostGroupsOptions - the ListDedicatedHostGroupsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostGroupCollection

    • listDedicatedHostGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostGroupCollection> listDedicatedHostGroups()
      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.
      Returns:
      a ServiceCall with a result of type DedicatedHostGroupCollection

    • createDedicatedHostGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostGroup> createDedicatedHostGroup(CreateDedicatedHostGroupOptions createDedicatedHostGroupOptions)
      Create a dedicated host group. This request creates a new dedicated host group.
      Parameters:
      createDedicatedHostGroupOptions - the CreateDedicatedHostGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostGroup

    • deleteDedicatedHostGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteDedicatedHostGroup(DeleteDedicatedHostGroupOptions deleteDedicatedHostGroupOptions)
      Delete a dedicated host group. This request deletes a dedicated host group.
      Parameters:
      deleteDedicatedHostGroupOptions - the DeleteDedicatedHostGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getDedicatedHostGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostGroup> getDedicatedHostGroup(GetDedicatedHostGroupOptions getDedicatedHostGroupOptions)
      Retrieve a dedicated host group. This request retrieves a single dedicated host group specified by the identifier in the URL.
      Parameters:
      getDedicatedHostGroupOptions - the GetDedicatedHostGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostGroup

    • updateDedicatedHostGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostGroup> updateDedicatedHostGroup(UpdateDedicatedHostGroupOptions updateDedicatedHostGroupOptions)
      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.
      Parameters:
      updateDedicatedHostGroupOptions - the UpdateDedicatedHostGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostGroup

    • listDedicatedHostProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostProfileCollection> listDedicatedHostProfiles(ListDedicatedHostProfilesOptions listDedicatedHostProfilesOptions)
      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.
      Parameters:
      listDedicatedHostProfilesOptions - the ListDedicatedHostProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostProfileCollection

    • listDedicatedHostProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostProfileCollection> listDedicatedHostProfiles()
      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.
      Returns:
      a ServiceCall with a result of type DedicatedHostProfileCollection

    • getDedicatedHostProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostProfile> getDedicatedHostProfile(GetDedicatedHostProfileOptions getDedicatedHostProfileOptions)
      Retrieve a dedicated host profile. This request retrieves a single dedicated host profile specified by the name in the URL.
      Parameters:
      getDedicatedHostProfileOptions - the GetDedicatedHostProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostProfile

    • listDedicatedHosts

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostCollection> listDedicatedHosts(ListDedicatedHostsOptions listDedicatedHostsOptions)
      List dedicated hosts. This request lists dedicated hosts in the region.
      Parameters:
      listDedicatedHostsOptions - the ListDedicatedHostsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostCollection

    • listDedicatedHosts

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostCollection> listDedicatedHosts()
      List dedicated hosts. This request lists dedicated hosts in the region.
      Returns:
      a ServiceCall with a result of type DedicatedHostCollection

    • createDedicatedHost

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHost> createDedicatedHost(CreateDedicatedHostOptions createDedicatedHostOptions)
      Create a dedicated host. This request creates a new dedicated host.
      Parameters:
      createDedicatedHostOptions - the CreateDedicatedHostOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHost

    • listDedicatedHostDisks

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostDiskCollection> listDedicatedHostDisks(ListDedicatedHostDisksOptions listDedicatedHostDisksOptions)
      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.
      Parameters:
      listDedicatedHostDisksOptions - the ListDedicatedHostDisksOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostDiskCollection

    • getDedicatedHostDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostDisk> getDedicatedHostDisk(GetDedicatedHostDiskOptions getDedicatedHostDiskOptions)
      Retrieve a dedicated host disk. This request retrieves a single dedicated host disk specified by the identifier in the URL.
      Parameters:
      getDedicatedHostDiskOptions - the GetDedicatedHostDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostDisk

    • updateDedicatedHostDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHostDisk> updateDedicatedHostDisk(UpdateDedicatedHostDiskOptions updateDedicatedHostDiskOptions)
      Update a dedicated host disk. This request updates the dedicated host disk with the information in a provided patch.
      Parameters:
      updateDedicatedHostDiskOptions - the UpdateDedicatedHostDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHostDisk

    • deleteDedicatedHost

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteDedicatedHost(DeleteDedicatedHostOptions deleteDedicatedHostOptions)
      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`.
      Parameters:
      deleteDedicatedHostOptions - the DeleteDedicatedHostOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getDedicatedHost

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHost> getDedicatedHost(GetDedicatedHostOptions getDedicatedHostOptions)
      Retrieve a dedicated host. This request retrieves a single dedicated host specified by the identifiers in the URL.
      Parameters:
      getDedicatedHostOptions - the GetDedicatedHostOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHost

    • updateDedicatedHost

      public com.ibm.cloud.sdk.core.http.ServiceCall<DedicatedHost> updateDedicatedHost(UpdateDedicatedHostOptions updateDedicatedHostOptions)
      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.
      Parameters:
      updateDedicatedHostOptions - the UpdateDedicatedHostOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type DedicatedHost

    • listPlacementGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<PlacementGroupCollection> listPlacementGroups(ListPlacementGroupsOptions listPlacementGroupsOptions)
      List placement groups. This request lists placement groups in the region.
      Parameters:
      listPlacementGroupsOptions - the ListPlacementGroupsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PlacementGroupCollection

    • listPlacementGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<PlacementGroupCollection> listPlacementGroups()
      List placement groups. This request lists placement groups in the region.
      Returns:
      a ServiceCall with a result of type PlacementGroupCollection

    • createPlacementGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<PlacementGroup> createPlacementGroup(CreatePlacementGroupOptions createPlacementGroupOptions)
      Create a placement group. This request creates a new placement group.
      Parameters:
      createPlacementGroupOptions - the CreatePlacementGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PlacementGroup

    • deletePlacementGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deletePlacementGroup(DeletePlacementGroupOptions deletePlacementGroupOptions)
      Delete a placement group. This request deletes a placement group. This operation cannot be reversed. For this request to succeed, the placement group must not be associated with an instance.
      Parameters:
      deletePlacementGroupOptions - the DeletePlacementGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getPlacementGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<PlacementGroup> getPlacementGroup(GetPlacementGroupOptions getPlacementGroupOptions)
      Retrieve a placement group. This request retrieves a single placement group specified by identifier in the URL.
      Parameters:
      getPlacementGroupOptions - the GetPlacementGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PlacementGroup

    • updatePlacementGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<PlacementGroup> updatePlacementGroup(UpdatePlacementGroupOptions updatePlacementGroupOptions)
      Update a placement group. This request updates a placement group with the information provided placement group patch. The placement group patch object is structured in the same way as a retrieved placement group and contains only the information to be updated.
      Parameters:
      updatePlacementGroupOptions - the UpdatePlacementGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PlacementGroup

    • listBareMetalServerProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerProfileCollection> listBareMetalServerProfiles(ListBareMetalServerProfilesOptions listBareMetalServerProfilesOptions)
      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.
      Parameters:
      listBareMetalServerProfilesOptions - the ListBareMetalServerProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerProfileCollection

    • listBareMetalServerProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerProfileCollection> listBareMetalServerProfiles()
      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.
      Returns:
      a ServiceCall with a result of type BareMetalServerProfileCollection

    • getBareMetalServerProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerProfile> getBareMetalServerProfile(GetBareMetalServerProfileOptions getBareMetalServerProfileOptions)
      Retrieve a bare metal server profile. This request retrieves a single bare metal server profile specified by the name in the URL.
      Parameters:
      getBareMetalServerProfileOptions - the GetBareMetalServerProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerProfile

    • listBareMetalServers

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerCollection> listBareMetalServers(ListBareMetalServersOptions listBareMetalServersOptions)
      List bare metal servers. This request lists bare metal servers in the region.
      Parameters:
      listBareMetalServersOptions - the ListBareMetalServersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerCollection

    • listBareMetalServers

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerCollection> listBareMetalServers()
      List bare metal servers. This request lists bare metal servers in the region.
      Returns:
      a ServiceCall with a result of type BareMetalServerCollection

    • createBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServer> createBareMetalServer(CreateBareMetalServerOptions createBareMetalServerOptions)
      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.
      Parameters:
      createBareMetalServerOptions - the CreateBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServer

    • createBareMetalServerConsoleAccessToken

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerConsoleAccessToken> createBareMetalServerConsoleAccessToken(CreateBareMetalServerConsoleAccessTokenOptions createBareMetalServerConsoleAccessTokenOptions)
      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`.
      Parameters:
      createBareMetalServerConsoleAccessTokenOptions - the CreateBareMetalServerConsoleAccessTokenOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerConsoleAccessToken

    • listBareMetalServerDisks

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerDiskCollection> listBareMetalServerDisks(ListBareMetalServerDisksOptions listBareMetalServerDisksOptions)
      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.
      Parameters:
      listBareMetalServerDisksOptions - the ListBareMetalServerDisksOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerDiskCollection

    • getBareMetalServerDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerDisk> getBareMetalServerDisk(GetBareMetalServerDiskOptions getBareMetalServerDiskOptions)
      Retrieve a bare metal server disk. This request retrieves a single disk specified by the identifier in the URL.
      Parameters:
      getBareMetalServerDiskOptions - the GetBareMetalServerDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerDisk

    • updateBareMetalServerDisk

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerDisk> updateBareMetalServerDisk(UpdateBareMetalServerDiskOptions updateBareMetalServerDiskOptions)
      Update a bare metal server disk. This request updates the bare metal server disk with the information in a provided patch.
      Parameters:
      updateBareMetalServerDiskOptions - the UpdateBareMetalServerDiskOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerDisk

    • listBareMetalServerNetworkAttachments

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkAttachmentCollection> listBareMetalServerNetworkAttachments(ListBareMetalServerNetworkAttachmentsOptions listBareMetalServerNetworkAttachmentsOptions)
      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.
      Parameters:
      listBareMetalServerNetworkAttachmentsOptions - the ListBareMetalServerNetworkAttachmentsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkAttachmentCollection

    • createBareMetalServerNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkAttachment> createBareMetalServerNetworkAttachment(CreateBareMetalServerNetworkAttachmentOptions createBareMetalServerNetworkAttachmentOptions)
      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.
      Parameters:
      createBareMetalServerNetworkAttachmentOptions - the CreateBareMetalServerNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkAttachment

    • deleteBareMetalServerNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteBareMetalServerNetworkAttachment(DeleteBareMetalServerNetworkAttachmentOptions deleteBareMetalServerNetworkAttachmentOptions)
      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.
      Parameters:
      deleteBareMetalServerNetworkAttachmentOptions - the DeleteBareMetalServerNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getBareMetalServerNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkAttachment> getBareMetalServerNetworkAttachment(GetBareMetalServerNetworkAttachmentOptions getBareMetalServerNetworkAttachmentOptions)
      Retrieve a bare metal server network attachment. This request retrieves a single bare metal server network attachment specified by the identifier in the URL.
      Parameters:
      getBareMetalServerNetworkAttachmentOptions - the GetBareMetalServerNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkAttachment

    • updateBareMetalServerNetworkAttachment

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkAttachment> updateBareMetalServerNetworkAttachment(UpdateBareMetalServerNetworkAttachmentOptions updateBareMetalServerNetworkAttachmentOptions)
      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.
      Parameters:
      updateBareMetalServerNetworkAttachmentOptions - the UpdateBareMetalServerNetworkAttachmentOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkAttachment

    • listBareMetalServerNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkInterfaceCollection> listBareMetalServerNetworkInterfaces(ListBareMetalServerNetworkInterfacesOptions listBareMetalServerNetworkInterfacesOptions)
      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.
      Parameters:
      listBareMetalServerNetworkInterfacesOptions - the ListBareMetalServerNetworkInterfacesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkInterfaceCollection

    • createBareMetalServerNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkInterface> createBareMetalServerNetworkInterface(CreateBareMetalServerNetworkInterfaceOptions createBareMetalServerNetworkInterfaceOptions)
      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.
      Parameters:
      createBareMetalServerNetworkInterfaceOptions - the CreateBareMetalServerNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkInterface

    • deleteBareMetalServerNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteBareMetalServerNetworkInterface(DeleteBareMetalServerNetworkInterfaceOptions deleteBareMetalServerNetworkInterfaceOptions)
      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.
      Parameters:
      deleteBareMetalServerNetworkInterfaceOptions - the DeleteBareMetalServerNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getBareMetalServerNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkInterface> getBareMetalServerNetworkInterface(GetBareMetalServerNetworkInterfaceOptions getBareMetalServerNetworkInterfaceOptions)
      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.
      Parameters:
      getBareMetalServerNetworkInterfaceOptions - the GetBareMetalServerNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkInterface

    • updateBareMetalServerNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerNetworkInterface> updateBareMetalServerNetworkInterface(UpdateBareMetalServerNetworkInterfaceOptions updateBareMetalServerNetworkInterfaceOptions)
      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.
      Parameters:
      updateBareMetalServerNetworkInterfaceOptions - the UpdateBareMetalServerNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerNetworkInterface

    • listBareMetalServerNetworkInterfaceFloatingIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPUnpaginatedCollection> listBareMetalServerNetworkInterfaceFloatingIps(ListBareMetalServerNetworkInterfaceFloatingIpsOptions listBareMetalServerNetworkInterfaceFloatingIpsOptions)
      List floating IPs associated with a bare metal server network interface. This request lists floating IPs associated with a bare metal server network interface.
      Parameters:
      listBareMetalServerNetworkInterfaceFloatingIpsOptions - the ListBareMetalServerNetworkInterfaceFloatingIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPUnpaginatedCollection

    • removeBareMetalServerNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeBareMetalServerNetworkInterfaceFloatingIp(RemoveBareMetalServerNetworkInterfaceFloatingIpOptions removeBareMetalServerNetworkInterfaceFloatingIpOptions)
      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.
      Parameters:
      removeBareMetalServerNetworkInterfaceFloatingIpOptions - the RemoveBareMetalServerNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getBareMetalServerNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> getBareMetalServerNetworkInterfaceFloatingIp(GetBareMetalServerNetworkInterfaceFloatingIpOptions getBareMetalServerNetworkInterfaceFloatingIpOptions)
      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.
      Parameters:
      getBareMetalServerNetworkInterfaceFloatingIpOptions - the GetBareMetalServerNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • addBareMetalServerNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> addBareMetalServerNetworkInterfaceFloatingIp(AddBareMetalServerNetworkInterfaceFloatingIpOptions addBareMetalServerNetworkInterfaceFloatingIpOptions)
      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.
      Parameters:
      addBareMetalServerNetworkInterfaceFloatingIpOptions - the AddBareMetalServerNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • listBareMetalServerNetworkInterfaceIps

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPCollectionBareMetalServerNetworkInterfaceContext> listBareMetalServerNetworkInterfaceIps(ListBareMetalServerNetworkInterfaceIpsOptions listBareMetalServerNetworkInterfaceIpsOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      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.
      Parameters:
      listBareMetalServerNetworkInterfaceIpsOptions - the ListBareMetalServerNetworkInterfaceIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPCollectionBareMetalServerNetworkInterfaceContext

    • getBareMetalServerNetworkInterfaceIp

      @Deprecated public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> getBareMetalServerNetworkInterfaceIp(GetBareMetalServerNetworkInterfaceIpOptions getBareMetalServerNetworkInterfaceIpOptions)
      Deprecated.
      this method is deprecated and may be removed in a future release
      Retrieve the primary reserved IP. This request retrieves the primary reserved IP for a bare metal server network interface.
      Parameters:
      getBareMetalServerNetworkInterfaceIpOptions - the GetBareMetalServerNetworkInterfaceIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • deleteBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteBareMetalServer(DeleteBareMetalServerOptions deleteBareMetalServerOptions)
      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.
      Parameters:
      deleteBareMetalServerOptions - the DeleteBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServer> getBareMetalServer(GetBareMetalServerOptions getBareMetalServerOptions)
      Retrieve a bare metal server. This request retrieves a single bare metal server specified by the identifier in the URL.
      Parameters:
      getBareMetalServerOptions - the GetBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServer

    • updateBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServer> updateBareMetalServer(UpdateBareMetalServerOptions updateBareMetalServerOptions)
      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.
      Parameters:
      updateBareMetalServerOptions - the UpdateBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServer

    • updateFirmwareForBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> updateFirmwareForBareMetalServer(UpdateFirmwareForBareMetalServerOptions updateFirmwareForBareMetalServerOptions)
      Update firmware for a bare metal server. This request updates a bare metal server to the latest available firmware. The server must be stopped.
      Parameters:
      updateFirmwareForBareMetalServerOptions - the UpdateFirmwareForBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getBareMetalServerInitialization

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerInitialization> getBareMetalServerInitialization(GetBareMetalServerInitializationOptions getBareMetalServerInitializationOptions)
      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.
      Parameters:
      getBareMetalServerInitializationOptions - the GetBareMetalServerInitializationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerInitialization

    • replaceBareMetalServerInitialization

      public com.ibm.cloud.sdk.core.http.ServiceCall<BareMetalServerInitialization> replaceBareMetalServerInitialization(ReplaceBareMetalServerInitializationOptions replaceBareMetalServerInitializationOptions)
      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.
      Parameters:
      replaceBareMetalServerInitializationOptions - the ReplaceBareMetalServerInitializationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BareMetalServerInitialization

    • restartBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> restartBareMetalServer(RestartBareMetalServerOptions restartBareMetalServerOptions)
      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`.
      Parameters:
      restartBareMetalServerOptions - the RestartBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • startBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> startBareMetalServer(StartBareMetalServerOptions startBareMetalServerOptions)
      Start a bare metal server. This request starts a bare metal server. It will run immediately provided the server is stopped.
      Parameters:
      startBareMetalServerOptions - the StartBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • stopBareMetalServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> stopBareMetalServer(StopBareMetalServerOptions stopBareMetalServerOptions)
      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.
      Parameters:
      stopBareMetalServerOptions - the StopBareMetalServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listVolumeProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeProfileCollection> listVolumeProfiles(ListVolumeProfilesOptions listVolumeProfilesOptions)
      List volume profiles. This request lists [volume profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.
      Parameters:
      listVolumeProfilesOptions - the ListVolumeProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeProfileCollection

    • listVolumeProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeProfileCollection> listVolumeProfiles()
      List volume profiles. This request lists [volume profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-profiles) available in the region. A volume profile specifies the performance characteristics and pricing model for a volume.
      Returns:
      a ServiceCall with a result of type VolumeProfileCollection

    • getVolumeProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeProfile> getVolumeProfile(GetVolumeProfileOptions getVolumeProfileOptions)
      Retrieve a volume profile. This request retrieves a single volume profile specified by the name in the URL.
      Parameters:
      getVolumeProfileOptions - the GetVolumeProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeProfile

    • listVolumes

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeCollection> listVolumes(ListVolumesOptions listVolumesOptions)
      List volumes. This request lists volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.
      Parameters:
      listVolumesOptions - the ListVolumesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VolumeCollection

    • listVolumes

      public com.ibm.cloud.sdk.core.http.ServiceCall<VolumeCollection> listVolumes()
      List volumes. This request lists volumes in the region. Volumes are network-connected block storage devices that may be attached to one or more instances in the same region.
      Returns:
      a ServiceCall with a result of type VolumeCollection

    • createVolume

      public com.ibm.cloud.sdk.core.http.ServiceCall<Volume> createVolume(CreateVolumeOptions createVolumeOptions)
      Create a volume. This request creates a new volume from a volume prototype object. The prototype object is structured in the same way as a retrieved volume, and contains the information necessary to create the new volume.
      Parameters:
      createVolumeOptions - the CreateVolumeOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Volume

    • deleteVolume

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVolume(DeleteVolumeOptions deleteVolumeOptions)
      Delete a volume. This request deletes a volume. This operation cannot be reversed. For this request to succeed, the volume must not be attached to any instances.
      Parameters:
      deleteVolumeOptions - the DeleteVolumeOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVolume

      public com.ibm.cloud.sdk.core.http.ServiceCall<Volume> getVolume(GetVolumeOptions getVolumeOptions)
      Retrieve a volume. This request retrieves a single volume specified by the identifier in the URL.
      Parameters:
      getVolumeOptions - the GetVolumeOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Volume

    • updateVolume

      public com.ibm.cloud.sdk.core.http.ServiceCall<Volume> updateVolume(UpdateVolumeOptions updateVolumeOptions)
      Update a volume. This request updates a volume with the information in a provided volume patch. The volume patch object is structured in the same way as a retrieved volume and contains only the information to be updated.
      Parameters:
      updateVolumeOptions - the UpdateVolumeOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Volume

    • listSnapshotConsistencyGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroupCollection> listSnapshotConsistencyGroups(ListSnapshotConsistencyGroupsOptions listSnapshotConsistencyGroupsOptions)
      List snapshot consistency groups. This request lists snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.
      Parameters:
      listSnapshotConsistencyGroupsOptions - the ListSnapshotConsistencyGroupsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroupCollection

    • listSnapshotConsistencyGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroupCollection> listSnapshotConsistencyGroups()
      List snapshot consistency groups. This request lists snapshot consistency groups in the region. A snapshot consistency group is a collection of individual snapshots taken at the same time.
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroupCollection

    • createSnapshotConsistencyGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroup> createSnapshotConsistencyGroup(CreateSnapshotConsistencyGroupOptions createSnapshotConsistencyGroupOptions)
      Create a snapshot consistency group. This request creates a new snapshot consistency group from a snapshot consistency group object. The prototype object is structured in the same way as a retrieved consistency group, and contains the information necessary to provision the new snapshot consistency group.
      Parameters:
      createSnapshotConsistencyGroupOptions - the CreateSnapshotConsistencyGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroup

    • deleteSnapshotConsistencyGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroup> deleteSnapshotConsistencyGroup(DeleteSnapshotConsistencyGroupOptions deleteSnapshotConsistencyGroupOptions)
      Delete a snapshot consistency group. This request deletes snapshot consistency group. This operation cannot be reversed. If the `delete_snapshots_on_delete` property is `true`, all snapshots in the consistency group will also be deleted.
      Parameters:
      deleteSnapshotConsistencyGroupOptions - the DeleteSnapshotConsistencyGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroup

    • getSnapshotConsistencyGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroup> getSnapshotConsistencyGroup(GetSnapshotConsistencyGroupOptions getSnapshotConsistencyGroupOptions)
      Retrieve a snapshot consistency group. This request retrieves a single snapshot consistency group specified by the identifier in the URL.
      Parameters:
      getSnapshotConsistencyGroupOptions - the GetSnapshotConsistencyGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroup

    • updateSnapshotConsistencyGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotConsistencyGroup> updateSnapshotConsistencyGroup(UpdateSnapshotConsistencyGroupOptions updateSnapshotConsistencyGroupOptions)
      Update a snapshot consistency group. This request updates a snapshot consistency group with the information in a provided snapshot consistency group patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot consistency group and contains only the information to be updated.
      Parameters:
      updateSnapshotConsistencyGroupOptions - the UpdateSnapshotConsistencyGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotConsistencyGroup

    • deleteSnapshots

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSnapshots(DeleteSnapshotsOptions deleteSnapshotsOptions)
      Delete a filtered collection of snapshots. This request deletes snapshots that match the specified filter. This operation cannot be reversed.
      Parameters:
      deleteSnapshotsOptions - the DeleteSnapshotsOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listSnapshots

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotCollection> listSnapshots(ListSnapshotsOptions listSnapshotsOptions)
      List snapshots. This request lists snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.
      Parameters:
      listSnapshotsOptions - the ListSnapshotsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotCollection

    • listSnapshots

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotCollection> listSnapshots()
      List snapshots. This request lists snapshots in the region. A snapshot preserves the data of a volume at the time the snapshot is created.
      Returns:
      a ServiceCall with a result of type SnapshotCollection

    • createSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<Snapshot> createSnapshot(CreateSnapshotOptions createSnapshotOptions)
      Create a snapshot. This request creates a new snapshot from a snapshot prototype object. The prototype object is structured in the same way as a retrieved snapshot, and contains the information necessary to provision the new snapshot.
      Parameters:
      createSnapshotOptions - the CreateSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Snapshot

    • deleteSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSnapshot(DeleteSnapshotOptions deleteSnapshotOptions)
      Delete a snapshot. This request deletes a snapshot. This operation cannot be reversed.
      Parameters:
      deleteSnapshotOptions - the DeleteSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<Snapshot> getSnapshot(GetSnapshotOptions getSnapshotOptions)
      Retrieve a snapshot. This request retrieves a single snapshot specified by the identifier in the URL.
      Parameters:
      getSnapshotOptions - the GetSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Snapshot

    • updateSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<Snapshot> updateSnapshot(UpdateSnapshotOptions updateSnapshotOptions)
      Update a snapshot. This request updates a snapshot with the information in a provided snapshot patch. The snapshot consistency group patch object is structured in the same way as a retrieved snapshot and contains only the information to be updated.
      Parameters:
      updateSnapshotOptions - the UpdateSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Snapshot

    • listSnapshotClones

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotCloneCollection> listSnapshotClones(ListSnapshotClonesOptions listSnapshotClonesOptions)
      List clones for a snapshot. This request lists clones for a snapshot. Use a clone to quickly restore a snapshot within the clone's zone.
      Parameters:
      listSnapshotClonesOptions - the ListSnapshotClonesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotCloneCollection

    • deleteSnapshotClone

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSnapshotClone(DeleteSnapshotCloneOptions deleteSnapshotCloneOptions)
      Delete a snapshot clone. This request deletes a snapshot clone. This operation cannot be reversed, but an equivalent clone may be recreated from the snapshot.
      Parameters:
      deleteSnapshotCloneOptions - the DeleteSnapshotCloneOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSnapshotClone

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotClone> getSnapshotClone(GetSnapshotCloneOptions getSnapshotCloneOptions)
      Retrieve a snapshot clone. This request retrieves a single clone specified by the snapshot identifier and zone name in the URL.
      Parameters:
      getSnapshotCloneOptions - the GetSnapshotCloneOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotClone

    • createSnapshotClone

      public com.ibm.cloud.sdk.core.http.ServiceCall<SnapshotClone> createSnapshotClone(CreateSnapshotCloneOptions createSnapshotCloneOptions)
      Create a clone for a snapshot. This request creates a new clone for a snapshot in the specified zone. A request body is not required, and if provided, is ignored. If the snapshot already has a clone in the zone, it is returned.
      Parameters:
      createSnapshotCloneOptions - the CreateSnapshotCloneOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SnapshotClone

    • listShareProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareProfileCollection> listShareProfiles(ListShareProfilesOptions listShareProfilesOptions)
      List file share profiles. This request lists [file share profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.
      Parameters:
      listShareProfilesOptions - the ListShareProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareProfileCollection

    • listShareProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareProfileCollection> listShareProfiles()
      List file share profiles. This request lists [file share profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-profiles) available in the region. A file share profile specifies the performance characteristics and pricing model for a file share.
      Returns:
      a ServiceCall with a result of type ShareProfileCollection

    • getShareProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareProfile> getShareProfile(GetShareProfileOptions getShareProfileOptions)
      Retrieve a file share profile. This request retrieves a single file share profile specified by the name in the URL.
      Parameters:
      getShareProfileOptions - the GetShareProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareProfile

    • listShares

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareCollection> listShares(ListSharesOptions listSharesOptions)
      List file shares. This request lists file shares in the region.
      Parameters:
      listSharesOptions - the ListSharesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareCollection

    • listShares

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareCollection> listShares()
      List file shares. This request lists file shares in the region.
      Returns:
      a ServiceCall with a result of type ShareCollection

    • createShare

      public com.ibm.cloud.sdk.core.http.ServiceCall<Share> createShare(CreateShareOptions createShareOptions)
      Create a file share. This request provisions new file shares from a share prototype object. The new file shares can be a standalone share, a replica share, or both a source and replica share. The prototype object is structured in the same way as a retrieved share, and contains the information necessary to provision the new file shares.
      Parameters:
      createShareOptions - the CreateShareOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Share

    • deleteShare

      public com.ibm.cloud.sdk.core.http.ServiceCall<Share> deleteShare(DeleteShareOptions deleteShareOptions)
      Delete a file share. This request deletes a share. This operation cannot be reversed. A share cannot be deleted if it: - has share mount targets - has a `lifecycle_state` of `updating` - has a replication operation in progress If the request is accepted, the share `lifecycle_state` will be set to `deleting`. Once deletion processing completes, it will no longer be retrievable.
      Parameters:
      deleteShareOptions - the DeleteShareOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Share

    • getShare

      public com.ibm.cloud.sdk.core.http.ServiceCall<Share> getShare(GetShareOptions getShareOptions)
      Retrieve a file share. This request retrieves a single file share specified by the identifier in the URL.
      Parameters:
      getShareOptions - the GetShareOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Share

    • updateShare

      public com.ibm.cloud.sdk.core.http.ServiceCall<Share> updateShare(UpdateShareOptions updateShareOptions)
      Update a file share. This request updates a share with the information in a provided share patch. The share patch object is structured in the same way as a retrieved share and contains only the information to be updated.
      Parameters:
      updateShareOptions - the UpdateShareOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Share

    • listShareAccessorBindings

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareAccessorBindingCollection> listShareAccessorBindings(ListShareAccessorBindingsOptions listShareAccessorBindingsOptions)
      List accessor bindings for a file share. This request lists accessor bindings for a share. Each accessor binding identifies a resource (possibly in another account) with access to this file share including its snapshots. The share accessor bindings will be sorted by their `created_at` property values, with newest bindings first.
      Parameters:
      listShareAccessorBindingsOptions - the ListShareAccessorBindingsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareAccessorBindingCollection

    • deleteShareAccessorBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteShareAccessorBinding(DeleteShareAccessorBindingOptions deleteShareAccessorBindingOptions)
      Delete a file share accessor binding. This request deletes a share accessor binding. This operation cannot be reversed.
      Parameters:
      deleteShareAccessorBindingOptions - the DeleteShareAccessorBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getShareAccessorBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareAccessorBinding> getShareAccessorBinding(GetShareAccessorBindingOptions getShareAccessorBindingOptions)
      Retrieve a file share accessor binding. This request retrieves a single accessor binding specified by the identifier in the URL.
      Parameters:
      getShareAccessorBindingOptions - the GetShareAccessorBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareAccessorBinding

    • failoverShare

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> failoverShare(FailoverShareOptions failoverShareOptions)
      Failover to replica file share. This request triggers a failover to the replica file share specified by the identifier in the URL. The failover cannot be started if a source share or the replica share has a `lifecycle_state` of `updating`, or has a replication operation in progress. If `fallback_policy` is specified as `split`, and the request is accepted but the failover operation cannot be performed, a split will be triggered.
      Parameters:
      failoverShareOptions - the FailoverShareOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listShareMountTargets

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareMountTargetCollection> listShareMountTargets(ListShareMountTargetsOptions listShareMountTargetsOptions)
      List mount targets for a file share. This request lists mount targets for a file share. A mount target is a network endpoint at which a file share may be mounted. The file share can be mounted by clients in the same VPC and zone after creating share mount targets. The share mount targets will be sorted by their `created_at` property values, with newest targets first.
      Parameters:
      listShareMountTargetsOptions - the ListShareMountTargetsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareMountTargetCollection

    • createShareMountTarget

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareMountTarget> createShareMountTarget(CreateShareMountTargetOptions createShareMountTargetOptions)
      Create a mount target for a file share. This request creates a new share mount target from a share mount target prototype object. The prototype object is structured in the same way as a retrieved share mount target, and contains the information necessary to provision the new file share mount target.
      Parameters:
      createShareMountTargetOptions - the CreateShareMountTargetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareMountTarget

    • deleteShareMountTarget

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareMountTarget> deleteShareMountTarget(DeleteShareMountTargetOptions deleteShareMountTargetOptions)
      Delete a file share mount target. This request deletes a share mount target. This operation cannot be reversed. If the request is accepted, the share mount target `lifecycle_state` will be set to `deleting`. Once deletion processing completes, it will no longer be retrievable.
      Parameters:
      deleteShareMountTargetOptions - the DeleteShareMountTargetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareMountTarget

    • getShareMountTarget

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareMountTarget> getShareMountTarget(GetShareMountTargetOptions getShareMountTargetOptions)
      Retrieve a file share mount target. This request retrieves a single share mount target specified by the identifier in the URL.
      Parameters:
      getShareMountTargetOptions - the GetShareMountTargetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareMountTarget

    • updateShareMountTarget

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareMountTarget> updateShareMountTarget(UpdateShareMountTargetOptions updateShareMountTargetOptions)
      Update a file share mount target. This request updates a share mount target with the information provided in a share mount target patch object. The share mount target patch object is structured in the same way as a retrieved share mount target and needs to contain only the information to be updated.
      Parameters:
      updateShareMountTargetOptions - the UpdateShareMountTargetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareMountTarget

    • listShareSnapshots

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareSnapshotCollection> listShareSnapshots(ListShareSnapshotsOptions listShareSnapshotsOptions)
      List file share snapshots. This request lists snapshots for the specified file share, or across all accessible file shares. A snapshot preserves the data of a share at the time the snapshot was captured. If the file share is a replica, the list will contain snapshots corresponding to snapshots on the source.
      Parameters:
      listShareSnapshotsOptions - the ListShareSnapshotsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareSnapshotCollection

    • createShareSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareSnapshot> createShareSnapshot(CreateShareSnapshotOptions createShareSnapshotOptions)
      Create a snapshot for a file share. This request creates a new share snapshot from a share snapshot prototype object. The prototype object is structured in the same way as a retrieved share snapshot, and contains the information necessary to create the new share snapshot. The share must have the `access_control_mode` set to `security_group`. At present, the snapshot's `resource_group` will be inherited from its share, but may be specifiable in the future. The new snapshot will inherit the encryption settings from its share, , and must have a `replication_role` of `source` or `none`. If the share has a `replication_role` of `source`, a corresponding snapshot on the replica share will be created with a `status` of `pending`. It will remain in `pending` until the data is synchronized per the replication schedule determined by the replica share's `replication_cron_spec`.
      Parameters:
      createShareSnapshotOptions - the CreateShareSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareSnapshot

    • deleteShareSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareSnapshot> deleteShareSnapshot(DeleteShareSnapshotOptions deleteShareSnapshotOptions)
      Delete a share snapshot. This request deletes a share snapshot. This operation cannot be reversed. For this request to succeed, the share must have a `replication_role` of `source` or `none`. If the request is accepted, the share snapshot `lifecycle_state` will be set to `deleting`. Once deletion processing completes, the share snapshot will no longer be retrievable. Deleting a share snapshot will not affect any previously-accepted requests to create a share from it. If the share has a `replication_role` of `source`, the corresponding snapshot on the replica share will be subsequently moved to a `lifecycle_state` of `deleting`. If the data for the corresponding snapshot has already been synchronized via the replication schedule determined by `replication_cron_spec`, the snapshot will remain available in the replica share's `.snapshot` directory until the next replication sync.
      Parameters:
      deleteShareSnapshotOptions - the DeleteShareSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareSnapshot

    • getShareSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareSnapshot> getShareSnapshot(GetShareSnapshotOptions getShareSnapshotOptions)
      Retrieve a share snapshot. This request retrieves a single share snapshot specified by the identifier in the URL.
      Parameters:
      getShareSnapshotOptions - the GetShareSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareSnapshot

    • updateShareSnapshot

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareSnapshot> updateShareSnapshot(UpdateShareSnapshotOptions updateShareSnapshotOptions)
      Update a share snapshot. This request updates a share snapshot with the information provided in a share snapshot patch object. The share snapshot patch object is structured in the same way as a retrieved share snapshot and needs to contain only the information to be updated.
      Parameters:
      updateShareSnapshotOptions - the UpdateShareSnapshotOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareSnapshot

    • deleteShareSource

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteShareSource(DeleteShareSourceOptions deleteShareSourceOptions)
      Split the source file share from a replica file share. This request removes the replication relationship between a source share and the replica share specified by the identifier in the URL. The replication relationship cannot be removed if a source share or the replica share has a `lifecycle_state` of `updating`, or has a replication operation in progress. This operation cannot be reversed.
      Parameters:
      deleteShareSourceOptions - the DeleteShareSourceOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getShareSource

      public com.ibm.cloud.sdk.core.http.ServiceCall<ShareReference> getShareSource(GetShareSourceOptions getShareSourceOptions)
      Retrieve the source file share for a replica file share. This request retrieves the source file share associated with the replica file share specified by the identifier in the URL.
      Parameters:
      getShareSourceOptions - the GetShareSourceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ShareReference

    • listBackupPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyCollection> listBackupPolicies(ListBackupPoliciesOptions listBackupPoliciesOptions)
      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.
      Parameters:
      listBackupPoliciesOptions - the ListBackupPoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyCollection

    • listBackupPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyCollection> listBackupPolicies()
      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.
      Returns:
      a ServiceCall with a result of type BackupPolicyCollection

    • createBackupPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> createBackupPolicy(CreateBackupPolicyOptions createBackupPolicyOptions)
      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.
      Parameters:
      createBackupPolicyOptions - the CreateBackupPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicy

    • listBackupPolicyJobs

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyJobCollection> listBackupPolicyJobs(ListBackupPolicyJobsOptions listBackupPolicyJobsOptions)
      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.
      Parameters:
      listBackupPolicyJobsOptions - the ListBackupPolicyJobsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyJobCollection

    • getBackupPolicyJob

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyJob> getBackupPolicyJob(GetBackupPolicyJobOptions getBackupPolicyJobOptions)
      Retrieve a backup policy job. This request retrieves a single backup policy job specified by the identifier in the URL.
      Parameters:
      getBackupPolicyJobOptions - the GetBackupPolicyJobOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyJob

    • listBackupPolicyPlans

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyPlanCollection> listBackupPolicyPlans(ListBackupPolicyPlansOptions listBackupPolicyPlansOptions)
      List plans for a backup policy. This request retrieves plans for a backup policy. Backup plans provide the backup schedule and deletion triggers.
      Parameters:
      listBackupPolicyPlansOptions - the ListBackupPolicyPlansOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyPlanCollection

    • createBackupPolicyPlan

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyPlan> createBackupPolicyPlan(CreateBackupPolicyPlanOptions createBackupPolicyPlanOptions)
      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.
      Parameters:
      createBackupPolicyPlanOptions - the CreateBackupPolicyPlanOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyPlan

    • deleteBackupPolicyPlan

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyPlan> deleteBackupPolicyPlan(DeleteBackupPolicyPlanOptions deleteBackupPolicyPlanOptions)
      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.
      Parameters:
      deleteBackupPolicyPlanOptions - the DeleteBackupPolicyPlanOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyPlan

    • getBackupPolicyPlan

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyPlan> getBackupPolicyPlan(GetBackupPolicyPlanOptions getBackupPolicyPlanOptions)
      Retrieve a backup policy plan. This request retrieves a single backup policy plan specified by the identifier in the URL.
      Parameters:
      getBackupPolicyPlanOptions - the GetBackupPolicyPlanOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyPlan

    • updateBackupPolicyPlan

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicyPlan> updateBackupPolicyPlan(UpdateBackupPolicyPlanOptions updateBackupPolicyPlanOptions)
      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.
      Parameters:
      updateBackupPolicyPlanOptions - the UpdateBackupPolicyPlanOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicyPlan

    • deleteBackupPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> deleteBackupPolicy(DeleteBackupPolicyOptions deleteBackupPolicyOptions)
      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.
      Parameters:
      deleteBackupPolicyOptions - the DeleteBackupPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicy

    • getBackupPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> getBackupPolicy(GetBackupPolicyOptions getBackupPolicyOptions)
      Retrieve a backup policy. This request retrieves a single backup policy specified by the identifier in the URL.
      Parameters:
      getBackupPolicyOptions - the GetBackupPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicy

    • updateBackupPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<BackupPolicy> updateBackupPolicy(UpdateBackupPolicyOptions updateBackupPolicyOptions)
      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.
      Parameters:
      updateBackupPolicyOptions - the UpdateBackupPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type BackupPolicy

    • listRegions

      public com.ibm.cloud.sdk.core.http.ServiceCall<RegionCollection> listRegions(ListRegionsOptions listRegionsOptions)
      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.
      Parameters:
      listRegionsOptions - the ListRegionsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type RegionCollection

    • listRegions

      public com.ibm.cloud.sdk.core.http.ServiceCall<RegionCollection> listRegions()
      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.
      Returns:
      a ServiceCall with a result of type RegionCollection

    • getRegion

      public com.ibm.cloud.sdk.core.http.ServiceCall<Region> getRegion(GetRegionOptions getRegionOptions)
      Retrieve a region. This request retrieves a single region specified by the name in the URL.
      Parameters:
      getRegionOptions - the GetRegionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Region

    • listRegionZones

      public com.ibm.cloud.sdk.core.http.ServiceCall<ZoneCollection> listRegionZones(ListRegionZonesOptions listRegionZonesOptions)
      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.
      Parameters:
      listRegionZonesOptions - the ListRegionZonesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ZoneCollection

    • getRegionZone

      public com.ibm.cloud.sdk.core.http.ServiceCall<Zone> getRegionZone(GetRegionZoneOptions getRegionZoneOptions)
      Retrieve a zone. This request retrieves a single zone specified by the region and zone names in the URL.
      Parameters:
      getRegionZoneOptions - the GetRegionZoneOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type Zone

    • listVirtualNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterfaceCollection> listVirtualNetworkInterfaces(ListVirtualNetworkInterfacesOptions listVirtualNetworkInterfacesOptions)
      List virtual network interfaces. This request lists virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource. The virtual network interfaces will be sorted by their `created_at` property values, with newest virtual network interfaces first. Virtual network interfaces with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Parameters:
      listVirtualNetworkInterfacesOptions - the ListVirtualNetworkInterfacesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterfaceCollection

    • listVirtualNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterfaceCollection> listVirtualNetworkInterfaces()
      List virtual network interfaces. This request lists virtual network interfaces in the region. A virtual network interface is a logical abstraction of a virtual network interface in a subnet, and may be attached to a target resource. The virtual network interfaces will be sorted by their `created_at` property values, with newest virtual network interfaces first. Virtual network interfaces with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterfaceCollection

    • createVirtualNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterface> createVirtualNetworkInterface(CreateVirtualNetworkInterfaceOptions createVirtualNetworkInterfaceOptions)
      Create a virtual network interface. This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.
      Parameters:
      createVirtualNetworkInterfaceOptions - the CreateVirtualNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterface

    • createVirtualNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterface> createVirtualNetworkInterface()
      Create a virtual network interface. This request creates a new virtual network interface from a virtual network interface prototype object. The prototype object is structured in the same way as a retrieved virtual network interface, and contains the information necessary to create the new virtual network interface.
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterface

    • deleteVirtualNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterface> deleteVirtualNetworkInterfaces(DeleteVirtualNetworkInterfacesOptions deleteVirtualNetworkInterfacesOptions)
      Delete a virtual network interface. This request deletes a virtual network interface. This operation cannot be reversed. For this request to succeed, the virtual network interface must not be required by another resource, such as the primary network attachment for an instance.
      Parameters:
      deleteVirtualNetworkInterfacesOptions - the DeleteVirtualNetworkInterfacesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterface

    • getVirtualNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterface> getVirtualNetworkInterface(GetVirtualNetworkInterfaceOptions getVirtualNetworkInterfaceOptions)
      Retrieve a virtual network interface. This request retrieves a single virtual network interface specified by the identifier in the URL.
      Parameters:
      getVirtualNetworkInterfaceOptions - the GetVirtualNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterface

    • updateVirtualNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualNetworkInterface> updateVirtualNetworkInterface(UpdateVirtualNetworkInterfaceOptions updateVirtualNetworkInterfaceOptions)
      Update a virtual network interface. This request updates a virtual network interface with the information in a provided virtual network interface patch. The virtual network interface patch object is structured in the same way as a retrieved virtual network interface and contains only the information to be updated.
      Parameters:
      updateVirtualNetworkInterfaceOptions - the UpdateVirtualNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VirtualNetworkInterface

    • listNetworkInterfaceFloatingIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPCollectionVirtualNetworkInterfaceContext> listNetworkInterfaceFloatingIps(ListNetworkInterfaceFloatingIpsOptions listNetworkInterfaceFloatingIpsOptions)
      List floating IPs associated with a virtual network interface. This request lists floating IPs associated with a virtual network interface.
      Parameters:
      listNetworkInterfaceFloatingIpsOptions - the ListNetworkInterfaceFloatingIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPCollectionVirtualNetworkInterfaceContext

    • removeNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeNetworkInterfaceFloatingIp(RemoveNetworkInterfaceFloatingIpOptions removeNetworkInterfaceFloatingIpOptions)
      Disassociate a floating IP from a virtual network interface. This request disassociates the specified floating IP from the specified virtual network interface.
      Parameters:
      removeNetworkInterfaceFloatingIpOptions - the RemoveNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPReference> getNetworkInterfaceFloatingIp(GetNetworkInterfaceFloatingIpOptions getNetworkInterfaceFloatingIpOptions)
      Retrieve associated floating IP. This request retrieves a specified floating IP if it is associated with the virtual network interface specified in the URL.
      Parameters:
      getNetworkInterfaceFloatingIpOptions - the GetNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPReference

    • addNetworkInterfaceFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPReference> addNetworkInterfaceFloatingIp(AddNetworkInterfaceFloatingIpOptions addNetworkInterfaceFloatingIpOptions)
      Add an association between a floating IP and a virtual network interface. This request adds an association between the specified floating IP and the specified virtual network interface. If the virtual network interface has `enable_infrastructure_nat` set to `true`, no more than one floating IP can be associated, and network address translation is performed between the floating IP address and the virtual network interface's `primary_ip` address. If the virtual network interface has `enable_infrastructure_nat` set to `false`, packets are passed unchanged to/from the virtual network interface. The floating IP must: - be in the same `zone` as the virtual network interface - not currently be associated with another resource The virtual network interface's `target` must not currently be a file share mount target. A request body is not required, and if provided, is ignored.
      Parameters:
      addNetworkInterfaceFloatingIpOptions - the AddNetworkInterfaceFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPReference

    • listVirtualNetworkInterfaceIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPCollectionVirtualNetworkInterfaceContext> listVirtualNetworkInterfaceIps(ListVirtualNetworkInterfaceIpsOptions listVirtualNetworkInterfaceIpsOptions)
      List reserved IPs bound to a virtual network interface. This request lists reserved IPs bound to a virtual network interface.
      Parameters:
      listVirtualNetworkInterfaceIpsOptions - the ListVirtualNetworkInterfaceIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPCollectionVirtualNetworkInterfaceContext

    • removeVirtualNetworkInterfaceIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeVirtualNetworkInterfaceIp(RemoveVirtualNetworkInterfaceIpOptions removeVirtualNetworkInterfaceIpOptions)
      Unbind a reserved IP from a virtual network interface. This request unbinds the specified reserved IP from the specified virtual network interface. If the reserved IP has `auto_delete` set to `true`, the reserved IP will be deleted. The reserved IP for the `primary_ip` cannot be unbound.
      Parameters:
      removeVirtualNetworkInterfaceIpOptions - the RemoveVirtualNetworkInterfaceIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVirtualNetworkInterfaceIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPReference> getVirtualNetworkInterfaceIp(GetVirtualNetworkInterfaceIpOptions getVirtualNetworkInterfaceIpOptions)
      Retrieve bound reserved IP. This request retrieves the specified reserved IP address if it is bound to the virtual network interface specified in the URL.
      Parameters:
      getVirtualNetworkInterfaceIpOptions - the GetVirtualNetworkInterfaceIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPReference

    • addVirtualNetworkInterfaceIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPReference> addVirtualNetworkInterfaceIp(AddVirtualNetworkInterfaceIpOptions addVirtualNetworkInterfaceIpOptions)
      Bind a reserved IP to a virtual network interface. This request binds the specified reserved IP to the specified virtual network interface. The reserved IP must currently be unbound and in the primary IP's subnet. The virtual network interface's `target` must not currently be a file share mount target.
      Parameters:
      addVirtualNetworkInterfaceIpOptions - the AddVirtualNetworkInterfaceIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPReference

    • listClusterNetworkProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkProfileCollection> listClusterNetworkProfiles(ListClusterNetworkProfilesOptions listClusterNetworkProfilesOptions)
      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.
      Parameters:
      listClusterNetworkProfilesOptions - the ListClusterNetworkProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkProfileCollection

    • listClusterNetworkProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkProfileCollection> listClusterNetworkProfiles()
      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.
      Returns:
      a ServiceCall with a result of type ClusterNetworkProfileCollection

    • getClusterNetworkProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkProfile> getClusterNetworkProfile(GetClusterNetworkProfileOptions getClusterNetworkProfileOptions)
      Retrieve a cluster network profile. This request retrieves a single cluster network profile specified by the name in the URL.
      Parameters:
      getClusterNetworkProfileOptions - the GetClusterNetworkProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkProfile

    • listClusterNetworks

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkCollection> listClusterNetworks(ListClusterNetworksOptions listClusterNetworksOptions)
      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.
      Parameters:
      listClusterNetworksOptions - the ListClusterNetworksOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkCollection

    • listClusterNetworks

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkCollection> listClusterNetworks()
      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.
      Returns:
      a ServiceCall with a result of type ClusterNetworkCollection

    • createClusterNetwork

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetwork> createClusterNetwork(CreateClusterNetworkOptions createClusterNetworkOptions)
      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.
      Parameters:
      createClusterNetworkOptions - the CreateClusterNetworkOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetwork

    • listClusterNetworkInterfaces

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkInterfaceCollection> listClusterNetworkInterfaces(ListClusterNetworkInterfacesOptions listClusterNetworkInterfacesOptions)
      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.
      Parameters:
      listClusterNetworkInterfacesOptions - the ListClusterNetworkInterfacesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkInterfaceCollection

    • createClusterNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkInterface> createClusterNetworkInterface(CreateClusterNetworkInterfaceOptions createClusterNetworkInterfaceOptions)
      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.
      Parameters:
      createClusterNetworkInterfaceOptions - the CreateClusterNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkInterface

    • deleteClusterNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkInterface> deleteClusterNetworkInterface(DeleteClusterNetworkInterfaceOptions deleteClusterNetworkInterfaceOptions)
      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.
      Parameters:
      deleteClusterNetworkInterfaceOptions - the DeleteClusterNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkInterface

    • getClusterNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkInterface> getClusterNetworkInterface(GetClusterNetworkInterfaceOptions getClusterNetworkInterfaceOptions)
      Retrieve a cluster network interface. This request retrieves a single cluster network interface specified by the identifier in the URL.
      Parameters:
      getClusterNetworkInterfaceOptions - the GetClusterNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkInterface

    • updateClusterNetworkInterface

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkInterface> updateClusterNetworkInterface(UpdateClusterNetworkInterfaceOptions updateClusterNetworkInterfaceOptions)
      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.
      Parameters:
      updateClusterNetworkInterfaceOptions - the UpdateClusterNetworkInterfaceOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkInterface

    • listClusterNetworkSubnets

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetCollection> listClusterNetworkSubnets(ListClusterNetworkSubnetsOptions listClusterNetworkSubnetsOptions)
      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.
      Parameters:
      listClusterNetworkSubnetsOptions - the ListClusterNetworkSubnetsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetCollection

    • createClusterNetworkSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnet> createClusterNetworkSubnet(CreateClusterNetworkSubnetOptions createClusterNetworkSubnetOptions)
      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.
      Parameters:
      createClusterNetworkSubnetOptions - the CreateClusterNetworkSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnet

    • listClusterNetworkSubnetReservedIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetReservedIPCollection> listClusterNetworkSubnetReservedIps(ListClusterNetworkSubnetReservedIpsOptions listClusterNetworkSubnetReservedIpsOptions)
      List cluster network subnet reserved IPs. This request lists cluster network subnet reserved IPs in the cluster network.
      Parameters:
      listClusterNetworkSubnetReservedIpsOptions - the ListClusterNetworkSubnetReservedIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetReservedIPCollection

    • createClusterNetworkSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetReservedIP> createClusterNetworkSubnetReservedIp(CreateClusterNetworkSubnetReservedIpOptions createClusterNetworkSubnetReservedIpOptions)
      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.
      Parameters:
      createClusterNetworkSubnetReservedIpOptions - the CreateClusterNetworkSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetReservedIP

    • deleteClusterNetworkSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetReservedIP> deleteClusterNetworkSubnetReservedIp(DeleteClusterNetworkSubnetReservedIpOptions deleteClusterNetworkSubnetReservedIpOptions)
      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.
      Parameters:
      deleteClusterNetworkSubnetReservedIpOptions - the DeleteClusterNetworkSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetReservedIP

    • getClusterNetworkSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetReservedIP> getClusterNetworkSubnetReservedIp(GetClusterNetworkSubnetReservedIpOptions getClusterNetworkSubnetReservedIpOptions)
      Retrieve a cluster network subnet reserved IP. This request retrieves a single cluster network subnet reserved IP specified by the identifier in the URL.
      Parameters:
      getClusterNetworkSubnetReservedIpOptions - the GetClusterNetworkSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetReservedIP

    • updateClusterNetworkSubnetReservedIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnetReservedIP> updateClusterNetworkSubnetReservedIp(UpdateClusterNetworkSubnetReservedIpOptions updateClusterNetworkSubnetReservedIpOptions)
      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.
      Parameters:
      updateClusterNetworkSubnetReservedIpOptions - the UpdateClusterNetworkSubnetReservedIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnetReservedIP

    • deleteClusterNetworkSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnet> deleteClusterNetworkSubnet(DeleteClusterNetworkSubnetOptions deleteClusterNetworkSubnetOptions)
      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.
      Parameters:
      deleteClusterNetworkSubnetOptions - the DeleteClusterNetworkSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnet

    • getClusterNetworkSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnet> getClusterNetworkSubnet(GetClusterNetworkSubnetOptions getClusterNetworkSubnetOptions)
      Retrieve a cluster network subnet. This request retrieves a single cluster network subnet specified by the identifier in the URL.
      Parameters:
      getClusterNetworkSubnetOptions - the GetClusterNetworkSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnet

    • updateClusterNetworkSubnet

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetworkSubnet> updateClusterNetworkSubnet(UpdateClusterNetworkSubnetOptions updateClusterNetworkSubnetOptions)
      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.
      Parameters:
      updateClusterNetworkSubnetOptions - the UpdateClusterNetworkSubnetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetworkSubnet

    • deleteClusterNetwork

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetwork> deleteClusterNetwork(DeleteClusterNetworkOptions deleteClusterNetworkOptions)
      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.
      Parameters:
      deleteClusterNetworkOptions - the DeleteClusterNetworkOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetwork

    • getClusterNetwork

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetwork> getClusterNetwork(GetClusterNetworkOptions getClusterNetworkOptions)
      Retrieve a cluster network. This request retrieves a single cluster network specified by the identifier in the URL.
      Parameters:
      getClusterNetworkOptions - the GetClusterNetworkOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetwork

    • updateClusterNetwork

      public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterNetwork> updateClusterNetwork(UpdateClusterNetworkOptions updateClusterNetworkOptions)
      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.
      Parameters:
      updateClusterNetworkOptions - the UpdateClusterNetworkOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ClusterNetwork

    • listPublicGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGatewayCollection> listPublicGateways(ListPublicGatewaysOptions listPublicGatewaysOptions)
      List public gateways. This request lists public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.
      Parameters:
      listPublicGatewaysOptions - the ListPublicGatewaysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGatewayCollection

    • listPublicGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGatewayCollection> listPublicGateways()
      List public gateways. This request lists public gateways in the region. A public gateway is a virtual network device associated with a VPC, which allows access to the Internet. A public gateway resides in a zone and can be connected to subnets in the same zone only.
      Returns:
      a ServiceCall with a result of type PublicGatewayCollection

    • createPublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGateway> createPublicGateway(CreatePublicGatewayOptions createPublicGatewayOptions)
      Create a public gateway. This request creates a new public gateway from a public gateway prototype object. For this to succeed, the VPC must not already have a public gateway in the specified zone. If a floating IP is provided, it must be unbound. If a floating IP is not provided, one will be created and bound to the public gateway. Once a public gateway has been created, its floating IP cannot be unbound. A public gateway must be explicitly attached to each subnet it will provide connectivity for.
      Parameters:
      createPublicGatewayOptions - the CreatePublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGateway

    • deletePublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deletePublicGateway(DeletePublicGatewayOptions deletePublicGatewayOptions)
      Delete a public gateway. This request deletes a public gateway. This operation cannot be reversed. For this request to succeed, the public gateway must not be attached to any subnets. The public gateway's floating IP will be automatically unbound. If the floating IP was created when the public gateway was created, it will be deleted.
      Parameters:
      deletePublicGatewayOptions - the DeletePublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getPublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGateway> getPublicGateway(GetPublicGatewayOptions getPublicGatewayOptions)
      Retrieve a public gateway. This request retrieves a single public gateway specified by the identifier in the URL.
      Parameters:
      getPublicGatewayOptions - the GetPublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGateway

    • updatePublicGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PublicGateway> updatePublicGateway(UpdatePublicGatewayOptions updatePublicGatewayOptions)
      Update a public gateway. This request updates a public gateway's name.
      Parameters:
      updatePublicGatewayOptions - the UpdatePublicGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PublicGateway

    • listFloatingIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPCollection> listFloatingIps(ListFloatingIpsOptions listFloatingIpsOptions)
      List floating IPs. This request lists floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.
      Parameters:
      listFloatingIpsOptions - the ListFloatingIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIPCollection

    • listFloatingIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIPCollection> listFloatingIps()
      List floating IPs. This request lists floating IPs in the region. Floating IPs allow inbound and outbound traffic from the Internet to an instance.
      Returns:
      a ServiceCall with a result of type FloatingIPCollection

    • createFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> createFloatingIp(CreateFloatingIpOptions createFloatingIpOptions)
      Reserve a floating IP. This request reserves a new floating IP.
      Parameters:
      createFloatingIpOptions - the CreateFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • deleteFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteFloatingIp(DeleteFloatingIpOptions deleteFloatingIpOptions)
      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.
      Parameters:
      deleteFloatingIpOptions - the DeleteFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> getFloatingIp(GetFloatingIpOptions getFloatingIpOptions)
      Retrieve a floating IP. This request retrieves a single floating IP specified by the identifier in the URL.
      Parameters:
      getFloatingIpOptions - the GetFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • updateFloatingIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<FloatingIP> updateFloatingIp(UpdateFloatingIpOptions updateFloatingIpOptions)
      Update a floating IP. This request updates a floating IP's name and/or target.
      Parameters:
      updateFloatingIpOptions - the UpdateFloatingIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FloatingIP

    • listNetworkAcls

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLCollection> listNetworkAcls(ListNetworkAclsOptions listNetworkAclsOptions)
      List network ACLs. This request lists network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.
      Parameters:
      listNetworkAclsOptions - the ListNetworkAclsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACLCollection

    • listNetworkAcls

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLCollection> listNetworkAcls()
      List network ACLs. This request lists network ACLs in the region. A network ACL defines a set of packet filtering (5-tuple) rules for all traffic in and out of a subnet. Both allow and deny rules can be defined, and rules are stateless such that reverse traffic in response to allowed traffic is not automatically permitted.
      Returns:
      a ServiceCall with a result of type NetworkACLCollection

    • createNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACL> createNetworkAcl(CreateNetworkAclOptions createNetworkAclOptions)
      Create a network ACL. This request creates a new stateless network ACL from a network ACL prototype object. The prototype object is structured in the same way as a retrieved network ACL, and contains the information necessary to create the new network ACL.
      Parameters:
      createNetworkAclOptions - the CreateNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACL

    • deleteNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteNetworkAcl(DeleteNetworkAclOptions deleteNetworkAclOptions)
      Delete a network ACL. This request deletes a network ACL. This operation cannot be reversed. For this request to succeed, the network ACL must not be the default network ACL for any VPCs, and the network ACL must not be attached to any subnets.
      Parameters:
      deleteNetworkAclOptions - the DeleteNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACL> getNetworkAcl(GetNetworkAclOptions getNetworkAclOptions)
      Retrieve a network ACL. This request retrieves a single network ACL specified by the identifier in the URL.
      Parameters:
      getNetworkAclOptions - the GetNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACL

    • updateNetworkAcl

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACL> updateNetworkAcl(UpdateNetworkAclOptions updateNetworkAclOptions)
      Update a network ACL. This request updates a network ACL's name.
      Parameters:
      updateNetworkAclOptions - the UpdateNetworkAclOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACL

    • listNetworkAclRules

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLRuleCollection> listNetworkAclRules(ListNetworkAclRulesOptions listNetworkAclRulesOptions)
      List rules for a network ACL. This request lists rules for a network ACL. These rules can allow or deny traffic between a source CIDR block and a destination CIDR block over a particular protocol and port range.
      Parameters:
      listNetworkAclRulesOptions - the ListNetworkAclRulesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACLRuleCollection

    • createNetworkAclRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLRule> createNetworkAclRule(CreateNetworkAclRuleOptions createNetworkAclRuleOptions)
      Create a rule for a network ACL. This request creates a new rule from a network ACL rule prototype object. The prototype object is structured in the same way as a retrieved rule, and contains the information necessary to create the new rule.
      Parameters:
      createNetworkAclRuleOptions - the CreateNetworkAclRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACLRule

    • deleteNetworkAclRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteNetworkAclRule(DeleteNetworkAclRuleOptions deleteNetworkAclRuleOptions)
      Delete a network ACL rule. This request deletes a rule. This operation cannot be reversed.
      Parameters:
      deleteNetworkAclRuleOptions - the DeleteNetworkAclRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getNetworkAclRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLRule> getNetworkAclRule(GetNetworkAclRuleOptions getNetworkAclRuleOptions)
      Retrieve a network ACL rule. This request retrieves a single rule specified by the identifier in the URL.
      Parameters:
      getNetworkAclRuleOptions - the GetNetworkAclRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACLRule

    • updateNetworkAclRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<NetworkACLRule> updateNetworkAclRule(UpdateNetworkAclRuleOptions updateNetworkAclRuleOptions)
      Update a network ACL rule. This request updates a rule with the information in a provided rule patch. The rule patch object contains only the information to be updated. The request will fail if the provided patch includes properties that are not used by the rule's protocol.
      Parameters:
      updateNetworkAclRuleOptions - the UpdateNetworkAclRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type NetworkACLRule

    • listSecurityGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupCollection> listSecurityGroups(ListSecurityGroupsOptions listSecurityGroupsOptions)
      List security groups. This request lists security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.
      Parameters:
      listSecurityGroupsOptions - the ListSecurityGroupsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupCollection

    • listSecurityGroups

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupCollection> listSecurityGroups()
      List security groups. This request lists security groups in the region. Security groups provide a way to apply IP filtering rules to instances in the associated VPC. With security groups, all traffic is denied by default, and rules added to security groups define which traffic the security group permits. Security group rules are stateful such that reverse traffic in response to allowed traffic is automatically permitted.
      Returns:
      a ServiceCall with a result of type SecurityGroupCollection

    • createSecurityGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroup> createSecurityGroup(CreateSecurityGroupOptions createSecurityGroupOptions)
      Create a security group. This request creates a new security group from a security group prototype object. The prototype object is structured in the same way as a retrieved security group, and contains the information necessary to create the new security group. If security group rules are included in the prototype object, those rules will be added to the security group. Each security group is scoped to one VPC. Only resources in that VPC can be added to the security group.
      Parameters:
      createSecurityGroupOptions - the CreateSecurityGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroup

    • deleteSecurityGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSecurityGroup(DeleteSecurityGroupOptions deleteSecurityGroupOptions)
      Delete a security group. This request deletes a security group. A security group cannot be deleted if it is referenced by any security group targets or rules. Additionally, a VPC's default security group cannot be deleted. This operation cannot be reversed.
      Parameters:
      deleteSecurityGroupOptions - the DeleteSecurityGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSecurityGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroup> getSecurityGroup(GetSecurityGroupOptions getSecurityGroupOptions)
      Retrieve a security group. This request retrieves a single security group specified by the identifier in the URL path.
      Parameters:
      getSecurityGroupOptions - the GetSecurityGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroup

    • updateSecurityGroup

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroup> updateSecurityGroup(UpdateSecurityGroupOptions updateSecurityGroupOptions)
      Update a security group. This request updates a security group with the information provided in a security group patch object. The security group patch object is structured in the same way as a retrieved security group and contains only the information to be updated.
      Parameters:
      updateSecurityGroupOptions - the UpdateSecurityGroupOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroup

    • listSecurityGroupRules

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupRuleCollection> listSecurityGroupRules(ListSecurityGroupRulesOptions listSecurityGroupRulesOptions)
      List rules in a security group. This request lists rules in a security group. These rules define what traffic the security group permits. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted.
      Parameters:
      listSecurityGroupRulesOptions - the ListSecurityGroupRulesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupRuleCollection

    • createSecurityGroupRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupRule> createSecurityGroupRule(CreateSecurityGroupRuleOptions createSecurityGroupRuleOptions)
      Create a rule for a security group. This request creates a new security group rule from a security group rule prototype object. The prototype object is structured in the same way as a retrieved security group rule and contains the information necessary to create the rule. As part of creating a new rule in a security group, the rule is applied to all the networking interfaces in the security group. Rules specify which IP traffic a security group will allow. Security group rules are stateful, such that reverse traffic in response to allowed traffic is automatically permitted. A rule allowing inbound TCP traffic on port 80 also allows outbound TCP traffic on port 80 without the need for an additional rule.
      Parameters:
      createSecurityGroupRuleOptions - the CreateSecurityGroupRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupRule

    • deleteSecurityGroupRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSecurityGroupRule(DeleteSecurityGroupRuleOptions deleteSecurityGroupRuleOptions)
      Delete a security group rule. This request deletes a security group rule. This operation cannot be reversed. Removing a security group rule will not end existing connections allowed by that rule.
      Parameters:
      deleteSecurityGroupRuleOptions - the DeleteSecurityGroupRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSecurityGroupRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupRule> getSecurityGroupRule(GetSecurityGroupRuleOptions getSecurityGroupRuleOptions)
      Retrieve a security group rule. This request retrieves a single security group rule specified by the identifier in the URL path.
      Parameters:
      getSecurityGroupRuleOptions - the GetSecurityGroupRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupRule

    • updateSecurityGroupRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupRule> updateSecurityGroupRule(UpdateSecurityGroupRuleOptions updateSecurityGroupRuleOptions)
      Update a security group rule. This request updates a security group rule with the information in a provided rule patch object. The rule patch object contains only the information to be updated. The request will fail if the provided patch includes properties that are not used by the rule's protocol.
      Parameters:
      updateSecurityGroupRuleOptions - the UpdateSecurityGroupRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupRule

    • listSecurityGroupTargets

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupTargetCollection> listSecurityGroupTargets(ListSecurityGroupTargetsOptions listSecurityGroupTargetsOptions)
      List targets associated with a security group. This request lists targets associated with a security group, to which the rules in the security group are applied.
      Parameters:
      listSecurityGroupTargetsOptions - the ListSecurityGroupTargetsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupTargetCollection

    • deleteSecurityGroupTargetBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteSecurityGroupTargetBinding(DeleteSecurityGroupTargetBindingOptions deleteSecurityGroupTargetBindingOptions)
      Remove a target from a security group. This request removes a target from a security group. For this request to succeed, the target must be attached to at least one other security group. The specified target identifier can be: - A bare metal server network interface identifier - A virtual network interface identifier - A VPN server identifier - A load balancer identifier - An endpoint gateway identifier - An instance network interface identifier Security groups are stateful, so any changes to a target's security groups are applied to new connections. Existing connections are not affected.
      Parameters:
      deleteSecurityGroupTargetBindingOptions - the DeleteSecurityGroupTargetBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getSecurityGroupTarget

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupTargetReference> getSecurityGroupTarget(GetSecurityGroupTargetOptions getSecurityGroupTargetOptions)
      Retrieve a security group target. This request retrieves a single target specified by the identifier in the URL path. The target must be an existing target of the security group.
      Parameters:
      getSecurityGroupTargetOptions - the GetSecurityGroupTargetOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupTargetReference

    • createSecurityGroupTargetBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<SecurityGroupTargetReference> createSecurityGroupTargetBinding(CreateSecurityGroupTargetBindingOptions createSecurityGroupTargetBindingOptions)
      Add a target to a security group. This request adds a resource to an existing security group. The specified target identifier can be: - A bare metal server network interface identifier - A virtual network interface identifier - A VPN server identifier - A load balancer identifier - An endpoint gateway identifier - An instance network interface identifier When a target is added to a security group, the security group rules are applied to the target. A request body is not required, and if provided, is ignored.
      Parameters:
      createSecurityGroupTargetBindingOptions - the CreateSecurityGroupTargetBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type SecurityGroupTargetReference

    • listIkePolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicyCollection> listIkePolicies(ListIkePoliciesOptions listIkePoliciesOptions)
      List IKE policies. This request lists IKE policies in the region.
      Parameters:
      listIkePoliciesOptions - the ListIkePoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IKEPolicyCollection

    • listIkePolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicyCollection> listIkePolicies()
      List IKE policies. This request lists IKE policies in the region.
      Returns:
      a ServiceCall with a result of type IKEPolicyCollection

    • createIkePolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicy> createIkePolicy(CreateIkePolicyOptions createIkePolicyOptions)
      Create an IKE policy. This request creates a new IKE policy.
      Parameters:
      createIkePolicyOptions - the CreateIkePolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IKEPolicy

    • deleteIkePolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteIkePolicy(DeleteIkePolicyOptions deleteIkePolicyOptions)
      Delete an IKE policy. This request deletes an IKE policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.
      Parameters:
      deleteIkePolicyOptions - the DeleteIkePolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getIkePolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicy> getIkePolicy(GetIkePolicyOptions getIkePolicyOptions)
      Retrieve an IKE policy. This request retrieves a single IKE policy specified by the identifier in the URL.
      Parameters:
      getIkePolicyOptions - the GetIkePolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IKEPolicy

    • updateIkePolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicy> updateIkePolicy(UpdateIkePolicyOptions updateIkePolicyOptions)
      Update an IKE policy. This request updates the properties of an existing IKE policy.
      Parameters:
      updateIkePolicyOptions - the UpdateIkePolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IKEPolicy

    • listIkePolicyConnections

      public com.ibm.cloud.sdk.core.http.ServiceCall<IKEPolicyConnectionCollection> listIkePolicyConnections(ListIkePolicyConnectionsOptions listIkePolicyConnectionsOptions)
      List VPN gateway connections that use a specified IKE policy. This request lists VPN gateway connections that use a IKE policy.
      Parameters:
      listIkePolicyConnectionsOptions - the ListIkePolicyConnectionsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IKEPolicyConnectionCollection

    • listIpsecPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicyCollection> listIpsecPolicies(ListIpsecPoliciesOptions listIpsecPoliciesOptions)
      List IPsec policies. This request lists IPsec policies in the region.
      Parameters:
      listIpsecPoliciesOptions - the ListIpsecPoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IPsecPolicyCollection

    • listIpsecPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicyCollection> listIpsecPolicies()
      List IPsec policies. This request lists IPsec policies in the region.
      Returns:
      a ServiceCall with a result of type IPsecPolicyCollection

    • createIpsecPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicy> createIpsecPolicy(CreateIpsecPolicyOptions createIpsecPolicyOptions)
      Create an IPsec policy. This request creates a new IPsec policy.
      Parameters:
      createIpsecPolicyOptions - the CreateIpsecPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IPsecPolicy

    • deleteIpsecPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteIpsecPolicy(DeleteIpsecPolicyOptions deleteIpsecPolicyOptions)
      Delete an IPsec policy. This request deletes an IPsec policy. This operation cannot be reversed. For this request to succeed, there must not be any VPN gateway connections using this policy.
      Parameters:
      deleteIpsecPolicyOptions - the DeleteIpsecPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getIpsecPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicy> getIpsecPolicy(GetIpsecPolicyOptions getIpsecPolicyOptions)
      Retrieve an IPsec policy. This request retrieves a single IPsec policy specified by the identifier in the URL.
      Parameters:
      getIpsecPolicyOptions - the GetIpsecPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IPsecPolicy

    • updateIpsecPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicy> updateIpsecPolicy(UpdateIpsecPolicyOptions updateIpsecPolicyOptions)
      Update an IPsec policy. This request updates the properties of an existing IPsec policy.
      Parameters:
      updateIpsecPolicyOptions - the UpdateIpsecPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IPsecPolicy

    • listIpsecPolicyConnections

      public com.ibm.cloud.sdk.core.http.ServiceCall<IPsecPolicyConnectionCollection> listIpsecPolicyConnections(ListIpsecPolicyConnectionsOptions listIpsecPolicyConnectionsOptions)
      List VPN gateway connections that use a specified IPsec policy. This request lists VPN gateway connections that use a IPsec policy.
      Parameters:
      listIpsecPolicyConnectionsOptions - the ListIpsecPolicyConnectionsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type IPsecPolicyConnectionCollection

    • listVpnGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayCollection> listVpnGateways(ListVpnGatewaysOptions listVpnGatewaysOptions)
      List VPN gateways. This request lists VPN gateways in the region.
      Parameters:
      listVpnGatewaysOptions - the ListVpnGatewaysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayCollection

    • listVpnGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayCollection> listVpnGateways()
      List VPN gateways. This request lists VPN gateways in the region.
      Returns:
      a ServiceCall with a result of type VPNGatewayCollection

    • createVpnGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGateway> createVpnGateway(CreateVpnGatewayOptions createVpnGatewayOptions)
      Create a VPN gateway. This request creates a new VPN gateway.
      Parameters:
      createVpnGatewayOptions - the CreateVpnGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGateway

    • deleteVpnGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpnGateway(DeleteVpnGatewayOptions deleteVpnGatewayOptions)
      Delete a VPN gateway. This request deletes a VPN gateway. This operation cannot be reversed. For this request to succeed, the VPN gateway must not have a `status` of `pending`, and there must not be any VPC routes using the VPN gateway's connections as a next hop.
      Parameters:
      deleteVpnGatewayOptions - the DeleteVpnGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpnGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGateway> getVpnGateway(GetVpnGatewayOptions getVpnGatewayOptions)
      Retrieve a VPN gateway. This request retrieves a single VPN gateway specified by the identifier in the URL.
      Parameters:
      getVpnGatewayOptions - the GetVpnGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGateway

    • updateVpnGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGateway> updateVpnGateway(UpdateVpnGatewayOptions updateVpnGatewayOptions)
      Update a VPN gateway. This request updates the properties of an existing VPN gateway.
      Parameters:
      updateVpnGatewayOptions - the UpdateVpnGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGateway

    • listVpnGatewayConnections

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnectionCollection> listVpnGatewayConnections(ListVpnGatewayConnectionsOptions listVpnGatewayConnectionsOptions)
      List connections of a VPN gateway. This request lists connections of a VPN gateway.
      Parameters:
      listVpnGatewayConnectionsOptions - the ListVpnGatewayConnectionsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnectionCollection

    • createVpnGatewayConnection

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnection> createVpnGatewayConnection(CreateVpnGatewayConnectionOptions createVpnGatewayConnectionOptions)
      Create a connection for a VPN gateway. This request creates a new VPN gateway connection.
      Parameters:
      createVpnGatewayConnectionOptions - the CreateVpnGatewayConnectionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnection

    • deleteVpnGatewayConnection

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpnGatewayConnection(DeleteVpnGatewayConnectionOptions deleteVpnGatewayConnectionOptions)
      Delete a VPN gateway connection. This request deletes a VPN gateway connection. This operation cannot be reversed. For this request to succeed, there must not be VPC routes using this VPN connection as a next hop.
      Parameters:
      deleteVpnGatewayConnectionOptions - the DeleteVpnGatewayConnectionOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpnGatewayConnection

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnection> getVpnGatewayConnection(GetVpnGatewayConnectionOptions getVpnGatewayConnectionOptions)
      Retrieve a VPN gateway connection. This request retrieves a single VPN gateway connection specified by the identifier in the URL.
      Parameters:
      getVpnGatewayConnectionOptions - the GetVpnGatewayConnectionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnection

    • updateVpnGatewayConnection

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnection> updateVpnGatewayConnection(UpdateVpnGatewayConnectionOptions updateVpnGatewayConnectionOptions)
      Update a VPN gateway connection. This request updates the properties of an existing VPN gateway connection.
      Parameters:
      updateVpnGatewayConnectionOptions - the UpdateVpnGatewayConnectionOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnection

    • listVpnGatewayConnectionsLocalCidrs

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnectionCIDRs> listVpnGatewayConnectionsLocalCidrs(ListVpnGatewayConnectionsLocalCidrsOptions listVpnGatewayConnectionsLocalCidrsOptions)
      List local CIDRs for a VPN gateway connection. This request lists local CIDRs for a VPN gateway connection. This request is only supported for policy mode VPN gateways.
      Parameters:
      listVpnGatewayConnectionsLocalCidrsOptions - the ListVpnGatewayConnectionsLocalCidrsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnectionCIDRs

    • removeVpnGatewayConnectionsLocalCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeVpnGatewayConnectionsLocalCidr(RemoveVpnGatewayConnectionsLocalCidrOptions removeVpnGatewayConnectionsLocalCidrOptions)
      Remove a local CIDR from a VPN gateway connection. This request removes a CIDR from a VPN gateway connection. This request is only supported for policy mode VPN gateways.
      Parameters:
      removeVpnGatewayConnectionsLocalCidrOptions - the RemoveVpnGatewayConnectionsLocalCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • checkVpnGatewayConnectionsLocalCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> checkVpnGatewayConnectionsLocalCidr(CheckVpnGatewayConnectionsLocalCidrOptions checkVpnGatewayConnectionsLocalCidrOptions)
      Check if the specified local CIDR exists on a VPN gateway connection. This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise. This request is only supported for policy mode VPN gateways.
      Parameters:
      checkVpnGatewayConnectionsLocalCidrOptions - the CheckVpnGatewayConnectionsLocalCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • addVpnGatewayConnectionsLocalCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> addVpnGatewayConnectionsLocalCidr(AddVpnGatewayConnectionsLocalCidrOptions addVpnGatewayConnectionsLocalCidrOptions)
      Set a local CIDR on a VPN gateway connection. This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored. This request is only supported for policy mode VPN gateways.
      Parameters:
      addVpnGatewayConnectionsLocalCidrOptions - the AddVpnGatewayConnectionsLocalCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listVpnGatewayConnectionsPeerCidrs

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNGatewayConnectionCIDRs> listVpnGatewayConnectionsPeerCidrs(ListVpnGatewayConnectionsPeerCidrsOptions listVpnGatewayConnectionsPeerCidrsOptions)
      List peer CIDRs for a VPN gateway connection. This request lists peer CIDRs for a VPN gateway connection. This request is only supported for policy mode VPN gateways.
      Parameters:
      listVpnGatewayConnectionsPeerCidrsOptions - the ListVpnGatewayConnectionsPeerCidrsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNGatewayConnectionCIDRs

    • removeVpnGatewayConnectionsPeerCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeVpnGatewayConnectionsPeerCidr(RemoveVpnGatewayConnectionsPeerCidrOptions removeVpnGatewayConnectionsPeerCidrOptions)
      Remove a peer CIDR from a VPN gateway connection. This request removes a CIDR from a VPN gateway connection. This request is only supported for policy mode VPN gateways.
      Parameters:
      removeVpnGatewayConnectionsPeerCidrOptions - the RemoveVpnGatewayConnectionsPeerCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • checkVpnGatewayConnectionsPeerCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> checkVpnGatewayConnectionsPeerCidr(CheckVpnGatewayConnectionsPeerCidrOptions checkVpnGatewayConnectionsPeerCidrOptions)
      Check if the specified peer CIDR exists on a VPN gateway connection. This request succeeds if a CIDR exists on the specified VPN gateway connection, and fails otherwise. This request is only supported for policy mode VPN gateways.
      Parameters:
      checkVpnGatewayConnectionsPeerCidrOptions - the CheckVpnGatewayConnectionsPeerCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • addVpnGatewayConnectionsPeerCidr

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> addVpnGatewayConnectionsPeerCidr(AddVpnGatewayConnectionsPeerCidrOptions addVpnGatewayConnectionsPeerCidrOptions)
      Set a peer CIDR on a VPN gateway connection. This request adds the specified CIDR to the specified VPN gateway connection. This request succeeds if the specified CIDR already exists. A request body is not required, and if provided, is ignored. This request is only supported for policy mode VPN gateways.
      Parameters:
      addVpnGatewayConnectionsPeerCidrOptions - the AddVpnGatewayConnectionsPeerCidrOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listVpnServers

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerCollection> listVpnServers(ListVpnServersOptions listVpnServersOptions)
      List VPN servers. This request lists VPN servers.
      Parameters:
      listVpnServersOptions - the ListVpnServersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerCollection

    • listVpnServers

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerCollection> listVpnServers()
      List VPN servers. This request lists VPN servers.
      Returns:
      a ServiceCall with a result of type VPNServerCollection

    • createVpnServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServer> createVpnServer(CreateVpnServerOptions createVpnServerOptions)
      Create a VPN server. This request creates a new VPN server.
      Parameters:
      createVpnServerOptions - the CreateVpnServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServer

    • deleteVpnServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpnServer(DeleteVpnServerOptions deleteVpnServerOptions)
      Delete a VPN server. This request deletes a VPN server. This operation cannot be reversed.
      Parameters:
      deleteVpnServerOptions - the DeleteVpnServerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpnServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServer> getVpnServer(GetVpnServerOptions getVpnServerOptions)
      Retrieve a VPN server. This request retrieves a single VPN server specified by the identifier in the URL.
      Parameters:
      getVpnServerOptions - the GetVpnServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServer

    • updateVpnServer

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServer> updateVpnServer(UpdateVpnServerOptions updateVpnServerOptions)
      Update a VPN server. This request updates the properties of an existing VPN server. Any updates other than to `name` will cause all connected VPN clients to be disconnected.
      Parameters:
      updateVpnServerOptions - the UpdateVpnServerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServer

    • getVpnServerClientConfiguration

      public com.ibm.cloud.sdk.core.http.ServiceCall<String> getVpnServerClientConfiguration(GetVpnServerClientConfigurationOptions getVpnServerClientConfigurationOptions)
      Retrieve client configuration. This request retrieves OpenVPN client configuration on a single VPN server specified by the identifier in the URL. This configuration includes directives compatible with OpenVPN releases 2.4 and 2.5.
      Parameters:
      getVpnServerClientConfigurationOptions - the GetVpnServerClientConfigurationOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type String

    • listVpnServerClients

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerClientCollection> listVpnServerClients(ListVpnServerClientsOptions listVpnServerClientsOptions)
      List VPN clients for a VPN server. This request retrieves connected VPN clients, and any disconnected VPN clients that the VPN server has not yet deleted based on its auto-deletion policy.
      Parameters:
      listVpnServerClientsOptions - the ListVpnServerClientsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerClientCollection

    • deleteVpnServerClient

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpnServerClient(DeleteVpnServerClientOptions deleteVpnServerClientOptions)
      Delete a VPN client. This request disconnects and deletes the VPN client from the VPN server. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.
      Parameters:
      deleteVpnServerClientOptions - the DeleteVpnServerClientOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpnServerClient

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerClient> getVpnServerClient(GetVpnServerClientOptions getVpnServerClientOptions)
      Retrieve a VPN client. This request retrieves a single VPN client specified by the identifier in the URL.
      Parameters:
      getVpnServerClientOptions - the GetVpnServerClientOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerClient

    • disconnectVpnClient

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> disconnectVpnClient(DisconnectVpnClientOptions disconnectVpnClientOptions)
      Disconnect a VPN client. This request disconnects the specified VPN client, and deletes the client according to the VPN server's auto-deletion policy. The VPN client may reconnect unless its authentication permissions for the configured authentication methods (such as its client certificate) have been revoked.
      Parameters:
      disconnectVpnClientOptions - the DisconnectVpnClientOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • listVpnServerRoutes

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerRouteCollection> listVpnServerRoutes(ListVpnServerRoutesOptions listVpnServerRoutesOptions)
      List VPN routes for a VPN server. This request lists VPN routes in a VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.
      Parameters:
      listVpnServerRoutesOptions - the ListVpnServerRoutesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerRouteCollection

    • createVpnServerRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerRoute> createVpnServerRoute(CreateVpnServerRouteOptions createVpnServerRouteOptions)
      Create a VPN route for a VPN server. This request creates a new VPN route in the VPN server. All VPN routes are provided to the VPN client when the connection is established. Packets received from the VPN client will be dropped by the VPN server if there is no VPN route matching their specified destinations. All VPN routes must be unique within the VPN server.
      Parameters:
      createVpnServerRouteOptions - the CreateVpnServerRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerRoute

    • deleteVpnServerRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteVpnServerRoute(DeleteVpnServerRouteOptions deleteVpnServerRouteOptions)
      Delete a VPN route. This request deletes a VPN route. This operation cannot be reversed.
      Parameters:
      deleteVpnServerRouteOptions - the DeleteVpnServerRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getVpnServerRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerRoute> getVpnServerRoute(GetVpnServerRouteOptions getVpnServerRouteOptions)
      Retrieve a VPN route. This request retrieves a single VPN route specified by the identifier in the URL.
      Parameters:
      getVpnServerRouteOptions - the GetVpnServerRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerRoute

    • updateVpnServerRoute

      public com.ibm.cloud.sdk.core.http.ServiceCall<VPNServerRoute> updateVpnServerRoute(UpdateVpnServerRouteOptions updateVpnServerRouteOptions)
      Update a VPN route. This request updates a VPN route with the information in a provided VPN route patch. The VPN route patch object is structured in the same way as a retrieved VPN route and contains only the information to be updated.
      Parameters:
      updateVpnServerRouteOptions - the UpdateVpnServerRouteOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type VPNServerRoute

    • listLoadBalancerProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerProfileCollection> listLoadBalancerProfiles(ListLoadBalancerProfilesOptions listLoadBalancerProfilesOptions)
      List load balancer profiles. This request lists load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.
      Parameters:
      listLoadBalancerProfilesOptions - the ListLoadBalancerProfilesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerProfileCollection

    • listLoadBalancerProfiles

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerProfileCollection> listLoadBalancerProfiles()
      List load balancer profiles. This request lists load balancer profiles available in the region. A load balancer profile specifies the performance characteristics and pricing model for a load balancer.
      Returns:
      a ServiceCall with a result of type LoadBalancerProfileCollection

    • getLoadBalancerProfile

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerProfile> getLoadBalancerProfile(GetLoadBalancerProfileOptions getLoadBalancerProfileOptions)
      Retrieve a load balancer profile. This request retrieves a load balancer profile specified by the name in the URL.
      Parameters:
      getLoadBalancerProfileOptions - the GetLoadBalancerProfileOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerProfile

    • listLoadBalancers

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerCollection> listLoadBalancers(ListLoadBalancersOptions listLoadBalancersOptions)
      List load balancers. This request lists load balancers in the region.
      Parameters:
      listLoadBalancersOptions - the ListLoadBalancersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerCollection

    • listLoadBalancers

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerCollection> listLoadBalancers()
      List load balancers. This request lists load balancers in the region.
      Returns:
      a ServiceCall with a result of type LoadBalancerCollection

    • createLoadBalancer

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancer> createLoadBalancer(CreateLoadBalancerOptions createLoadBalancerOptions)
      Create a load balancer. This request creates and provisions a new load balancer.
      Parameters:
      createLoadBalancerOptions - the CreateLoadBalancerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancer

    • deleteLoadBalancer

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancer(DeleteLoadBalancerOptions deleteLoadBalancerOptions)
      Delete a load balancer. This request deletes a load balancer. This operation cannot be reversed. A load balancer cannot be deleted if its `provisioning_status` is `delete_pending` or it is referenced by a resource.
      Parameters:
      deleteLoadBalancerOptions - the DeleteLoadBalancerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancer

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancer> getLoadBalancer(GetLoadBalancerOptions getLoadBalancerOptions)
      Retrieve a load balancer. This request retrieves a single load balancer specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerOptions - the GetLoadBalancerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancer

    • updateLoadBalancer

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancer> updateLoadBalancer(UpdateLoadBalancerOptions updateLoadBalancerOptions)
      Update a load balancer. This request updates a load balancer with the information in a provided load balancer patch. The load balancer patch object is structured in the same way as a retrieved load balancer and contains only the information to be updated. A load balancer can only be updated if its `provisioning_status` is `active`.
      Parameters:
      updateLoadBalancerOptions - the UpdateLoadBalancerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancer

    • getLoadBalancerStatistics

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerStatistics> getLoadBalancerStatistics(GetLoadBalancerStatisticsOptions getLoadBalancerStatisticsOptions)
      List statistics of a load balancer. This request lists statistics of a load balancer.
      Parameters:
      getLoadBalancerStatisticsOptions - the GetLoadBalancerStatisticsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerStatistics

    • listLoadBalancerListeners

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerCollection> listLoadBalancerListeners(ListLoadBalancerListenersOptions listLoadBalancerListenersOptions)
      List listeners for a load balancer. This request lists listeners for a load balancer.
      Parameters:
      listLoadBalancerListenersOptions - the ListLoadBalancerListenersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerCollection

    • createLoadBalancerListener

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListener> createLoadBalancerListener(CreateLoadBalancerListenerOptions createLoadBalancerListenerOptions)
      Create a listener for a load balancer. This request creates a new listener for a load balancer.
      Parameters:
      createLoadBalancerListenerOptions - the CreateLoadBalancerListenerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListener

    • deleteLoadBalancerListener

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancerListener(DeleteLoadBalancerListenerOptions deleteLoadBalancerListenerOptions)
      Delete a load balancer listener. This request deletes a load balancer listener. This operation cannot be reversed. For this operation to succeed, the listener must not be the target of another load balancer listener.
      Parameters:
      deleteLoadBalancerListenerOptions - the DeleteLoadBalancerListenerOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancerListener

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListener> getLoadBalancerListener(GetLoadBalancerListenerOptions getLoadBalancerListenerOptions)
      Retrieve a load balancer listener. This request retrieves a single listener specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerListenerOptions - the GetLoadBalancerListenerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListener

    • updateLoadBalancerListener

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListener> updateLoadBalancerListener(UpdateLoadBalancerListenerOptions updateLoadBalancerListenerOptions)
      Update a load balancer listener. This request updates a load balancer listener from a listener patch.
      Parameters:
      updateLoadBalancerListenerOptions - the UpdateLoadBalancerListenerOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListener

    • listLoadBalancerListenerPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicyCollection> listLoadBalancerListenerPolicies(ListLoadBalancerListenerPoliciesOptions listLoadBalancerListenerPoliciesOptions)
      List policies for a load balancer listener. This request lists policies for a load balancer listener. A policy consists of rules to match against each incoming request, and an action to apply to the request if a rule matches.
      Parameters:
      listLoadBalancerListenerPoliciesOptions - the ListLoadBalancerListenerPoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicyCollection

    • createLoadBalancerListenerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicy> createLoadBalancerListenerPolicy(CreateLoadBalancerListenerPolicyOptions createLoadBalancerListenerPolicyOptions)
      Create a policy for a load balancer listener. This request creates a new policy from a load balancer listener policy object. The prototype object is structured in the same way as a retrieved policy, and contains the information necessary to create the new policy. For this request to succeed, the listener must have a `protocol` of `http` or `https`.
      Parameters:
      createLoadBalancerListenerPolicyOptions - the CreateLoadBalancerListenerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicy

    • deleteLoadBalancerListenerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancerListenerPolicy(DeleteLoadBalancerListenerPolicyOptions deleteLoadBalancerListenerPolicyOptions)
      Delete a load balancer listener policy. Deletes a policy of the load balancer listener. This operation cannot be reversed.
      Parameters:
      deleteLoadBalancerListenerPolicyOptions - the DeleteLoadBalancerListenerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancerListenerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicy> getLoadBalancerListenerPolicy(GetLoadBalancerListenerPolicyOptions getLoadBalancerListenerPolicyOptions)
      Retrieve a load balancer listener policy. Retrieve a single policy specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerListenerPolicyOptions - the GetLoadBalancerListenerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicy

    • updateLoadBalancerListenerPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicy> updateLoadBalancerListenerPolicy(UpdateLoadBalancerListenerPolicyOptions updateLoadBalancerListenerPolicyOptions)
      Update a load balancer listener policy. This request updates a load balancer listener policy with the information in a provided policy patch. The policy patch object is structured in the same way as a retrieved policy and contains only the information to be updated.
      Parameters:
      updateLoadBalancerListenerPolicyOptions - the UpdateLoadBalancerListenerPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicy

    • listLoadBalancerListenerPolicyRules

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicyRuleCollection> listLoadBalancerListenerPolicyRules(ListLoadBalancerListenerPolicyRulesOptions listLoadBalancerListenerPolicyRulesOptions)
      List rules of a load balancer listener policy. This request lists rules of a load balancer listener policy.
      Parameters:
      listLoadBalancerListenerPolicyRulesOptions - the ListLoadBalancerListenerPolicyRulesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicyRuleCollection

    • createLoadBalancerListenerPolicyRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicyRule> createLoadBalancerListenerPolicyRule(CreateLoadBalancerListenerPolicyRuleOptions createLoadBalancerListenerPolicyRuleOptions)
      Create a rule for a load balancer listener policy. Creates a new rule for the load balancer listener policy.
      Parameters:
      createLoadBalancerListenerPolicyRuleOptions - the CreateLoadBalancerListenerPolicyRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicyRule

    • deleteLoadBalancerListenerPolicyRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancerListenerPolicyRule(DeleteLoadBalancerListenerPolicyRuleOptions deleteLoadBalancerListenerPolicyRuleOptions)
      Delete a load balancer listener policy rule. Deletes a rule from the load balancer listener policy. This operation cannot be reversed.
      Parameters:
      deleteLoadBalancerListenerPolicyRuleOptions - the DeleteLoadBalancerListenerPolicyRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancerListenerPolicyRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicyRule> getLoadBalancerListenerPolicyRule(GetLoadBalancerListenerPolicyRuleOptions getLoadBalancerListenerPolicyRuleOptions)
      Retrieve a load balancer listener policy rule. Retrieves a single rule specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerListenerPolicyRuleOptions - the GetLoadBalancerListenerPolicyRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicyRule

    • updateLoadBalancerListenerPolicyRule

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerListenerPolicyRule> updateLoadBalancerListenerPolicyRule(UpdateLoadBalancerListenerPolicyRuleOptions updateLoadBalancerListenerPolicyRuleOptions)
      Update a load balancer listener policy rule. Updates a rule of the load balancer listener policy.
      Parameters:
      updateLoadBalancerListenerPolicyRuleOptions - the UpdateLoadBalancerListenerPolicyRuleOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerListenerPolicyRule

    • listLoadBalancerPools

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolCollection> listLoadBalancerPools(ListLoadBalancerPoolsOptions listLoadBalancerPoolsOptions)
      List pools of a load balancer. This request lists pools of a load balancer.
      Parameters:
      listLoadBalancerPoolsOptions - the ListLoadBalancerPoolsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolCollection

    • createLoadBalancerPool

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPool> createLoadBalancerPool(CreateLoadBalancerPoolOptions createLoadBalancerPoolOptions)
      Create a load balancer pool. This request creates a new pool from a pool prototype object.
      Parameters:
      createLoadBalancerPoolOptions - the CreateLoadBalancerPoolOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPool

    • deleteLoadBalancerPool

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancerPool(DeleteLoadBalancerPoolOptions deleteLoadBalancerPoolOptions)
      Delete a load balancer pool. This request deletes a load balancer pool. This operation cannot be reversed. The pool must not currently be the default pool for any listener in the load balancer.
      Parameters:
      deleteLoadBalancerPoolOptions - the DeleteLoadBalancerPoolOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancerPool

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPool> getLoadBalancerPool(GetLoadBalancerPoolOptions getLoadBalancerPoolOptions)
      Retrieve a load balancer pool. This request retrieves a single pool specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerPoolOptions - the GetLoadBalancerPoolOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPool

    • updateLoadBalancerPool

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPool> updateLoadBalancerPool(UpdateLoadBalancerPoolOptions updateLoadBalancerPoolOptions)
      Update a load balancer pool. This request updates a load balancer pool from a pool patch.
      Parameters:
      updateLoadBalancerPoolOptions - the UpdateLoadBalancerPoolOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPool

    • listLoadBalancerPoolMembers

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolMemberCollection> listLoadBalancerPoolMembers(ListLoadBalancerPoolMembersOptions listLoadBalancerPoolMembersOptions)
      List members of a load balancer pool. This request lists members of a load balancer pool.
      Parameters:
      listLoadBalancerPoolMembersOptions - the ListLoadBalancerPoolMembersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolMemberCollection

    • createLoadBalancerPoolMember

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolMember> createLoadBalancerPoolMember(CreateLoadBalancerPoolMemberOptions createLoadBalancerPoolMemberOptions)
      Create a member in a load balancer pool. This request creates a new member and adds the member to the pool.
      Parameters:
      createLoadBalancerPoolMemberOptions - the CreateLoadBalancerPoolMemberOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolMember

    • replaceLoadBalancerPoolMembers

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolMemberCollection> replaceLoadBalancerPoolMembers(ReplaceLoadBalancerPoolMembersOptions replaceLoadBalancerPoolMembersOptions)
      Replace load balancer pool members. This request replaces the existing members of the load balancer pool with new members created from the collection of member prototype objects.
      Parameters:
      replaceLoadBalancerPoolMembersOptions - the ReplaceLoadBalancerPoolMembersOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolMemberCollection

    • deleteLoadBalancerPoolMember

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteLoadBalancerPoolMember(DeleteLoadBalancerPoolMemberOptions deleteLoadBalancerPoolMemberOptions)
      Delete a load balancer pool member. This request deletes a member from the pool. This operation cannot be reversed.
      Parameters:
      deleteLoadBalancerPoolMemberOptions - the DeleteLoadBalancerPoolMemberOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getLoadBalancerPoolMember

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolMember> getLoadBalancerPoolMember(GetLoadBalancerPoolMemberOptions getLoadBalancerPoolMemberOptions)
      Retrieve a load balancer pool member. This request retrieves a single member specified by the identifier in the URL path.
      Parameters:
      getLoadBalancerPoolMemberOptions - the GetLoadBalancerPoolMemberOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolMember

    • updateLoadBalancerPoolMember

      public com.ibm.cloud.sdk.core.http.ServiceCall<LoadBalancerPoolMember> updateLoadBalancerPoolMember(UpdateLoadBalancerPoolMemberOptions updateLoadBalancerPoolMemberOptions)
      Update a load balancer pool member. This request updates an existing member from a member patch.
      Parameters:
      updateLoadBalancerPoolMemberOptions - the UpdateLoadBalancerPoolMemberOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type LoadBalancerPoolMember

    • listEndpointGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointGatewayCollection> listEndpointGateways(ListEndpointGatewaysOptions listEndpointGatewaysOptions)
      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.
      Parameters:
      listEndpointGatewaysOptions - the ListEndpointGatewaysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type EndpointGatewayCollection

    • listEndpointGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointGatewayCollection> listEndpointGateways()
      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.
      Returns:
      a ServiceCall with a result of type EndpointGatewayCollection

    • createEndpointGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointGateway> createEndpointGateway(CreateEndpointGatewayOptions createEndpointGatewayOptions)
      Create an endpoint gateway. This request creates a new endpoint gateway. An endpoint gateway maps one or more reserved IPs in a VPC to a target outside the VPC.
      Parameters:
      createEndpointGatewayOptions - the CreateEndpointGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type EndpointGateway

    • listEndpointGatewayIps

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIPCollectionEndpointGatewayContext> listEndpointGatewayIps(ListEndpointGatewayIpsOptions listEndpointGatewayIpsOptions)
      List reserved IPs bound to an endpoint gateway. This request lists reserved IPs bound to an endpoint gateway.
      Parameters:
      listEndpointGatewayIpsOptions - the ListEndpointGatewayIpsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIPCollectionEndpointGatewayContext

    • removeEndpointGatewayIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> removeEndpointGatewayIp(RemoveEndpointGatewayIpOptions removeEndpointGatewayIpOptions)
      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.
      Parameters:
      removeEndpointGatewayIpOptions - the RemoveEndpointGatewayIpOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getEndpointGatewayIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> getEndpointGatewayIp(GetEndpointGatewayIpOptions getEndpointGatewayIpOptions)
      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.
      Parameters:
      getEndpointGatewayIpOptions - the GetEndpointGatewayIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • addEndpointGatewayIp

      public com.ibm.cloud.sdk.core.http.ServiceCall<ReservedIP> addEndpointGatewayIp(AddEndpointGatewayIpOptions addEndpointGatewayIpOptions)
      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.
      Parameters:
      addEndpointGatewayIpOptions - the AddEndpointGatewayIpOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type ReservedIP

    • deleteEndpointGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteEndpointGateway(DeleteEndpointGatewayOptions deleteEndpointGatewayOptions)
      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.
      Parameters:
      deleteEndpointGatewayOptions - the DeleteEndpointGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getEndpointGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointGateway> getEndpointGateway(GetEndpointGatewayOptions getEndpointGatewayOptions)
      Retrieve an endpoint gateway. This request retrieves a single endpoint gateway specified by the identifier in the URL.
      Parameters:
      getEndpointGatewayOptions - the GetEndpointGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type EndpointGateway

    • updateEndpointGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<EndpointGateway> updateEndpointGateway(UpdateEndpointGatewayOptions updateEndpointGatewayOptions)
      Update an endpoint gateway. This request updates an endpoint gateway's name.
      Parameters:
      updateEndpointGatewayOptions - the UpdateEndpointGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type EndpointGateway

    • listFlowLogCollectors

      public com.ibm.cloud.sdk.core.http.ServiceCall<FlowLogCollectorCollection> listFlowLogCollectors(ListFlowLogCollectorsOptions listFlowLogCollectorsOptions)
      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 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).
      Parameters:
      listFlowLogCollectorsOptions - the ListFlowLogCollectorsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FlowLogCollectorCollection

    • listFlowLogCollectors

      public com.ibm.cloud.sdk.core.http.ServiceCall<FlowLogCollectorCollection> listFlowLogCollectors()
      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 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).
      Returns:
      a ServiceCall with a result of type FlowLogCollectorCollection

    • createFlowLogCollector

      public com.ibm.cloud.sdk.core.http.ServiceCall<FlowLogCollector> createFlowLogCollector(CreateFlowLogCollectorOptions createFlowLogCollectorOptions)
      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.
      Parameters:
      createFlowLogCollectorOptions - the CreateFlowLogCollectorOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FlowLogCollector

    • deleteFlowLogCollector

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteFlowLogCollector(DeleteFlowLogCollectorOptions deleteFlowLogCollectorOptions)
      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.
      Parameters:
      deleteFlowLogCollectorOptions - the DeleteFlowLogCollectorOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getFlowLogCollector

      public com.ibm.cloud.sdk.core.http.ServiceCall<FlowLogCollector> getFlowLogCollector(GetFlowLogCollectorOptions getFlowLogCollectorOptions)
      Retrieve a flow log collector. This request retrieves a single flow log collector specified by the identifier in the URL.
      Parameters:
      getFlowLogCollectorOptions - the GetFlowLogCollectorOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FlowLogCollector

    • updateFlowLogCollector

      public com.ibm.cloud.sdk.core.http.ServiceCall<FlowLogCollector> updateFlowLogCollector(UpdateFlowLogCollectorOptions updateFlowLogCollectorOptions)
      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.
      Parameters:
      updateFlowLogCollectorOptions - the UpdateFlowLogCollectorOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type FlowLogCollector

    • listPrivatePathServiceGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayCollection> listPrivatePathServiceGateways(ListPrivatePathServiceGatewaysOptions listPrivatePathServiceGatewaysOptions)
      List private path service gateways. This request lists private path service gateways in the region. Private path service gateways allow [service providers](https://cloud.ibm.com/docs/private-path?topic=private-path-private-path-service-architecture#private-path-service-components) to make their services available using [private path connectivity](https://cloud.ibm.com/docs/private-path?topic=private-path-private-path-service-architecture#private-path-service-components). Private path service gateways are used to facilitate and manage the private path connectivity between private path network load balancers and their associated endpoint gateways.
      Parameters:
      listPrivatePathServiceGatewaysOptions - the ListPrivatePathServiceGatewaysOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayCollection

    • listPrivatePathServiceGateways

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayCollection> listPrivatePathServiceGateways()
      List private path service gateways. This request lists private path service gateways in the region. Private path service gateways allow [service providers](https://cloud.ibm.com/docs/private-path?topic=private-path-private-path-service-architecture#private-path-service-components) to make their services available using [private path connectivity](https://cloud.ibm.com/docs/private-path?topic=private-path-private-path-service-architecture#private-path-service-components). Private path service gateways are used to facilitate and manage the private path connectivity between private path network load balancers and their associated endpoint gateways.
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayCollection

    • createPrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGateway> createPrivatePathServiceGateway(CreatePrivatePathServiceGatewayOptions createPrivatePathServiceGatewayOptions)
      Create a private path service gateway. This request creates a private path service gateway from a private path service gateway prototype object. The prototype object is structured in the same way as a retrieved private path service gateway, and contains the information necessary to create the new private path service gateway.
      Parameters:
      createPrivatePathServiceGatewayOptions - the CreatePrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGateway

    • deletePrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deletePrivatePathServiceGateway(DeletePrivatePathServiceGatewayOptions deletePrivatePathServiceGatewayOptions)
      Delete a private path service gateway. This request deletes a private path service gateway. For this request to succeed, the value of `endpoint_gateway_count` must be `0`. This operation cannot be reversed.
      Parameters:
      deletePrivatePathServiceGatewayOptions - the DeletePrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getPrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGateway> getPrivatePathServiceGateway(GetPrivatePathServiceGatewayOptions getPrivatePathServiceGatewayOptions)
      Retrieve a private path service gateway. This request retrieves the private path service gateway specified by the identifier in the URL.
      Parameters:
      getPrivatePathServiceGatewayOptions - the GetPrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGateway

    • updatePrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGateway> updatePrivatePathServiceGateway(UpdatePrivatePathServiceGatewayOptions updatePrivatePathServiceGatewayOptions)
      Update a private path service gateway. This request updates a private path service gateway with the information provided in a private path service gateway patch object. The private path service gateway patch object is structured in the same way as a retrieved private path service gateway and contains only the information to be updated.
      Parameters:
      updatePrivatePathServiceGatewayOptions - the UpdatePrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGateway

    • listPrivatePathServiceGatewayAccountPolicies

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayAccountPolicyCollection> listPrivatePathServiceGatewayAccountPolicies(ListPrivatePathServiceGatewayAccountPoliciesOptions listPrivatePathServiceGatewayAccountPoliciesOptions)
      List account policies for a private path service gateway. This request lists account policies for a private path service gateway. Each policy defines how requests to use the private path service gateway from that account will be handled. The account policies will be sorted by their `created_at` property values, with newest account policies first. Account policies with identical `created_at` property values will in turn be sorted by ascending `id` property values.
      Parameters:
      listPrivatePathServiceGatewayAccountPoliciesOptions - the ListPrivatePathServiceGatewayAccountPoliciesOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayAccountPolicyCollection

    • createPrivatePathServiceGatewayAccountPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayAccountPolicy> createPrivatePathServiceGatewayAccountPolicy(CreatePrivatePathServiceGatewayAccountPolicyOptions createPrivatePathServiceGatewayAccountPolicyOptions)
      Create an account policy for a private path service gateway. This request creates an account policy from an account policy prototype object. The prototype object is structured in the same way as a retrieved account policy, and contains the information necessary to create the new account policy.
      Parameters:
      createPrivatePathServiceGatewayAccountPolicyOptions - the CreatePrivatePathServiceGatewayAccountPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayAccountPolicy

    • deletePrivatePathServiceGatewayAccountPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deletePrivatePathServiceGatewayAccountPolicy(DeletePrivatePathServiceGatewayAccountPolicyOptions deletePrivatePathServiceGatewayAccountPolicyOptions)
      Delete an account policy for a private path service gateway. This request deletes an account policy. This operation cannot be reversed and it does not affect the `status` of any existing endpoint gateway bindings.
      Parameters:
      deletePrivatePathServiceGatewayAccountPolicyOptions - the DeletePrivatePathServiceGatewayAccountPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • getPrivatePathServiceGatewayAccountPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayAccountPolicy> getPrivatePathServiceGatewayAccountPolicy(GetPrivatePathServiceGatewayAccountPolicyOptions getPrivatePathServiceGatewayAccountPolicyOptions)
      Retrieve an account policy for a private path service gateway. This request retrieves a single account policy specified by the identifier in the URL.
      Parameters:
      getPrivatePathServiceGatewayAccountPolicyOptions - the GetPrivatePathServiceGatewayAccountPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayAccountPolicy

    • updatePrivatePathServiceGatewayAccountPolicy

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayAccountPolicy> updatePrivatePathServiceGatewayAccountPolicy(UpdatePrivatePathServiceGatewayAccountPolicyOptions updatePrivatePathServiceGatewayAccountPolicyOptions)
      Update an account policy for a private path service gateway. This request updates an account policy with the information in a provided account policy patch. The account policy patch object is structured in the same way as a retrieved account policy and contains only the information to be updated.
      Parameters:
      updatePrivatePathServiceGatewayAccountPolicyOptions - the UpdatePrivatePathServiceGatewayAccountPolicyOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayAccountPolicy

    • listPrivatePathServiceGatewayEndpointGatewayBindings

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayEndpointGatewayBindingCollection> listPrivatePathServiceGatewayEndpointGatewayBindings(ListPrivatePathServiceGatewayEndpointGatewayBindingsOptions listPrivatePathServiceGatewayEndpointGatewayBindingsOptions)
      List endpoint gateway bindings for a private path service gateway. This request lists endpoint gateway bindings for a private path service gateway. Each endpoint gateway binding is implicitly created when an endpoint gateway is created targeting the private path service gateway. The associated account policy is applied to all new endpoint gateway bindings. If an associated account policy doesn't exist, the private path service gateway's `default_access_policy` is used. The endpoint gateway bindings will be sorted by their `created_at` property values, with newest endpoint gateway bindings first. Endpoint gateway bindings with identical `created_at` property values will in turn be sorted by ascending `name` property values.
      Parameters:
      listPrivatePathServiceGatewayEndpointGatewayBindingsOptions - the ListPrivatePathServiceGatewayEndpointGatewayBindingsOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayEndpointGatewayBindingCollection

    • getPrivatePathServiceGatewayEndpointGatewayBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<PrivatePathServiceGatewayEndpointGatewayBinding> getPrivatePathServiceGatewayEndpointGatewayBinding(GetPrivatePathServiceGatewayEndpointGatewayBindingOptions getPrivatePathServiceGatewayEndpointGatewayBindingOptions)
      Retrieve an endpoint gateway binding for a private path service gateway. This request retrieves a single endpoint gateway binding specified by the identifier in the URL.
      Parameters:
      getPrivatePathServiceGatewayEndpointGatewayBindingOptions - the GetPrivatePathServiceGatewayEndpointGatewayBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a result of type PrivatePathServiceGatewayEndpointGatewayBinding

    • denyPrivatePathServiceGatewayEndpointGatewayBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> denyPrivatePathServiceGatewayEndpointGatewayBinding(DenyPrivatePathServiceGatewayEndpointGatewayBindingOptions denyPrivatePathServiceGatewayEndpointGatewayBindingOptions)
      Deny an endpoint gateway binding for a private path service gateway. This request denies a `pending` endpoint gateway request, and optionally sets the policy to deny future requests from the same account.
      Parameters:
      denyPrivatePathServiceGatewayEndpointGatewayBindingOptions - the DenyPrivatePathServiceGatewayEndpointGatewayBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • permitPrivatePathServiceGatewayEndpointGatewayBinding

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> permitPrivatePathServiceGatewayEndpointGatewayBinding(PermitPrivatePathServiceGatewayEndpointGatewayBindingOptions permitPrivatePathServiceGatewayEndpointGatewayBindingOptions)
      Permit an endpoint gateway binding for a private path service gateway. This request permits a `pending` endpoint gateway request, and optionally sets the policy to permit future requests from the same account.
      Parameters:
      permitPrivatePathServiceGatewayEndpointGatewayBindingOptions - the PermitPrivatePathServiceGatewayEndpointGatewayBindingOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • publishPrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> publishPrivatePathServiceGateway(PublishPrivatePathServiceGatewayOptions publishPrivatePathServiceGatewayOptions)
      Publish a private path service gateway. This request publishes a private path service gateway, allowing any account to request access to it.
      Parameters:
      publishPrivatePathServiceGatewayOptions - the PublishPrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • revokeAccountForPrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> revokeAccountForPrivatePathServiceGateway(RevokeAccountForPrivatePathServiceGatewayOptions revokeAccountForPrivatePathServiceGatewayOptions)
      Revoke access to a private path service gateway for an account. This request revokes a consumer account. This operation cannot be reversed. The `status` of all endpoint gateway bindings associated with the specified private path service gateway become `denied`. If the specified account has an existing access policy, that policy will be updated to `denied`. Otherwise, a new `deny` access policy will be created for the account.
      Parameters:
      revokeAccountForPrivatePathServiceGatewayOptions - the RevokeAccountForPrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result

    • unpublishPrivatePathServiceGateway

      public com.ibm.cloud.sdk.core.http.ServiceCall<Void> unpublishPrivatePathServiceGateway(UnpublishPrivatePathServiceGatewayOptions unpublishPrivatePathServiceGatewayOptions)
      Unpublish a private path service gateway. This request unpublishes a private path service gateway. For this request to succeed, any existing access from other accounts must first be revoked. Once unpublished, access will again be restricted to the account that created this private path service gateway.
      Parameters:
      unpublishPrivatePathServiceGatewayOptions - the UnpublishPrivatePathServiceGatewayOptions containing the options for the call
      Returns:
      a ServiceCall with a void result