Struct Projects

pub struct Projects {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Projects

pub async fn view(&self, id: &str) -> Result<Project>

Fetch a project by id.

This function performs a GET to the /by-id/projects/{id} endpoint.

Parameters:

• id: &str

pub async fn get_page( &self, limit: u32, organization_name: &str, page_token: &str, sort_by: NameOrIdSortMode, ) -> Result<Vec<Project>>

List projects.

This function performs a GET to the /organizations/{organization_name}/projects endpoint.

Parameters:

• limit: u32 – Maximum number of items returned by a single call.
• page_token: &str – Token returned by previous call to retrieve the subsequent page.
• sort_by: crate::types::NameOrIdSortMode – Supported set of sort modes for scanning by name or id.
• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

pub async fn get_all( &self, organization_name: &str, sort_by: NameOrIdSortMode, ) -> Result<Vec<Project>>

List projects.

This function performs a GET to the /organizations/{organization_name}/projects endpoint.

As opposed to get, this function returns all the pages of the request at once.

pub async fn post( &self, organization_name: &str, body: &ProjectCreate, ) -> Result<Project>

Create a project.

This function performs a POST to the /organizations/{organization_name}/projects endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

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

Fetch a project.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
• project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

pub async fn put( &self, organization_name: &str, project_name: &str, body: &ProjectUpdate, ) -> Result<Project>

Update a project.

This function performs a PUT to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
• project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

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

Delete a project.

This function performs a DELETE to the /organizations/{organization_name}/projects/{project_name} endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
• project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

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

Fetch a project’s IAM policy.

This function performs a GET to the /organizations/{organization_name}/projects/{project_name}/policy endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
• project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.

pub async fn put_policy( &self, organization_name: &str, project_name: &str, body: &ProjectRolePolicy, ) -> Result<ProjectRolePolicy>

Update a project’s IAM policy.

This function performs a PUT to the /organizations/{organization_name}/projects/{project_name}/policy endpoint.

Parameters:

• organization_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.
• project_name: &str – Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and ‘-’, and may not end with a ‘-’. Names cannot be a UUID though they may contain a UUID.