Class LoadBalancer

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.LoadBalancer
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class LoadBalancer extends com.ibm.cloud.sdk.core.service.model.GenericModel
LoadBalancer.

  • Method Details

    • getAccessMode

      public String getAccessMode()
      Gets the accessMode. The access mode for this load balancer: - `private`: reachable from within its VPC, at IP addresses in `private_ips` - `private_path`: reachable through an endpoint gateway - `public`: reachable from the internet at the IP addresses in `public_ips`. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the accessMode

    • getAvailability

      public String getAvailability()
      Gets the availability. The availability of this load balancer: - `subnet`: remains available if at least one zone that the load balancer's subnets reside in is available - `region`: remains available if at least one zone in the region is available. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the availability

    • getCreatedAt

      public Date getCreatedAt()
      Gets the createdAt. The date and time that this load balancer was created.
      Returns:
      the createdAt

    • getCrn

      public String getCrn()
      Gets the crn. The CRN for this load balancer.
      Returns:
      the crn

    • getDns

      public LoadBalancerDNS getDns()
      Gets the dns. The DNS configuration for this load balancer. If absent, DNS `A` records for this load balancer's `hostname` property will be added to the public DNS zone `lb.appdomain.cloud`. Not supported by private path load balancers.
      Returns:
      the dns

    • getHostname

      public String getHostname()
      Gets the hostname. Fully qualified domain name assigned to this load balancer.
      Returns:
      the hostname

    • getHref

      public String getHref()
      Gets the href. The URL for this load balancer.
      Returns:
      the href

    • getId

      public String getId()
      Gets the id. The unique identifier for this load balancer.
      Returns:
      the id

    • isInstanceGroupsSupported

      public Boolean isInstanceGroupsSupported()
      Gets the instanceGroupsSupported. Indicates whether this load balancer supports instance groups.
      Returns:
      the instanceGroupsSupported

    • isIsPrivatePath

      public Boolean isIsPrivatePath()
      Gets the isPrivatePath. Indicates whether this is a private path load balancer.
      Returns:
      the isPrivatePath

    • isIsPublic

      public Boolean isIsPublic()
      Gets the isPublic. The type of this load balancer, public or private.
      Returns:
      the isPublic

    • getListeners

      public List<LoadBalancerListenerReference> getListeners()
      Gets the listeners. The listeners of this load balancer.
      Returns:
      the listeners

    • getLogging

      public LoadBalancerLogging getLogging()
      Gets the logging. The logging configuration for this load balancer.
      Returns:
      the logging

    • getName

      public String getName()
      Gets the name. The name for this load balancer. The name is unique across all load balancers in the VPC.
      Returns:
      the name

    • getOperatingStatus

      public String getOperatingStatus()
      Gets the operatingStatus. The operating status of this load balancer. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the operatingStatus

    • getPools

      public List<LoadBalancerPoolReference> getPools()
      Gets the pools. The pools of this load balancer.
      Returns:
      the pools

    • getPrivateIps

      public List<ReservedIPReference> getPrivateIps()
      Gets the privateIps. The private IP addresses assigned to this load balancer. Will be empty if `is_private` is `false`.
      Returns:
      the privateIps

    • getProfile

      public LoadBalancerProfileReference getProfile()
      Gets the profile. The profile for this load balancer.
      Returns:
      the profile

    • getProvisioningStatus

      public String getProvisioningStatus()
      Gets the provisioningStatus. The provisioning status of this load balancer: - `active`: The load balancer is running. - `create_pending`: The load balancer is being created. - `delete_pending`: The load balancer is being deleted. - `maintenance_pending`: The load balancer is unavailable due to an internal error (contact IBM support). - `migrate_pending`: The load balancer is migrating to the requested configuration. Performance may be degraded. - `update_pending`: The load balancer is being updated to the requested configuration. The enumerated values for this property may [expand](https://cloud.ibm.com/apidocs/vpc#property-value-expansion) in the future.
      Returns:
      the provisioningStatus

    • getPublicIps

      public List<IP> getPublicIps()
      Gets the publicIps. The public IP addresses assigned to this load balancer. Will be empty if `is_public` is `false`.
      Returns:
      the publicIps

    • getResourceGroup

      public ResourceGroupReference getResourceGroup()
      Gets the resourceGroup. The resource group for this load balancer.
      Returns:
      the resourceGroup

    • getResourceType

      public String getResourceType()
      Gets the resourceType. The resource type.
      Returns:
      the resourceType

    • isRouteMode

      public Boolean isRouteMode()
      Gets the routeMode. Indicates whether route mode is enabled for this load balancer. At present, public load balancers are not supported with route mode enabled.
      Returns:
      the routeMode

    • getSecurityGroups

      public List<SecurityGroupReference> getSecurityGroups()
      Gets the securityGroups. The security groups targeting this load balancer. If empty, all inbound and outbound traffic is allowed.
      Returns:
      the securityGroups

    • isSecurityGroupsSupported

      public Boolean isSecurityGroupsSupported()
      Gets the securityGroupsSupported. Indicates whether this load balancer supports security groups.
      Returns:
      the securityGroupsSupported

    • isSourceIpSessionPersistenceSupported

      public Boolean isSourceIpSessionPersistenceSupported()
      Gets the sourceIpSessionPersistenceSupported. Indicates whether this load balancer supports source IP session persistence.
      Returns:
      the sourceIpSessionPersistenceSupported

    • getSubnets

      public List<SubnetReference> getSubnets()
      Gets the subnets. The subnets this load balancer is provisioned in. All subnets will be in the same VPC.
      Returns:
      the subnets

    • isUdpSupported

      public Boolean isUdpSupported()
      Gets the udpSupported. Indicates whether this load balancer supports UDP.
      Returns:
      the udpSupported