Struct oxide_api::networking::Networking

pub struct Networking {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Networking

pub async fn project_vpcs_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Vpc>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs endpoint.
• List VPCs in a project.
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.

pub async fn project_vpcs_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str
) -> Result<Vec<Vpc>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs endpoint.
• As opposed to project_vpcs_get, this function returns all the pages of the request at once.
• List VPCs in a project.

pub async fn project_vpcs_post(
    &self,
    organization_name: &str,
    project_name: &str,
    body: &VpcCreate
) -> Result<Vpc>

• This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/vpcs endpoint.
• Create a VPC in a project.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.

pub async fn project_vpcs_get_vpc(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vpc>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name} endpoint.
• Get a VPC in a project.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn project_vpcs_put_vpc(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str,
    body: &VpcUpdate
) -> Result<()>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name} endpoint.
• Update a VPC.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn project_vpcs_delete_vpc(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name} endpoint.
• Delete a vpc from a project.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_firewall_rules_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcFirewallRule>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/firewall/rules endpoint.
• List firewall rules for a VPC.
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_firewall_rules_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcFirewallRule>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/firewall/rules endpoint.
• As opposed to vpc_firewall_rules_get, this function returns all the pages of the request at once.
• List firewall rules for a VPC.

pub async fn vpc_firewall_rules_put(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str,
    body: &VpcFirewallRuleUpdate
) -> Result<VpcFirewallRule>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/firewall/rules endpoint.
• Replace the firewall rules for a VPC
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_routers_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcRouter>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers endpoint.
• List VPC Custom and System Routers
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_routers_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcRouter>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers endpoint.
• As opposed to vpc_routers_get, this function returns all the pages of the request at once.
• List VPC Custom and System Routers

pub async fn vpc_routers_post(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str,
    body: &ProjectCreate
) -> Result<VpcRouter>

• This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers endpoint.
• Create a VPC Router
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_routers_get_router(
    &self,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<VpcRouter>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name} endpoint.
• Get a VPC Router
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_routers_put_router(
    &self,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str,
    body: &VpcRouterUpdate
) -> Result<()>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name} endpoint.
• Update a VPC Router
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_routers_delete_router(
    &self,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name} endpoint.
• Delete a router from its VPC
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn routers_routes_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<Vec<RouterRoute>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes endpoint.
• List a Router’s routes
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn routers_routes_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<Vec<RouterRoute>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes endpoint.
• As opposed to routers_routes_get, this function returns all the pages of the request at once.
• List a Router’s routes

pub async fn routers_routes_post(
    &self,
    organization_name: &str,
    project_name: &str,
    router_name: &str,
    vpc_name: &str,
    body: &RouterRouteCreateParams
) -> Result<RouterRoute>

• This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes endpoint.
• Create a VPC Router
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn routers_routes_get_route(
    &self,
    organization_name: &str,
    project_name: &str,
    route_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<RouterRoute>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes/{route_name} endpoint.
• Get a VPC Router route
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • route_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn routers_routes_put_route(
    &self,
    organization_name: &str,
    project_name: &str,
    route_name: &str,
    router_name: &str,
    vpc_name: &str,
    body: &RouterRouteUpdateParams
) -> Result<()>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes/{route_name} endpoint.
• Update a Router route
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • route_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn routers_routes_delete_route(
    &self,
    organization_name: &str,
    project_name: &str,
    route_name: &str,
    router_name: &str,
    vpc_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/routers/{router_name}/routes/{route_name} endpoint.
• Delete a route from its router
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • route_name: &str – human-readable free-form text about a resource.
• • router_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_subnets_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcSubnet>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets endpoint.
• List subnets in a VPC.
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_subnets_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str
) -> Result<Vec<VpcSubnet>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets endpoint.
• As opposed to vpc_subnets_get, this function returns all the pages of the request at once.
• List subnets in a VPC.

pub async fn vpc_subnets_post(
    &self,
    organization_name: &str,
    project_name: &str,
    vpc_name: &str,
    body: &VpcSubnetCreate
) -> Result<VpcSubnet>

• This function performs a POST to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets endpoint.
• Create a subnet in a VPC.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_subnets_get_subnet(
    &self,
    organization_name: &str,
    project_name: &str,
    subnet_name: &str,
    vpc_name: &str
) -> Result<VpcSubnet>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets/{subnet_name} endpoint.
• Get subnet in a VPC.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • subnet_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_subnets_put_subnet(
    &self,
    organization_name: &str,
    project_name: &str,
    subnet_name: &str,
    vpc_name: &str,
    body: &VpcSubnetUpdate
) -> Result<()>

• This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets/{subnet_name} endpoint.
• Update a VPC Subnet.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • subnet_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn vpc_subnets_delete_subnet(
    &self,
    organization_name: &str,
    project_name: &str,
    subnet_name: &str,
    vpc_name: &str
) -> Result<()>

• This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets/{subnet_name} endpoint.
• Delete a subnet from a VPC.
• Parameters:
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • subnet_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn subnets_ips_get(
    &self,
    limit: u32,
    page_token: &str,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    subnet_name: &str,
    vpc_name: &str
) -> Result<Vec<NetworkInterface>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets/{subnet_name}/ips endpoint.
• List IP addresses on a VPC subnet.
• Parameters:
• • limit: u32 – A count of bytes, typically used either for memory or storage capacity
• The maximum supported byte count is i64::MAX. This makes it somewhat inconvenient to define constructors: a u32 constructor can be infallible, but an i64 constructor can fail (if the value is negative) and a u64 constructor can fail (if the value is larger than i64::MAX). We provide all of these for consumers’ convenience.
• • page_token: &str – human-readable free-form text about a resource.
• • sort_by: crate::types::NameSortModeAscending – Supported set of sort modes for scanning by name only
• Currently, we only support scanning in ascending order.
• • organization_name: &str – human-readable free-form text about a resource.
• • project_name: &str – human-readable free-form text about a resource.
• • subnet_name: &str – human-readable free-form text about a resource.
• • vpc_name: &str – human-readable free-form text about a resource.

pub async fn subnets_ips_get_all(
    &self,
    sort_by: NameSortModeAscending,
    organization_name: &str,
    project_name: &str,
    subnet_name: &str,
    vpc_name: &str
) -> Result<Vec<NetworkInterface>>

• This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/vpcs/{vpc_name}/subnets/{subnet_name}/ips endpoint.
• As opposed to subnets_ips_get, this function returns all the pages of the request at once.
• List IP addresses on a VPC subnet.