Class ListPublicIpsRequest

Inheritance

object

ListPublicIpsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CoreService.Requests

Assembly: OCI.DotNetSDK.Core.dll

Syntax

public class ListPublicIpsRequest : IOciRequest

Examples

Click here to see an example of how to use ListPublicIps request.

Properties

AvailabilityDomain

Declaration

[HttpConverter(TargetEnum.Query, "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The name of the availability domain. Example: Uocm:PHX-AD-1

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

Lifetime

Declaration

[HttpConverter(TargetEnum.Query, "lifetime")]
public ListPublicIpsRequest.LifetimeEnum? Lifetime { get; set; }

Property Value

Type	Description
ListPublicIpsRequest.LifetimeEnum?	A filter to return only public IPs that match given lifetime.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. Example: 50

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see List Pagination.

PublicIpPoolId

Declaration

[HttpConverter(TargetEnum.Query, "publicIpPoolId")]
public string PublicIpPoolId { get; set; }

Property Value

Type	Description
string	A filter to return only resources that belong to the given public IP pool.

Scope

Declaration

[Required(ErrorMessage = "Scope is required.")]
[HttpConverter(TargetEnum.Query, "scope")]
public ListPublicIpsRequest.ScopeEnum? Scope { get; set; }

Property Value

Type Description

Type	Description
ListPublicIpsRequest.ScopeEnum?	Whether the public IP is regional or specific to a particular availability domain. `REGION`: The public IP exists within a region and is assigned to a regional entity (such as a {@link NatGateway}), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do ephemeral public IPs assigned to a regional entity. `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.

ListPublicIpsRequest.ScopeEnum?

Whether the public IP is regional or specific to a particular availability domain.

REGION: The public IP exists within a region and is assigned to a regional entity (such as a {@link NatGateway}), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have scope = REGION, as do ephemeral public IPs assigned to a regional entity.
AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.

Remarks

Required

Implements

IOciRequest